Bank Match

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.

SecuritybearerToken
Request
query Parameters
registrationId
required
string

registrationId of company

countryCode
required
string

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:
Unsupported Country parameter requirements

bban
string

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

bankCountry
string

Bank Country always expected in ISO-2-alpha code

iban
required
string

Bank Account details in IBAN format

bic
string

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

routingCode
string

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

Responses
200
400
401
403
get/localSolutions/FR/bankmatch
Request samples
Response samples
application/json
{
  • "@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": {
    },
  • "issuerCompany": {
    },
  • "input": {
    },
  • "withDeferredResult": true,
  • "byAPI": true,
  • "byFTP": true,
  • "workflow": "string",
  • "reasons": [
    ],
  • "reasonLabels": {
    }
}