v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB

Cases

Transition a case to a stage

This endpoint transitions a case to a new stage.

Note:

case_state is deprecated. Please use case_stage instead.
For those already integrated using case_state, if any new case stages are added the case state response for these will be returned as USER_DEFINED

You need the "Update cases" permission to use this endpoint.

post/v2/cases/{case_identifier}/transition

Path parameters

case_identifierstring uuid required

The unique identifier of the case.

Request body

OR

Example request

{
  "note": "Case accepted after confirmation from user.",
  "state": "ONBOARDING_POSITIVE_END_STATE"
}

Response

OK

last_user_stage_identifierstring uuid nullable

The stage identifier to which the case was last transitioned by a user.

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

stage_identifierstring uuid required

The stage identifier to which the case has been transitioned.

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

updated_atstring date-time required

The date and time at which this case was last updated.

updated_bystring uuid nullable

The user identifier that last updated this case.

Example response

{
  "last_user_state": "ONBOARDING_POSITIVE_END_STATE",
  "state": "ONBOARDING_POSITIVE_END_STATE"
}