https://api.bitsighttech.com/ratings/v2/company-requests/bulk
Submit a request for multiple companies to be added to the Bitsight inventory in bulk (Company Request). Once your request is completed and the companies have been added to the Bitsight inventory (provided they can be mapped), you will be notified of their availability via email and you’ll then be able to add them to your portfolio.
To request a single company, use POST: Request to Add a Company to the Bitsight Inventory.
Parameters
* Required.
Parameter | Values |
---|---|
file * [Body] Identify companies to be added. |
[String] A CSV file containing a column of domains without any column headings. |
subscription_type [Body] Identify a subscription for the requested companies. |
[String] Subscription slug name. See Licenses and Subscriptions. |
folder_guid [Body] Identify a folder for the requested companies. |
[String] Folder unique identifier [folder_guid ]. See GET: Folder Details. |
tier_guid [Body] Identify a tier for the requested companies. |
[String] Tier unique identifier [tier_guid ]. See GET: Tiers. |
Example Request
curl 'https://api.bitsighttech.com/ratings/v2/company-requests/bulk' -H 'Content-Type: multipart/form-data' --data-binary '{"csv_file":"path/file-name.csv","subscription_type":"continuous_monitoring","folder_guid":"4ce9df6d-e92b-4a5c-9530-521dae4a5f83","tier_guid":"3bb00fb0-8316-4aa0-8263-b6ca13c1978a"}' --compressed -u api_token:
Response
You will receive an email summarizing the status of the requested companies, indicating the following:
- The domain is invalid and the company could not be added to the Bitsight inventory.
- Under review or is being re-evaluated. Please refer to the Company Requests page for a status. You will also be notified of changes.
- Already registered and subscribed.
- Already registered but could not be subscribed due to insufficient subscriptions.
- Already subscribed with the same subscription type. If already subscribed with a different subscription, it will be switched to the new one.
- Domain is tied to multiple companies. Please select and subscribe to the company.
Errors and Status Codes
See the common errors and status codes.
Code | Description |
---|---|
202 – Company request submitted successfully |
The request was successfully submitted. |
400 – Bad data |
This can often be due to missing a required parameter. |
401 – Unauthorized |
No valid API token was provided. |
403 – Permission Denied for this action |
You do not have permission to access this resource. |
Feedback
0 comments
Please sign in to leave a comment.