Sign in

v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB
Customers

Retrieve cases for a customer

Returns a paginated list of cases associated with a customer.

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/customers/{customer_identifier}/cases

Path parameters

customer_identifierstring uuid required

The unique identifier of the customer.

Query parameters

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
}