Publication Date – April 28, 2023
https://api.bitsighttech.com/ratings/v1/underwriting-guidelines
Create a new underwriting guideline.
Parameters
*Required.
Parameter | Description | Values | |
---|---|---|---|
risk_vectorsBody |
Define the guidelines for each risk vector. |
[Array]
"risk_vectors": [
{
[…]
}
|
|
risk_vector_slugBody |
Identify the risk vector. | [String] The risk vector slug. See risk types. | |
minimum_gradeBody |
Set the minimum risk vector grade. |
[String] A - F
|
|
is_activeBody |
Determine if the minimum risk vector grade should be active for comparison. |
[Boolean]
|
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. |