Creating an API Key
- Log in to the dashboard at app.antifraudai.com.
- Navigate to Settings → API Keys.
- Click Create New Key.
- Enter a descriptive label so you can identify the key later (e.g.,
production-backend,ci-pipeline). - Select the desired permission level (see Key Permissions below).
- Click Generate and copy the key immediately.
Using Your API Key
Pass your API key as a Bearer token in theAuthorization header of every request:
Key Permissions
When creating an API key, you choose its permission level. Use the most restrictive level that meets your integration’s needs.
You cannot upgrade a key’s permissions after creation — create a new key with the required level and retire the old one.
Rotating Keys
Regularly rotating API keys is a security best practice and is essential if a key is ever exposed. Follow these steps to rotate a key with zero downtime:- Create a new key — In Settings → API Keys, create a new key with the same permission level as the key you’re replacing.
- Deploy the new key — Update your application’s environment variable (or secrets manager) to use the new key and deploy the change.
- Verify the new key is active — Confirm your integration is successfully authenticating with the new key by checking recent API logs in the dashboard.
- Delete the old key — In Settings → API Keys, locate the old key and click Revoke.
Authentication Errors
If a request fails due to an authentication or authorization problem, the API returns one of the following HTTP error codes:
All error responses follow a consistent JSON structure:

