BVN Identity Matching

BVN Identity Boolean matching

Please note that when using your test key, Our test persona is John Doe and his BVN is 10000000001. Hence all matching done with your test keys with details other than our Test Persona would simulate a failed identity matching.

John Doe's matching test

ID_SAMPLE = {
    idNumber: '10000000001',
    firstname: 'John',
    lastname: 'Doe',
    dob: '04-04-1944',
    gender: 'male',
    email: '[email protected]',
    phone: '[phone]'
}

JSON

{
    "firstname": "JOHN",
    "lastname": "Doe",
    "phone": "[phone]",
    "dob": "04-04-1944",
    "gender": "female",
    "email": "[email protected]"
}

CURL

curl --location --request POST 'https://vapi.verifyme.ng/v1/verifications/identities/bvn/10000000001/match' \
--header 'Authorization: Bearer {your secret key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "firstname": "JOHN",
    "lastname": "DOe",
    "phone": "[phone]",
    "dob": "04-04-1944",
    "gender": "female",
    "email": "[email protected]"
}
'

Identity Matching

POST https://vapi.verifyme.ng/v1/verifications/identities/bvn/:ref/match

Use this endpoint to match data supplied to bvn verified data

Path Parameters

Name	Type	Description
ref*	string	BVN number

Headers

Name	Type	Description
Authorization*	string	Authorization Header

Request Body

Name	Type	Description
firstname	string	First name
emailAddress	string	Email address
phoneNumber	String	Phone number
dob	String	Date of birth
lastname	String	Last name
gender	String	Gender

201: Created Success response

{
    "status": "success",
    "data": {
        "bvn": "10000000001",
        "fieldMatches": {
            "firstname": true,
            "lastname": true,
            "dob": true,
            "gender": false,
            "phoneNumber": true,
            "emailAddress": true
        }
    }
}

401: Unauthorized Unauthorized Error

{
    "statusCode": 401,
    "error": "Unauthorized"
}

404: Not Found BVN not found

{
    "code":"NOT_FOUND_ERROR",
    "message":"BVN provided is not found. Please provide a valid bvn"
}