Bank Account Validation
Account Verification API
Account Verification API is the Brick Bank Account Validation endpoint for checking destination bank account details. Send the bank short code and account number, then use the response to confirm whether Brick can validate the account through the supported bank network.
Use this API before saving beneficiary details or initiating a payout. The response may include the account holder name returned by the bank network, but it does not by itself prove legal ownership or complete fraud screening.
Request parameters
| Key Parameter | Data Type | Description |
|---|---|---|
| public_access_token | String | The public access token is generated using your clientId and clientSecret, and you can retrieve it from this endpoint. |
| accountNumber | String | Account number that the funds are intended to be sent to. |
| bankShortCode | String | This should be the institution that your end-customer intends to validate. Please see Validation Coverage for the list of supported validation destinations. |
| clientReference | String | Optional unique reference from your system for tracking, transaction matching, and reconciliation. Use up to 64 characters: letters, numbers, hyphen (-), underscore (_), or period (.). |
Response parameters
| Key Parameter | Data type | Description |
|---|---|---|
| accountNo | String | Account number of the user |
| bankShortCode | String | Institution short code of the user |
| accountName | String | Institution account name that the funds are intended to be sent to. |
| activityId | String | A unique reference ID for each request for bank account validation. |
| clientReference | String | Client-supplied reference returned when it is provided in the request. |
Response examples
Use the interactive Account Verification API reference to test the endpoint and switch between response examples by status code.
Last modified on