Skip to content

Verify Access Key API

The Verify Access Key API lets a developer check a credential before relying on it in other calls. Its purpose is to verify that the provided access key is valid, using a single header parameter and a small success response that is easy to assert in client code.

Request contract

Use this operation when a client needs a lightweight preflight check for its credential. Send a GET request to /v1/health/auth and supply the credential through the Authorization parameter named accessKey. The value travels in the x-access-key header, so the request carries the key as a header value rather than as a query parameter or request-body field. Keep the token out of URLs and logs, and read it from configuration or a secret store at runtime.

Response contract

A successful check returns status 200 with an application/json body. The documented response contains one required field, ok, whose type is boolean. In the documented example the value is true, indicating that the check returned success for the supplied key. Treat the presence and type of ok as the contract: a client should parse the JSON body and check the boolean field instead of relying only on the HTTP status.

Worked example

The worked example titled Verify Access Key API request example shows the exact method and path with the origin replaced by the modular base URL placeholder, plus the x-access-key header carrying a placeholder token. Replace the placeholder with the real key only in your own request configuration, never in committed examples. The example titled Verify Access Key API success response example shows the exact documented body for a successful check.

Interpretation and limits

Interpret the result narrowly and only as documented. A 200 response with ok set to true means the access-key check returned success. The source documents no additional response fields, so do not depend on fields that are not listed in the response contract table. Likewise, do not assume undocumented error codes, error bodies, rate limits, or key lifecycle behavior; handle any non-success outcome as an unspecified failure and surface it for investigation rather than inventing a meaning for it. The interpretation matrix titled Verify Access Key API interpretation matrix summarizes the documented behavior and its limits.

Verify Access Key API input contract
NameLocationTypeRequiredDescription
accessKeyheader (x-access-key)string (<token> placeholder)As documented in AuthorizationAccess key supplied for validation

Documented source contract; no additional parameters documented.

Verify Access Key API response contract
FieldTypeRequiredDocumented example
okbooleantruetrue

Documented source contract for the 200 response.

Verify Access Key API interpretation matrix
StatusMedia typeBodyInterpretation
200application/json{"ok": true}The access-key check returned success

Limited to documented behavior; no error codes or extra fields invented.

Verify Access Key API request example
curl -X GET "{{API_BASE_URL}}/v1/health/auth" \
  -H "x-access-key: <token>"
Verify Access Key API success response example
{
  "ok": true
}
Interface fields
ScopeFieldTypeType referenceRequiredDescription
response#1responseobject__0
response#1response.okboolean__1Yes