Overview
Use this method to create a case for Case Management.
Note
The endpoint is supported only for Case Management 2.0 and does not create cases in earlier Case Management 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 how the case was created (byApi when created via API). |
createdAt | Date | Date and time when the case was created, in the format YYYY-MM-DD hh:mm:ss+0000 (for example, 2026-02-03 05:50:07+0000). |
updatedAt | Date | Date and time when the case was last updated, in the format YYYY-MM-DD hh:mm:ss+0000 (for example, 2026-02-03 05:50:07+0000). |
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. clientId is automatically added to the applicant profile when it is created. |
review | Object | Includes case review data. |
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 | Contains the case review status field with theopen value — since the case is newly created and ready for investigation). |
priority | String | Case priority. 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. |
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:ss+0000 (for example, 2026-02-03 05:50:07+0000). |
reviewStatus | String | Case review status (init since the case has just been created). |
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. |
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."
}