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 |
|---|---|---|---|
| selfie_image | 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 |
| bvn | string | A Valid BVN 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 BVN verification response data |
| entity.bvn | string | The Bank Verification Number |
| entity.first_name | string | First name of the BVN holder |
| entity.middle_name | string | Middle name of the BVN holder |
| entity.last_name | string | Last name of the BVN holder |
| entity.date_of_birth | string | Date of birth of the BVN holder (DD-MMMM-YYYY, e.g., 01-January-1907) |
| entity.phone_number1 | string | Primary phone number associated with the BVN |
| entity.phone_number2 | string | Secondary phone number associated with the BVN (may be empty) |
| entity.gender | string | Gender of the BVN holder |
| entity.image | string | Base64-encoded photo from the BVN record |
| entity.selfie_verification | object | Selfie verification result comparing the submitted selfie to the BVN 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 BVN photo (true if confidence β₯ 90) |
| entity.selfie_image_url | string | URL of the uploaded selfie image stored on S3 |
Test Credentials for Sandbox
Kindly use this Test BVN in sandbox Environment bvn =22222222222