Skip to main content
GET
/
tax
/
ping
curl https://api.numeralhq.com/tax/ping \
  -H "Authorization: Bearer sk_test_xxx" \
  -H "X-API-Version: 2026-01-01"

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

Documentation Index

Fetch the complete documentation index at: https://docs.numeral.com/llms.txt

Use this file to discover all available pages before exploring further.

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 https://api.numeralhq.com/tax/ping \
  -H "Authorization: Bearer sk_test_xxx" \
  -H "X-API-Version: 2026-01-01"

{
  "status": "ok",
  "env": "test",
  "timestamp": "2026-01-01T12:00:00.000Z",
  "api_version": "2026-01-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

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"