GET: Company Details – Bitsight Knowledge Base

https://api.bitsighttech.com/ratings/v1/companies/company_guid

Get a company’s details, including:

Their rating.
Rating history.
Risk vector grades.
Company information.
Relationship details.

Parameters

* Required.

See query parameters for details on the format (Value: json) parameter.

company_guid

* Required.

[Path] Identify the company to query.

Value: [String] Company unique identifier [entity_guid]. See GET: Portfolio Details.

fields

[Query] Filter by fields.

Value: [Array] Comma-separated field names, which are available in the response. The order of the specific fields might not be reflected in the response when using this parameter.

industry_average = Get the average rating of the industry sector.
industry_percentile = Get the company’s percentile rank.

Example Request

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

Use the fields parameter to get the average rating and percentile rank:

curl https://api.bitsighttech.com/ratings/v1/companies/a940bb61-33c4-42c9-9231-c8194c305db3?fields=industry_average,industry_percentile -u api_token:

See the example response and response attributes.

Example Response

{
  "guid":"a940bb61-33c4-42c9-9231-c8194c305db3",
  "custom_id":"MyCo",
  "name":"Saperix, Inc.",
  "description":"Saperix Technologies LLC develops risk analysis software solutions.",
  "ipv4_count":4172,
  "people_count":300,
  "shortname":"Saperix",
  "industry":"Technology",
  "industry_slug":"technology",
  "sub_industry":"Computer & Network Security",
  "sub_industry_slug":"computer_network_security",
  "homepage":"http://www.saperix.com",
  "primary_domain":"saperix.com",
  "type":"CURATED",
  "display_url":"https://service.bitsighttech.com/app/company/a940bb61-33c4-42c9-9231-c8194c305db3/overview/",
  "rating_details":{
    […]
    "data_breaches":{
      "name":"Security Incidents",
      "rating":800,
      "grade":"B",
      "percentile":70,
      "grade_color":"#2AB277",
      "category":"Public Disclosures",
      "category_order":3,
      "beta":false,
      "order":19,
      "display_url":"https://service.bitsighttech.com/app/company/a940bb61-33c4-42c9-9231-c8194c305db3/rating-details/?vector=news"
    }
  },
  "ratings":[
    […]
    {
      "rating_date":"2021-06-01",
      "rating":490,
      "range":"Basic",
      "rating_color":"#c23024"
    }
  ],
  "search_count":9270,
  "subscription_type":"Total Risk Monitoring",
  "sparkline":"https://api.bitsighttech.com/ratings/v1/companies/a940bb61-33c4-42c9-9231-c8194c305db3/sparkline?size=small",
  "subscription_type_key":"continuous_monitoring",
  "subscription_end_date":null,
  "confidence":"HIGH",
  "bulk_email_sender_status":"NONE",
  "service_provider":false,
  "customer_monitoring_count":232,
  "available_upgrade_types":[ ],
  "has_company_tree":true,
  "has_preferred_contact":true,
  "is_bundle":false,
  "rating_industry_median":"below",
  "primary_company":{
    "guid":"eed24cfa-c3ea-4467-aefa-89648881e277",
    "name":"Saperix Corporate"
   },
   "permissions":{
    "can_manage_primary_company":true,
    "can_annotate":true,
    "can_view_ip_attributions":true,
    "can_view_infrastructure":true,
    "can_view_forensics":true,
    "can_download_company_report":true,
    "can_view_company_reports":true,
    "can_view_service_providers":true,
    "can_request_self_published_entity":true,
    "has_control":true
  },
  "is_primary":false,
    "in_spm_portfolio":true,
  "is_mycomp_mysubs_bundle":false,
  "company_features":[
    {
      "name":"Risk Quantification",
      "slug":"risk-quantification"
    }
  ],
  "compliance_claim":{
    "trust_page":"https://saperix.com/compliance",
    "certifications":[
      […]
      {
        "name":"NIST CSF",
        "slug":"nist-csf"
      }
    ]
  },
  "related_companies":[ ]
}

Response Attributes

Field				Description
`guid` String [`entity_guid`]				This company’s unique identifier.
`custom_id` String				This company’s customized ID.
`name` String				This company’s name.
`description` String				Details about this company, which typically includes its industry and location.
`ipv4_count` Integer				The number of IP addresses attributed to this company.
`people_count` Integer				The number of employees in this company.
`shortname` String				The abbreviated name of this company.
`industry` String				This company’s industry.
`industry_slug` String				This company’s industry (slug name).
`sub_industry` String				This company’s sub-industry.
`sub_industry_slug` String				This company’s sub-industry slug name.
`homepage` String				The URL of this company’s primary external website.
`primary_domain` String				This company’s primary domain.
`type` String				This company’s rating type.
`display_url` String				The URL to this company’s overview page in the Bitsight platform.
`rating_details` Object				Information about this company’s performance by risk vector and details for use in HTML applications.
	Risk Vector Slug Name Object			This company’s performance for this risk vector.
		`name` String		The risk vector.
		`rating` Integer		For internal Bitsight use.
		`grade` String		The risk vector’s letter grade.
		`percentile` Integer		This company’s performance on this risk vector against their peers.
		`grade_color` String		The hex color code to display the letter grade in HTML applications.
		`category` String		The risk category.
		`category_order` Integer		The risk category’s visual sorting order in the Bitsight platform.
		`beta` Boolean		`true` = This risk vector is in beta and does not affect this company’s security rating.
		`order` Integer		The risk vector’s visual sorting order in the Bitsight platform.
		`display_url` String		The URL in the Bitsight platform for this risk vector’s details.
`ratings` Array				1 year of daily security ratings, starting with the most recent entry.
	`rating_date` String [`YYYY-MM-DD`]			The date when this rating was calculated.
	`rating` Integer			This company’s Bitsight Security Rating on this day.
	`range` String			This company’s rating category on this day.
	`rating_color` String			The hex code to display the rating category’s color in HTML applications.
`search_count` Integer				The number of times this company has been listed in search results.
`subscription_type` String				The subscription type used to monitor this company.
`sparkline` String				The URL to this company’s security rating trend line during the past 1 year.
`subscription_type_key` String				The subscription slug name used to monitor this company.
`subscription_end_date` String [`YYYY-MM-DD`]				The date when the subscription to this company expires.
`confidence` String				For internal Bitsight use.
`bulk_email_sender_status` String				`FULL` = This company provides bulk email sending services, which excludes this company from the Spam Propagation risk vector.
`service_provider` Boolean				`true` = This company is a service provider.
`customer_monitoring_count` Integer				The number of companies that are monitoring this company.
`available_upgrade_types` Array				For internal Bitsight use.
`has_company_tree` Boolean				`true` = This company has a ratings tree.
`has_preferred_contact` Boolean				`true` = This company assigned a collaboration contact.
`is_bundle` Boolean				`true` = This company is part of a ratings bundle.
`rating_industry_median` String				This company’s position in the peer group distribution chart.
`primary_company` Object				The primary company of this company’s organization.
	`guid` String [`entity_guid`]			The primary company’s unique identifier.
	`name` String			The primary company’s name.
`permissions` Object				Your Bitsight account capabilities and permissions.
	`can_manage_primary_company` Boolean			`true` = You have permission to highlight a primary for your organization.
	`can_annotate` Boolean			`true` = You have permission to identify assets and segment your network with infrastructure tags.
	`can_view_ip_attributions` Boolean			`true` = You have permission to view IP attributions.
	`can_view_infrastructure` Boolean			`true` = You have permission to view your infrastructure attribution.
	`can_view_forensics` Boolean			`true` = You have the Event Forensics add-on package.
	`can_download_company_report` Boolean			`true` = You have permission to view and download Bitsight Security Rating Reports (PDF).
	`can_view_company_reports` Boolean			`true` = You have permission to view Bitsight Security Rating Reports.
	`can_view_service_providers` Boolean			`true` = You have permission to access Bitsight for Fourth Party Risk Management.
	`can_request_self_published_entity` Boolean			`true` = You have permission to request the creation of a self-published rating.
	`has_control` Boolean			For internal Bitsight use.
`is_primary` Boolean				`true` = Your company is the primary for your organization.
`in_spm_portfolio` Boolean				`true` = This company is in your Security Posture Management portfolio (My Company, My Subsidiary, etc.). See subscription types.
`is_mycomp_mysubs_bundle` Boolean				`true` = This company is part of your ratings bundle.
`company_features` Array				Features that are enabled for your organization.
	Object			A feature.
		`name` String		The name of this feature.
		`slug` String		The slug name of this feature.
`compliance_claim` Object				Self-attested compliance claims.
	`trust_page` String			The trust website.
	`certifications` Array			Certification frameworks.
		Object		A framework.
			`name` String	The name of this framework.
			`slug` String	The slug name of this framework.
`related_companies` Array				For internal Bitsight use.

Fields Parameter

If you used the fields parameter to get the average rating and percentile rank (?fields=industry_average,industry_percentile):

Example Response

{
  "industry_average":690.0,
  "industry_percentile":"0"
}

Response Attributes

Field Description

industry_average

Decimal

The average rating of the company’s industry sector.

industry_percentile

Integer

The percentile rank of the company in its industry sector.

July 18, 2024: is_unsampled_allowed no longer supported.
October 24, 2022: industry_average & industry_percentile values available for fields parameter; Self-attested compliance claim details.
June 13, 2022: Added has_preferred_contact, can_view_ip_attributions, is_unsampled_allowed, is_mycomp_mysubs_bundle, & company_features.

Parameters

Example Request

Example Response

Response Attributes

Fields Parameter

Example Response

Response Attributes

Related articles