Sign in

v1

latestOpenAPI 3.0.02026-08-06132933.0 KB
Auth

Validate an API key

Validates the API key supplied in the x-api-key header.

Use this endpoint as a setup/health check. Integration partners can call it to confirm a customer's key before enabling data ingestion or completing account linking.

  • 200 OK: Key is valid.
  • 401 Unauthorized: Key is missing or invalid (standard error envelope).
get/v1/auth/validate-key

Response

Successful response confirming the provided API key is valid.

requestIdstring

Unique identifier for the request.

statusstring

Indicates the status of the request.

Example response

{
  "requestId": "b0eac937-c25c-47a5-bb7e-552f6b860458",
  "status": "success"
}