BVN Boolean Match


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



Before you proceed, ensure you review the prerequisites for integrating to our APIs for a more detailed guide.

API Endpoint


Request ParameterDescriptionDescriptionTest Data
searchParameterRequiredThe BVN will be passed into this field22231411111
transactionReferenceOptionalThis 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 reconciliationTo be generated by the customer
verificationTypeRequiredThis field is used to identify the service being called. Ensure to use the value provided exactly as providedBVN-BOOLEAN-MATCH
firstNameRequiredThe first name will be passed into this fieldOluwaseun1
lastNameRequiredThe last name will be passed into this fieldAkinmukomi
phoneOptionalThe phone number will be passed into this field08167396655
emailOptionalThe email address will be passed into this field[email protected]
dobRequiredThe date of birth will be passed into this field19-Aug-1991
    "firstName": "Oluwaseun1",
    "lastName": "Akinmukomi",
    "phone": "08167396655",
    "email": "[email protected]",
    "searchParameter": "22231411111",
    "dob": "19-Aug-1991",


Response ParameterTypeDescription
responseCodeStringPlease reference Response Codes page for details on all possible responses
descriptionStringThis is a description of the response received.
verificationTypeStringThe same verificationType passed in request will be returned here
verificationStatusStringThis 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
transactionStatusStringThis indicates the wallet debit status. The options are successful or failed.
transactionReferenceStringIf you supplied a transactionReference, the same will be returned here. Else, we would generate a reference and return that to you in this field.
transactionDateStringDate the transaction was done
searchParameterStringBVN used for the verification
responseJsonThis 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