Getting Started
Create a test key and send your first Idyntic verification request.
This guide takes you from a new API key to your first identity verification.
1. Create a test API key
Create a Test Sandbox key in the Developer Dashboard and select the scopes your integration needs.
| Scope | Access |
|---|---|
BALANCE_READ | Read wallet balance |
NIN_VERIFY | All NIN verification endpoints |
BVN_VERIFY | All BVN verification endpoints |
Test keys begin with id_test_; live keys begin with id_live_. Store the complete secret immediately because it is shown only once.
2. Send your first request
curl -X POST "https://api.idyntic.getapexly.com/v1/verifications/nin" \
-H "Authorization: Bearer id_test_your_key" \
-H "Idempotency-Key: customer-123-verification-001" \
-H "Content-Type: application/json" \
-d '{"nin":"12345678901"}'3. Inspect data.status
data.statusA completed sandbox lookup returns HTTP 200. Use data.status to distinguish SUCCESSFUL, NOT_FOUND, SUSPENDED, and BLOCKED.
4. Move to production
Before using a live key:
- Complete the required developer profile details.
- Fund the developer wallet.
- Keep a unique idempotency key for each intended verification.
- Never expose API keys in browser or mobile client code.
- Treat
NOT_FOUND,SUSPENDED, andBLOCKEDas completed, billable lookups.
Continue
Updated about 2 hours ago
Did this page help you?