Time	Status	User Agent
Retrieving recent requests…

Time

Status

User Agent

Retrieving recent requests…

Overview

Use this method to edit an existing transaction note.

📘
Note
To add a new note to the particular transaction, use this method.

Request example

curl -X PATCH \
     'https://api.sumsub.com/resources/kyt/txns/notes' \
     -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 '{
            "txnId": "66c46d7566f5244e45a81167",
            "id": "66cf0fcec9ba855902121cf7",
            "note": "Updated text of the note"
          }'

Response explained

The response is a JSON file representing the details of the updated note.

The following table explains the response attributes.

Field	Type	Description
`id`	String	Note identifier. You may need it in case you want to edit or remove the note .
`txnId`	String	Unique transaction identifier in the Sumsub system.
`note`	String	Text of the note that was added to the transaction.
`createdAt`	Date	Date and time when the note was added.
`createdBy`	Date	Identifier of the note author.

Response examples

If the request is sent and processed successfully, you will receive a response like the following:

{
  "id": "66cf0fcec9ba855902121cf7",
  "txnId": "66c46d7566f5244e45a81167",
  "note": "Updated text of the note",
  "createdAt": "2024-08-28 11:53:50+0000",
  "createdBy": "service-prd-XXXDYWTFWAQXXX-app-name lastname"
}

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

{
  "description": "Malformed data provided in the request",
  "code": 400,
  "correlationId": "f08a5c47fbb49289bb1c8116a296ddf5"
}