---
updatedAt: 2026-09-29T11:02:10.000Z
agentTools:
  projectIndex: https://docs.sumsub.com/llms.txt
---

# Create case

# Overview

Use this method to create a case for [Case Management](https://docs.sumsub.com/sumsub/docs/case-management).

## Required permissions

To use this method, your [app token](https://docs.sumsub.com/sumsub/docs/app-tokens) must have the **View case management** [permission](https://docs.sumsub.com/sumsub/docs/user-roles#permissions).

<Callout icon="📘" theme="info">
  ### Info

  This endpoint is available **only in the paid version** of [Case Management 2.0](https://docs.sumsub.com/sumsub/docs/migrating-to-case-management-20) and does not create cases in earlier versions.
</Callout>

# Request example

```curl
curl -X POST \
     'https://api.sumsub.com/resources/api/caseManagement/v2/cases' \
     -H 'content-type: application/json' \
     -H 'X-App-Token: <your-app-token>' \
     -H 'X-App-Access-Sig: <your-signature>' \
     -H 'X-App-Access-Ts: <unix-timestamp>' \  
     -d '{
            "applicantId": "63e25fd763e1fc4014e00000",
            "txnIds": [
              "6901f0f654ec3deaa5700000",
              "6901f0f654ec3deaa1200000"
            ],
            "blueprintId": "687a5973dc7ec611c8f23451",
            "name": "Case name",
            "tags": [
                "tag-1",
                "tag-2"
            ]
          }'
```

# Response explained

The response is a JSON object containing data for a newly created case.

Below is the response structure, along with its possible content and field descriptions.

## Root variables

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Field
      </th>

      <th>
        Type
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `id`
      </td>

      <td>
        String
      </td>

      <td>
        Unique case identifier.
      </td>
    </tr>

    <tr>
      <td>
        `name`
      </td>

      <td>
        String
      </td>

      <td>
        Case name.
      </td>
    </tr>

    <tr>
      <td>
        `applicantReference`
      </td>

      <td>
        [Object](#applicantreference-attributes)
      </td>

      <td>
        Reference data for the applicant associated with the case.
      </td>
    </tr>

    <tr>
      <td>
        `createdByType`
      </td>

      <td>
        String
      </td>

      <td>
        Indicates the type of entity that created the case.
        Possible values: `byOfficer`, `byRule`, `byWorkflow`, `byOngoingAmlHit`, `byApi`.
      </td>
    </tr>

    <tr>
      <td>
        `groupByType`
      </td>

      <td>
        String
      </td>

      <td>
        Grouping type used for the case.
      </td>
    </tr>

    <tr>
      <td>
        `createdByRule`
      </td>

      <td>
        [Object](#createdbyrule-attributes)
      </td>

      <td>
        Information about the rule that created the case.
        Returned only if `"createdByType": "byRule"`.
      </td>
    </tr>

    <tr>
      <td>
        `createdByOfficer`
      </td>

      <td>
        String
      </td>

      <td>
        Officer's identifier.
        Returned only if `"createdByType": "byOfficer"`.
      </td>
    </tr>

    <tr>
      <td>
        `createdByWorkflowRef`
      </td>

      <td>
        Object
      </td>

      <td>
        Information about the workflow that created the case.
        Returned only if `"createdByType": "byWorkflow"`.
      </td>
    </tr>

    <tr>
      <td>
        `createdAt`
      </td>

      <td>
        Date
      </td>

      <td>
        Date and time when the case was created, in the format `yyyy-MM-dd HH:mm:ssZZ`.
      </td>
    </tr>

    <tr>
      <td>
        `updatedAt`
      </td>

      <td>
        Date
      </td>

      <td>
        Date and time when the case was last updated, in the format `yyyy-MM-dd HH:mm:ssZZ`.
      </td>
    </tr>

    <tr>
      <td>
        `totalAmountInDefaultCurrency`
      </td>

      <td>
        Double
      </td>

      <td>
        Total amount of all transactions submitted for the case, in the default currency.
        Returned if at least one transaction was submitted in the request.
      </td>
    </tr>

    <tr>
      <td>
        `clientId`
      </td>

      <td>
        String
      </td>

      <td>
        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.
      </td>
    </tr>

    <tr>
      <td>
        `review`
      </td>

      <td>
        [Object](#review-attributes)
      </td>

      <td>
        Includes case review data.
        **Note:** This field is deprecated and will be removed once KM1 support ends.
      </td>
    </tr>

    <tr>
      <td>
        `applicantInfo`
      </td>

      <td>
        [Object](#applicantinfo-attributes)
      </td>

      <td>
        General information about the applicant associated with the case.
      </td>
    </tr>

    <tr>
      <td>
        `blueprintReference`
      </td>

      <td>
        [Object](#blueprintreference-attributes)
      </td>

      <td>
        Includes reference data of the blueprint assigned to the case.
      </td>
    </tr>

    <tr>
      <td>
        `caseReview`
      </td>

      <td>
        [Object](#casereview-attributes)
      </td>

      <td>
        The current review state and checklist of the case.
      </td>
    </tr>

    <tr>
      <td>
        `amlCases`
      </td>

      <td>
        [Array of objects](#amlcases)
      </td>

      <td>
        AML screenings performed on **transaction-related entities** referenced by this case (counterparty, financial institution, or payment method). **Not** the applicant's own AML screening — see [About amlCases](#about-amlcases). Omitted entirely when the case has no such transaction-level screening.
      </td>
    </tr>

    <tr>
      <td>
        `priority`
      </td>

      <td>
        String
      </td>

      <td>
        Case priority (`low`, `medium`, `high`). Defaults to `medium`.
      </td>
    </tr>

    <tr>
      <td>
        `sourceKeys`
      </td>

      <td>
        Array of strings
      </td>

      <td>
        A list of [source keys](https://docs.sumsub.com/sumsub/docs/source-keys) that help you group clients sending applicants.
      </td>
    </tr>

    <tr>
      <td>
        `tags`
      </td>

      <td>
        Array of strings
      </td>

      <td>
        A list of [transaction tags](https://docs.sumsub.com/sumsub/docs/use-transaction-tags) assigned to the case.
      </td>
    </tr>
  </tbody>
</Table>

## `applicantReference` attributes

This 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

Returned 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

Returned 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

This 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

This 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`)..                             |
| applicantTags  | Array of strings | [Tags](https://docs.sumsub.com/sumsub/docs/add-applicant-tags) currently assigned to the applicant. Returned only when the applicant has one or more tags. |

## `blueprintReference` attributes

This table describes the `blueprintReference` attributes.

| Field         | Type   | Description                         |
| :------------ | :----- | :---------------------------------- |
| `name`        | String | Name of the assigned blueprint.     |
| `blueprintId` | String | Unique identifier of the blueprint. |

## `caseReview` attributes

The table describes the `caseReview` attributes.

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Field
      </th>

      <th>
        Type
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `status`
      </td>

      <td>
        String
      </td>

      <td>
        Current status of the case review.
        Possible values: `open`, `awaitingUser`, `blocked`, `resolvedFalsePositive`, `resolvedPotentialThreat`.
      </td>
    </tr>

    <tr>
      <td>
        `stage`
      </td>

      <td>
        String
      </td>

      <td>
        Custom name of the case review stage.
      </td>
    </tr>

    <tr>
      <td>
        `assignee`
      </td>

      <td>
        String
      </td>

      <td>
        Login of the user assigned to the case (usually a corporate email address, for example: `john.doe@company.com`).
      </td>
    </tr>

    <tr>
      <td>
        `startDate`
      </td>

      <td>
        Date
      </td>

      <td>
        Date and time when the case was created, in the format `yyyy-MM-dd HH:mm:ssZZ`.
      </td>
    </tr>

    <tr>
      <td>
        `checklistState`
      </td>

      <td>
        [Object](#checkliststatechecklist)
      </td>

      <td>
        Checklist state associated with the case.
      </td>
    </tr>
  </tbody>
</Table>

## `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[]`

| Field       | Type   | Description                        |
| :---------- | :----- | :--------------------------------- |
| `amlCaseId` | String | Unique identifier of the AML case. |

<br />

# Response examples

If the request is successfully sent and processed, you will get a response like the one below.

```json
{
  "id": "69818c8f76dd490000000000",
  "name": "Case name",
  "applicantReference": {
    "applicantId": "69818c8f76dd49000111100",
    "fullName": "John Doe"
  },
  "createdByType": "byOfficer",
  "createdByOfficer": "Service",
  "createdAt": "2026-06-30 08:26:41+0000",
  "updatedAt": "2026-06-30 08:42:08+0000",
  "clientId": "your_cool_client_id",
  "review": {
    "reviewId": "tewaY",
    "attemptId": "cWjSf",
    "attemptCnt": 0,
    "createDate": "2026-06-30 08:26:40+0000",
    "reviewStatus": "init"
  },
  "applicantInfo": {
    "firstName": "John",
    "firstNameEn": "John",
    "lastName": "Doe",
    "lastNameEn": "Doe",
    "dob": -157766400000,
    "country": "USA",
    "applicantTags": [
      "VIP",
      "High risk"
    ]
  },
  "blueprintReference": {
    "name": "amlBp",
    "blueprintId": "69818c8f76dd490000000000"
  },
  "caseReview": {
    "status": "open",
    "assignee": "jim.johnson@example.com",
    "startDate": "2026-06-30 08:26:41+0000"
  },
  "priority": "medium",
  "sourceKeys": [
    "sourceKeyLatest"
  ]
}
```

If the request fails, you will receive an HTTP response containing an error code along with a message explaining the error. For example:

```json
{
  "code": 400,
  "correlationId": "6afb958d4f064b5fd4f19986b56299b8",
  "description": "Couldn't find or parse value of `blueprintId` parameter."
}
```

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "sumsub-api",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.sumsub.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "name": "X-App-Token",
        "in": "header",
        "x-default": ""
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/resources/api/caseManagement/v2/cases": {
      "post": {
        "summary": "Create case",
        "description": "",
        "operationId": "create-case",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "applicantId",
                  "blueprintId"
                ],
                "properties": {
                  "applicantId": {
                    "type": "string",
                    "description": "Unique identifier of the applicant in the Sumsub system. <br><br>This identifier is a random combination of 24 digits and lowercase Latin characters. It is automatically generated when the applicant is created on the Sumsub side, and can be found in the [Dashboard](https://cockpit.sumsub.com/checkus/#/applicants/individual?limit=10&page=0). <br><br>If the `applicantId` is unknown to you, use the [Get applicant data (externalUserId)](https://docs.sumsub.com/sumsub/reference/get-applicant-data-via-externaluserid) method to fetch it."
                  },
                  "txnIds": {
                    "type": "array",
                    "description": "Each string in the array is a unique transaction identifier in the Sumsub system. <br><br>This ID is returned in the [response](https://docs.sumsub.com/reference/get-transaction#root-variables) to this request and a webhook (`kytTxnId`). Save it for future use in subsequent API calls. Alternatively, you can get this identifier by the [following method](https://docs.sumsub.com/sumsub/reference/get-transaction-information-by-txnid).",
                    "items": {
                      "type": "string"
                    }
                  },
                  "blueprintId": {
                    "type": "string",
                    "description": "Unique identifier of a blueprint in the Sumsub system. <br><br>You can find this identifier in the address bar when selecting a specific blueprint on [this page](https://cockpit.sumsub.com/checkus/caseMgmt/settings/blueprints) in the Dashboard."
                  },
                  "name": {
                    "type": "string",
                    "description": "Optional case name. If the field is `null` or empty, the system will generate the case name automatically."
                  },
                  "priority": {
                    "type": "string",
                    "description": "Case priority. Select from `low`, `medium`, or `high`. Defaults to `medium`.",
                    "enum": [
                      "low",
                      "medium",
                      "high"
                    ],
                    "default": "medium"
                  },
                  "tags": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "description": "Custom [transaction tags](https://docs.sumsub.com/sumsub/docs/use-transaction-tags) you want to assign to the case, with each string representing an individual tag. Maximum 20 tags; sending more returns a `400` error.<br><br>⚠️ Each string must exactly match the name of a tag already [configured in your transaction tag settings](https://docs.sumsub.com/sumsub/docs/use-transaction-tags) — unrecognized tags are ignored (the case is still created)."
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```