IBAN Company Endpoints

The IBAN (International Bank Account Number) endpoints in the Bank Match API allow you to verify and match company bank account details using the IBAN format. These endpoints support compliance, fraud prevention, and onboarding processes for companies in a wide range of supported countries.

Below is a flow diagram guide on how to use these endpoints effectively.

Diagram summary (accessibility): Authenticate first, then retrieve IBAN search criteria, run the IBAN company search, review the returned match results and, if needed, review your previous searches in the search history.

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

View endpoint documentation

POST /authenticate

This endpoint returns the supported languages and required criteria for IBAN company searches.

View endpoint documentation

GET /compliance/bankMatch/IBAN/company/searchCriteria?bankCountry=DE

{
    "correlationId": "e7334c77-f9eb-49f5-9212-b6c637e91862",
    "criteriaSets": [
        {
            "regNo": {
                "required": true
            },
            "country": {
                "required": true
            },
            "iban": {
                "validationRegExp": "^DE\\d{20}$",
                "required": true
            }
        }
    ],
    "bankCountry": "DE",
    "languages": [
        "EN",
        "FR",
        "ES",
        "IT"
    ]
}

Use this endpoint to search and match company bank account details using the IBAN format. Search details are passed as query parameters. Use the search criteria from step 2 to confirm which parameters are required for the bank country and the format the IBAN must match.

View endpoint documentation

GET /compliance/bankMatch/IBAN/company?country=DE&bankCountry=DE&regNo={registrationNumber}&iban={iban}

After submitting an IBAN 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 a correlationId, a checkId and a message describing the request.

A successful response includes the following fields:

Compare entity with input and use reasons and reasonLabels to understand why the account was, or was not, matched.

Use this endpoint to return a paginated list of previous IBAN company searches made by your account, including each search's result: MATCH, NO_MATCH or PENDING.

View endpoint documentation

You can filter the list by company name or registration number (name), date range (startDate, endDate in YYYY-MM-DD format), your reference (reference), result (result) and user (userId). Use page and pageSize (maximum 100) to page through results.

GET /compliance/bankMatch/IBAN/company/history?result=PENDING&page=1&pageSize=20