Security Performance Management
Continuous Monitoring
Cyber Insurance
National Cybersecurity

Articles in this section

POST: Request to Add a Company to the Bitsight Inventory

Avatar
Ingrid
Follow
  • January 13, 2021: Bulk company requests now available.
  • August 17, 2021: Added status codes.
  • July 20, 2020: Published.

⇤ Company Requests

https://api.bitsighttech.com/ratings/v2/company-requests

Submit a Company Request to request a company to be added to the Bitsight inventory. Once your request is completed and the company has been added to the Bitsight inventory (provided the company can be mapped), you will be notified of its availability via email and you’ll then be able to add the company to your portfolio.

To request a multiple companies, see POST: Request Multiple Companies to be Added to the Bitsight Inventory.

Parameters

*Required.

Parameter Description Values 
domain
Data		 Identify the company to request by domain. [String] The domain name of the company.
Example: example.com
 
subscription_type
Data		 Automatically subscribe to this company once it’s successfully added to the Bitsight inventory.

See subscription modification user permissions.

 [String] Subscription slug name. See subscription types.
Default: continuous_monitoring (If available)

Example Request

cURL:

curl -X POST 'https://api.bitsighttech.com/ratings/v2/company-requests' -u api_token: --header "Content-Type:application/json" --data-ascii '{"domain":"blueseas.com"}'

JSON:

{
  "domain":"blueseas.com"
 }

Example Response

{
  "guid":"1a1a1a1a-a1a1-1a1a-a1a1-1a1a1a1a1a1a",
  "domain":"blueseas.com",
  "created_time":"2020-02-02T02:02:02.290653Z",
  "updated_time":"2020-02-02T02:02:02.624111Z",
  "status":"Pending",
  "company":null,
  "requester":{
    "guid":"11111111-aaaa-1111-aaaa-111111111111",
    "formal_name":"Arnold Brown"
  },
  "subscription_type":"continuous_monitoring"
}

Response Attributes

Field Description 
guid
String [company_request_guid]		 The unique identifier of your request. 
domain
String		 The requested company’s domain name. 
created_time
String [YYYY-MM-DDTHH:MM:SSZ]		 The date and time when your request was submitted. 
updated_time
String [YYYY-MM-DDTHH:MM:SSZ]		 The date and time when your request was last edited. 
status
String		 The status of your request. 
company
Object		 If the request status has been completed ("status":"Complete"), this information about the requested company is included. 
requester
Object		 Details of the requesting user (you).
  
guid
String [user_guid]		 The unique identifier of the requester. 
formal_name
String		 The full name of the requester. 
subscription_type
String		 The slug name of the subscription that was used or will be used to monitor the company.

Status Codes

See the common errors and status codes.

Code Description
201 – Success The request was successfully submitted.
400 – Bad Request A required parameter is missing or you have already submitted this request. If so, information regarding the previous request will be returned with this status code.
401 – No Authentication No valid API token was provided.
403 – Unauthorized You do not have permission to access this resource.
404 – Not Found The specified resource does not exist.

Related articles