Authenticated health check endpoint

get/tax/ping

Request

  • Base URL
    https://api.numeralhq.com
  • URL
    https://api.numeralhq.com/tax/ping
  • Auth
    HTTP bearer

Headers

X-API-Version'2026-03-01'

Response

Successful health check response

status'ok'
env'test' | 'prod'
timestampstring date-time
api_versionstring

Changes

    • breaking

      for the header request parameter X-API-Version, default value 2024-09-01 was removed

    • breaking

      removed the enum value 2024-09-01 from the header request parameter X-API-Version

    • breaking

      removed the enum value 2025-05-12 from the header request parameter X-API-Version

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      removed the required property from the response with the status

    • warning

      the optional response header Cache-Control removed for the status 200

    • warning

      the optional response header X-Request-ID removed for the status 200

    • info

      api operation id pingHealthCheck removed and replaced with pingHealthCheck_v20260301

    • info

      the endpoint scheme security bearerAuth was removed from the API

    • info

      added the new enum value 2026-03-01 to the header request parameter X-API-Version

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      removed the 2024-09-01 enum value from the response property for the response status

    • info

      removed the 2025-05-12 enum value from the response property for the response status