Bank Account Validation
# Introduction
Used to validate a customer's bank account details.
# Request Parameters
The following parameters are expected:
| Field | Description | Type |
|---|---|---|
| search_type | Must be BankAccountValidation | String |
| score_type | Must be BankAccountValidation | String |
| identifier | The bank account number to validate | String |
| bank | The name of the bank. Examples: co-operative bank | String |
| consent | Indicates whether the data owner has consented to identity verification 1 if yes 0 if no. | String |
| consent_collected_by | Name or identifier of the person who collected the data owner's consent. | String |
Please find sample implementation on the left
# Response Parameters
The response returns bank account validation details and a tracking request ID.
| Field | Description | Type |
|---|---|---|
| success | Whether the request succeeded | Boolean |
| response_code | HTTP-style status code returned by the service | Number |
| message | Result message | String |
| data.account_number | The validated bank account number | String |
| data.account_name | Name on the bank account | String |
| data.bank_name | Name of the bank | String |
| data.bank_branch | Branch of the bank | String |
| data.account_type | Type of account (e.g. Savings, Current) | String |
| data.currency | Account currency | String |
| data.valid | Whether the account is valid and active | Boolean |
| request_id | Request identifier for tracking | String |
Below is a sample response:
{
"success": true,
"response_code": 200,
"message": "Bank Account Validation Successful",
"data": {
"account_number": "04405353816250",
"account_name": "JOHN DOE",
"bank_name": "CO-OPERATIVE BANK",
"bank_branch": "NAIROBI BRANCH",
"account_type": "Savings",
"currency": "KES",
"valid": true
},
"request_id": "223e4567-e89b-12d3-a456-426614174000"
}