# Confidence Match Search

Supply all company search criteria to find potential company matches ranked by a .   - See here for more information.

Endpoint: GET /companies/match
Version: 1.10.9
Security: bearerToken

## Query parameters:

  - `country` (string, required)
    Iso-2 country code
    Example: "GB"

  - `matchThreshold` (integer, required)
    Minimum threshold value , maximum threshold value .
    Example: 905

  - `regNo` (string,null)
    Local Company Identifier - The Company identifier associated with it's Domestic Filing Agency. i.e. French SIREN/SIRET, United Kingdom Companies House CRN.

  - `vatNo` (string,null)
    Company VAT Number

  - `name` (string,null, required)
    Company Name

  - `street` (string,null)
    Address part identifier - Street of the Company

  - `houseNo` (string,null)
    Address part identifier - House/Building Number of the Company

  - `city` (string,null)
    Address part identifier - City of the Company

  - `postCode` (string,null)
    Address part identifier - Postcode/Zip Code of the Company.

  - `province` (string,null)
    Address part identifier - Province of the Company

  - `phoneNo` (string,null)

  - `reference1` (string)
    Customer supplied free text reference 1 of 3
    Example: "free text 1"

  - `reference2` (string)
    Customer supplied free text reference 2 of 3
    Example: "free text 2"

  - `reference3` (string)
    Customer supplied free text reference 3 of 3
    Example: "free text 3"

  - `callRef` (string,null)
    This parameter allows users to assign a unique identifier to their API queries. By using a callRef, it facilitates easier tracking and logging within Connect. If you provide a callRef, the Connect team can later retrieve and identify the specific requests associated with that identifier, enabling detailed tracing of interactions.

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