BVN (Boolean Match)

The BVN Boolean Match service allows you to verify that the first name, last name, DOB, Gender, email, or phone number of a user matches their Bank Verification Number (BVN) data.

To verify BVN Boolean match

{{baseUrl}}/v1/ng/identities/bvn-match/{idNumber}

Path Parameter

Parameter	Type	Description
idNumber (REQUIRED)	string	Bank Verification Number

Request Body

POST Parameters	Type	Description
fistname (REQUIRED)	string	First Name
lastname (REQUIRED)	string	Last Name
dob (OPTIONAL)	dateString	Date Of Birth(YYYY-MM-DD)
phone (OPTIONAL)	string	Phone Number
email (OPTIONAL)	string	Email Address
gender (OPTIONAL)	string	Gender

This endpoint returns Boolean values (true/false) for your selected parameters. To conduct an actual test

Response Sample

{
    "id": 1***9,
    "applicant": {
        "firstname": "James",
        "lastname": "Doe"
    },
    "summary": {
        "bvn_match_check": {
            "status": "EXACT_MATCH",
            "fieldMatches": {
                "firstname": true,
                "lastname": true
            }
        }
    },
    "status": {
        "state": "complete",
        "status": "verified"
    },
    "bvn_match": {
        "fieldMatches": {
            "firstname": true,
            "lastname": true
        }
    }
}