Sign in

v1

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

Searches through monitored companies.

Create a search operation for companies. 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 getCompanies operation. Attention: Every unique client id can create a maximum of 100000 search key per day. Attention: All array type search criteria may take a maximum of 100000 values each.

post/api/v2/companies/search

Request body

GenericSearchTextstring

A generic search text which will be searched over many of the companies' fields, such as company name, domains, industry codes, etc.

EcosystemIdsnumber[] nullable

The list of ecosystem ids that the companies are defined under.

IndustryIdsnumber[] nullable

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

CountryCodesstring[] nullable

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

TagIdsnumber[] nullable

The list of tag ids that the companies are attributed with.

ProductGroupIdsnumber[] nullable

The list of product group ids that the companies products are defined under.

LicenseTypesstring[] nullable

The list of license type.

LicenseStatusstring[] nullable

The list of license status.

GradeLettersstring[] nullable

The list of grade letters that the companies have as a technical risk score.

ControlCodesstring[] nullable

The list of Black Kite security controls that the company has a finding of.

CveOrCweCodesstring[] nullable

The list of CVE or CWE codes that the company has a finding of.

ThreatActorIdsnumber[] nullable

The list of threat actor ids.

LeakIdsnumber[] nullable

The list of leak ids.

TagConfidencesstring[] nullable

The confidence levels of tags

HasCriticalVulnboolean

Whether the company contains at least one critical finding. That means a finding with CWSS score > 8 or CVSS > 8.

HasLeakIn90Daysboolean

Whether the company has breached credentials in the last 90 days.

HasPoorSslboolean

Whether the company broken crypto algorithms, such as SSL v2.0, SSL v3.0 or TLS v1.0.

HasPoorDdosboolean

Whether the company has a DDOS Black Kite grade with smaller than or equal to C.

HasPoorSmtpboolean

Whether the company has a Email Security Black Kite grade with smaller than or equal to C.

HasPoorDnsboolean

Whether the company has a DNS Black Kite grade with smaller than or equal to C.

CwssCvssBiggerThanValuenumber double

The value of minimum CWSS or CVSS of the company findings. Supports decimal values (e.g., 8.99). 0 means all findings.

CompanySizeGreaterThannumber nullable

The value of minimum company size.

CompanySizeLessThannumber nullable

The value of maximum company size.

CountryRiskRatingsstring[] nullable

The list of country risk ratings to filter companies by.

NumberOfEmployeeGreaterThannumber nullable

The value of minimum number of employee.

NumberOfEmployeeLessThannumber nullable

The value of maximum number of employee.

IsInOfacboolean

Whether the company is listed in OFAC (Office of Foreign Assets Control) sanctions list.

RevenueGreaterThannumber nullable

The value of minimum revenue.

RevenueLessThannumber nullable

The value of maximum revenue.

NetIncomeGreaterThannumber nullable

The value of minimum net income.

NetIncomeLessThannumber nullable

The value of maximum net income.

OperatingIncomeGreaterThannumber nullable

The value of minimum operating income.

OperatingIncomeLessThannumber nullable

The value of maximum operating income.

EquityGreaterThannumber nullable

The value of minimum equity.

EquityLessThannumber nullable

The value of maximum equity.

UseGenAIsstring[] nullable

The list of Gen AI usage to filter companies by.

Example request

{
  "GenericSearchText": "Health",
  "EcosystemIds": [
    1234
  ],
  "IndustryIds": [
    1234
  ],
  "CountryCodes": [
    "US"
  ],
  "TagIds": [
    1234
  ],
  "ProductGroupIds": [
    1234
  ],
  "LicenseTypes": [
    "Not Attached"
  ],
  "LicenseStatus": [
    "Inactive"
  ],
  "GradeLetters": [
    "C-"
  ],
  "ControlCodes": [
    "APPSEC-000"
  ],
  "CveOrCweCodes": [
    "CVE-2022-23589"
  ],
  "ThreatActorIds": [
    1234
  ],
  "LeakIds": [
    1234
  ],
  "TagConfidences": [
    "High"
  ],
  "CwssCvssBiggerThanValue": 8.99,
  "CompanySizeGreaterThan": 1,
  "CompanySizeLessThan": 10,
  "CountryRiskRatings": [
    "High"
  ],
  "NumberOfEmployeeGreaterThan": 10,
  "NumberOfEmployeeLessThan": 100,
  "RevenueGreaterThan": 1000,
  "RevenueLessThan": 10000,
  "NetIncomeGreaterThan": 1000,
  "NetIncomeLessThan": 10000,
  "OperatingIncomeGreaterThan": 1000,
  "OperatingIncomeLessThan": 10000,
  "EquityGreaterThan": 1000,
  "EquityLessThan": 10000,
  "UseGenAIs": [
    "Yes"
  ]
}

Response

Success

Keystring required

A key in GUID format, which points to the newly created company search action. Use this key in getCompanies action as a URL 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"
}