Skip to main content
GET
/
tax
/
ping
Health Check Ping
curl --request GET \
  --url https://api.numeralhq.com/tax/ping \
  --header 'Authorization: Bearer <token>'
{
  "status": "ok",
  "env": "test",
  "timestamp": "2025-09-12T17:30:00.000Z",
  "api_version": "2025-05-12"
}

​
Health Check Endpoint (2025-05-12)

Authenticated health check endpoint that returns status, environment, timestamp, and API version information.
The X-API-Version header is optional for this endpoint. If provided, it will be reflected in the response’s api_version field.

​
Use Cases

Use this endpoint to:
  • Verify API connectivity and authentication
  • Check which environment your API key is configured for (test vs. production)
  • Confirm API version compatibility
  • Monitor service availability in your application health checks

​
Response Fields

  • status: Always returns “ok” for successful requests
  • env: “test” if using a testmode API key, “prod” for production keys
  • timestamp: Current ISO 8601 timestamp when the request was processed
  • api_version: The API version from the X-API-Version header, or falls back to “2024-09-01”

​
Authentication Required

This endpoint requires a SECRET API key. PUBLIC keys are not supported and will return a 401 error.

​
Rate Limiting

This endpoint is subject to rate limiting per API key and IP address. If you exceed the rate limit, you’ll receive a 429 error response.

​
Response Headers

  • X-Request-ID: Unique identifier for the request (useful for debugging)
  • Cache-Control: Set to “no-cache, no-store” to prevent caching

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"