Skip to content

Ping

Method GET
Path /v1/ping

Health check endpoint used to confirm that the Xref API is available.

Authentication is not required. This is the only endpoint that bypasses both auth and throttling.

Request

No headers required.

Response

200 — application/json

{
  "data": {
    "status": "ok"
  },
  "status_message": "ok",
  "message": ""
}

A 200 response confirms that the Xref API is available. This endpoint does not check the availability of downstream services or third-party providers.

Errors

A non-200 response may indicate that the Xref API is unavailable. See Errors and status codes for details.

Notes

  • Authentication is not required.
  • The endpoint is not subject to rate limits.