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.
accounting:writeGrant 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_orsk_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
- 200
- 401
- 403
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.