v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB

Case Workflows

Get a specific case workflow

This endpoint returns the latest version of a single workflow by ID.

get/v2/cases/workflows/{workflow_identifier}

Path parameters

workflow_identifierstring uuid required

The unique identifier of the workflow.

Response

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.