Skip to main content

Test Numeral API Key

POST 

/api/numeral/test

Validates an unsaved Numeral secret key live (Numeral GET /tax/ping) and reports its mode. Nothing is saved.

Required scope: accounting:write

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

Body fields:

  • api_key (string, required): a Numeral secret key, 16–255 characters, starting with sk_test_ or sk_prod_. Whitespace is trimmed.

Returns 200 with connected, mode (test | prod) and api_version. 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.create permission.

Request​

Responses​

OK

Response Headers
    Content-Type