| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Overview
Use this method to retrieve all notes added to a specific case in Case Management. The response returns a list of note objects ordered by creation time, each containing the note content, author, timestamp, and any tags if they were assigned.
NoteThis endpoint is available only in the paid version of Case Management 2.0 and does not retrieve notes from cases in earlier versions.
Request example
curl -X GET \
'https://api.sumsub.com/resources/api/caseManagement/v2/cases/notes?caseId=69818ec8a5197bfa820ef2a3&offset=0&limit=100' \
-H 'content-type: application/json' \
-H 'X-App-Token: <your-app-token>' \
-H 'X-App-Access-Sig: <your-request-signature>' \
-H 'X-App-Access-Ts: <unix-timestamp>'Response explained
The response is a JSON file representing the list of notes with related metadata added to the case.
The following is the root-level argument:
| Field | Type | Description |
|---|---|---|
list | Object | Includes data with items, totalItems, pageInfo. |
list attributes
list attributesThe following table explains the list attributes.
| Field | Type | Description |
|---|---|---|
items | Array of objects | Each item is an object representing an individual note with its details. |
totalItems | Integer | Total number of the notes found. |
pageInfo | Object | Applied limit and offset settings. |
items element fields
items element fieldsThe following table explains the items element fields representing the note details.
| Field | Type | Description |
|---|---|---|
id | String | Unique identifier of the note. |
caseId | String | Unique identifier of the case 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:ssZZ. |
createdBy | String | Identifies the entity that created the note: Service if created by the system, or a personal identifier if created by an officer. |
attachments | Array of objects | An array where each object represents a file attached to the note. Returned only if at least one file is added to the note. |
tags | Array of strings | The tags assigned to the note. Returned only if at least one tag is present. |
attachments element fields
attachments element fieldsEach object in the attachments array represents a file attached to the note.
| Field | Type | Description |
|---|---|---|
id | String | Unique file identifier. |
fileName | String | File name. |
createdAt | Date | Date and time when the file was added, in the format yyyy-MM-dd HH:mm:ssZZ. |
createdBy | String | Identifies the officer who added the file. |
fileSize | Integer | File size. |
pageInfo attributes
pageInfo attributesThe following table explains the pageInfo attributes.
| Field | Type | Description |
|---|---|---|
limit | Integer | Applied to the response limit. |
offset | Integer | Applied to the response offset. |
Response examples
If the request is successfully sent and processed, you will get a response like the following:
{
"list": {
"items": [
{
"id": "69ccd56d9b24ddbbd2e0b864",
"caseId": "69cccf009b24ddbbd2e0b7c6",
"note": "Api test note.",
"createdAt": "2026-04-01 08:21:01+0000",
"createdBy": "Service"
},
{
"id": "69ccd5db9b24ddbbd2e0b884",
"caseId": "69cccf009b24ddbbd2e0b7c6",
"note": "Tag test note",
"createdAt": "2026-04-01 08:22:51+0000",
"createdBy": "Service",
"tags": [
"important_tag",
"test_tag"
]
},
{
"id": "69ccd5fb9b24ddbbd2e0b889",
"caseId": "69cccf009b24ddbbd2e0b7c6",
"note": "Api test note.",
"createdAt": "2026-04-01 08:23:23+0000",
"createdBy": "Service"
},
{
"id": "69ccd5fc9b24ddbbd2e0b88c",
"caseId": "69cccf009b24ddbbd2e0b7c6",
"note": "Api test note.",
"createdAt": "2026-04-01 08:23:24+0000",
"createdBy": "Service",
"attachments": [
{
"id": "69e7441d9b0334cdca8a000f",
"fileName": "file_name.png",
"createdAt": "2026-04-21 09:32:13+0000",
"createdBy": "[email protected]",
"fileSize": 25600
}
]
}
],
"totalItems": 4,
"pageInfo": {
"limit": 100,
"offset": 0
}
}
}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": "4ecb96fa0d2499ac553139286dd1877d",
"description": "HTTP 404 Not Found"
}If no notes have been added to the case, the response returns an empty items array:
{
"list": {
"items": [],
"totalItems": 0,
"pageInfo": {
"limit": 100,
"offset": 0
}
}
}