Skip to main content
GET
/
v1
/
cases
/
{case_token}
/
risk-assessment
Get risk assessment
curl --request GET \
  --url https://instance.prod.onboardapp.io/v1/cases/{case_token}/risk-assessment \
  --header 'X-API-KEY: <api-key>'
{
  "data": {
    "token": "rsk_2m6n4p8q",
    "case_token": "<string>",
    "status": "Draft",
    "overall_score": 50,
    "tier": "High",
    "dimensions": {
      "customer": {
        "score": 50,
        "weight": 123,
        "weighted_score": 123,
        "factors": [
          {
            "name": "<string>",
            "value": "<string>",
            "score_contribution": 123
          }
        ]
      },
      "geographic": {
        "score": 50,
        "weight": 123,
        "weighted_score": 123,
        "factors": [
          {
            "name": "<string>",
            "value": "<string>",
            "score_contribution": 123
          }
        ]
      },
      "product_service": {
        "score": 50,
        "weight": 123,
        "weighted_score": 123,
        "factors": [
          {
            "name": "<string>",
            "value": "<string>",
            "score_contribution": 123
          }
        ]
      },
      "transaction": {
        "score": 50,
        "weight": 123,
        "weighted_score": 123,
        "factors": [
          {
            "name": "<string>",
            "value": "<string>",
            "score_contribution": 123
          }
        ]
      }
    },
    "due_diligence_path": "SDD",
    "review_frequency": "6 Months",
    "override_tier": "High",
    "override_justification": "<string>",
    "approved_by": "<string>",
    "approved_at": "2023-11-07T05:31:56Z",
    "model_version": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "request_id": "req_9k4m2n1p3q",
    "page": {
      "cursor": "<string>",
      "has_more": true
    }
  }
}

Authorizations

X-API-KEY
string
header
required

Project-scoped API key for server-to-server authentication. Obtain keys from the Zenoo dashboard under Project Settings > API Keys. Staging and production environments use separate keys.

Path Parameters

case_token
string
required

Case token.

Response

Current risk assessment.

Standard response wrapper for all API endpoints. Contains the resource data and pagination metadata.

data
object

A 4-dimension risk assessment that scores an entity across customer, geographic, product/service, and transaction dimensions. The overall score determines the risk tier and drives the due diligence path.

meta
object