Skip to content
Last updated

IBAN Person Endpoints

The IBAN Person endpoints in the Bank Match API allow you to verify and match personal bank account details using the IBAN format. These endpoints support compliance, fraud prevention, and onboarding processes for individuals.

IBAN Person Search is currently available for France only.

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

Flow Diagram

Authenticate

Retrieve IBAN Person Search Criteria

Run IBAN Person Search

Review Search Results

Review Search History

Authenticate

Retrieve IBAN Person Search Criteria

Run IBAN Person Search

Review Search Results

Review Search History

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


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

Example Request

POST /authenticate

2. Retrieve IBAN Person Search Criteria

This endpoint returns the supported languages and search criteria for IBAN person searches in the requested bank country, including the IBAN validation rules.

View endpoint documentation

Example Request

GET /compliance/bankMatch/IBAN/person/searchCriteria?bankCountry=FR

Use this endpoint to search and match personal bank account details using the IBAN format. Search details are passed as query parameters. Use the search criteria from step 2 to confirm which details are supported.

View endpoint documentation

ParameterRequiredDescription
bankCountryYesISO Alpha-2 country code used to specify the country for person bank matching criteria.
firstNameNoFirst name of the person.
lastNameNoLast name of the person.
birthDateNoBirth date of the person in the format DD/MM/YYYY.
ibanNoInternational Bank Account Number (IBAN).
languageNoResponse language. Use the search criteria endpoint to confirm available languages. Unsupported languages default to English (EN).

Example Request

GET /compliance/bankMatch/IBAN/person?bankCountry=FR&firstName={firstName}&lastName={lastName}&birthDate=28/04/1978&iban={iban}

4. Review Search Results

After submitting an IBAN person 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:

FieldDescription
idUnique identifier for the bank match search.
statusStatus of the search process, for example SUCCEEDED.
classificationClassification result of the search.
reasonsList of reason codes for the result.
reasonLabelsLabels describing each reason code.
entityThe payment identity associated with the IBAN and, where returned, the account holder's representative details.
inputThe payment identity and person details you supplied.
sepamailVerificationStatusStatus of the SepaMail verification.
lastMatchVerificationDetailStatus, date and any additional data from the last match verification.

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


5. Review Search History

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

View endpoint documentation

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

Example Request

GET /compliance/bankMatch/IBAN/person/history?startDate=2026-01-01&endDate=2026-01-31&page=1&pageSize=20