# BBAN Company Endpoints

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.

## Flow Diagram


```mermaid
%%{ init: { "theme": "default" } }%%
flowchart TB
  A[Authenticate]
  B[Retrieve BBAN Search Criteria]
  C[Run BBAN Company Search]
  D[Review Search Results]

  A --> B --> C --> D
```

## Supported Countries for BBAN

| 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 |


## 1. Authenticate

Before using any of the endpoints, you must authenticate. This ensures you have the necessary permissions to access the data.

[View endpoint documentation](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/bankmatch/bankmatch/authentication)

### Example Request


```http
POST /authenticate
```

## 2. Retrieve BBAN Search Criteria

This endpoint returns the supported languages for BBAN company searches along with other required criteria to carry out the search.

[View endpoint documentation](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/bankmatch/bankmatch/bank-match/compliancegetbankmatchbbancompanysearchcriteria)

### Example Request


```http
GET /compliance/bankMatch/BBAN/company/searchCriteria?bankCountry=AU
```

### Example Response


```json
{
    "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"
    ]
}
```

## 3. BBAN Company Search

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.

[View endpoint documentation](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/bankmatch/bankmatch/bank-match/compliancegetbankmatchbbancompanysearch)

### Example Request


```http
POST /compliance/bankMatch/BBAN/company
```

## 4. Review Search Results

After submitting a BBAN company search, review the response to determine if the bank account details have been successfully