Get available case filters

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Use this endpoint to retrieve the list of available search keys that can be used in the filtering logic of the Get cases by filters method.

📘

Note

This endpoint is available only in the paid version of Case Management 2.0 and does not apply to earlier versions.

Request example

curl -X GET \
     'https://api.sumsub.com/resources/api/caseManagement/v2/cases/filters'

Response explained

The response is a JSON file that includes the array of available search keys.

[
  "createdAt",
  "createdByType",
  "caseReview.assignee",
  "blueprintReference.blueprintId",
  "applicantReference.applicantId",
  "caseReview.status",
  "updatedAt",
]

Available search keys

The following table describes the available search keys that you can use for the Get cases by filters method.

Search keyDescription
createdAtTimestamp indicating when the case was created, in the format yyyy-MM-dd HH:mm:ssZZ.
createdByType

Type of entity that created the case.

Possible values: byOfficer, byRule, byWorkflow, byOngoingAmlHit, byApi.

caseReview.assigneeIdentifier of the user assigned to review the case.
blueprintReference.blueprintIdUnique identifier of the blueprint associated with the case.
applicantReference.applicantIdUnique identifier of the applicant associated with the case.
caseReview.status

Current status of the case review.

Possible values: open, awaitingUser, blocked, resolvedFalsePositive, resolvedPotentialThreat.

updatedAtTimestamp indicating when the case was last updated, in the format yyyy-MM-dd HH:mm:ssZZ.
Response
200
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!