Signatures
Document Comment
Adds a text comment to a document that's part of an envelope.
- The document must be uploaded to the Storage system before you can comment on it.
- Use the documentId (a unique document URN) to reference the stored document.
- The document can be identified by a unique transactionId (tid).
- Provide the tid as a query parameter.
parentCommentIdis optional; if it doesn't reference an existing comment, the new comment is created as a top-level comment instead.
AuthorizationBearer <token>
JWT token to authenticate the request.
In: header
X-Api-Key<token>
API key, sent as a request header.
In: header
Path Parameters
documentId*string
The ID(URN) of the document from the envelope, where you'd like to place a comment.
Query Parameters
tid?string
Transaction token identifying a specific recipient+envelope pair. Required for anonymous/recipient access (no Authorization header, or the header doesn't resolve to the envelope owner).
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/signatures/document/string/comment" \ -H "Content-Type: application/json" \ -d '{ "comment": { "content": "Looks good, approved.", "pageNumber": 0, "positionX": 0, "positionY": 0, "parentCommentId": "336494c1-1838-4e1b-aa75-2bceaa96c675", "visibleTo": [ "string" ] }, "externalContext": {} }'{ "result": { "statusCode": 201, "message": "Created", "data": { "comments": {} } }, "origin": "POST https://api.doctavian.com/v1/signatures/document/{documentId}/comment", "dateTime": "2026-07-20T12:00:00.000Z", "externalContext": {}, "userId": "64b1a3da-0805-4794-b4b4-0f4fd431c081"}{ "error": { "message": "Envelope not found.", "statusCode": 400, "innerErrors": [ { "code": "ENVELOPE_ID_INVALID", "message": "Envelope not found.", "userMessage": "Envelope not found." } ] }, "origin": "POST https://api.doctavian.com/v1/signatures/document/{documentId}/comment", "dateTime": "2026-07-20T12:00:00.000Z", "userId": "d08ae9c2-048c-4dc2-bf6b-b58ca6293c5c", "operationId": "352290dd797f1acccc4eefdffb5fb46c"}{ "error": { "message": "Envelope not found.", "statusCode": 500, "innerErrors": [ { "code": "ENVELOPE_ID_INVALID", "message": "Envelope not found.", "userMessage": "Envelope not found." } ] }, "origin": "POST https://api.doctavian.com/v1/signatures/document/{documentId}/comment", "dateTime": "2026-07-20T12:00:00.000Z", "userId": "12baf209-22f1-46b8-b237-60e9187d252a", "operationId": "965dcd12be3ec47ebfb5060bb57fd564"}