Sign in
Company

Starts monitoring an already-known Black Kite company (e.g. found via global search) by its Black Kite Id.

Attaches an existing Black Kite company, identified by its Black Kite Id, to one of the caller's own ecosystems and starts a continuous scan and monitoring process.

post/api/v2/companies/{id}

Path parameters

idinteger required

The Black Kite Id of the company, as returned by the global search endpoints.

Request body

EcosystemIdnumber required

The identifier of the ecosystem that the company will be included in.

LicenseType'ContinuousAnnual' | 'Continuous60day' | 'Inventory-only'

This parameter can get ContinuousAnnual or Continuous60day values, depending on which license you want to use for the company monitored. This field is optional and when left out, the system automatically utilizes an existing Continuous Annual license. In case there's none, an existing Continuous 60 Day license is used. When there are no valid continuous licenses, the system refuses to add that single company. Passing Inventory-only adds the company without consuming or requiring any active continuous license, tracked in the inventory but not fully monitored.

Example request

{
  "EcosystemId": 32,
  "LicenseType": "ContinuousAnnual"
}

Response

Success

BlackKiteIdinteger

The Black Kite Id of the company that is started to be monitored.

DomainValuestring

The main domain value of the company that is started to be monitored.

Example response

{
  "BlackKiteId": 1024,
  "DomainValue": "acmeinc.com"
}

Changes

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