v1

latestOpenAPI 3.1.02026-07-2685154311.7 KB

Transfers

Add a comment to a transfer

Appends a free-form note to a transfer. Comments are scoped to the writing entity and are not shared with the counterparty.

post/entities/{entityDID}/tx/{transferId}/comments

Path parameters

entityDIDstring did required

Decentralized Identifier (DID)

Example:did:web:vasps.id:jxnl0411:at

The DID of the entity

transferIdstring uuid required

Example:01f09c55-9de0-42c5-874f-237dcb51fd9f

The transfer ID

Request body

textstring required

The body of the comment

Example request

{
  "text": "We looked into this. All good on our side."
}

Response

Comment created

idstring uuid required

The id of the created comment event

actorstring required

Identifier of the actor that created the comment

textstring required

occurredAtstring required

ISO-8601 timestamp the comment was recorded at

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "actor": "user:john@example.com",
  "text": "We looked into this. All good on our side.",
  "occurredAt": "2026-04-30T12:00:00.000Z"
}