# 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. 

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


Endpoint: GET /localSolutions/FR/bankmatch
Version: 1.10.9
Security: bearerToken

## Query parameters:

  - `registrationId` (string, required)
    registrationId of company

  - `countryCode` (string, required)
    Country codes in iso-2 format 

The following counties do  support the  parameter - 
, ,, , ,,,, , , , 
Please see the following link for required parameters on these countries:  FR Bank Match Parameter Information

  - `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` (string, required)
    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

## Response 200 fields (application/json):

  - `@domain` (string)
    The domain associated with the match.

  - `createdBy` (string)
    The user or system that created the match record.

  - `createdDate` (string)
    The date and time when the match record was created.

  - `lastModifiedBy` (string)
    The user or system that last modified the match record.

  - `lastModifiedDate` (string)
    The date and time when the match record was last modified.

  - `id` (string)
    The unique identifier of the match record.

  - `score` (integer)
    The score assigned to the match.

  - `classification` (string)
    The classification of the match.

  - `status` (string)
    The current status of the match.

  - `entity` (object)
    Details of the entity involved in the match.

  - `entity.createdDate` (string)
    The date and time when the entity was created.

  - `entity.lastModifiedDate` (string)
    The date and time when the entity was last modified.

  - `entity.paymentIdentity` (object)
    Payment identity information.

  - `entity.paymentIdentity.iban` (string)
    The International Bank Account Number (IBAN).

  - `entity.paymentIdentity.type` (string)
    The type of payment identity.

  - `entity.company` (object)
    Company information associated with the entity.

  - `entity.company.createdDate` (string)
    The date and time when the company was created.

  - `entity.company.lastModifiedDate` (string)
    The date and time when the company was last modified.

  - `entity.company.registrationId` (string)
    The registration ID of the company.

  - `entity.company.name` (string)
    The name of the company.

  - `entity.company.legalPerson` (boolean)
    Indicates if the company is a legal entity.

  - `entity.company.codeTva` (string)
    The VAT code of the company.

  - `entity.company.typeId` (string)
    The type ID of the company.

  - `entity.company.countryCode` (string)
    The country code of the company.

  - `entity.company.status` (string)
    The current status of the company.

  - `entity.additionalProperties` (object)
    Additional properties related to the entity.

  - `entity.additionalProperties.vatRequestInfo` (object)
    VAT request information.

  - `entity.additionalProperties.vatRequestInfo.valid` (boolean)
    Indicates if the VAT request is valid.

  - `entity.additionalProperties.vatRequestInfo.requestIdentifier` (string)
    The identifier for the VAT request.

  - `entity.additionalProperties.vatRequestInfo.date` (string)
    The date of the VAT request.

  - `issuerCompany` (object)
    Information about the issuer company.

  - `issuerCompany.createdBy` (string)
    The user or system that created the issuer company record.

  - `issuerCompany.createdDate` (string)
    The date and time when the issuer company record was created.

  - `issuerCompany.lastModifiedBy` (string)
    The user or system that last modified the issuer company record.

  - `issuerCompany.lastModifiedDate` (string)
    The date and time when the issuer company record was last modified.

  - `issuerCompany.id` (string)
    The unique identifier of the issuer company.

  - `issuerCompany.registrationId` (string)
    The registration ID of the issuer company.

  - `issuerCompany.name` (string)
    The name of the issuer company.

  - `issuerCompany.typeId` (string)
    The type ID of the issuer company.

  - `issuerCompany.countryCode` (string)
    The country code of the issuer company.

  - `input` (object)
    Input data for the match.

  - `input.@input` (string)
    The input data identifier.

  - `input.paymentIdentity` (object)
    Payment identity information from the input.

  - `input.paymentIdentity.iban` (string)
    The International Bank Account Number (IBAN) from the input.

  - `input.company` (object)
    Company information from the input.

  - `input.company.registrationId` (string)
    The registration ID of the company from the input.

  - `input.company.countryCode` (string)
    The country code of the company from the input.

  - `withDeferredResult` (boolean)
    Indicates if the match result is deferred.

  - `byAPI` (boolean)
    Indicates if the match was processed via API.

  - `byFTP` (boolean)
    Indicates if the match was processed via FTP.

  - `workflow` (string)
    The workflow associated with the match.

  - `reasons` (array)
    The reasons associated with the match.

  - `reasonLabels` (object)
    Labels for the reasons associated with the match.

## Response 400 fields (application/json):

  - `correlationId` (string)
    A unique ID assigned to this request.

  - `message` (string)

  - `details` (string)
    Provides further information on why the request was rejected

## Response 401 fields (application/json):

  - `error` (string)

## Response 403 fields (application/json):

  - `message` (string)
    Example: "Access forbidden"

## Response 404 fields (application/json):

  - `correlationId` (string)
    A unique ID assigned to this request.

  - `message` (string)

  - `details` (string)
    Provides further information on why the request was rejected