Skip to content

Return IBAN Person Search

Request

Gets search for bankmatch IBAN person matching

Security
bearerToken
Query
languagestring, = 2 characters

The language code to specify the desired language of the response. Please use the /IBAN/person/searchCriteria endpoint to confirm available languages. If unsupported language is passed, the system defaults to English (EN).

bankCountrystringrequired

An ISO Alpha-2 country code used to specify the country for person bank matching criteria

firstNamestring

First name of the person for bank matching criteria

lastNamestring

Last name of the person for bank matching criteria

birthDatestring

Birth date of the person in the format DD/MM/YYYY for bank matching criteria

Example:birthDate=28/04/1978
ibanstring

International Bank Account Number (IBAN) for bank matching criteria

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/compliance/bankMatch/IBAN/person?language=st&bankCountry=string&firstName=string&lastName=string&birthDate=28%2F04%2F1978&iban=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstring

Unique identifier for the bank match search.

classificationstring

Classification result of the search (e.g., 'NO').

statusstring

Status of the search process (e.g., 'SUCCEEDED').

entityobject

Contains details about the entity associated with the IBAN.

inputobject

Input details used for the search.

reasonsArray of strings

List of reason codes for the result.

sepamailVerificationStatusstring

Status of the SepaMail verification.

reasonLabelsobject

Labels describing the reasons for the result.

lastMatchVerificationDetailobject

Details about the last match verification.

Response
{ "id": "string", "classification": "string", "status": "string", "entity": { "paymentIdentity": {}, "company": {} }, "input": { "paymentIdentity": {}, "physicalPersonIdentifier": {} }, "reasons": [ "string" ], "sepamailVerificationStatus": "string", "reasonLabels": { "property1": "string", "property2": "string" }, "lastMatchVerificationDetail": { "status": "string", "date": "2019-08-24T14:15:22Z", "additionalData": {} } }