Signatures
Envelope Open
Opens a sent envelope as a recipient to view or sign documents.
- The envelope is identified using the transactionId (tid) query parameter, which can be obtained from the GET /signatures/envelope/list endpoint. tid is effectively required even for a logged-in caller, because the server always resolves a transaction token as part of authorization on this operation.
AuthorizationBearer <token>
JWT token to authenticate the request.
In: header
X-Api-Key<token>
API key, sent as a request header.
In: header
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
uuidResponse Body
application/json
application/json
application/json
curl -X GET "https://example.com/signatures/envelope/open"{ "result": { "statusCode": 200, "message": "OK", "data": { "envelope": { "id": "f630ef0b-7c83-43b0-b2ca-19cffeeeda96", "createdBy": { "id": "eb024905-3d7a-4628-9161-b93d34931683", "name": "Jane Doe", "email": "name@example.com" }, "subject": "Q3 vendor agreement", "message": "Thank you for completing this document.", "senderName": "Jane Doe", "senderEmail": "name@example.com", "status": "Completed", "notifyWhenOpened": true, "notifyWhenSigned": true, "isSignOrder": true, "expireInDays": 0, "uploadDate": "string", "sendDate": "string", "locale": "en-US", "timezone": "Europe/London" }, "documents": [ { "id": "92c44f73-fbd9-46c1-a637-10eb53b0d384", "name": "NDA Agreement.pdf" } ], "recipients": [ { "id": "076c7a98-368a-45dc-a8a1-30a3537d14e8", "name": "John Smith", "email": "name@example.com", "role": "signer", "status": "Delivered", "signDate": "string", "signOrder": 0, "signGroupId": "e70db552-95dd-4244-b556-4924e87125d4", "userId": "e9fa41a5-5cb1-4c73-9235-b4b4b10c725d", "mandatory": true, "hostEmail": "name@example.com" } ], "signGroups": [ { "id": "c7eb110f-6ebc-4539-b9f6-6228fce5c030", "name": "Jane Doe", "role": "signer", "status": "Completed", "signOrder": 0, "mandatory": true } ], "fields": [ { "id": "ddf260a9-99f2-4c1f-bf48-7f28fde6f0d1", "name": "Full Name Field", "recipientId": "769d5671-ca7f-4ac8-b111-64e8c237ee62", "signGroupId": "44bd7a99-f0e0-4e32-a048-406e248781ec", "documentId": "cd6637fa-e720-476d-8a67-de5b190c4cb9", "type": "signature", "value": "Jane Doe", "page": 0, "height": 0, "width": 0, "positionX": 0, "positionY": 0, "tooltip": "Enter your full name", "isRequired": true, "properties": { "fontFamily": "Arial", "fontSize": 0, "color": "#000000", "bold": true, "italic": true, "underline": true, "textAlign": "right", "placeholder": "Type here", "isSignedDate": true, "selectionGroup": "group2", "selectionValue": "Option A" }, "signerInfo": {} } ], "attachments": [ { "name": "Q3 Sales Report.pdf", "urn": "string", "mimeType": "application/pdf", "documentId": "6fe47ab3-c148-429e-8a10-7efadffc824c" } ], "signer": "256e09c6-074d-4581-aa12-0be470254df2", "comments": {}, "savedSignatures": [ { "id": "b0c1a28d-7149-4af0-8f0f-2f84656b54fe", "data": "string", "isDefault": true } ], "settings": [ {} ] } }, "origin": "GET https://api.doctavian.com/v1/signatures/envelope/open", "dateTime": "2026-07-20T12:00:00.000Z", "userId": "0b266565-8229-4c60-8da4-1fb93b179e82"}{ "error": { "message": "Envelope not found.", "statusCode": 400, "innerErrors": [ { "code": "ENVELOPE_ID_INVALID", "message": "Envelope not found.", "userMessage": "Envelope not found." } ] }, "origin": "GET https://api.doctavian.com/v1/signatures/envelope/open", "dateTime": "2026-07-20T12:00:00.000Z", "userId": "add6dc00-676c-498c-8546-0007069c302d", "operationId": "357563311da775cf6d588b6bf5f71b6b"}{ "error": { "message": "Envelope not found.", "statusCode": 500, "innerErrors": [ { "code": "ENVELOPE_ID_INVALID", "message": "Envelope not found.", "userMessage": "Envelope not found." } ] }, "origin": "GET https://api.doctavian.com/v1/signatures/envelope/open", "dateTime": "2026-07-20T12:00:00.000Z", "userId": "37745ba5-897f-401f-a48b-83e3e29b3ada", "operationId": "6a5efc0dc978d510d676f8602e4fa5a4"}