GET: Ratings Tree

Ingrid

https://api.bitsighttech.com/ratings/v1/companies/company_guid/company-tree

Get a company’s information, along with all of its subsidiaries. Since subsidiaries may also possess its own subsidiary that are related to the parent company as part of the bundle, this path continues past the first generation when returning subsidiary data.

Example Request

curl 'https://api.bitsighttech.com/ratings/v1/companies/a940bb61-33c4-42c9-9231-c8194c305db3/company-tree' -u api_token:

Example Response

{
  "guid":"a940bb61-33c4-42c9-9231-c8194c305db3",
  "name":"Saperix, Inc.",
  "rating":500,
  "industry":"Technology",
  "is_service_provider":false,
  "rating_type":"CURATED",
  "is_subscribed":true,
  "is_primary":false,
  "children":[
    […]
  ],
  "is_bundled":false,
  "has_control":true,
  "is_shell":false
}

Response Attributes

Field	Description
guid String [`entity_guid`]	The unique identifier of this company.
name String	The display name of this company.
rating Integer	The current security rating of this company.
industry String	The industry of this company.
is_service_provider Boolean	`true` = This company is a service provider.
rating_type String	Indicates how this rating was curated. See rating types.
is_subscribed Boolean	`true` = You’re subscribed to this company.
is_primary Boolean	`true` = This rating is designated as the primary, which the publisher believes better reflects their security posture.
children Object	The subsidiaries of this company.
is_bundled Boolean	`true` = This is part of a rating bundle.
has_control Boolean	`true` = The requesting user has control over this company.
is_shell Boolean	`true` = This is a shell company.

September 25, 2023: is_shell parameter; is_bundled, has_control, is_shell fields.
August 16, 2019: Published.