patch https://api.sumsub.com/resources/api/applicants/notes
Overview
Use this method to edit an existing note in the applicant profile.
Info
- To add a new note to the applicant profile, use this method.
- To add an attachment to the note use this method.
- To remove an attachment from the note use this method.
Request example
curl -X PATCH \
'https://api.sumsub.com/resources/api/applicants/notes' \
-H 'content-type: application/json' \
-d '{
"id": "6893925cff736e92c020acaa",
"applicantId": "687fb2373fc85ad66b5d6244",
"note": "This is an updated example note",
"tags": [
"First tag",
"Second tag"
]
}'
Response explained
The response is a JSON file representing the note details. The following tables explain the response attributes.
| 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). |
Response examples
If the request is sent and processed successfully, you will receive a response like the following:
{
"id": "6893925cff736e92c020acaa",
"applicantId": "687fb2373fc85ad66b5d6244",
"note": "This is an updated example note",
"createdAt": "2025-08-07 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": 400,
"description": "note must not be null",
"correlationId": "f23e05c9f1a0aa2beb83065f98dc0544"
}