POST: Request to Add a Company to the Bitsight Inventory [v1] – Bitsight Knowledge Base

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

Use this path to request a company to be added to the Bitsight inventory. Once added, you can automatically subscribe to the company and automatically add it to a folder.

Version 2 is now available.

Parameters

* Required.

Parameter Values

domain

* [Data] Identify the company to be added to the Bitsight inventory.

[String] The domain name (compatible without the “www” prefix).

guid

[Data] Identify a folder to automatically add the company to when your company request is processed.

[String] Folder unique identifier [folder_guid]. See GET: Folder Details.

subscription_type

[Data] Specify the subscription that you would like to use for the company if the company request is successful to save time. It will be automatically added once the request finishes.

[String] Subscription slug name. See subscriptions.

Example Request

cURL Example

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

JSON Example

{
  "domain":"saperix.com"
}

Example Response

The server responds with a response object. The processed_company_guid field is present depending on the status of the company request.

{
    "guid":"feeccea4-e062-4cf5-9a3d-7034addb12d1",
    "domain":"blueseas.com",
    "request_date":"2019-07-27 20:48:36.928209+00:00",
    "status":"Pending",
    "processed_company_guid":null,
    "folder":null,
    "subscription_type":"null"
}

Errors

While the state is pending, you may change the requested subscription type by submitting the same domain with a different subscription type. The request date is updated to the time of the most recent request.

The server can return the following folder error messages:

Message	Description
“Could not find the folder by provided guid.”	Double check the folder unique identifier. Fetch the folder unique identifier [`folder_guid`] using GET: Folder Details.
“Could not find the subscription type.”	Check the spelling for the subscription type.
“This field is required.”	You may have forgotten to specify a folder unique identifier.
“You can only add companies to folders you can edit.”	The owner of the folder that you are trying to add to will need to give you edit permissions for that folder.
“You do not have permission to subscribe a company, please talk to your company administrators.”	Only Admin (Customer Admin), Group Admin, and Portfolio Manager may subscribe to companies. See subscription modification user permissions.

July 20, 2020: /v2/company-requests now available.