Creditsafe Connect

Creditsafe Connect

(0 reviews)

Searching Companies

In order to use the main features of the API such as retrieving a Company Report, monitoring a company for changes or running a company through a Decision Engine model, you must first obtain the companies unique identifier. This is done by performing a Company Search. When you have found your desired companies unique identifier it is also known as obtaining a Match.

Prerequisites

Before you can start searching for companies you must have obtained the following:

  • A valid Authorization token

Please see Getting Authenticated for instructions on how to retrieve an Authorization Token.

GET https://connect.creditsafe.com/v1/companies?countries={Comma Separated ISO-2 country codes}&{paramList}

HEADERS
Key: Authorization, Value: authToken
Key: Content-Type, Value: application/json


Parameter Examples

name=Creditsafe

pageSize=50

pageCount=10

status=active

city=Cardiff

postCode=CF10
...

e.g. GET https://connect.creditsafe.com/v1/companies?countries=GB,NL=Creditsafe

For a detailed description of the search interface, and list of parameters please see the Connect API Interface RAML - GET \companies

/companies will return a JSON collection of companies scored in order of the relevance of the search parameters. Each company search result will contain a field 'ID'

Search Criteria

Creditsafe Connect has common search parameters across its countries. However, there are some search parameters that only exist at a local level, and have no relevance in other country searches. To obtain the country specific search parameters, call the following endpoint

GET https://connect.creditsafe.com/v1/companies/searchcriteria?countries='{Comma Separated ISO-2 country code}'

HEADERS

Key: Authorization, Value: authToken

Key: Content-Type, Value: application/json

This is a collection of fields that can be submitted as query parameters to the /companies?{params} endpoint to refine, or broaden your search.

Calling GET /companies/searchcriteria?countries='C1','C2' with multiple countries will return only search parameters that are common between those countries. A ramification of this is that searching in a singular country will offer more search specific criteria.

For example

GET https://connect.creditsafe.com/v1/companies/searchcriteria?countries='FR,NL'

Country Access List

In certain integrations you may want your user users to be presented with a list of countries that your account has access to (for example, to pick a region to search specifically in). This can be obtained by calling

GET https://connect.creditsafe.com/v1/access/countries

HEADERS

Key: Authorization, Value: authToken

Key: Content-Type, Value: application/json

Reviews