Skip to content
On this page

Authentication

The Aegis API uses Bearer token authentication. Include your API key in the Authorization header of every request.

Getting Your API Key

  1. Sign in to the Aegis Dashboard
  2. Navigate to Settings → API Keys
  3. Click "Create API Key"
  4. Copy and securely store your key

WARNING

Never expose your API key in client-side code or public repositories. Use environment variables.

Using Your API Key

bash
curl https://api.aegis-dig.com/v1/verify/cpf \
  -H "Authorization: Bearer aegis_live_xxxxxxxxxxxx"

API Key Types

EnvironmentPrefixUse Case
Productionaegis_live_Live verifications
Sandboxaegis_test_Testing and development

Error Responses

Authentication errors return HTTP 401:

json
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key",
    "request_id": "req_xyz789"
  }
}

Released under the MIT License.