Skip to main content
GET
/
risk
/
score
/
{objectId}
Get risk score for an object
curl --request GET \
  --url http://sandbox.mintlify.com/risk/score/{objectId} \
  --header 'Authorization: Bearer <token>'
{
  "objectId": "<string>",
  "riskScore": 0.5,
  "riskFactors": [
    {
      "factor": "<string>",
      "severity": "low"
    }
  ],
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
objectId
string
required

Unique identifier of the object to score

Response

Risk score retrieved successfully

​
objectId
string

The ID of the scored object

​
riskScore
number<float>

Risk score between 0 (low risk) and 1 (high risk)

Required range: 0 <= x <= 1
​
riskFactors
object[]

List of identified risk factors

​
timestamp
string<date-time>

When the risk score was calculated