Sign in

v1

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

Searches through supply chain relationships.

Create a search operation for supply chain analysis. This endpoint will not return the list of resulting companies, but instead it will return a search token that can be used to list the supply chain companies found by using getSupplyChainCompanies operation. Attention: Every unique client id can create a maximum of 100000 search keys per day.

post/api/v2/supplychain/search

Request body

Relationshipsstring[] nullable

The list of relationship types to filter companies by.

CountryCodesstring[] nullable

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

IndustryIdsinteger[] nullable

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

TagIdsinteger[] nullable

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

EcosystemIdsinteger[] nullable

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

GradeLettersstring[] nullable

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

DetectionTypesstring[] nullable

The list of detection types to filter companies by.

AssetCountryCodesstring[] nullable

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

RsiMinnumber double nullable

The value of minimum Ransomware Susceptibility Index (0-1).

DbiMinnumber double nullable

The value of minimum Data Breach Index (0-1).

FairMinnumber double nullable

The value of minimum FAIR score.

ConcentrationRiskMininteger nullable

The minimum concentration risk percentage to filter companies by (1-100).

ComplianceRatingMaxinteger nullable

The maximum compliance rating percentage to filter companies by (0-100).

Example request

{
  "Relationships": [
    "3rd Party"
  ],
  "CountryCodes": [
    "US"
  ],
  "IndustryIds": [
    54
  ],
  "TagIds": [
    123
  ],
  "EcosystemIds": [
    456
  ],
  "GradeLetters": [
    "C-"
  ],
  "DetectionTypes": [
    "Cloud Asset Detected"
  ],
  "AssetCountryCodes": [
    "DE"
  ],
  "RsiMin": 0.5,
  "DbiMin": 0.5,
  "FairMin": 100000,
  "ConcentrationRiskMin": 25,
  "ComplianceRatingMax": 75
}

Response

Success

Keystring required

A key in GUID format, which points to the newly created supply chain search action. Use this key in getSupplyChainCompanies action as a URL parameter in order to fetch the results. The key has a lifetime of 6 hours. A new search operation should be performed when the search keys are expired.

Example response

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