Skip to content

Authentication

Every request must include an API key in the Authorization header:

Authorization: Bearer ak_live_3f9c...
Prefix Mode Data Billing
ak_test_ Sandbox Sandbox test lists Never billed
ak_live_ Production Official lists and your custom lists Billed per screening

Every response object includes livemode so you can confirm which mode produced it.

Keys belong to a project inside your organisation. Each project has its own keys, threshold, enabled sources, custom lists, whitelist and webhook endpoints. Billing is aggregated across all projects of an organisation.

  • Create, rotate and revoke keys in the merchant portal. During early access, keys are issued by our team.
  • Keys are shown once at creation. Store them in a secrets manager, never in client-side code or version control.
  • To rotate without downtime, create a new key, deploy it, then revoke the old key.

A missing, malformed or revoked key returns 401 with code unauthorized. A key that cannot access a resource returns 403 with code forbidden. See Errors.