This API is use to confirm if the supplied BVN and account number belongs to the same entity and retrieve the details of the entity/account-owner
Base URL: https://api-gateway.interswitchng.com/isw-data-service
Request Parameters
SN | Field Name | Data Type | Max Length / Format | Required | Description |
1 | client-code | String | 20 | Yes | The unique client code provided at the point of profiling the client on the interswitch Data service platform. |
2 | bvn | Integer | 11 | YES | The 11 digit individually unique BVN number to be validated |
3 | bank-code | integer | 3 | Yes | The 3 digit unique bank-code assigned by CBN to identify a bank |
4 | account | Integer | Yes | The bank account number belonging to the bank-code to be validated against the BVN provided |
Sample Request
{{baseurl}}/api/v1/request/verification/client-code/sampleClientCode/bvn/22355202908/bank-code/058/account/0261642240
Request Headers
HTTP Method: GET
Authorization: Bearer TOKEN
Sample Response Fields (success)
SN | Field Name | Data Type | Description |
1 | responseCode | String | The code representing the state of the response, it show whether the response was a success or not. NB: “00” is the code for success |
2 | responseMessage | String | The description that explains the responseCode from above |
3 | data | Object | The section that contains the account owner details |
4 | bvn | String | BVN of the owner of the account, would always be same as the BVN supplied in the request if it was successful |
5 | accountNumber | String | Account number of the owner of the account, would always be same as the account number supplied in the request if it was successful |
6 | bankCode | String | The bankcode used to identify the bank, would always be same as the bank-code supplied in the request if it was successful |
7 | accountName | String | Full names of the account holder |
8 | dob | String | The account holder date of birth (Format: dd-MMM-yy) |
9 | firstName | String | The account holder’s first name |
10 | lastName | String | The account holder’s last name |
9 | phone | String | The account holder’s mobile phone number |
10 | residentialAddress | String | The account holder’s residential address |
Sample Response (success)
{
"responseCode": "00",
"responseMessage": "Successful",
"data": {
"bvn": "22292083231",
"accountNumber": "0696363603",
"accountName": "MICHEAL SYDENY EDE",
"bankCode": "044",
"firstName": "MICHEAL",
"lastName": "EDE",
"dob": "12-Mar-75",
"phone": "08064088818",
"residentialAddress": "SHEHU AUDI RESIDENCE, FUNTUA STREET, KAFANCHAN"
}
}
Sample Response Fields (Failed)
SN | Field Name | Data Type | Description |
1 | responseCode | String | The code representing the state of the response, it show whether the response was a success or not. NB: “00” is the code for success |
2 | responseMessage | String | The description that explains the responseCode from above |
{
"responseCode": "10404",
"responseMessage": "No Information Found - No Information Found For Account Details",
}