v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB

Cases

Get a specific case

This endpoint returns a single case by ID.

You need one of the "View cases (customer onboarding)", "View cases (customer monitoring)", "View cases (payment screening)" or "View cases (transaction monitoring)" permissions to use this endpoint.

get/v2/cases/{case_identifier}

Path parameters

case_identifierstring uuid required

The unique identifier of the case.

Response

OK

assigneestring uuid nullable

User unique identifier that is currently assigned to case.

null if un-assigned.

created_atstring date-time required

Case created date and time.

identifierstring uuid required

Case unique identifier.

last_user_state'ONBOARDING_NOT_STARTED' | 'ONBOARDING_IN_PROGRESS' | 'ONBOARDING_ESCALATED' | 'ONBOARDING_BLOCKED' | 'ONBOARDING_POSITIVE_END_STATE' | 'ONBOARDING_MANAGEABLE_RISK_POSITIVE_END_STATE' | 'ONBOARDING_NEGATIVE_END_STATE' | 'MONITORING_NOT_STARTED' | 'MONITORING_IN_PROGRESS' | 'MONITORING_ESCALATED' | 'MONITORING_BLOCKED' | 'MONITORING_NO_RISK_DETECTED_POSITIVE_END_STATE' | 'MONITORING_RISK_DETECTED_POSITIVE_END_STATE' | 'MONITORING_RISK_DETECTED_NEGATIVE_END_STATE' | 'PAYMENT_SCREENING_NOT_STARTED' | 'PAYMENT_SCREENING_IN_PROGRESS' | 'PAYMENT_SCREENING_ESCALATED' | 'PAYMENT_SCREENING_BLOCKED' | 'PAYMENT_SCREENING_AWAITING_INFORMATION' | 'PAYMENT_SCREENING_PROCESS_PAYMENT_END_STATE' | 'PAYMENT_SCREENING_REJECT_PAYMENT_END_STATE' | 'TRANSACTION_MONITORING_NOT_STARTED' | 'TRANSACTION_MONITORING_IN_PROGRESS' | 'TRANSACTION_MONITORING_ESCALATED' | 'TRANSACTION_MONITORING_BLOCKED' | 'TRANSACTION_MONITORING_ACCEPTED_POSITIVE_END_STATE' | 'TRANSACTION_MONITORING_ESCALATED_NEGATIVE_END_STATE' | 'USER_DEFINED' nullable

The last state the case was transitioned to by a user (as opposed to a system action).

For those using the deprecated case_state, if any new case stages are added the case state response for these will be returned as USER_DEFINED

review_items_countinteger required

Number of items to review in case.

state'ONBOARDING_NOT_STARTED' | 'ONBOARDING_IN_PROGRESS' | 'ONBOARDING_ESCALATED' | 'ONBOARDING_BLOCKED' | 'ONBOARDING_POSITIVE_END_STATE' | 'ONBOARDING_MANAGEABLE_RISK_POSITIVE_END_STATE' | 'ONBOARDING_NEGATIVE_END_STATE' | 'MONITORING_NOT_STARTED' | 'MONITORING_IN_PROGRESS' | 'MONITORING_ESCALATED' | 'MONITORING_BLOCKED' | 'MONITORING_NO_RISK_DETECTED_POSITIVE_END_STATE' | 'MONITORING_RISK_DETECTED_POSITIVE_END_STATE' | 'MONITORING_RISK_DETECTED_NEGATIVE_END_STATE' | 'PAYMENT_SCREENING_NOT_STARTED' | 'PAYMENT_SCREENING_IN_PROGRESS' | 'PAYMENT_SCREENING_ESCALATED' | 'PAYMENT_SCREENING_BLOCKED' | 'PAYMENT_SCREENING_AWAITING_INFORMATION' | 'PAYMENT_SCREENING_PROCESS_PAYMENT_END_STATE' | 'PAYMENT_SCREENING_REJECT_PAYMENT_END_STATE' | 'TRANSACTION_MONITORING_NOT_STARTED' | 'TRANSACTION_MONITORING_IN_PROGRESS' | 'TRANSACTION_MONITORING_ESCALATED' | 'TRANSACTION_MONITORING_BLOCKED' | 'TRANSACTION_MONITORING_ACCEPTED_POSITIVE_END_STATE' | 'TRANSACTION_MONITORING_ESCALATED_NEGATIVE_END_STATE' | 'USER_DEFINED' required

The current state of the case.

For those using the deprecated case_state, if any new case stages are added the case state response for these will be returned as USER_DEFINED

type'CUSTOMER_ONBOARDING' | 'CUSTOMER_MONITORING' | 'PAYMENT_SCREENING' | 'TRANSACTION_MONITORING' required

Case type.

updated_atstring date-time required

Case last updated date and time.

updated_bystring uuid nullable

Last state of case set by an user.

Example response

{
  "last_user_state": "ONBOARDING_POSITIVE_END_STATE",
  "payment": {
    "type": "BANK_PAYMENT"
  },
  "state": "ONBOARDING_POSITIVE_END_STATE",
  "subjects": [
    {
      "detail": {
        "type": "PERSON"
      },
      "type": "CUSTOMER"
    }
  ],
  "type": "CUSTOMER_ONBOARDING"
}