Security Performance Management
Continuous Monitoring
Cyber Insurance
National Cybersecurity

Articles in this section

POST: Create an Underwriting Guideline

Avatar
Ingrid
Follow
Publication Date – April 28, 2023

⇤ Underwriting Guidelines

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

Create a new underwriting guideline.

Only Admin can create underwriting guidelines. See underwriting guideline user permissions.

Parameters

*Required.

Parameter Description Values 
risk_vectors
Body 		Define the guidelines for each risk vector. [Array] 
"risk_vectors": [
  {
    […]
  }
  
risk_vector_slug
Body 		Identify the risk vector. [String] The risk vector slug. See risk types. 
minimum_grade
Body 		Set the minimum risk vector grade. [String] A - F 
is_active
Body 		Determine if the minimum risk vector grade should be active for comparison. [Boolean]
  • true = Risk vector and its minimum grade are active for comparison.
  • false = Risk vector and its minimum grade are not active for comparison.

Example Request

curl -X POST –data-ascii '{
  "risk_vectors": [
    {
      "risk_vector_slug": "application_security",
      "minimum_grade": "A",
      "is_active": true
    }
  ]
}' https://api.bitsighttech.com/ratings/v1/underwriting-guidelines -u api_token: --header "Content-Type:application/json"

Example Response

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

Status Codes

Code Description
201 – Success The request was successfully submitted.
400 – Bad Request This can often be due to missing a required parameter.
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.

Related articles