This API allows you to verify that the Bank verification number and the account number supplied by a user match the BVN and account number linked to that account.
| Info |
|---|
Endpoint: POSTThis endpoint is protected with OAuth 2.0 Bearer token. To find out more about authorization for Monnify endpoints, check Here |
Endpoint URL: https://api.monnify.com/api/v1/vas/bvn-account-match
This endpoint is protected with Basic Authentication
HTTP Method: POST
Scenario 1: BVN is not valid.
Sample Request:
| Code Block | ||
|---|---|---|
| ||
{
"bankCode":"057",
"accountNumber":"2191802645",
"bvn":"22222222226"
} |
Sample Response:
| Code Block | ||
|---|---|---|
| ||
{
"requestSuccessful": false,
"responseMessage": "Unable to process request. Invalid BVN provided",
"responseCode": "99"
} |
...
Sample Response:
| Code Block | ||
|---|---|---|
| ||
{
"requestSuccessful": false,
"responseMessage": "Unable to process request. Name inquiry failed. Account 0103284195 Bank 044. Invalid Account",
"responseCode": "99"
} |
...
| Code Block |
|---|
{
"requestSuccessful": true,
"responseMessage": "success",
"responseCode": "0",
"responseBody": {
"bvn": "22222222226",
"accountNumber": "0105284275",
"accountName": "OLATUNDE JOSIAH OGUNBOYEJO",
"matchStatus": "FULL_MATCH",
"matchPercentage": 100
}
} |
...
Field Reference:
Field | Description | Comment |
|---|---|---|
bvn | 11 digit bank verification number expected to belong to the account holder. | Required |
bankCode | CBN bank code for the bank where the account number is domiciled. Click here to get a full list of all supported banks. | Required |
accountNumber | 10 digit bank account number. | Required |