BVN Boolean Match 🇳🇬

Overview

The BVN boolean match services accepts the BVN, firstname, lastname, date of birth 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	12345678901
firstName	Required	The first name will be passed into this field	ABDULHAKeEM
lastName	Required	The last name will be passed into this field	IDOWU
dob	Required	The date of birth will be passed into this field	04-09-1970
verificationType	Required	This field is used to identify the service being called. Ensure to use the value provided exactly as provided	BVN-BOOLEAN-MATCH

BVN Boolean Match Request Sample

{
    "firstName": "ABDULHAKeEM",
    "lastName": "IDOWU",
    "searchParameter": "12345678901",
    "dob": "04-09-1970",
    "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 the validity of the BVN data as retrieved from the service provider. For this service the data is: validFirstName: true, validLastName: true, validDateOfBirth: true

BVN Boolean Match Response Sample

{
    "responseCode": "00",
    "description": "Successful",
    "verificationType": "BVN-BOOLEAN-MATCH",
    "verificationStatus": "VERIFIED",
    "transactionStatus": "SUCCESSFUL",
    "transactionReference": "1677841079768-1696858854992-f505ac5c-e457-4aec-9c76-862f63328e93",
    "transactionDate": "1696858857765",
    "searchParameter": "12345678901",
    "callBackUrl": null,
    "livenessScore": 0.0,
    "paymentRef": null,
    "response": {
        "validFirstName": true,
        "validLastName": true,
        "validDateOfBirth": true
    },
    "faceMatch": null
}