Health Check

Authenticated health check endpoint

GET /tax/ping

cURL

curl https://api.numeralhq.com/tax/ping \
  -H "Authorization: Bearer sk_test_xxx" \
  -H "X-API-Version: 2026-03-01"

200 - Success

{
  "status": "ok",
  "env": "test",
  "timestamp": "2026-03-01T12:00:00.000Z",
  "api_version": "2026-03-01"
}

Authenticated health check endpoint that returns status, environment, timestamp, and API version.

Headers

Authorization · string · required

Bearer token authentication.

X-API-Version · string

API version to use. Defaults to 2024-09-01 if not specified.

Response

status · string

Always ok for successful health checks.

env · string

Environment indicator: test for testmode keys, prod for production keys.

timestamp · string

Current ISO 8601 timestamp.

api_version · string

The API version being used.

cURL

curl https://api.numeralhq.com/tax/ping \
  -H "Authorization: Bearer sk_test_xxx" \
  -H "X-API-Version: 2026-03-01"

200 - Success

{
  "status": "ok",
  "env": "test",
  "timestamp": "2026-03-01T12:00:00.000Z",
  "api_version": "2026-03-01"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Version · enum<string> · default: 2024-09-01

API version to use. Defaults to 2024-09-01 if not specified.

Available options: 2025-05-12, 2024-09-01

Response

200

application/json

Successful health check response

Health check response containing status, environment, timestamp, and API version information

status · enum<string> · required

Always returns 'ok' for successful health checks

Available options: ok

Example:

"ok"

env · enum<string> · required

Environment indicator based on API key type: 'test' for testmode keys, 'prod' for production keys

Available options: test, prod

Example:

"test"

timestamp · string<date-time> · required

Current ISO 8601 timestamp when the request was processed

Example:

"2025-09-12T17:30:00.000Z"

api_version · enum<string> · required

API version from X-API-Version header, or falls back to 2024-09-01

Available options: 2024-09-01, 2025-05-12

Example:

"2025-05-12"