Sign in

v1

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

Get a list of monitored companies.

Get the list of companies, in other words, the requesting customer's portfolio. Products will be available when a search is being executed using the ProductGroupIds field in the companies/search endpoint.

get/api/v2/companies

Query parameters

page_numberinteger
Example:1

The number of the page requested.

page_size10 | 20 | 30 | 50 | 100 | 250
Example:10

The number of result items in a single response. It's highly probable to get 524 timeout errors when using page sizes more than 50.

keystring

A key in GUID format, which points to the search criteria used in searchCompanies operation.

Example:0f8fad5b-d9cb-469f-a165-70867728950e

The search key fetched from a call to searchCompanies operation. When this field is empty all companies are returned.

Response

Success

CompanyIdinteger required

The ID of the company in BlackKite.

CompanyNamestring

The name of the company in BlackKite.

DomainNamestring

The main domain value of the company.

Type'normal' | 'group'

There are two types of companies; normal and group. Group companies are formed by grouping normal or group companies.

DashboardLinkstring

The BlackKite portal dashboard link for the specified company.

Countrystring nullable

The full country name of the company.

ScanStatus'Extended Scan Queued' | 'Extended Scan Running' | 'Extended Scan Failed' | 'Extended Results Ready' | 'Extended Rescan Queued' | 'Extended Rescan Running' | 'Extended Rescan Failed' | 'Extended Rescan Results Ready' | 'Unknown Scan Status'

The ones with "Extended Scan" prefix mean, this is the first time Black Kite executes a comprehensive scan on the related company. This is the phase where extensive technical issues will be extracted. The ones with "Extended Rescan" prefix mean, this is one of the many continuous scans that Black Kite executes against the target company. In summary, when the status value contains both the words "Extended" and "Ready", that means the results are ready for processing. Beware that this property is only related to the technical rating part of the three dimensional Black Kite rating system. So, the value of ScanStatus property doesn’t tell you whether the Compliance or FinancialImpact property values are calculated yet or not.

Example response

[
  {
    "CompanyId": 22,
    "CompanyName": "Demo Inc.",
    "DomainName": "demoinc.com",
    "Type": "normal",
    "CyberRating": {
      "GradeLetter": "B+",
      "CyberRating": 87,
      "BreachIndex": 0.65,
      "RansomwareIndex": 0.322,
      "CyberRatingLastUpdatedAt": "2021-04-01T10:01:17.641Z",
      "RansomwareIndexLastUpdatedAt": "2021-04-01T10:04:17.641Z",
      "BreachIndexLastUpdatedAt": "2021-04-01T10:05:17.641Z"
    },
    "ThreatActor": {
      "OverallAsiScore": 75,
      "ThreatActorResults": [
        {
          "ThreatActorName": "APT20",
          "AsiScore": 82,
          "Reasoning": "The company has strong technical exposure due to one or more CVEs actively exploited by the threat actor. It aligns with sectors or geographies previously targeted by this actor."
        }
      ]
    },
    "Compliance": {
      "Rating": 78,
      "Confidence": 11,
      "Completeness": 78,
      "LastUpdatedAt": "2021-04-01T10:01:17.641Z"
    },
    "FinancialImpact": {
      "Rating": 40845,
      "RatingMin": 10697,
      "RatingMax": 647362,
      "LossMagnitude": 3098734,
      "LossEventFrequency": 0.0132,
      "LastUpdatedAt": "2021-04-01T10:03:17.641Z"
    },
    "FinancialImpacts": [
      {
        "Rating": 40845,
        "RatingMin": 10697,
        "RatingMax": 647362,
        "LossMagnitude": 3098734,
        "LossEventFrequency": 0.0132,
        "LastUpdatedAt": "2021-04-01T10:03:17.641Z",
        "RiskType": "Data Breach"
      }
    ],
    "DashboardLink": "https://app.blackkitetech.com/ecosystem/12/company/22/dashboard",
    "Ecosystems": [
      {
        "EcosystemId": 173,
        "EcosystemName": "MyCompanies"
      }
    ],
    "Licenses": [
      {
        "LicenseType": "Continuous 60-day",
        "LicenseStatus": "Active"
      }
    ],
    "Industry": {
      "IndustryId": 5412,
      "IndustryName": "Manifacturing"
    },
    "Country": "United States of America",
    "Tags": [
      {
        "TagId": 45,
        "TagName": "Finance",
        "TagType": "Custom Tag"
      }
    ],
    "Products": [
      {
        "Asset": "192.168.3.4",
        "Cpe": "cpe:/a:product:product:4.89:rc5",
        "Protocol": "HTTP"
      }
    ],
    "ScanStatus": "Extended Results Ready"
  }
]