Skip to main content

Test Numeral Connection

POST 

/api/numeral/instances/:instance/test-connection

Re-validates the stored key. Success stamps last_verified_at and clears a key error; a rejected key flags the connection (connection_error: auth_error) and pauses sending until the key is replaced.

Required scope: accounting:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Numeral failures return 422 with a stable code: invalid_key (Numeral did not recognise this key), production_key_refused (a production key on a non-production SKU.io), rate_limited, api_error (Numeral refused the request; message carries its reason) or unreachable (Numeral could not be reached).

Authentication: Requires a Bearer token. Requires the integrations.sync permission.

Request​

Responses​

OK

Response Headers
    Content-Type