Skip to content
Clarative Docs Clarative Docs Clarative
Get started
API Reference
Risk Events

Fetch in-depth information about a single risk event

client.riskEvents.retrieve(stringurn, RequestOptionsoptions?): RiskEventRetrieveResponse { ai_risk_level_recommendation, created_at, description, 8 more }
GET/v1/risk-events/{urn}

Fetch in-depth information about a single risk event

ParametersExpand Collapse
urn: string
ReturnsExpand Collapse
RiskEventRetrieveResponse { ai_risk_level_recommendation, created_at, description, 8 more }
ai_risk_level_recommendation: AIRiskLevelRecommendation | null

AI's risk level recommendation for this event, if available. AI recommendations are made automatically, shortly after a risk event is discovered.

explanation: string

The explanation for the AI's risk level recommendation

Accepts one of the following:
created_at: string

An ISO-8601-formatted timestamp representing when the risk event was created (UTC)

formatdate-time
description: string | null

The risk event's description

name: string

The risk event's display name

review_status: "PENDING" | "VERIFYING" | "APPLICABLE" | "NOT_APPLICABLE"

The current review status of the risk event, representing where it is in the triage process.

Accepts one of the following:
"PENDING"
"VERIFYING"
"APPLICABLE"
"NOT_APPLICABLE"
risk_level: "UNASSIGNED" | "NONE" | "LOW" | 3 more

The finalized, user-determined risk level for the event (if set)

Accepts one of the following:
"UNASSIGNED"
"NONE"
"LOW"
"MEDIUM"
"HIGH"
"CRITICAL"
source_type: "STATUS_PAGE" | "MONITOR" | "NEWS" | "SEC_FILING"

The type of the risk event

Accepts one of the following:
"STATUS_PAGE"
"MONITOR"
"NEWS"
"SEC_FILING"
url: string | null

A URL with more information about the risk event

urn: string

A unique identifier for the risk event

vendor: Vendor { created_at, description, name, urn }

Details about the vendor associated with this risk event.

created_at: string

An ISO-8601-formatted timestamp representing when the vendor was created (UTC)

formatdate-time
description: string | null

The vendor's description

name: string

The vendor's display name

urn: string

A unique identifier for the vendor

category_tags?: Array<string> | null

Tags indicating the nature of the risk event.

Fetch in-depth information about a single risk event

import Clarative from 'clarative';

const client = new Clarative({
  apiKey: process.env['CLARATIVE_API_KEY'], // This is the default and can be omitted
});

const riskEvent = await client.riskEvents.retrieve('urn');

console.log(riskEvent.ai_risk_level_recommendation);
{
  "ai_risk_level_recommendation": {
    "explanation": "explanation",
    "recommended_risk_level": "UNASSIGNED"
  },
  "created_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "name": "name",
  "review_status": "PENDING",
  "risk_level": "UNASSIGNED",
  "source_type": "STATUS_PAGE",
  "url": "url",
  "urn": "urn",
  "vendor": {
    "created_at": "2019-12-27T18:11:19.117Z",
    "description": "description",
    "name": "name",
    "urn": "urn"
  },
  "category_tags": [
    "string"
  ]
}
Returns Examples
{
  "ai_risk_level_recommendation": {
    "explanation": "explanation",
    "recommended_risk_level": "UNASSIGNED"
  },
  "created_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "name": "name",
  "review_status": "PENDING",
  "risk_level": "UNASSIGNED",
  "source_type": "STATUS_PAGE",
  "url": "url",
  "urn": "urn",
  "vendor": {
    "created_at": "2019-12-27T18:11:19.117Z",
    "description": "description",
    "name": "name",
    "urn": "urn"
  },
  "category_tags": [
    "string"
  ]
}