Sign in

v1

latestOpenAPI 3.0.0Proprietary - Commercial Use Only2026-08-06172139621.6 KB
Company

The given company is started to be monitored.

A continuous scan and monitoring process is triggered to produce technical, compliance and financial security scores. If the main domain value provided redirects to another domain, then the redirected domain will be taken as the main domain value instead of the original input.

post/api/v2/companies

Request body

MainDomainValuestring required

The main domain value of the new company. Make sure you read IsSubsidiary property to make sure that you are adding the correct main domain of the company.

EcosystemIdnumber required

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

LicenseType'ContinuousAnnual' | 'Continuous60day'

This parameter can get either 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 add that single company.

IsSubsidiaryboolean

If the company is represented by only a subdomain (e.g., in.example.com), then this box should be checked. Otherwise, the whole domain (example.com instead of in.example.com) will be scanned.

IsCloudProviderboolean

Scanning Internet Service Providers and Infrastructure-as-a-Service providers that provide hosting services for their clients might result in a massive digital footprint where most of the assets used by these clients. Thus, Black Kite filters out these assets while scanning such providers. If scanning such a company is desired, even though Black Kite has its own detection algorithms, sending this value true would fasten the scanning and eliminates any misattribution.

IgnoreDomainCheckboolean

If false, Black Kite checks whether the main domain value exists or not. If the domain is invalid an error will be returned. If you are positive that the domain is valid, set this parameter to true.

Example request

{
  "MainDomainValue": "acmeinc.com",
  "LicenseType": "ContinuousAnnual"
}

Response

Success

CompanyIdinteger

The ID of the company that is started to be monitored.

MainDomainValuestring required

The main domain value of the new company that is started to be monitored. This may differ from the given main domain value in the request depending on the value of IsSubsidiary. For example, www.acmeinc.com can be transformed into acmeinc.com.

LicenseIdinteger

The license chosen to be consumed by monitoring the newly added company.

Example response

{
  "CompanyId": 228,
  "MainDomainValue": "acmeinc.com",
  "LicenseId": 213
}