Get risk classification by ID

get/api/risk-classifications/{id}

Request

Base URL: http://localhost:4100
URL: http://localhost:4100/api/risk-classifications/{id}
Auth: none required

Path parameters

idstring uuid required

Risk classification ID

Response

Risk classification

account_holder_idstring uuid required

classification_reasonstring required

Human-readable justification for the classification

classified_by_user_idstring uuid nullable

User who performed the classification (nil = auto-classified by engine)

compliance_screening_idstring uuid nullable

ComplianceScreening that drove this classification

effective_fromstring date required

Start date of the classification (inclusive)

effective_untilstring date nullable

End date of the classification (exclusive), nil = open-ended

idstring uuid

inserted_atstring date-time

is_activeboolean

True when this is the current active classification for the holder

notesstring nullable

Free-text analyst notes

risk_level'low' | 'medium' | 'high' | 'very_high' required

Risk level driving the LedgerAccount limit cascade

tenant_idstring uuid required

updated_atstring date-time

Example response

{
  "account_holder_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "classification_reason": "",
  "classified_by_user_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "compliance_screening_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "effective_from": "2020-04-20",
  "effective_until": "2020-04-20",
  "id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "inserted_at": "2020-04-20T16:20:00Z",
  "is_active": false,
  "notes": "",
  "risk_level": "low",
  "tenant_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "updated_at": "2020-04-20T16:20:00Z"
}

Changes

No recorded changes to this operation across all 4 revisions of this API.