API REFERENCE · SCHEMA

CaseDetail schema

Required fields are always present in their containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

All endpoints and schemas
idRequired
string

Format: uuid.

environmentRequired
string
screening_idRequired
string

Format: uuid.

monitor_idRequired
string or null

May be null.

monitor_id fields and rules

Allowed alternatives

  • string

    Format: uuid.

  • null

    May be null.

decisionRequired
string
business_dispositionRequired
string
review_started_atRequired
string

Format: date-time.

superseded_by_screening_idRequired
string or null

May be null.

superseded_by_screening_id fields and rules

Allowed alternatives

  • string

    Format: uuid.

  • null

    May be null.

superseded_by_case_idRequired
string or null

May be null.

superseded_by_case_id fields and rules

Allowed alternatives

  • string

    Format: uuid.

  • null

    May be null.

created_atRequired
string

Format: date-time.

updated_atRequired
string

Format: date-time.

latest_screening_idRequired
string or null

May be null.

latest_screening_id fields and rules

Allowed alternatives

  • string

    Format: uuid.

  • null

    May be null.

counterparty_idRequired
string or null

May be null.

counterparty_id fields and rules

Allowed alternatives

  • string

    Format: uuid.

  • null

    May be null.

assignee_idRequired
string or null

May be null.

assignee_id fields and rules

Allowed alternatives

  • string
  • null

    May be null.

priorityRequired
string
due_atRequired
string or null

May be null.

due_at fields and rules

Allowed alternatives

  • string

    Format: date-time.

  • null

    May be null.

escalated_atRequired
string or null

May be null.

escalated_at fields and rules

Allowed alternatives

  • string

    Format: date-time.

  • null

    May be null.

revisionRequired
integer
requires_second_reviewRequired
boolean
review_stateRequired
string
submitted_byRequired
string or null

May be null.

submitted_by fields and rules

Allowed alternatives

  • string
  • null

    May be null.

approved_byRequired
string or null

May be null.

approved_by fields and rules

Allowed alternatives

  • string
  • null

    May be null.

submitted_screening_idRequired
string or null

May be null.

submitted_screening_id fields and rules

Allowed alternatives

  • string

    Format: uuid.

  • null

    May be null.

retention_policyRequired
string
retention_yearsRequired
integer or null

May be null.

retention_years fields and rules

Allowed alternatives

  • integer
  • null

    May be null.

retention_daysRequired
integer or null

May be null.

retention_days fields and rules

Allowed alternatives

  • integer
  • null

    May be null.

closed_atRequired
string or null

May be null.

closed_at fields and rules

Allowed alternatives

  • string

    Format: date-time.

  • null

    May be null.

retention_expires_atRequired
string or null

May be null.

retention_expires_at fields and rules

Allowed alternatives

  • string

    Format: date-time.

  • null

    May be null.

retention_triggerRequired
string
retention_event_atRequired
string or null

May be null.

retention_event_at fields and rules

Allowed alternatives

  • string

    Format: date-time.

  • null

    May be null.

retention_event_reasonRequired
string or null

May be null.

retention_event_reason fields and rules

Allowed alternatives

  • string
  • null

    May be null.

retention_event_actorRequired
string or null

May be null.

retention_event_actor fields and rules

Allowed alternatives

  • string
  • null

    May be null.

subjectNameRequired
string or null

May be null.

subjectName fields and rules

Allowed alternatives

  • string
  • null

    May be null.

entityTypeRequired
string or null

May be null.

entityType fields and rules

Allowed alternatives

  • string
  • null

    May be null.

originRequired
string
statusRequired
string or null

May be null.

status fields and rules

Allowed alternatives

  • string

    Values: "potential_match", "no_match".

  • null

    May be null.

matchCountRequired
integer

Minimum: 0.

evidenceAvailableRequired
boolean
retentionRequired
string

Values: "standard", "minimal".

expiresAtRequired
string or null

May be null.

expiresAt fields and rules

Allowed alternatives

  • string

    Format: date-time.

  • null

    May be null.

decisionsRequired
object[]
decisions item fields

Each array item: object.

decisions[].idRequired
string

Format: uuid.

decisions[].actor_idRequired
string
decisions[].decisionRequired
string

Values: "open", "confirmed", "dismissed".

decisions[].business_dispositionRequired
string

Values: "pending", "allow", "restrict", "escalate".

decisions[].appliedControlsRequired
AppliedDecisionControls or null

May be null.

decisions[].appliedControls fields and rules

Allowed alternatives

decisions[].notesRequired
string or null

May be null.

decisions[].notes fields and rules

Allowed alternatives

  • string
  • null

    May be null.

decisions[].created_atRequired
string

Format: date-time.

decisions[].actor_emailRequired
string or null

May be null.

decisions[].actor_email fields and rules

Allowed alternatives

  • string
  • null

    May be null.

decisions[].screening_idRequired
string or null

May be null.

decisions[].screening_id fields and rules

Allowed alternatives

  • string

    Format: uuid.

  • null

    May be null.

nextDecisionCursorRequired
string or null

May be null.

nextDecisionCursor fields and rules

Allowed alternatives

  • string

    Format: uuid.

  • null

    May be null.