Skip to main content
Clearlayer uses API key authentication via the HTTP Authorization header. Every request (except GET /v1/health) must include a Bearer token. Requests without a valid key are rejected with a 401 response.

Your API key

The sandbox API key is:
Use this key for all sandbox requests. See the Sandbox guide for details on available test data.

Making authenticated requests

Pass your API key in the Authorization header on every request:
Store your API key in an environment variable rather than hardcoding it in scripts or source files.
GET /v1/health does not require authentication. All other endpoints require a valid Authorization: Bearer <API_KEY> header.

Error responses

The API returns 401 for two distinct authentication failures.

Missing or malformed header

Returned when the Authorization header is absent or does not start with Bearer .

Invalid API key

Returned when the header is correctly formed but the key is not recognized.