Skip to main content
POST
/
v1
/
cases
/
{case_token}
/
risk-assessments
Create/recalculate risk assessment
curl --request POST \
  --url https://instance.prod.onboardapp.io/v1/cases/{case_token}/risk-assessments \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "model_token": "<string>",
  "override_data": {}
}
'
{
  "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.

Headers

​
Idempotency-Key
string<uuid>

Unique key for idempotent request handling. If a request with the same key was already processed within the last 24 hours, the original response is returned.

Path Parameters

​
case_token
string
required

Case token.

Body

application/json
​
model_token
string

Optional risk model token. Uses the active model if omitted.

​
override_data
object

Optional data overrides for the risk calculation.

Response

Risk assessment created.

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