Sign in
Global Companies

Searches through all companies known to Black Kite, across all customers.

Create a global (cross-tenant) search operation for companies. Unlike the companies/search operation, this searches the entire Black Kite company catalog, not just the requesting customer's portfolio. This endpoint will not return the list of resulting companies, but instead it will return a search key, that can be used to list the companies found by using the getGlobalCompanies operation. At least one of CompanyName, Domain, CountryCodes, IndustryCodes or Statuses must be provided. Attention: Every unique client id can create a maximum of 100000 search key per day.

post/api/v2/global-company-searches

Request body

CompanyNamestring nullable

The name (or part of the name) of the company to search for.

Domainstring nullable

The main domain value of the company to search for.

CountryCodesstring[] nullable

The list of countries that the companies belong to in two letters format.

IndustryCodesnumber[] nullable

The list of industry codes that the companies are classified with.

Statusesstring[] nullable

The list of statuses of the company relative to the requesting customer's account.

Example request

{
  "CompanyName": "Acme Inc.",
  "Domain": "acmeinc.com",
  "CountryCodes": [
    "US"
  ],
  "IndustryCodes": [
    1234
  ],
  "Statuses": [
    "Not Tracked"
  ]
}

Response

Success

Keystring required

A key in GUID format, which points to the newly created global company search action. Use this key in the getGlobalCompanies operation as a query parameter in order to fetch the results. The key has a life time of 6 hours. A new search operation should be performed when the search keys are expired.

Example response

{
  "Key": "0f8fad5b-d9cb-469f-a165-70867728950e"
}

Changes

Changed in 1 of the 5 revisions of this API.1