GET: Underwriting Guidelines

Ingrid

https://api.bitsighttech.com/ratings/v1/underwriting-guidelines

Example Request

curl https://api.bitsighttech.com/ratings/v1/underwriting-guidelines -u api_token:

Example Response

[
  […]
  {
    "guid": "m520bb61-33c4-42c9-1234-c8194c305db3",
    "risk_vectors": [
      […]
      {
        "risk_vector_slug": "application_security",
        "minimum_grade": "A",
        "is_active": true,
        "risk_vector_category": "Diligence"
      }
    ],
    "created_by": {
      "guid": "a940bb61-33c4-42c9-1234-c8194c305db3",
      "name": "Arnold Brown",
      "email": "arnold@actorsfilms.us"
    },
    "updated_by": {
      "guid": "a940bb61-33c4-42c9-1234-c8194c305db3",
      "name": "Emma Waters",
      "email": "emma@blueseas.com"
    },
    "created_time": "2023-03-30T10:41:02.404000Z",
    "updated_time": "2023-03-30T10:41:02.404000Z"
  },
 "threats": [
    […]
    {
      "guid": "a940bb61-33c4-42c9-1234-c8194c305db3",
    }
  ],
  "threat_groups": [
    […]
    {
      "guid": "a940bb61-33c4-42c9-1234-c8194c305db3",
    }
  "infections": [
    […]
    {
      "id": 132
    }
  ]
]

Response Attributes

Field			Description
guid String [`guideline_guid`]			The unique identifier of this underwriting guideline.
risk_vectors Array			Risk vectors and their minimum grades.
	Object		A risk vector.
		risk_vector_slug String	The risk vector slug name.
		minimum_grade String	The minimum letter grade of this risk vector.
		is_active Boolean	`true` = The minimum grade is active for this risk vector.
		risk_vector_category String	The risk vector category.
created_by Object			The user who created the underwriting guideline.
	guid String [`user_guid`]		This user’s unique identifier.
	name String		This user’s name.
	email String		This user’s email address.
updated_by Object			The user who last updated the underwriting guideline.
	guid String [`user_guid`]		This user’s unique identifier.
	name String		This user’s name.
	email String		This user’s email address.
created_time String [`YYYY-MM-DDTHH:MM:SSZ`]			The date when the underwriting guideline was created.
updated_time String [`YYYY-MM-DDTHH:MM:SSZ`]			The date when the underwriting guideline was last updated.
threats Array			The company's threats.
	guid String [`threat_guid`]		The threat unique identifier.
threat_groups Array			The company's threat groups.
	guid String [`threat_group_guid`]		The threat group unique identifier.
infections Array			Infections that we will check if the company contains.
	id String		The infection id.

Status Codes

200 – Okay: Everything worked as expected.
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 could not be found.

August 20, 2024:

infections

April 9, 2024: threats & threat_groups fields.
April 28, 2023: Published.