Confidence Match Search

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

SecuritybearerToken
Request
query Parameters
country
required
string

Iso-2 country code

Example: country=GB
matchThreshold
required
integer

There are 3 main score bands to use for a successful response.
- Use score 898 for a 'good' match on 'name'.
- Use score 899 for a 'good' match on 'name' and 'ok' response on an address component.
- Use scores between 900 - 999 for use on the other searches adjusting for level of 'match' response.

Example: matchThreshold=905
regNo
string or 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 or null

Company VAT Number

name
string or null

Company Name

street
string or null
Default: null

Address part identifier - Street of the Company

houseNo
string or null

Address part identifier - House/Building Number of the Company

city
string or null

Address part identifier - City of the Company

postCode
string or null

Address part identifier - Postcode/Zip Code of the Company.

province
string or null

Address part identifier - Province of the Company

state
string or null

Address part identifier - State of the Company

phoneNo
string or null
reference1
string

Customer supplied free text reference 1 of 3

Example: reference1=free text 1
reference2
string

Customer supplied free text reference 2 of 3

Example: reference2=free text 2
reference3
string

Customer supplied free text reference 3 of 3

Example: reference3=free text 3
callRef
string or null
Default: 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.

Responses
200
400
401
get/companies/match
Request samples 
Response samples 
application/json
{
  • "totalMatches": 0,
  • "matchedCompanies": [
    ]
}
➔ Next to People/Directors