Authentication
Authenticate with an API key and use customer identifiers to attribute and correlate requests.
API keys
Open API Keys in your Kausate dashboard and create a key for your organization.
Send it over HTTPS in the X-API-Key header. Keep the key on your server and
load it from a secret store. If a key is exposed, replace it and revoke the old
one in the dashboard.
curl "https://api.kausate.com/v2/platform/jurisdictions" \
-H "X-API-Key: ${API_KEY}" \
-H "Kausate-Version: 2026-08-01"A missing key returns HTTP 401 (auth.unauthorized). An invalid key or an
authenticated request without access to the resource can return HTTP 403
(auth.forbidden). See the error guide for how to handle each case.
Customer identifiers
| Identifier | Where to send it | Purpose |
|---|---|---|
X-Customer-Id | Request header on operations that list it | Identify the customer or tenant the request is for, for example acme-bank. Use the same ID for requests on behalf of that customer. |
customerId | An operation-specific query or body field where documented | Supply the customer ID when the operation accepts it in a different location. For example, a customer-specific credential registration accepts it in the query string. |
customerReference | JSON request body on operations that list it | Correlate a particular order with a record in your system, for example kyc-check-456. Kausate echoes it in the asynchronous submission response. |
These identifiers are optional on most data requests. Use at most 150 characters per value, drawn from ASCII letters, digits, hyphens and underscores. The API key authorizes the request. On operations that use customer-specific credentials, the customer ID selects the credentials to use. The jurisdiction guide explains how to set them up.
If a submission reuses an existing order, polling returns the reference stored
on that order. To poll, follow resultUrl when present or use orderId in the
result endpoint. When building a company report result URL yourself, pass
customerId as a query parameter to validate the order against that customer.
See the company data model for the difference
between orderId, kausateId and registry identifiers.
Last updated on