Request
[POST]
Header
| Header | Type | Description |
|---|---|---|
| AppId | string | Create an app to get your app ID on dashboard here |
| Authorization | string | Private/secret key. Use <key> not Bearer <key> |
Body Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| last_name OPTIONAL | string | Last Name | optional |
| first_name OPTIONAL | string | First Name | optional |
| selfie_image REQUIRED | string | Base64 value of the selfie image. NB: Kindly truncate data:image/jpeg;base64, from the selfie_image object and pass only the buffer starting with /9. | required |
| nin REQUIRED | string | National Identity Verification Number. | required |
Confidence Values range from 0% to 100%
- 0% - 90% denote match value is false
- 90% - 100% denote match value is true
Response
Response
Response Fields
| Field | Type | Description |
|---|---|---|
| entity | object | Contains the NIN verification response data |
| entity.first_name | string | First name of the NIN holder |
| entity.last_name | string | Last name of the NIN holder |
| entity.middle_name | string | Middle name of the NIN holder |
| entity.gender | string | Gender of the NIN holder |
| entity.image | string | Base64-encoded photo from the NIN record |
| entity.phone_number | string | Phone number associated with the NIN record |
| entity.date_of_birth | string | Date of birth of the NIN holder |
| entity.nin | string | The National Identification Number |
| entity.selfie_verification | object | Selfie verification result comparing the submitted selfie to the NIN photo |
| entity.selfie_verification.confidence_value | number | Confidence score of the selfie match (0β100). Values below 90 indicate no match |
| entity.selfie_verification.match | boolean | Whether the selfie matches the NIN photo (true if confidence β₯ 90) |
Test Credentials for Sandbox
Kindly use this Test NIN in sandbox Environment nin =70123456789