Skip to content
Connect API Catalog/
/
/
Bank Match

Bank Match

Request

This endpoint can be used to check the reliability of a company/bank details combination, and ensure that the IBAN is not linked to a risk of fraud.

NOTE - There are a set of 'required' parameters for this endpoint, however please note the exceptions in the countryCode description.

Security
bearerToken
Query
registrationIdstringrequired

registrationId of company

countryCodestringrequired

Country codes in iso-2 format

The following counties do NOT support the iban parameter -
AU, CA,CN, HK, IN,JP,KR,MX, MY, SG, US, ZA

Please see the following link for required parameters on these countries:
FR Bank Match Parameter Information

bbanstring

Bank Account Number for countries where IBAN format doesn't support

bankCountrystring

Bank Country always expected in ISO-2-alpha code

ibanstringrequired

Bank Account details in IBAN format

bicstring

Business/Bank Identifier Code to identify the bank/branch holding the account along with BBAN

routingCodestring

Routing Code to identify the bank/branch holding the account along with BBAN

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/localSolutions/FR/bankmatch?registrationId=string&countryCode=string&bban=string&bankCountry=string&iban=string&bic=string&routingCode=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
@domainstring

The domain associated with the match.

createdBystring

The user or system that created the match record.

createdDatestring, (date-time)

The date and time when the match record was created.

lastModifiedBystring

The user or system that last modified the match record.

lastModifiedDatestring, (date-time)

The date and time when the match record was last modified.

idstring

The unique identifier of the match record.

scoreinteger

The score assigned to the match.

classificationstring

The classification of the match.

statusstring

The current status of the match.

entityobject

Details of the entity involved in the match.

issuerCompanyobject

Information about the issuer company.

inputobject

Input data for the match.

withDeferredResultboolean

Indicates if the match result is deferred.

byAPIboolean

Indicates if the match was processed via API.

byFTPboolean

Indicates if the match was processed via FTP.

workflowstring

The workflow associated with the match.

reasonsArray of strings

The reasons associated with the match.

reasonLabelsobject

Labels for the reasons associated with the match.

Response
{
  "@domain": "string",
  "createdBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedBy": "string",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "id": "string",
  "score": 0,
  "classification": "string",
  "status": "string",
  "entity": {
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "paymentIdentity": { … },
    "company": { … },
    "additionalProperties": { … }
  },
  "issuerCompany": {
    "createdBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedBy": "string",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "id": "string",
    "registrationId": "string",
    "name": "string",
    "typeId": "string",
    "countryCode": "string"
  },
  "input": {
    "@input": "string",
    "paymentIdentity": { … },
    "company": { … }
  },
  "withDeferredResult": true,
  "byAPI": true,
  "byFTP": true,
  "workflow": "string",
  "reasons": [
    "string"
  ],
  "reasonLabels": {
    "property1": "string",
    "property2": "string"
  }
}