post
https://api.sumsub.com/resources/api/caseManagement/v2/notes
Overview
Use this method to add a note and optional applicant tags to the case for Case Management.
Info
- The endpoint is supported only for Case Management 2.0 and does not add notes to cases in earlier Case Management versions.
- Do not use notes as a channel for instant messages.
Tip
- You can add notes to cases in the Dashboard. Open the case you need, and click Add note in the top-right of the Notes section.
Request example
curl -X POST \
'https://api.sumsub.com/resources/api/caseManagement/v2/notes' \
-H 'content-type: application/json' \
-d '{
"caseId": "69818c8f76dd4920f527fa9e",
"note": "Applicant provided additional documents during the interview.",
"tags": [
"interview",
"documents",
"follow-up"
]
}'
Response explained
The response is a JSON object containing ...
Below, you can see the response structure and possible content with descriptions.
Root variables
| Field | Type | Description |
|---|---|---|
id | String | Unique note identifier. |
caseId | String | Unique case identifier in the Sumsub system. |
note | String | Text of the note. |
createdAt | Date | Date and time when the note was added, in the format YYYY-MM-DD hh:mm:ss+0000 (for example, 2026-02-03 05:50:07+0000). |
createdBy | String | Identifier of the note author. |
tags | Array of strings | Tags assigned to the note. |
Response examples
If the request is successfully sent and processed, you will get a response like the one below.
{
"id": "6893925cff736e92c020ffff",
"applicantId": "687fb2373fc85a0000000000",
"note": "This is an example note.",
"createdAt": "2025-08-06 17:35:24+0000",
"createdBy": "example_user",
"tags": [
"First tag",
"Second tag"
]
}
If the request fails, you will receive an HTTP response containing an error code along with a message explaining the error. For example:
{
"code": 404,
"correlationId": "4ad61ffde97994e72d2af9bdb4d63e8c",
"description": "HTTP 404 Not Found"
}