Skip to content
Connect API Catalog/
/
/
Company Search

Company Search

Request

Endpoint to search for Companies according to the provided Search Criteria. To get the most relevant results, it is recommended to use a unique identifier such as regNo where available. If a unique identifier is not available, use a combination of the companies registered postCode and name for the next best hit rate.

Security
bearerToken
Query
pageinteger

Starting page number.

Default:1
pageSizeinteger

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

countriesstring^([a-zA-Z\\s]+,)*[a-zA-Z\\s]+$required

comma-separated list of iso-2 country codes.
The code PLC can be used here to search for companies of this type across all countries.

Example:countries=GB,FR
languagestring or null, = 2 characters

Only used for Countries where more than one Company Name exists for different languages e.g. Japanese Kanji and English.
Country - Languages Available
Japan [JP] - EN & JA

Default:null
idstring or null

connectId - The primary Company identifier that is used to uniquely identify all companies across Creditsafe's Universe and Partner Network. This is returned on all Company Search Results. Use this field to use in other operations such as Ordering Company Credit Report by Id, and Adding Company to Monitoring Portfolio.

Default:null
safeNostring or null

Safe Number - Identifier for Companies in Creditsafe's Home Countries.

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 null

Company Name

tradeNamestring or null

Trade Name of the Company, typically used in Countries where Name is not uniquely registered.

acronymstring or null

A (non-unique) identifier to look for Companies by their more commonly known acronym rather than their lesser known full name. Acronym is predominantly available on French Companies.

exactboolean or null

Provide as true to find Companies matching a Name exactly.
A list of countries this is available at company search exact parameter availability.

addressstring or null
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. Can be provided partially to extend to a region with a * as a wildcard. I.e. CF* can represent all postcodes starting with CF.

provincestring or null

Address part identifier - Province/State of the Company

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
officeTypeCreditsafeGlobalDataOfficeType (string) or null
Any of:
string(CreditsafeGlobalDataOfficeType)
Enum:"Registered""Trading""HeadOffice""Branch""Subsidiary""Franchise""Franchisor""SingleOffice""Other"
phoneNoArray of strings or null

Provides Array of phone numbers or Null

statusCreditsafeGlobalDataCompanyStatus (string) or null
Any of:

High-level status. Values include "Active", "NonActive", "Pending" and "Other". Note - “Pending” indicates that the entity has entered into a legal process such as insolvency or liquidation, and “Other” indicates an unknown status.

string(CreditsafeGlobalDataCompanyStatus)
Enum:"Active""NonActive""Pending""Other"
typestring(CreditsafeGlobalDataCompanyType)

NonLtdNonReg is only available for countries in Norway.

Enum:"NotSet""Ltd""NonLtd""NonLtdNonReg"
websitestring or null
customDatastring or null

Not currently used.

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/companies?page=1&pageSize=0&countries=GB%2CFR&language=%7Blanguage%7D&id=%7Bid%7D&safeNo=string&regNo=string&vatNo=string&name=string&tradeName=string&acronym=string&exact=true&address=string&street=%7Bstreet%7D&houseNo=string&city=string&postCode=string&province=string&callRef=%7BcallRef%7D&officeType=Registered&phoneNo=string&status=Active&type=NotSet&website=string&customData=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
One of:
correlationIdstring

A unique ID assigned to this request.

messagesArray of objects(CreditsafeGlobalDataMessage)
totalSizeinteger, (int32)
companiesArray of objects(CreditsafeGlobalDataCompany)
Response
{
  "correlationId": "string",
  "messages": [
    { … }
  ],
  "totalSize": 0,
  "companies": [
    { … }
  ]
}