# Bank Match

The Bank Verification tool allows customers to instantly verify that small and medium sized companies you are working with are providing correct bank details, to reduce fraud and avoid delays in your on boarding process. The bank data for these companies is provided to Creditsafe by various financial providers, including major banks. When you provide us with a company number and their bank details, we are able to perform instant checks to verify that those bank details are associated with that company and return -  Match – We have bank information on the company, and the data provided by the customer matches the company records  No Match – We have bank information on the company, but the data provided does not match any of the company records  Data Unavailable - We do not have bank information on the company.

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

## Query parameters:

  - `checkType` (any, required)
    Validation uses an algorithm to determine if a SCAN or IBAN exists, but does not let you know if that SCAN or IBAN actually belongs to the company who has provided it. Verification takes this a step further and checks the Creditsafe database for a match on the SCAN/IBAN, and tells you if the bank details actually belong to the company, so you can be assured that you are sending your money to the correct entity.
    Enum: "Both", "Validate", "Verify"

  - `companyId` (string, required)
    The connectId or safeNumber of the company to check against.
    Example: "GB-0-X9999999"

  - `sortCode` (string)
    Sort Code to check - Must be passed in with Account Number to form a SCAN Result
    Example: "089997"

  - `accountNumber` (string)
    Account Number to check - Must be passed in with Sort Code to form a SCAN Result
    Example: 66374958

  - `iban` (string)
    IBAN to check
    Example: "GB55TEST08999966374957"

  - `vatNumber` (string)
    VAT Number to check

## Response 200 fields (application/json):

  - `totalSize` (integer)
    Example: 1

  - `bankMatchResults` (array)

  - `bankMatchResults.companyNumber` (string,null)
    Example: "X9999999"

  - `bankMatchResults.accountNumber` (string,null)
    Example: "66374957"

  - `bankMatchResults.iban` (string,null)
    Example: "GB55TEST08999966374957"

  - `bankMatchResults.ibanResult` (string,null)
    Match or No Match

  - `bankMatchResults.ibanText` (string,null)
    Example: "The IBAN provided does not match the company UK07499628."

  - `bankMatchResults.logDate` (string,null)
    Example: "2020-06-04T11:04:32.7301608+00:00"

  - `bankMatchResults.safeNumber` (string,null)
    Example: "UK07499628"

  - `bankMatchResults.scanResult` (string,null)
    Match or No Match

  - `bankMatchResults.scanText` (string,null)
    Example: "The Sort Code and Account Number provided does not match the company UK07499628."

  - `bankMatchResults.sortCode` (string,null)
    Example: "089999"

  - `bankMatchResults.statusResult` (string,null)
    Request status, e.g. Success, Error, Warning

  - `bankMatchResults.statusText` (string,null)
    Explanation for error or warning, if applicable, otherwise empty quotation marks

  - `bankMatchResults.vatResult` (string,null)
    Match or No Match

  - `bankMatchResults.vatText` (string,null)
    Example: "The VAT provided matches the company UK07499628."

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