Get AI risk score for a risk

GET

/v1/risks/{id}/score

const url = 'https://api.adversarial.com/api/v1/risks/RSK-00001/score';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.adversarial.com/api/v1/risks/RSK-00001/score

Parameters

Path Parameters

required

string

The ID of the risk — RSK-00001 (case-insensitive) or a bare number

Example

RSK-00001

Responses

200

Risk Score Suggestion

application/json

object

required

integer format: int64

impact

required

string

Allowed values: Very Low Low Medium High Severe

impact_reasoning

required

string

likelihood

required

string

Allowed values: Remote Unlikely Possible Probable Imminent

likelihood_reasoning

required

string

threat_objectives

required

Array<object>

object

reasoning

required

string

relevance

required

Defines how relevant a threat objective is to a particular risk

string

Allowed values: Moderate Substantial

threat_name

required

Identifies a specific threat objective

string

Allowed values: Sabotage Data Disclosure Extortion Customer Targeting Resource Hijacking Fraud

threat_objectives_reasoning

required

string

Example

{
  "impact": "Very Low",
  "likelihood": "Remote",
  "threat_objectives": [
    {
      "relevance": "Moderate",
      "threat_name": "Sabotage"
    }
  ]
}

400

Scoring failed