Responses and Status Codes
Handle the response envelope, completed statuses, and endpoint-specific verification data.
Idyntic uses a stable response envelope with endpoint-specific verification data.
Completed verification envelope
{
"success": true,
"message": "NIN Verification (NIN) Successful",
"data": {
"reference": "550e8400-e29b-41d4-a716-446655440001",
"status": "SUCCESSFUL",
"type": "nin",
"environment": "live",
"nin_data": {}
},
"billing": {
"amount": 100,
"currency": "NGN",
"unit": "naira",
"charged": true,
"note": "Wallet charged 100.00 NGN"
}
}BVN endpoints use bvn_data instead of nin_data.
Completed statuses
| Status | Meaning | Identity data |
|---|---|---|
SUCCESSFUL | A matching identity record was returned | Verification data object |
NOT_FOUND | The lookup completed without a matching record | null |
SUSPENDED | NIMC reports that the NIN is suspended | Verification data when available, otherwise null |
BLOCKED | The BVN is blocked or watchlisted | Verification data when available, otherwise null |
All four statuses return HTTP 200 and success: true. Always branch on data.status.
Type values
| Type | Endpoint |
|---|---|
nin | NIN Verification |
nin_phone | NIN Verification by Phone |
bvn | BVN Verification |
bvn_phone | BVN Verification by Phone |
Environment values
test: deterministic sandbox response.live: live identity data and wallet billing.
Verification data contract
The fields inside nin_data and bvn_data are specific to each verification endpoint. Idyntic:
- Returns every documented field for the endpoint.
- Preserves empty strings,
null, booleans, casing, and field names. - Keeps response field names stable within API version
v1.
Build against the response example for the endpoint you use. Contract changes are introduced through API versioning.
Request identifier
Every response includes an X-Request-Id header. Error bodies also include the same identifier at error.requestId. Include it when contacting support.
Updated about 2 hours ago
Did this page help you?