BVN (Boolean Match)

The BVN Boolean Match service allows you to confirm whether a customer’s first name, last name, date of birth, gender, email address, or phone number corresponds to the details associated with their Bank Verification Number (BVN). This endpoint returns true or false for each field selected.

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"
    },
    "insight": [  // detail of other organisations that have checked this same ID recently
        {
            "serviceCategory": "Commercial Banks",
            "insightCount": 1,
            "timeframeInMonths": 12
        },
        {
            "serviceCategory": "Digital Bank",
            "insightCount": 1,
            "timeframeInMonths": 12
        }
    ],
    "bvn_match": {
        "fieldMatches": {
            "firstname": true,
            "lastname": true
        }
    }
}