Overview
Use this method to create a case for Case Management.
InfoThis endpoint is available only in the paid version of Case Management 2.0 and does not create cases in earlier versions.
Request example
curl -X POST \
'https://api.sumsub.com/resources/api/caseManagement/v2/cases' \
-H 'content-type: application/json' \
-d '{
"applicantId": "63e25fd763e1fc4014ea8a1f",
"txnIds": [
"6901f0f654ec3deaa5711d31",
"6901f0f654ec3deaa1234h67"
],
"blueprintId": "687a5973dc7ec611c8f93982",
"name": "Case name"
}'Response explained
The response is a JSON object containing data for a newly created case.
Below, you can see the response structure and possible content with descriptions.
Root variables
| Field | Type | Description |
|---|---|---|
id | String | Unique case identifier. |
name | String | Case name. |
applicantReference | Object | Reference data for the applicant associated with the case. |
createdByType | String | Indicates the type of entity that created the case. Possible values: |
groupByType | String | Grouping type used for the case. |
createdByRule | Object | Information about the rule that created the case. Returned only if |
createdByOfficer | String | Officer's identifier. Returned only if |
createdByWorkflowRef | Object | Information about the workflow that created the case. Returned only if |
createdAt | Date | Date and time when the case was created, in the format yyyy-MM-dd HH:mm:ssZZ. |
updatedAt | Date | Date and time when the case was last updated, in the format yyyy-MM-dd HH:mm:ssZZ. |
totalAmountInDefaultCurrency | Double | Total amount of all transactions submitted for the case, in the default currency. Returned if at least one transaction was submitted in the request. |
clientId | String | Unique identifier of you as our client in the Sumsub system. This identifier is assigned to you when you are registered in and get access to the Sumsub system. It usually resembles your name or your company name. |
review | Object | Includes case review data. Note: This field is deprecated and will be removed once KM1 support ends. |
applicantInfo | Object | General information about the applicant associated with the case. |
blueprintReference | Object | Includes reference data of the blueprint assigned to the case. |
caseReview | Object | The current review state and checklist of the case. |
amlCases | Array of objects | A list of AML cases associated with the case. |
priority | String | Case priority (low, medium, high). Defaults to medium. |
applicantReference attributes
applicantReference attributesThis table describes the applicantReference attributes.
| Field | Type | Description |
|---|---|---|
applicantId | String | Unique identifier of the applicant in the Sumsub system. |
fullName | String | Applicant's full name. |
createdByRule attributes
createdByRule attributesReturned only if "createdByType": "byRule".
| Field | Type | Description |
|---|---|---|
id | String | Unique identifier of the rule. |
name | String | Name of the rule. |
title | String | Display name of the rule. |
revision | Integer | Revision number. |
createdByWorkflowRef attributes
createdByWorkflowRef attributesReturned only if "createdByType": "byWorkflow".
| Field | Type | Description |
|---|---|---|
id | String | Unique identifier of the workflow. |
title | String | Name of the action from the workflow. |
review attributes
review attributesThis table describes the review attributes.
| Field | Type | Description |
|---|---|---|
reviewId | String | Unique review identifier. |
attemptId | String | Unique identifier of the current case verification attempt. |
attemptCnt | Integer | Sequential number of the current case verification attempt. |
createDate | Date | Date and time when the case review was initiated in the Sumsub system, in the format yyyy-MM-dd HH:mm:ssZZ. |
reviewStatus | String | Case review status (for example, init). |
applicantInfo attributes
applicantInfo attributesThis table describes the applicantInfo attributes.
| Field | Type | Description |
|---|---|---|
firstName | String | Applicant's first name in the original language. |
firstNameEn | String | Automatic's transliteration of the applicant first name into Latin characters. |
middleName | String | Applicant's middle name in the original language. |
middleNameEn | String | Automatic's transliteration of the applicant middle name into Latin characters. |
lastName | String | Applicant's last name in the original language. |
lastNameEn | String | Automatic's transliteration of the applicant last name into Latin characters. |
dob | String | Applicant's date of birth as a Unix timestamp in milliseconds. |
country | String | Applicant's country as an ISO 3166-1 alpha-3 country code (for example, DEU, GBR, ARG).. |
blueprintReference attributes
blueprintReference attributesThis table describes the blueprintReference attributes.
| Field | Type | Description |
|---|---|---|
name | String | Name of the assigned blueprint. |
blueprintId | String | Unique identifier of the blueprint. |
caseReview attributes
caseReview attributesThe table describes the caseReview attributes.
| Field | Type | Description |
|---|---|---|
status | String | Current status of the case review. Possible values: |
checklistState | Object | Checklist state associated with the case. |
checklistState.checklist[]
checklistState.checklist[]| Field | Type | Description |
|---|---|---|
name | String | The name of the checklist item. |
checked | Boolean | Indicates whether the checklist item is completed (true) or not (false). |
amlCases[]
amlCases[]| Field | Type | Description |
|---|---|---|
amlCaseId | String | Unique identifier of the AML case. |
Response examples
If the request is successfully sent and processed, you will get a response like the one below.
{
"id": "69818c8f76dd490000000000",
"name": "Case name",
"applicantReference": {
"applicantId": "63e25fd763e1fc0000000000",
"fullName": "John Doe"
},
"createdByType": "byApi",
"createdAt": "2026-02-03 05:50:07+0000",
"updatedAt": "2026-02-03 05:50:07+0000",
"totalAmountInDefaultCurrency": 101000,
"clientId": "your_cool_client_id",
"review": {
"reviewId": "cvNHe",
"attemptId": "wIOCl",
"attemptCnt": 0,
"createDate": "2026-02-03 05:50:07+0000",
"reviewStatus": "init"
},
"applicantInfo": {
"firstName": "John",
"firstNameEn": "John",
"middleName": "",
"middleNameEn": "",
"lastName": "Doe",
"lastNameEn": "Doe",
"dob": 944697600000,
"country": "GBR"
},
"blueprintReference": {
"name": "AML investigation",
"blueprintId": "687a5973dc7ec611c8f93982"
},
"caseReview": {
"status": "open"
},
"priority": "medium"
}If the request fails, you will receive an HTTP response containing an error code along with a message explaining the error. For example:
{
"code": 400,
"correlationId": "6afb958d4f064b5fd4f19986b56299b8",
"description": "Couldn't find or parse value of `blueprintId` parameter."
}