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.
page | integer Default: 1 Starting page number. |
pageSize | integer Number of items to return per Page. |
countries required | string (Creditsafe.GlobalData.CountryCode) comma-separated list of iso-2 country codes. Example: countries=GB,FR |
language | string or null = 2 characters Default: null Only used for Countries where more than one Company Name exists for different languages e.g. Japanese Kanji and English. |
id | string or null Default: 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. |
safeNo | string or null Safe Number - Identifier for Companies in Creditsafe's Home Countries. |
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 |
tradeName | string or null Trade Name of the Company, typically used in Countries where Name is not uniquely registered. |
acronym | string 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. |
exact | boolean or null Provide as |
address | string or null |
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. Can be provided partially to extend to a region with a * as a wildcard. I.e. CF* can represent all postcodes starting with CF. |
province | string or null Address part identifier - Province/State of the Company |
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. |
officeType | string (Creditsafe.GlobalData.OfficeType) Enum: "registered" "trading" "headOffice" "branch" "subsidiary" "franchise" "franchisor" "singleOffice" "other" |
phoneNo | Array of strings or null Provides Array of phone numbers or Null |
status | string (Creditsafe.GlobalData.CompanyStatus) 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. |
type | string (Creditsafe.GlobalData.CompanyType)
|
website | string or null |
customData | string or null Not currently used. |
Bad Request
Invalid Token
{- "correlationId": "string",
- "messages": [
- {
- "type": "Information",
- "code": "NoResults",
- "text": "string"
}
], - "totalSize": 0,
- "companies": [
- {
- "id": "string",
- "country": "AF",
- "regNo": "string",
- "safeNo": "string",
- "idType": "Other",
- "name": "string",
- "type": "NotSet",
- "officeType": "registered",
- "status": "Active",
- "vatNo": "string",
- "additionalInformation": {
- "isPLC": "string",
- "coefficientLinear": 0
}, - "address": {
- "type": "string",
- "simpleValue": "string",
- "street": "string",
- "houseNo": "string",
- "city": "string",
- "postCode": "string",
- "province": "string",
- "telephone": "string",
- "directMarketingOptOut": true,
- "directMarketingOptIn": true,
- "country": "AF"
}, - "activity": {
- "code": "string",
- "industrySector": "string",
- "description": "string",
- "classification": "string"
}, - "legalForm": "string",
- "additionalData": { },
- "dateOfLatestAccounts": "2019-08-24T14:15:22Z",
- "dateOfLatestChange": "2019-08-24T14:15:22Z",
- "phoneNumbers": [
- "string"
], - "activityCode": "string"
}
]
}