Sign in

v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB
Cases

Get list of cases

Returns a paginated list of cases for the user's account. Accepts filter and sort query parameters.

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

Query parameters

assigneestring[]

User identifier or null.

assignee_identifierstring[]

Provide an array of user identifiers or blank with which to filter the case list.

  • Includes all cases assigned to user matching user identifiers.

  • If array includes blank, also includes cases without an assignee (i.e. unassigned).

typestring[]

Filter cases by specific case types

created_at_fromstring date-time

Filter cases created on or after this date and time.

created_at_tostring date-time

Filter cases created on or before this date and time.

customer.identifierstring[]

Filter cases by a list of customer identifiers

customer.risk_levelstring[]

Filter cases by a list of customer risk levels.

customer.labelstring[]

Provide an array of customer label identifiers or blank with which to filter the case list.

  • Includes all cases matching at least one customer label.

  • If array includes blank, also includes cases without a customer label.

customer.acquisition_sourcestring[]

Provide an array of customer acquisition sources or blank with which to filter the case list.

  • Includes all cases matching at least one customer acquisition source.

  • If array includes blank, also includes cases without a customer acquisition source.

searchstring

Search for cases by customer name, customer external identifier, counterparty name, counterparty external identifier, or external activity identifier (for payment screening cases only). Supports wildcard search.

statestring[]

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

stage.identifierstring[]

Provide an array of stage identifiers with which to filter the case list.

risk_typestring[]

Filter cases by a list of risk types. You can retrieve the full list of available risk types from the /v2/risk-types endpoint.

alerts.titlestring[]

Filter cases by alert title(s).

Allows filtering for cases with alerts matching any of the provided titles.

alerts.highest_priorityinteger[]

Filter cases by the highest priority alert (1-9).

Allows filtering for cases where the highest priority alert matches the provided value.

risk_catalog_risk_types.keystring[]

Filter cases by risk catalog risk type keys.

Allows filtering for cases with risk types matching any of the provided keys.

page_numberinteger

One-based page index (1..N)

page_sizeinteger

The size of the page to be returned

sortstring[]

Sorting criteria in the format of: [-]property (- descending modifier).

  • Default sort order is ascending (without -).

  • Multiple sort criteria are supported.

Response

OK

firststring required

The URL path to the first page.

nextstring nullable

The URL path to the next page.

prevstring nullable

The URL path to the previous page.

selfstring required

The URL path to the current page.

total_countinteger nullable

Total number of items.

Example response

{
  "cases": [
    {
      "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"
    }
  ],
  "first": "/v1/resource?page_number=1",
  "next": "/v1/resource?page_number=4",
  "prev": "/v1/resource?page_number=2",
  "self": "/v1/resource?page_number=3",
  "total_count": 60
}