BVN Boolean Match
Overview
The BVN boolean match services accepts the BVN, firstname and surname and confirms the validity of the BVN. This article will guide you on how to integrate to the BVN Boolean Match Service
Important!
Before you proceed, ensure you review the prerequisites for integrating to our APIs for a more detailed guide.
API Endpoint
https://api.verified.africa/sfx-verify/v3/id-service/
Request
| Request Parameter | Description | Description | Test Data |
|---|---|---|---|
| searchParameter | Required | The BVN will be passed into this field | 22231411111 |
| transactionReference | Optional | This is a field that uniquely identifies your transaction. We generate this field if you leave it empty; however, we encourage you to generate it for proper reconciliation | To be generated by the customer |
| verificationType | Required | This field is used to identify the service being called. Ensure to use the value provided exactly as provided | BVN-BOOLEAN-MATCH |
| firstName | Required | The first name will be passed into this field | Oluwaseun1 |
| lastName | Required | The last name will be passed into this field | Akinmukomi |
| phone | Optional | The phone number will be passed into this field | 08167396655 |
| Optional | The email address will be passed into this field | [email protected] | |
| dob | Required | The date of birth will be passed into this field | 19-Aug-1991 |
{
"firstName": "Oluwaseun1",
"lastName": "Akinmukomi",
"phone": "08167396655",
"email": "[email protected]",
"searchParameter": "22231411111",
"dob": "19-Aug-1991",
"verificationType":"BVN-BOOLEAN-MATCH"
}
Response
| Response Parameter | Type | Description |
|---|---|---|
| responseCode | String | Please reference Response Codes page for details on all possible responses |
| description | String | This is a description of the response received. |
| verificationType | String | The same verificationType passed in request will be returned here |
| verificationStatus | String | This field lets you know if the identity verification was successful. Options are: VERIFIED: This means that the BVN is valid. NOT VERIFIED This means that the BVN is invalid PENDING This status means that the verification could not be completed. Refer to the responseCode for the specific failure reason |
| transactionStatus | String | This indicates the wallet debit status. The options are successful or failed. |
| transactionReference | String | If you supplied a transactionReference, the same will be returned here. Else, we would generate a reference and return that to you in this field. |
| transactionDate | String | Date the transaction was done |
| searchParameter | String | BVN used for the verification |
| response | Json | This is a json containing all the actual BVN data as retrieved from the service provider. For this service the data is: "verified" = "true" |
{
"responseCode": "00",
"description": "Success",
"verificationType": "BVN-BOOLEAN-MATCH",
"verificationStatus": "VERIFIED",
"transactionStatus": "SUCCESSFUL",
"transactionReference": "1508329024227-L6BZZ406",
"transactionDate": "1659433695106",
"searchParameter": "22231411111",
"callBackUrl": null,
"livenessScore": 0.0,
"paymentRef": null,
"response": {
"validity": "VALID",
"bvn": null,
"status": "00",
"basicDetailBase64": null,
"description": null,
"imageBase64": null
},
"faceMatch": null
}
Updated 19 days ago