get https://api.sumsub.com/resources/api/applicants/notes
Overview
Use this method to retrieve all the notes added to the applicant profile.
Request example
curl -X GET \
'https://api.sumsub.com/resources/api/applicants/notes?applicantId=687fb2373fc85ad66b5d6777'
Response explained
The response is a JSON file representing the list of notes added to the applicant profile.
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 that represents a note with its associated details. |
totalItems | Integer | Total number of the found notes. |
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 | Note identifier. You may need it in case you want to edit a note, remove a note, or add an attachment. |
applicantId | String | Unique applicant identifier in the Sumsub system (applicantId).This identifier is a random combination of 24 digits and lowercase Latin characters. It is automatically generated when the applicant profile is created on the Sumsub side. |
note | String | Text of the note. |
createdAt | Date | Date and time when the note was added. |
createdBy | Date | Identifier of the note author. |
tags | Array of strings | Tags assigned to the note. |
attachments | Array of objects | Contains information about attached files. |
attachments element fields
attachments element fieldsThe following table explains the attachments element fields representing information about attached files.
| Field | Type | Description |
|---|---|---|
id | String | Identifier of the attached file. |
fileName | String | Name of the file. |
createdAt | Date | Date and time when the file was attached. |
createdBy | Date | Identifier of the attachment author. |
fileSize | Integer | Image file size (in bytes). |
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 sent and processed successfully, you will receive a response like the following:
{
"list": {
"items": [
{
"id": "68938af6ac933039513fdd97",
"applicantId": "687fb2373fc85ad66b5d6244",
"note": "note example 1",
"createdAt": "2025-08-06 17:03:50+0000",
"createdBy": "example_user"
},
{
"id": "6893925cff736e92c020acaa",
"applicantId": "687fb2373fc85ad66b5d6244",
"note": "note example 2",
"createdAt": "2025-08-06 17:35:24+0000",
"createdBy": "example_user",
"tags": [
"First tag",
"Second tag"
]
},
{
"id": "689326431a0a280674b311ca",
"applicantId": "687fb2373fc85ad66b5d6244",
"note": "note example 3",
"createdAt": "2025-08-06 09:54:11+0000",
"createdBy": "example_user",
"tags": [
"First tag",
"Second tag"
],
"attachments": [
{
"id": "6893a5c660e0659e03327608",
"fileName": "example_image.png",
"createdAt": "2025-08-06 18:58:14+0000",
"createdBy": "example_user",
"fileSize": 733158
}
]
}
],
"totalItems": 3,
"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": 400,
"description": "limit must be greater than zero",
"correlationId": "955bce80ffb06f470d4bd7665f02f2df"
}