Financial Accounts
Retrieve all bank account linked to either a phone number or a BVN
This endpoint allows you to retrieve all bank accounts linked to a particular phone number or BVN (Bank Verification Number). This can be a useful feature for financial institutions, businesses, or individuals who need to verify bank account details for various purposes.
When using this endpoint, you would typically provide either a phone number or a BVN and a mode (either PHONE or BVN) as a parameter to the API call. The API would then query the relevant database or APIs of various financial institutions to retrieve all bank accounts linked to the provided phone number or BVN.
TEST DATA
number: 08012345678
mode: PHONE
POST
{{URL}}/identitypass/verification/list/financial_accounts
Parameters
Header
Key | Description |
---|---|
app-id | Your App ID |
x-api-key | Your Secret Key |
Body
Key | Description |
---|---|
number | Phone number or BVN |
mode | PHONE or BVN |
Responses
{
"status": true,
"detail": "Verification Successful",
"response_code": "00",
"data": [
{
"mobile_number": "08012345678",
"bankCode": "070",
"bankName": "Fidelity bank",
"accountDescription": "000****000"
},
{
"mobile_number": "08012345678",
"bankCode": "044",
"bankName": "Access Bank Nigeria Plc",
"accountDescription": "000****000"
}
]
}
Response Description
Response | Description |
---|---|
status | Indicates that the request was successful. |
detail | This field indicates the detail of the response. |
response_code | Represents the response code. |
data | An array containing the information received. |
mobile_number | The mobile number of the customer. |
bankCode | The bank code of the customer's bank. |
bankName | The name of the customer's bank. |
accountDescription | A description of the customer's account. |
Updated about 1 year ago