v1

latestOpenAPI 3.0.1MIT2026-07-13153492.5 KB

Health Check Ping

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

get/tax/ping

X-API-Version'2025-05-12' | '2024-09-01'

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

Successful health check response

status'ok' required

Always returns 'ok' for successful health checks

env'test' | 'prod' required

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

timestampstring date-time required

Current ISO 8601 timestamp when the request was processed

api_version'2024-09-01' | '2025-05-12' required

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

{
  "status": "ok",
  "env": "test",
  "timestamp": "2025-09-12T17:30:00.000Z",
  "api_version": "2025-05-12"
}