Sign in

v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB
Case Workflows

Update a specific case workflow

This endpoint updates a single workflow by ID.

Supported Operations:

  • Rename Stages:

    • You can change the name of existing stages
    • Any change in name will apply to all cases, including closed cases. Ensure the new stage name preserves the original meaning to maintain integrity in audit logs, insights, and reports
    • Renaming decisions does not change their decision type

  • Reorder Stages:

    • Stages of types Reviews and Decision can be reordered across the new display order
    • Stages can only be reordered within their types

  • Add Stages:

    • Review stage:
      • a minimum of 1 review stage is needed
      • a maximum of 8 review stages are allowed
    • Decisions:
      • a minimum of 2 decisions are needed and this should include one of each:
        • positive
        • negative
      • a maximum of 8 decisions are allowed

  • Change Alert Grouping:

    • Alert Grouping can be set to true or false
    • If the property is not set no change will be made

You need the "Update case workflows" permission to use this endpoint.

put/v2/cases/workflows/{workflow_identifier}

Path parameters

workflow_identifierstring uuid required

The unique identifier of the workflow.

Request body

alert_grouping_enabledboolean nullable

Clients can enable or disable grouping of multiple alerts in a case via this configuration. When enabled, if new alerts are generated, these will continue to group within an existing open case rather than trigger the creation of new cases. We recommend that this configuration must always remain enabled for Transaction monitoring cases, as having alerts grouped in a single case provides an overall view of alert activity for a given customer or counterparty.

Response

OK

alert_grouping_enabledboolean required

Clients can enable or disable grouping of multiple alerts in a case via this configuration. When enabled, if new alerts are generated, these will continue to group within an existing open case rather than trigger the creation of new cases. We recommend that this configuration must always remain enabled for Transaction monitoring cases, as having alerts grouped in a single case provides an overall view of alert activity for a given customer or counterparty.

case_type'CUSTOMER_ONBOARDING' | 'CUSTOMER_MONITORING' | 'PAYMENT_SCREENING' | 'TRANSACTION_MONITORING' required

The type of the case to which the workflow applies.

created_atstring date-time required

Workflow created date and time.

created_bystring uuid nullable

User identifier that created the workflow; null if created by a system action.

identifierstring uuid required

Workflow unique identifier.

versioninteger required

The version of the workflow.