Verify the validity of a bank account by providing account number and bank_id. Required scope: bank:read.
Authorization
oauth2ClientCredentials bank:readUse your OAuth client credentials to obtain a short-lived Bearer token from POST /oauth/token.
In: header
Scope: bank:read
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
This endpoint allows you to verify the validity of a bank account by providing the account number and the associated bank ID. It returns information about the account, such as the account holder's name, to ensure accuracy before initiating transactions. We advise using this to confirm recipient details for payments, transfers, or any transaction involving a bank account. Example Use Cases:
- Validate a recipient's bank account details during payment setup.
- Ensure accurate data entry before processing a transaction.
- Provide real-time verification for user onboarding or payout processes.
Response Body
application/json
application/json
application/json
curl --request POST \ --url 'https://example.com/api/external/bank/account-lookup' \ --header 'Content-Type: application/json' \ --data '{ "account_number": "0123456789", "bank_id": "044"}'{ "message": "Account resolved successfully", "account_name": "John Doe"}GETList all banks
Retrieve all supported banks. Filter by currency or country if desired. Required scope: `bank:read`.
POSTVerify GBP payee
Run a Confirmation-of-Payee check on a GBP account. Blaaiz returns a match or no-match result and never returns the real account name. Required scope: `bank:read`.