...
For name, a slightly advanced comparison is done and you can get one of three statuses: FULL_MATCH, PARTIAL_MATCH, NO_MATCH.
| Info |
|---|
Price This service costs N10 for each successful request. |
| Info |
|---|
Endpoint: POST: https://api.monnify.com/api/v1/vas/bvn-details-match |
This endpoint is protected with Basic Authentication
| Info |
|---|
Please note that the BVN samples used in this documentation are not real and are just indicative of how the API should be used |
Scenario 1: Bank Verification Number is not valid
...
| Code Block | ||
|---|---|---|
| ||
{
"requestSuccessful": true,
"responseMessage": "success",
"responseCode": "0",
"responseBody": {
"bvn": "22222222226",
"name": {
"matchStatus": "FULL_MATCH",
"matchPercentage": 100
},
"dateOfBirth": "NO_MATCH",
"mobileNo": "FULL_MATCH"
}
} |
Field Reference
Field | Description | Status |
|---|---|---|
bvn | 11 digit bank verification number expected to belong to the account holder. | Required |
mobileNo | 11 - 13 digit number expected to belong to the account holder | Required |
dateOfBirth | Date of birth of the account holder. The expected format is | Required |
Name matching Rules:
Description of Scenario | Sample BVN Names | Sample Account Name | Match Status | |
|---|---|---|---|---|
1. | Name on BVN contains all of names on account number | ABC | CBA | FULL_MATCH |
2.. | There are at least two matches in BVN or account names | ABC, BC, CD | BCD, AB, AC | PARTIAL_MATCH |
3. | There is one match in BVN or account names, or no match at all | ABC | CDE, FGH | NO_MATCH |
| Info |
|---|
Matching rules for the mobileNo and dateofBirth dateOfBirth fields are exact matches so you either get a value of FULL_MATCH or NO_MATCH as the case may be. |