Authentication
Authenticate securely with scoped test and live API keys.
Idyntic authenticates public API requests with environment-specific Bearer tokens.
Authorization header
Authorization: Bearer id_test_your_keyUse the exact Bearer scheme followed by one space and the API key.
Key environments
| Prefix | Environment | Identity data | Wallet charges |
|---|---|---|---|
id_test_ | Test Sandbox | Test data | No |
id_live_ | Live Production | Live data | Yes |
A key belongs to one environment. Test keys cannot access live data, and live keys do not return sandbox fixtures.
Scopes
| Scope | Required by |
|---|---|
BALANCE_READ | GET /v1/balance |
NIN_VERIFY | All NIN verification endpoints |
BVN_VERIFY | All BVN verification endpoints |
A missing scope returns HTTP 401 with UNAUTHORIZED.
Key lifecycle
- The complete secret is shown once when the key is created or rotated.
- Revoked and expired keys stop authenticating immediately.
- An account can have up to 10 active keys.
- Use separate keys for separate applications or deployment environments.
- Rotate a key through the Developer Dashboard if it may have been exposed.
Secure storage
Store API keys in a server-side secret manager or environment variable. Never commit keys to source control, include them in logs, or ship them in frontend JavaScript or a mobile application.
Treat live keys like payment credentialsA live key can initiate billable identity lookups against your wallet. Restrict access and revoke suspected credentials immediately.
Authentication failure
{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Provide a valid API key with the NIN_VERIFY scope.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
},
"billing": {
"amount": 100,
"currency": "NGN",
"unit": "naira",
"charged": false,
"note": "No charges"
}
}The message names the scope required by the requested endpoint.
Updated about 2 hours ago