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.
Diagram summary (accessibility): Authenticate first, then retrieve BBAN search criteria, run the BBAN company search, and review the returned match results.
| 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. Search details are passed as query parameters. Please refer to the table above to determine what combination of parameters are needed for each country.
| Parameter | Required | Description |
|---|---|---|
country | Yes | ISO Alpha-2 country code of the company. |
bankCountry | Yes | ISO Alpha-2 country code used to specify the country for company bank matching criteria. |
regNo | No | Company registration number. |
bban | No | Basic Bank Account Number (BBAN). |
bic | No | Bank Identifier Code (BIC). |
routingCode | No | Routing code for the bank account. |
language | No | Response language. Use the search criteria endpoint to confirm available languages. Unsupported languages default to English (EN). |
Parameters shown as optional in this table may still be required for a specific country. Check the supported countries table and the search criteria response before searching.
GET /compliance/bankMatch/BBAN/company?country=AU&bankCountry=AU®No={registrationNumber}&bban={bban}&routingCode={routingCode}After submitting a BBAN company search, review the response to determine if the bank account details have been successfully matched.
200 Success: The search has completed. The response contains the result of the match.202 Accepted: The bank details are still being verified. The response contains acorrelationId, acheckIdand a message describing the request.
A successful response includes the following fields:
| Field | Description |
|---|---|
id | Unique identifier for the bank match search. |
status | Status of the search process, for example SUCCEEDED. |
classification | Classification result of the search. |
reasons | List of reason codes for the result. |
reasonLabels | Labels describing each reason code. |
entity | The payment identity (including BBAN, BIC and routing code) and company associated with the account. |
input | The payment identity and company details you supplied. |
sepamailVerificationStatus | Status of the SepaMail verification. |
Compare entity with input and use reasons and reasonLabels to understand why the account was, or was not, matched.