### Example Product Details Response

Source: https://help.bitsighttech.com/hc/en-us/articles/360044245433-GET-Product-Details

This is an example of the JSON response received when successfully querying for product details. It includes the product's GUID, name, types, and information about its provider.

```json
{
  "product_guid":"ffffffff-2222-3333-cccc-111111111111",
  "product_name":"Hosting Product",
  "product_types":[
    "Hosting"
  ],
  "provider_guid":"77777777-ffff-aaaa-8888-ffffffffffff",
  "provider_name":"Internet Hosting Co.",
  "provider_industry":"Business Services"
}
```

--------------------------------

### Initial Stream Connection Example

Source: https://help.bitsighttech.com/hc/en-us/articles/115015829747-Infection-Detection-API-Guide

An example of establishing an initial stream connection with specific fields to be returned.

```url
/stream?key=xxx&fields=foo
```

--------------------------------

### Get Product Details by GUID (cURL)

Source: https://help.bitsighttech.com/hc/en-us/related/click_data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCLkxT9RTADoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCBd0w_f0106b_A0NDI0NTQzMy1HRVQtUHJvZHVjdC1EZXRhaWxzBjsIVDoJcmFua2kG--be437376350215b862d2c8a2ff579f8a56a06805

Fetches detailed information for a specific product using its GUID. This example uses cURL to make the API request.

```cURL
curl https://api.bitsighttech.com/ratings/v1/products/ffffffff-2222-3333-cccc-111111111111 -u api_token:
```

--------------------------------

### Portfolio Contacts Response Example

Source: https://help.bitsighttech.com/hc/en-us/articles/360025177613-GET-Portfolio-Contacts

Provides an example JSON response structure for the Portfolio Contacts API, detailing fields like GUID, company GUID, names, email, and phone number.

```json
[
  {
    "guid":"72bd0c20-9911-47cc-9413-2cb30c69191d",
    "company_guid":"1b3d260c-9e23-4e19-b3a5-a0bcf67d74d9",
    "creator":"richard.kuga@saperix.com",
    "creation_date":"2020-12-14",
    "last_editor":"richard.kuga@saperix.com",
    "last_edit_date":"2020-12-14",
    "friendly_name":"Diane",
    "formal_name":"Diane Jones",
    "email":"diane@actorsfilms.us",
    "phone_number":"555-555-5555"
  }
]
```

--------------------------------

### KPI Module Configuration and Example

Source: https://help.bitsighttech.com/hc/en-us/articles/115015829747-Infection-Detection-API-Guide

Demonstrates how to configure the KPI module with various parameters and provides an example of the expected output format for aggregated data.

```text
Modules: kpi
Parameters:
kpi → list of fields to define the unique key
kpitime (alias kpi_time), in milliseconds, default 1 second → period to push kpi messages
kpiavg (alias kpi_avg), in milliseconds, default 300 seconds → period to calculate averages
kpilimit (alias kpi_limit), default 10 → max number of items to return
kpisum (alias kpi_sum) → default to count messages, can specify numeric field to sum
kpiranges → allow to define numeric ranges

Example Usage:
...&otherfilters&modules=kpi&kpi=type,_geo_ip.country_code
```

--------------------------------

### GET Bitsight Life Cycle Stages Overview (Onboarding)

Source: https://help.bitsighttech.com/hc/en-us/related/click_data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCF5mj9RTADoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCNk4m_0ad726_1BUEktRmllbGRzLUxpZmUtQ3ljbGUtU3RhZ2VzBjsIVDoJcmFua2kK--e2990fcbec86a330cf8552dbb298cd80cd3e24a6

Fetches an overview of Bitsight Life Cycle Stages, specifically indicating 'onboarding' as the next stage. This is useful for understanding the flow between different stages.

```http
GET /v1/company-life-cycle-types
```

```json
{
  "next_life_cycle_name": "onboarding"
}
```

--------------------------------

### Portfolio Contacts Response Example

Source: https://help.bitsighttech.com/hc/en-us/related/click_data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCA0%2BLNNTADoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCJf_67aba0_E3NzYxMy1HRVQtUG9ydGZvbGlvLUNvbnRhY3RzBjsIVDoJcmFua2kG--0a7f9afc5fdb2e23445aad54e24055745addd59c

This is an example JSON response for the Portfolio Contacts API endpoint. It details the structure and fields returned for each contact, including their GUID, company GUID, name, and contact information.

```json
[
  {
    "guid":"72bd0c20-9911-47cc-9413-2cb30c69191d",
    "company_guid":"1b3d260c-9e23-4e19-b3a5-a0bcf67d74d9",
    "creator":"richard.kuga@saperix.com",
    "creation_date":"2020-12-14",
    "last_editor":"richard.kuga@saperix.com",
    "last_edit_date":"2020-12-14",
    "friendly_name":"Diane",
    "formal_name":"Diane Jones",
    "email":"diane@actorsfilms.us",
    "phone_number":"555-555-5555"
  }
]
```

--------------------------------

### Example JSON API Response

Source: https://help.bitsighttech.com/hc/en-us/articles/231872628-API-Documentation-Overview_sort_by=created_at

A sample JSON response from the Bitsight API, detailing the API version, name, available resources (companies, industries, alerts, subscriptions), and a disclaimer.

```json
{
"version": 1,
  "name": "Bitsight API",
  "resources": [
    {
      "href": "https://api.bitsighttech.com/ratings/v1/companies",
      "name": "Companies"
    },
    {
      "href": "https://api.bitsighttech.com/ratings/v1/industries",
      "name": "Industries"
    },
    {
      "href": "https://api.bitsighttech.com/ratings/v1/alerts",
      "name": "Alerts"
    },
      "href": "https://api.bitsighttech.com/ratings/v1/subscriptions",
      "name": "Subscriptions"
    }
  ],
  "disclaimer": "This API contains sensitive information intended only for authorized viewers. All content is the property of Bitsight and cannot be shared, copied, or distributed without the express permission of Bitsight. Use of this data must adhere to the Bitsight Terms of Service."
}
```

--------------------------------

### Portfolio Contacts API Response Example

Source: https://help.bitsighttech.com/hc/en-us/related/click_data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCA0%2BLNNTADoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCCF_3bb7a5_E3NzYxMy1HRVQtUG9ydGZvbGlvLUNvbnRhY3RzBjsIVDoJcmFua2kI--b1639432e0fb9ad19410c156681f5aef2108541a

This is an example of the JSON response received when querying the Portfolio Contacts API. It includes details such as GUID, company GUID, contact names, email, and phone number.

```json
[
  {
    "guid":"72bd0c20-9911-47cc-9413-2cb30c69191d",
    "company_guid":"1b3d260c-9e23-4e19-b3a5-a0bcf67d74d9",
    "creator":"richard.kuga@saperix.com",
    "creation_date":"2020-12-14",
    "last_editor":"richard.kuga@saperix.com",
    "last_edit_date":"2020-12-14",
    "friendly_name":"Diane",
    "formal_name":"Diane Jones",
    "email":"diane@actorsfilms.us",
    "phone_number":"555-555-5555"
  }
]
```

--------------------------------

### Create Underwriting Guideline Response Example

Source: https://help.bitsighttech.com/hc/en-us/articles/14232168715415-POST-Create-an-Underwriting-Guideline

This snippet shows an example response when successfully creating an underwriting guideline. It includes the unique identifier (guid), details of the risk vectors, and lists of associated threats, threat groups, and infections.

```json
[
  …
  {
    "guid": "m521bb61-33c4-42c9-1234-c8194c305db3",
    "risk_vectors": [
      …
      {
        "risk_vector_slug": "application_security",
        "minimum_grade": "A",
        "is_active": true,
        "risk_vector_category": "Diligence"
      }
    ],
    "threats": [
      …
      {
        "guid": "a940bb61-33c4-42c9-1234-c8194c305db3",
      }
    ],
    "threat_groups": [
      …
      {
        "guid": "a940bb61-33c4-42c9-1234-c8194c305db3",
      }
    ],
    ],
    "infections": [
      …
      {
        "id": 135
      }
    ],
    "updated_time": "2023-03-30T10:41:02.404000Z"
  }
]
```

--------------------------------

### Install Bitsight Script

Source: https://help.bitsighttech.com/hc/en-us/articles/360021189753-Infection-Alerts-Integration-Guide

Installs the Bitsight json2cefleef conversion script using Python's setup tools. This is a prerequisite for running the integration.

```bash
python setup.py install
```

--------------------------------

### API Endpoint Examples

Source: https://help.bitsighttech.com/hc/en-us/related/click_data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCEa0aNRTADoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCBfM7_36c22b_1Qb3J0Zm9saW8tUGVyZm9ybWFuY2UtUmVwb3J0BjsIVDoJcmFua2kG--1749c2a69b048547e1e8e8caf940a3dfcf479a8e

A list of recently viewed articles, including examples of API endpoints for interacting with Bitsight services.

```API Endpoints
GET: Service Provider Details
POST: Request to Add a Company to the Bitsight Inventory [v1]
GET: Bulk Work From Home Requests
```

--------------------------------

### Install Bitsight Script

Source: https://help.bitsighttech.com/hc/en-us/related/click_data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCHlk79JTADoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCBd2i_3f8b4c_Rpb24tQWxlcnRzLUludGVncmF0aW9uLUd1aWRlBjsIVDoJcmFua2kI--f9dede244724aa2eed934e735bd68900f42a6c90

Installs the Bitsight json2cefleef conversion script using Python's setup tools. This is a prerequisite for using the integration.

```bash
python setup.py install
```

--------------------------------

### Install Bitsight Script

Source: https://help.bitsighttech.com/hc/en-us/related/click_data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCHlk79JTADoYcmVmZXJyZXJfYXJ0aWNsZV9pZGkEsB3SD_67bef3_Rpb24tQWxlcnRzLUludGVncmF0aW9uLUd1aWRlBjsIVDoJcmFua2kI--f0ae3f2989a4ea349f338076bf32dd5a4d45a03c

Installs the Bitsight json2cefleef conversion script using Python's setup tools. This is a prerequisite for running the integration.

```bash
python setup.py install
```

--------------------------------

### Open Ports Example Response

Source: https://help.bitsighttech.com/hc/en-us/related/click_data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCL4i0tRTADoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCB6iZ_668d2c_LUZyb20tSG9tZS1GaW5kaW5nLURldGFpbHMGOwhUOglyYW5raQk%3D--7e3888453d358c9a448cadd792e400e914f9f2c1

This JSON object illustrates an example response for an Open Ports finding. It includes the grade of the finding, a message, the raw HTTP response, and the service type.

```json
{
  "grade":{
    "grade":"GOOD"
  },
  "message":[
    "Detected service: HTTPS"
  ],
  "response":"HTTP/1.1 200 OK\r\nDate: Sun, 23 Aug 2020 08:15:02 GMT\r\nServer: Apache\r\nUpgrade: h2,h2c\r\nConnection: Upgrade\r\nLast-Modified: Fri, 10 May 2019 03:34:15 GMT\r\nETag: \"24002b-7ab-588803db2483a\"
\nAccept-Ranges: bytes\r\nContent-Length: 1963\r\nVary: Accept-Encoding,User-Agent\r\nContent-Type: text/html",
  "service":"HTTPS"
}
```

--------------------------------

### Domain Attribution Examples

Source: https://help.bitsighttech.com/hc/en-us/related/click_data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCBcA0jQfHDoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCBcKQ_43f86a_E5LUF0dHJpYnV0aW9uLUV4cGxhaW5hYmlsaXR5BjsIVDoJcmFua2kH--ed4be4317f58ffe026bbd2a1cd1ea4ac9f1463b1

Illustrates common scenarios for attributing domains, including redirects between domains and DNS mappings between IP addresses and domains.

```text
Domain Attribution
  * Redirects: example.com redirects to www.example.com.
  * DNS Mapping: 104.22.74.242/32 maps to example.com.
```

--------------------------------

### Get Tier Summaries API Response Example

Source: https://help.bitsighttech.com/hc/en-us/related/click_data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCMYgkNRTADoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCJW68_79aa83_ODUwMDkzNC1HRVQtVGllci1TdW1tYXJpZXMGOwhUOglyYW5raQg%3D--3a61f0d5fc93701296c6de3134e5ad8f016dd05d

This snippet provides an example of the JSON response received from the Bitsight API when requesting tier summaries. It details the structure of tier information, including GUID, name, count, and category breakdowns.

```json
[
  {
    "guid":"86b6ffa2-ca5a-4585-9fbf-b22f9be8e99b",
    "name":"Tier 1",
    "count":84,
    "categories":[
      {
        "count":54,
        "vendor_action_plan":"monitor",
        "name":"monitor",
        "rating":{
          "lt":700,
          "gte":null
        }
      },
      […] 
      }
    ]
  }
  […] 
]
```

--------------------------------

### Example DKIM Record Format

Source: https://help.bitsighttech.com/hc/en-us/related/click_data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGkEMOnRDToYcmVmZXJyZXJfYXJ0aWNsZV9pZGkEfOjRDToLb_d11a69_ctdG8tU2V0LVVwLURLSU0tUmVjb3JkcwY7CFQ6CXJhbmtpBw%3D%3D--d01e3abea7b4e3f25e1f064ed08598db625e1638

An example of a fully assembled DKIM record, including the selector, TTL, record type, and the public key in the 'p=' tag. This record is added to DNS.

```DNS TXT Record
yourselector._domainkey.yourdomain.com 21600 IN TXT "v=DKIM1; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDwIRP/UC3SBsEmGqZ9ZJW3/DkMoGeLnQg1fWn7/zYtIxN2SnFCjxOCKG9v3b4jYfcTNh5ijSsq631uBItLa7od+v/RtdC2UzJ1lWT947qR+Rcac2gbto/NMqJ0fzfVjH4OuKhitdY9tf6mcwGjaNBcWToIMmPSPDdQPNUYckcQ2QIDAQAB"
```

--------------------------------

### Get Company Statistics (cURL)

Source: https://help.bitsighttech.com/hc/en-us/related/click_data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCF56FNJTADoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCJcwA_a875cf_AwNjg0Mjk3NC1HRVQtU3RhdGlzdGljcwY7CFQ6CXJhbmtpBw%3D%3D--7966608f8a14eb8768f1a8f98d00c104420b187f

Example cURL request to fetch statistics for a specific company using its GUID. Requires an API token for authentication.

```curl
curl -u 'api_token:' 'https://api.bitsighttech.com/ratings/v1/companies/a940bb61-33c4-42c9-9231-c8194c305db3/observations/statistics'
```

--------------------------------

### Example Underwriting Guideline Response (JSON)

Source: https://help.bitsighttech.com/hc/en-us/related/click_data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCBcvvirxDDoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCBeNx_356ba9_ZhdWx0LVVuZGVyd3JpdGluZy1HdWlkZWxpbmVzBjsIVDoJcmFua2kH--e5727b310f7b24bc451b2b4ae42ef1e1fa32176b

This JSON structure represents a successful response from the Bitsight API after creating an underwriting guideline. It includes details of the created guideline, its risk vectors, associated threats, threat groups, infections, and update time.

```json
[ { "guid": "m521bb61-33c4-42c9-1234-c8194c305db3", "risk_vectors": [ { "risk_vector_slug": "application_security", "minimum_grade": "A", "is_active": true, "risk_vector_category": "Diligence" } ], "threats": [ { "guid": "a940bb61-33c4-42c9-1234-c8194c305db3" } ], "threat_groups": [ { "guid": "a940bb61-33c4-42c9-1234-c8194c305db3" } ], "infections": [ { "id": 135 } ], "updated_time": "2023-03-30T10:41:02.404000Z" } ]
```

--------------------------------

### Example Service Provider Response (JSON)

Source: https://help.bitsighttech.com/hc/en-us/articles/360037161033-GET-Service-Provider-Details

This is an example of the JSON response received when successfully querying for service provider details. It includes the provider's GUID, name, and industry.

```JSON
{
  "provider_guid":"a5e23bf0-38d4-4cea-aa50-19ee75da481d",
  "provider_name":"Black Hills Technologies",
  "provider_industry":"Technology"
}
```

--------------------------------

### Create User Response (JSON)

Source: https://help.bitsighttech.com/hc/en-us/related/click_data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCB7Di9RTADoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCDLNi_e0a4cc_IxNDgxNC1QT1NULUNyZWF0ZS1hLU5ldy1Vc2VyBjsIVDoJcmFua2kH--c6b16235ba80cb0d739dc694d8326f298b6d245c

Example JSON response after successfully creating a new user, detailing the user's properties including GUID, name, email, group, status, and roles.

```json
{
  "guid":"11111111-aaaa-1111-aaaa-111111111111",
  "friendly_name":"Arnold",
  "formal_name":"Arnold Brown",
  "email":"arnold@actors.us",
  "group":{
    "guid":"bbbbbbbb-2222-bbbb-2222-bbbbbbbbbbbb",
    "name":"All Companies"
  },
  "status":"Created",
  "last_login_time":null,
  "joined_time":"2020-02-02T20:20:20Z",
  "roles":[
    {
      "name":"User",
      "slug":"customer_user"
    }
  ],
  "is_available_for_contact":false,
  "is_company_api_token":false,
  "features":[
    {
      "slug":"wfh-ro",
      "value":false,
      "can_update":true
    }
  ]
}
```

--------------------------------

### Example Response for Portfolio Unique Identifiers

Source: https://help.bitsighttech.com/hc/en-us/articles/360010788933-GET-Portfolio-Unique-Identifier-GUID-

This is an example of the JSON response received when requesting portfolio unique identifiers. The response is an array containing GUIDs for companies or countries in the portfolio.

```json
[
  "06111982-d568-42c7-ad87-d2075e1c494a",
  "12345678-c3b0-a2d2-bb80-d5df44c3a2e5"
]
```

--------------------------------

### Example JSON API Response

Source: https://help.bitsighttech.com/hc/en-us/related/click_data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGkEdBjSDToYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCBdg%2BWt_ae2b44_ktRG9jdW1lbnRhdGlvbi1PdmVydmlldwY7CFQ6CXJhbmtpCA%3D%3D--12bcd82768c0b3f5245b7ac38f0978a0b582afcc

A sample JSON response from the Bitsight API, detailing the API version, name, available resources (companies, industries, alerts, subscriptions), and a disclaimer.

```json
{
"version": 1,
  "name": "Bitsight API",
  "resources": [
    {
      "href": "https://api.bitsighttech.com/ratings/v1/companies",
      "name": "Companies"
    },
    {
      "href": "https://api.bitsighttech.com/ratings/v1/industries",
      "name": "Industries"
    },
    {
      "href": "https://api.bitsighttech.com/ratings/v1/alerts",
      "name": "Alerts"
    },
      "href": "https://api.bitsighttech.com/ratings/v1/subscriptions",
      "name": "Subscriptions"
    }
  ],
  "disclaimer": "This API contains sensitive information intended only for authorized viewers. All content is the property of Bitsight and cannot be shared, copied, or distributed without the express permission of Bitsight. Use of this data must adhere to the Bitsight Terms of Service."
}
```

--------------------------------

### Create User Request (cURL)

Source: https://help.bitsighttech.com/hc/en-us/related/click_data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCB7Di9RTADoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCDLNi_e0a4cc_IxNDgxNC1QT1NULUNyZWF0ZS1hLU5ldy1Vc2VyBjsIVDoJcmFua2kH--c6b16235ba80cb0d739dc694d8326f298b6d245c

Example of creating a new user using cURL, specifying essential user details like friendly name, formal name, and email.

```bash
curl -X POST --data-ascii '{"friendly_name": "Arnold","formal_name": "Arnold Brown","email": "arnold@actors.us"}' https://api.bitsighttech.com/ratings/v2/users -u api_token: --header "Content-Type:application/json"
```

--------------------------------

### Example Response for Company Requests

Source: https://help.bitsighttech.com/hc/en-us/articles/360033387834

This snippet provides an example of the JSON response received when querying the Company Requests API. It includes details like GUID, domain, request date, and status for each request.

```json
[
  {
    "guid":"1a1a1a1a-a1a1-1a1a-a1a1-1a1a1a1a1a1a",
    "domain":"blueseas.com",
    "request_date":"2019-07-17 21:09:33+00:00",
    "status":"Cancelled",
    "processed_company_guid":"feeccea4-e062-4cf5-9a3d-7034addb12d1"
  }
]
```

--------------------------------

### Get Company Diligence Finding Counts (curl)

Source: https://help.bitsighttech.com/hc/en-us/articles/360051143873-GET-Diligence-Finding-Counts-of-a-Company

Fetches the historical Diligence finding counts for a given company using its GUID. This example demonstrates a basic curl request to the API endpoint.

```curl
curl https://api.bitsighttech.com/ratings/v1/companies/company_guid/diligence/historical-statistics -u api_token:
```

--------------------------------

### Domain Evidence Summary Examples

Source: https://help.bitsighttech.com/hc/en-us/related/click_data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCBcA0jQfHDoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCBe3L_adbc4f_E5LUF0dHJpYnV0aW9uLUV4cGxhaW5hYmlsaXR5BjsIVDoJcmFua2kH--4063034d523ed8eb9c06bac1f9451a93c0242940

Provides examples of summarized relationships within the Evidence field, indicating potential connections between assets like redirects and DNS mappings.

```text
Examples:
  * professional.bu.edu to cpe.bu.edu suggests a redirect observed between two assets.
  * xmail.bu.edu to newmail.bu.edu indicates DNS mappings leading to an asset association.
```

--------------------------------

### Example Response for Custom Company Identifiers (JSON)

Source: https://help.bitsighttech.com/hc/en-us/articles/360002993594-GET-Custom-Company-Identifiers

This is an example of the JSON response returned by the Bitsight API when requesting custom company identifiers. It includes the GUID, name, and custom ID for each company.

```json
[
  {
    "guid": "e998279a-3748-4f3d-8595-217d0807e049",
    "name": "Acme Space Sprockets",
    "custom_id": "ASP-024"
  },
  {
    "guid": "c1954e2c-b04c-4bb0-8c8f-3581bae3ff3b",
    "name": "Acme Insurance",
    "custom_id": "199"
  }
]
```

--------------------------------

### Example JSON API Response

Source: https://help.bitsighttech.com/hc/en-us/related/click_data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGkEdBjSDToYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCJc1k6MxH_e19e16_ktRG9jdW1lbnRhdGlvbi1PdmVydmlldwY7CFQ6CXJhbmtpCg%3D%3D--a9428ade255a1c4433a32cf94f695e862666f7a4

A sample JSON response from the Bitsight API, detailing the API version, name, available resources (companies, industries, alerts, subscriptions), and a disclaimer.

```json
{
"version": 1,
  "name": "Bitsight API",
  "resources": [
    {
      "href": "https://api.bitsighttech.com/ratings/v1/companies",
      "name": "Companies"
    },
    {
      "href": "https://api.bitsighttech.com/ratings/v1/industries",
      "name": "Industries"
    },
    {
      "href": "https://api.bitsighttech.com/ratings/v1/alerts",
      "name": "Alerts"
    },
      "href": "https://api.bitsighttech.com/ratings/v1/subscriptions",
      "name": "Subscriptions"
    }
  ],
  "disclaimer": "This API contains sensitive information intended only for authorized viewers. All content is the property of Bitsight and cannot be shared, copied, or distributed without the express permission of Bitsight. Use of this data must adhere to the Bitsight Terms of Service."
}
```

--------------------------------

### Get Company Diligence Statistics (cURL)

Source: https://help.bitsighttech.com/hc/en-us/related/click_data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCP4HrdRTADoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCJfh5_c5971d_NC1HRVQtRGlsaWdlbmNlLVN0YXRpc3RpY3MGOwhUOglyYW5raQk%3D--1da5b0053c9747f9e461fbfa45b4a3069b469c94

Example cURL request to fetch diligence statistics for a company using its unique GUID. Authentication is handled via an API token.

```bash
curl https://api.bitsighttech.com/ratings/v1/companies/a940bb61-33c4-42c9-9231-c8194c305db3/diligence/statistics -u api_token:
```

--------------------------------

### Example JSON API Response

Source: https://help.bitsighttech.com/hc/en-us/related/click_data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGkEdBjSDToYcmVmZXJyZXJfYXJ0aWNsZV9pZGkE48nODToLb_0b41ba_ktRG9jdW1lbnRhdGlvbi1PdmVydmlldwY7CFQ6CXJhbmtpBg%3D%3D--5271187a62430f18cbcb334ce9f6b9714e4d7d62

A sample JSON response from the Bitsight API, detailing the API version, name, available resources (companies, industries, alerts, subscriptions), and a disclaimer.

```json
{
"version": 1,
  "name": "Bitsight API",
  "resources": [
    {
      "href": "https://api.bitsighttech.com/ratings/v1/companies",
      "name": "Companies"
    },
    {
      "href": "https://api.bitsighttech.com/ratings/v1/industries",
      "name": "Industries"
    },
    {
      "href": "https://api.bitsighttech.com/ratings/v1/alerts",
      "name": "Alerts"
    },
      "href": "https://api.bitsighttech.com/ratings/v1/subscriptions",
      "name": "Subscriptions"
    }
  ],
  "disclaimer": "This API contains sensitive information intended only for authorized viewers. All content is the property of Bitsight and cannot be shared, copied, or distributed without the express permission of Bitsight. Use of this data must adhere to the Bitsight Terms of Service."
}
```

--------------------------------

### Example API Request

Source: https://help.bitsighttech.com/hc/en-us/articles/360055740193-GET-Portfolio-Details

An example of how to make a request to the Bitsight API using `curl` to fetch portfolio data.

```bash
curl https://api.bitsighttech.com/ratings/v2/portfolio -u api_token:
```

--------------------------------

### Get Company Statistics (cURL)

Source: https://help.bitsighttech.com/hc/en-us/related/click_data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCF56FNJTADoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCDJ5F_3e1c13_AwNjg0Mjk3NC1HRVQtU3RhdGlzdGljcwY7CFQ6CXJhbmtpBg%3D%3D--02f3f09d2478f945361ddfa28a02d8f0a1c18b73

Example cURL request to fetch compromised systems statistics for a specific company using the BitSight API. Requires an API token and the company's GUID.

```curl
curl -u 'api_token:' 'https://api.bitsighttech.com/ratings/v1/companies/a940bb61-33c4-42c9-9231-c8194c305db3/observations/statistics'
```

--------------------------------

### Example Response for Collaboration Registration Forms

Source: https://help.bitsighttech.com/hc/en-us/related/click_data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCJfv%2FV9eEzoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCJc_c6c427_F0aW9uLVJlZ2lzdHJhdGlvbi1Gb3JtcwY7CFQ6CXJhbmtpBg%3D%3D--109beedb2d0c1c43d66cae8a9b624045679049ec

This is an example JSON response when retrieving collaboration registration forms. It includes details about the forms, such as their GUID, link, creation time, and associated users.

```json
{
  "links": {
    "next": null,
    "previous": null
  },
  "count": 1,
  "results": [
    {
      "guid": "19caa9ab-0560-4661-9d02-3364b13714ec",
      "link": "https://service.bitsighttech.com/app/static/pages/access-request?token=19caa9ab-0560-4661-9d02-3364b13714ec",
      "name": null,
      "description": null,
      "is_active": true,
      "created_time": "2024-01-29T11:32:20.094183Z",
      "updated_time": "2024-01-29T13:36:10.828123Z",
      "created_by": {
        "guid": "de5750f0-f60b-4478-9bfc-08m20e71f4b2",
        "formal_name": "User one"
      },
      "updated_by": {
        "guid": "de4750f0-f60z-3478-9bfc-08f20e71e4b2",
        "formal_name": "User Two"
      }
    }
  ]
}
```

--------------------------------

### Example Response for Bulk WFH Request

Source: https://help.bitsighttech.com/hc/en-us/related/click_data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCHX63dRTADoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCEII0_ddba5e_stV29yay1Gcm9tLUhvbWUtUmVxdWVzdAY7CFQ6CXJhbmtpBg%3D%3D--45a6a17c670070e34bb810dacde1e1510cfc39c0

This snippet shows an example JSON response received after submitting a bulk Work From Home (WFH) request. It includes details about the request's creation time, the filename, a unique GUID, update time, the number of IP addresses processed, and the current status of the request.

```json
{
  "created_time":"2020-08-27T16:55:21.078465Z",
  "filename":"WFH IPs.csv",
  "guid":"f518aa14-a755-4c96-acb7-ae35e79098a6",
  "updated_time":"2020-08-27T16:55:21.078505Z",
  "length":31,
  "status":"not_started"
}
```

--------------------------------

### Get Domain Squatting Details (cURL)

Source: https://help.bitsighttech.com/hc/en-us/articles/360051017334-GET-Domain-Squatting-Details

This example demonstrates how to fetch domain squatting details for a given company GUID using a cURL request. Ensure the API token is provided for authentication and the URL includes a trailing slash.

```bash
curl https://api.bitsighttech.com/domain-squatting/1263b9c6-af38-4497-84ee-e15efdb065e9/ -u api_token:
```

--------------------------------

### Assemble DKIM Record

Source: https://help.bitsighttech.com/hc/en-us/related/click_data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGkEMOnRDToYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCI22Vj9dA_cb985f_ctdG8tU2V0LVVwLURLSU0tUmVjb3JkcwY7CFQ6CXJhbmtpCg%3D%3D--96688eb138a07b1057ad45a7b047d5845bfef9b6

Shows how to assemble a DKIM record using a selector, the public portion of an RSA keypair, and a Time To Live (TTL). The record is formatted as a TXT record for DNS.

```DNS
yourselector._domainkey.yourdomain.com 21600 IN TXT "v=DKIM1; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDwIRP/UC3SBsEmGqZ9ZJW3/DkMoGeLnQg1fWn7/zYtIxN2SnFCjxOCKG9v3b4jYfcTNh5ijSsq631uBItLa7od+v/RtdC2UzJ1lWT947qR+Rcac2gbto/NMqJ0fzfVjH4OuKhitdY9tf6mcwGjaNBcWToIMmPSPDdQPNUYckcQ2QIDAQAB"
```