The BBAN (Basic Bank Account Number) endpoints in the Bank Match API allow you to verify and match company bank account details using the BBAN format. These endpoints support compliance, fraud prevention, and onboarding processes for companies in a range of supported countries.
Below is a flow diagram guide on how to use these endpoints effectively.
| Country | Code | Required | One or Both Parameters |
|---|---|---|---|
| Australia | AU | bban | routingCode |
| Canada | CA | bban | routingCode |
| China | CN | bban | bic / routingCode |
| Hong Kong | HK | bban | bic |
| India | IN | bban | routingCode |
| Japan | JP | bban | bic / routingCode |
| Malaysia | MY | bban | bic |
| Mexico | MX | bban | bic |
| Singapore | SG | bban | bic |
| South Africa | ZA | bban | bic / routingCode |
| South Korea | KR | bban | bic |
| USA * | US | bban | bic / routingCode |
Before using any of the endpoints, you must authenticate. This ensures you have the necessary permissions to access the data.
POST /authenticateThis endpoint returns the supported languages for BBAN company searches along with other required criteria to carry out the search.
GET /compliance/bankMatch/BBAN/company/searchCriteria?bankCountry=AU{
"correlationId": "bc61dfad-188b-42d6-acc2-06f9858a7a4b",
"criteriaSets": [
{
"regNo": {
"required": true
},
"country": {
"required": true
},
"bban": {
"validationRegExp": "^\\d{7}$",
"required": true
},
"routingCode": {
"validationRegExp": "^\\d{3}-?\\d{3}$",
"required": true
}
}
],
"bankCountry": "AU",
"languages": [
"EN",
"FR",
"ES",
"IT"
]
}Use this endpoint to search and match company bank account details using the BBAN format. Please refer to the table above to determine what combination of parameters are needed for each country.
POST /compliance/bankMatch/BBAN/companyAfter submitting a BBAN company search, review the response to determine if the bank account details have been successfully