POST: Use Current Ratings License – Bitsight Knowledge Base

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

Use a Current Ratings license for getting a 24-hrs snapshot of a company’s rating.

Vendor Risk Assessment Data Service (VRADS)

Parameters

* Required.

guids

* Required.

[Data] Identify the company to query.

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

use_license

* Required.

[Data] Use a Current Ratings license to get a snapshot of this company’s rating.

Value: [Boolean] true = Use license.

Example Request

curl -H "Content-Type: application/json" -X POST -i https://api.bitsighttech.com/ratings/v1/current-ratings -u api_token: -d '{
"guids": ["9ecd7b7e-42b4-4d32-99e8-1b65e59b0774"],
"use_license": true}'

Example Response

{
  "results":[
    {
      "guid":"9ecd7b7e-42b4-4d32-99e8-1b65e59b0774",
      "name":"Frontstore, Inc.",
      "rating":690,
      "rating_category":"intermediate"
    }
  ],
  "rating_as_of":"2023-10-04",
  "rating_licenses_used":0,
  "total_rating_licenses_used":0,
  "total_rating_licenses_remaining":0
}

Response Attributes

Field			Description
results Array			The entity’s rating and details.
	Object		Rating details.
		guid String [`entity_guid`]	The unique identifier of this entity in your portfolio.
		name String	The name of this entity.
		rating Integer	The current Bitsight Security Rating of this entity.
		rating_category String	The rating category.
rating_as_of String [`YYYY-MM-DD`]			When the rating was calculated.
rating_licenses_used Integer			The number of used licenses.
total_rating_licenses_used Integer			The total number of used licenses.
total_rating_licenses_remaining Integer			The remaining number of available licenses.

Response Codes

200 – Okay: Everything worked as expected.
400 – Bad Data: The request was incorrect. This can often be due to missing a required parameter.
401 – Unauthorized: No valid API token was provided.
403 – Permission Denied: You do not have permission to access this resource.
404 – Not Found: The specified resource could not be found.
default: Unexpected error.

August 26, 2024: Specified license type.
October 5, 2023: Published.

Parameters

Example Request

Example Response

Response Attributes

Response Codes

Related articles