How it runs
List supported banks
Fetch the bank list (with codes) from
GET /v1/banks. Use the bank_code from this list when connecting an account.Connect an account
Submit the account number, bank code, and bank name to
POST /v1/connect-account/{companyId}. The account is resolved with the bank and the resolved name is compared to the company name.List banks — GET /v1/banks
Response
Connect an account — POST /v1/connect-account/{companyId}
The body requires a 10-digit account_number, a bank_code, and a bank_name.
Verified
400:
Name mismatch
Errors
| Status | Body | When |
|---|---|---|
404 | { "message": "Company not found" } | The company is missing or not yours. |
400 | { "message": "Could not resolve the bank account details provided", "suggestions": [...] } | The account could not be resolved with the bank. |
400 | { "message": "Bank account name does not match company name", "suggestions": [...], "details": {...} } | The resolved name is too dissimilar to the company name. |
500 | { "error": "An error occurred while verifying your bank account" } | Unexpected error. |
