Account Lookup API
The Account Lookup API allows you to verify bank account details and retrieve the account holder's name before creating beneficiaries or initiating transfers. This helps ensure accuracy and reduces failed transactions.
Lookup Bank Account
Verify if a bank account exists and retrieve the account holder's name. This endpoint is essential for validating account information before creating beneficiaries or processing payments.
Endpoint
POST /api/v1/client/banks/account/lookup
Authentication
This endpoint requires JWT authentication. Include your access token in the Authorization header:
Request Body
Request Example
Success Response (200 OK)
Returns the account holder's name if the account exists:
Response Fields
Error Responses
Example: cURL
Example: HTTP Request
Example: JavaScript (Fetch)
Use Cases
- Pre-validation - Verify account details before creating beneficiaries to ensure accuracy
- User Experience - Display the account holder's name to users for confirmation before submitting transfers
- Error Prevention - Catch invalid account numbers early to avoid failed transactions
- Compliance - Verify account ownership before processing sensitive financial transactions
Best Practices
- Cache Results - Account names don't change frequently; consider caching results for a short period
- Validate Input - Ensure
account_numberandbank_idare valid before making the request - Handle Errors Gracefully - Provide clear error messages when accounts are not found
- Use Bank IDs - Prefer using bank
idfrom the Banks API over bank codes for better reliability - Verify Before Creating - Always verify account details before creating beneficiaries or initiating transfers
Supported Countries
Currently, account lookup is supported for:
- Nigeria (NGN) - All major Nigerian banks
Sample NGN test account (staging)
For testing in non‑production environments, you can use the following sample NGN bank account (OPay, code from Banks API) to verify your integration end‑to‑end:
Use bank code 100004 (OPay). This sample request returns an account_name value of "OPAY Test Account", which is convenient for automated tests and manual QA flows.
Note: Support for additional countries may be added in the future. Contact support for more information.
Related Endpoints
- Banks API - Get list of banks for a country (to obtain
bank_id) - Beneficiaries - Create a beneficiary after verifying account details
- Create and accept quotes - Create a quote for a transfer after beneficiary verification
Next Steps
After verifying an account:
- Create Beneficiary - Use the verified account details to create a beneficiary record
- Initiate Transfer - Create a quote and process the transfer with confidence
- Display Confirmation - Show the account holder's name to users for final confirmation
For more information, see:
- Beneficiaries - How to create and manage beneficiaries
- Banks API - Get list of banks for a country