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
uuidHeader Parameters
X-Origin-IpAddress?string
Caller IP address, recorded in the audit trail. Not validated.
Request 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": "string", "pageNumber": 0, "positionX": 0, "positionY": 0, "parentCommentId": "string", "visibleTo": [ "string" ] }, "externalContext": {} }'{ "result": { "statusCode": 201, "message": "Created", "data": { "comments": {} } }, "origin": "string", "dateTime": "string", "externalContext": {}}{ "error": { "message": "Envelope not found.", "statusCode": 400, "innerErrors": [ { "code": "ENVELOPE_ID_INVALID", "message": "Envelope not found.", "userMessage": "Envelope not found." } ] }, "origin": "POST https://apim-mavenheadless-dev-westeu-1.azure-api.net/v1/signatures/envelope/create", "dateTime": "2026-07-20T12:00:00.0000000+00:00"}{ "error": { "message": "Envelope not found.", "statusCode": 400, "innerErrors": [ { "code": "ENVELOPE_ID_INVALID", "message": "Envelope not found.", "userMessage": "Envelope not found." } ] }, "origin": "POST https://apim-mavenheadless-dev-westeu-1.azure-api.net/v1/signatures/envelope/create", "dateTime": "2026-07-20T12:00:00.0000000+00:00"}