GET: Company Request Details

Ingrid

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

Get information about an existing Company Request to get a company added to the Bitsight inventory.

Parameters

* Required.

guid

* Required.

[Path] Identify the company request to query.

Value: [String] Company request unique identifier [company_request_guid]. See GET: Company Requests.

Example Request

curl 'https://api.bitsighttech.com/ratings/v2/company-requests/companyr-1111-1111-eque-stexample111' -u api_token:

Example Response

{
  "guid":"1a1a1a1a-a1a1-1a1a-a1a1-1a1a1a1a1a1a",
  "domain":"blueseas.com",
  "created_time":"2020-07-17T18:54:09Z",
  "updated_time":"2020-07-17T18:56:26Z",
  "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 this request.
domain String		The domain name of the requested company.
created_time String [`YYYY‑MM‑DDTHH:MM:SSZ`]		The date and time when this request was submitted.
updated_time String [`YYYY‑MM‑DDTHH:MM:SSZ`]		The date and time when this request was last edited.
status String		The status of this 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 requester.
	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 type that was used or will be used to monitor the company.

July 20, 2020: Published.