Authenticate with an API token

Every metered CompliAPI endpoint requires authentication. The standard method is a bearer API token, which you create and manage from your dashboard.

Creating a token

1. Log in and navigate to the Tokens page.
2. Click to create a new token.
3. Copy the token value right away — it is shown in plaintext only once at creation and cannot be retrieved again. Store it securely, for example in an environment variable or a secrets manager.

Using the token

Pass the token as a bearer Authorization header on every request:

curl https://api.compliapi.com/api/v1/screen/email/test@example.com \  -H "Authorization: Bearer capi_..."

This applies to all metered endpoints, including screening, VPN detection, and geolocation.

Quota and org scope

Tokens are scoped to your organization, not to individual users. All requests made with any token in your organization count against the same shared monthly quota. If your organization exceeds its quota, the API returns a 402 response — you can either pay per request or upgrade your plan from the dashboard.

Revoking a token

To revoke a token, return to the Tokens page and delete it. Revocation takes effect immediately, so any service still using that token will start receiving 401 responses. Create a replacement token before revoking the old one to avoid downtime.