Security Performance Management
Continuous Monitoring
Cyber Insurance
National Cybersecurity

Articles in this section

POST: Rapid Underwriting Assessments

Avatar
Ingrid
Follow
  • July 10, 2023: Removed PDF.
  • December 10, 2020: Use “GET: Portfolio Summary” (/v2/portfolio/summaries) to get industry information.

⇤ Endpoints

https://api.bitsighttech.com/ratings/v1/fast-ratings

Use Rapid Underwriting Assessments to quickly get rating details for any mapped or unmapped company within 1 minute.

This is a “pay-per-use” service that goes through the standard invoicing process for each API request, including multiple requests for the same rating report.

Parameters

*Required.

Parameter Description Values 
industry
[Query]

Compare the average security rating and risk vector letter grades of a particular industry or sub-industry.

The return is based on the industry, rather than the sub-industry. If two sub-industries belong to the same industry, they will result in the same response.

 [String] Industry name. See industries in GET: Portfolio Summary. 
generate_report
[Query]		 Get the Amazon Simple Storage Service (S3) link to download a PDF of the report.

[String] true = Include the Amazon Simple Storage Service (S3) PDF link in the response.

The request must also include the industry parameter.

 
url
[Query]		 The domain of the company to query.

[String]

Example: http://saperix.com

Example Request

cURL:

$ curl -H "Content-Type: application/json" -X POST -i https://api.bitsighttech.com/ratings/v1/fast-ratings -u api_token: -d '{"url": "www.example.com", "generate_report":"boolean", "industry": "industry_name"}'

JSON:

{
  "url":"www.example.com",
  "generate_report":"boolean",
  "industry":"industry_name"
}

Response Attributes

Field Description 
pdf_url
String		 If the generate_report parameter is set to true, this Amazon Simple Storage Service (S3) PDF link is included in the response. 
status
String		 The results of the request. See result codes and result statuses. 
status_message
String		 A description of the status type. 
ratings
Array		 The list of daily ratings for the past year (1 year). Each date has its own entry in the array, starting with the most recent entry.
  
rating_date
String [YYYY‑MM‑DD]		 The date on which the rating was generated. 
rating
Integer		 The security rating for the company, generated on that day. 
range
String		 Indicates the rating category for the rating for that day. 
rating_color
String		 The hex code used for displaying the color associated with the rating category. 
rating_details
Object		 Contains information about the company's risk vector grades and extra information for use in HTML applications.
  
risk_vector_name
Object		 Each risk vector is a single object, identified by a named slug field that corresponds to the risk vector. See risk types.
  
category
String		 The category of the risk vector. See risk types. 
rating
Integer		 The Bitsight Security Rating of the company, generated on that day. 
beta
Boolean		 true = The risk vector is in beta and does not currently affect the company's security rating. 
name
String		 The full name of the risk vector. 
grade
String		 The letter grade for the risk vector. Learn more about how security ratings are calculated. 
category_order
Integer		 Used for visual sorting. 
order
Integer		 Used for visual sorting. 
grade_color
String		 The hex code used for displaying the color of the rating in HTML applications. 
quota_details
Object		 Information on used, available, and remaining licenses.
  
quota_purchased
Integer		 The number of purchased requests for this endpoint since the contract started. 
quota_used
Integer		 The total allocated licenses since the contract started. 
quota_available
Integer		 The number of the remaining available licenses.

Result Codes

Result Messages Description
invalid_url An invalid/incomplete URL or domain or no URL was supplied in the “url” field for a company, like “ww.website.c” or “asbdffdf.”
in_inventory Already mapped. Multiple companies share the supplied URL/domain.

Result Statuses

See the common errors and status codes.

Response Code Description
200 – Okay The request was successful.
202 – Accepted The request has been submitted, but has not yet been processed.
400 – Bad Request

The request contained an invalid input:

  • Incorrect field name.
  • The requested company didn't have a specified unique identifier or URL.
401 – Unauthorized The authorization header didn't contain a valid API token.
403 – Large Request The company is too large to process.
404 – Not Found No events were found for the provided URL. Either the URL is incorrect or you don’t have permission to access the requested resource.
429 – Too Many Requests There have been too many consecutive requests. Please try again later.
503 – Service Unavailable Returned in the rare case that an exception is thrown by the system. An email is also sent to support if this happens.

Related articles