Confidence Match Search

Request

Supply all company search criteria to find potential company matches ranked by a single score. - Interpreting confidence match scores.

Note: This endpoint does not support pagination. Any pagination-related query parameters sent by the client will be ignored and will not affect the response.

Security

bearerToken

Query

countrystringrequired

Iso-2 country code

Example:country=GB

matchThresholdintegerrequired

Minimum threshold value 893, maximum threshold value 999.

Example:matchThreshold=905

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

vatNostring or null

Company VAT Number

namestring or nullrequired

Company Name

streetstring or null

Address part identifier - Street of the Company

Default:null

houseNostring or null

Address part identifier - House/Building Number of the Company

citystring or null

Address part identifier - City of the Company

postCodestring or null

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

provincestring or null

Address part identifier - Province of the Company

phoneNostring or null

reference1string

Customer supplied free text reference 1 of 3

Example:reference1=free text 1

reference2string

Customer supplied free text reference 2 of 3

Example:reference2=free text 2

reference3string

Customer supplied free text reference 3 of 3

Example:reference3=free text 3

callRefstring or 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.

Default:null

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/companies/match?country=GB&matchThreshold=905&regNo=string&vatNo=string&name=string&street=%7Bstreet%7D&houseNo=string&city=string&postCode=string&province=string&phoneNo=string&reference1=free%20text%201&reference2=free%20text%202&reference3=free%20text%203&callRef=%7BcallRef%7D' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

One of:

totalMatchesinteger

The total number of companies matched in the search results.

matchedCompaniesArray of objects

A list of companies that matched the search criteria.

Response

{
  "totalMatches": 0,
  "matchedCompanies": [
    { … }
  ]
}