Signatures
Envelope Get
Retrieves details of a specific envelope in JSON format.
- The envelope is identified using the envelopeId path parameter.
- Secure access is ensured via the transactionId (tid) query parameter, restricting visibility to authorized recipients. The tid can be obtained from the GET /signatures/envelope/list endpoint.
- This endpoint is available to the envelope's owner (via standard authentication) or to a recipient presenting a valid tid.
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
envelopeId*string
The ID of the needed envelope.
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/string/get"{ "result": { "statusCode": 200, "message": "OK", "data": { "envelope": { "id": "376ac86f-f09d-4200-ab2c-53710a3ec415", "createdBy": { "id": "bce58553-cab5-44a8-b9fe-0cc87c1d00c2", "name": "Acme Corp Agreement.pdf", "email": "name@example.com" }, "uploadDate": "string", "sendDate": "string", "status": "Draft", "subject": "Please review and sign", "message": "Thank you for completing this document.", "isSignOrder": true, "expireInDays": 0, "firstReminderDays": 0, "repeatingReminderDays": 0, "notifyWhenOpened": true, "notifyWhenSigned": true, "alertDaysBeforeExpiry": 0, "locale": "en-GB", "timezone": "America/New_York" }, "documents": [ { "id": "c5a51ded-be70-4660-a577-2facd9be153f", "name": "Q3 Sales Report.pdf", "externalContext": {} } ], "originalDocuments": [ { "id": "756547dd-137b-4a3d-b8f4-a8f9c97b9caf", "referenceDocumentId": "1f09e2c8-a249-447f-bfd2-dd5932174275", "name": "Q3 Sales Report.pdf" } ], "recipients": [ { "id": "9059594b-d536-436f-91eb-4b86091f652d", "name": "Jane Doe", "email": "name@example.com", "role": "signer", "status": "Signed", "signDate": "string", "signOrder": 0, "signGroupId": "32f3313c-58fd-483a-b4d6-05e4c52b7220", "userId": "00ed0b21-b09c-492e-85aa-61ffa05b71ee", "mandatory": true, "hostEmail": "name@example.com", "isMFAEnabled": true, "phoneNumber": "+1-555-0134", "externalContext": {} } ], "signGroups": [ { "id": "4749dd87-727f-4632-9f9c-f882eac48561", "name": "John Smith", "role": "signer", "status": "Completed", "signOrder": 0, "mandatory": true } ], "fields": [ { "id": "7324d6a3-420c-4d5a-b1ae-5b6d1aa9da92", "name": "Full Name Field", "recipientId": "9981289b-03e4-4833-b48c-f308f43a08df", "signGroupId": "d34ea0d6-9027-4d3f-a96f-add7a05b3f92", "documentId": "ba72d47b-5750-4eee-a591-cb60edb09194", "type": "signature", "value": "Approved", "page": 0, "height": 0, "width": 0, "positionX": 0, "positionY": 0, "tooltip": "Sign here", "isRequired": true, "properties": { "fontFamily": "Arial", "fontSize": 0, "color": "#1a1a1a", "bold": true, "italic": true, "underline": true, "textAlign": "right", "placeholder": "Type here", "isSignedDate": true, "selectionGroup": "group2", "selectionValue": "Option B" }, "signerInfo": {} } ], "comments": {}, "settings": [ {} ], "externalContext": {} } }, "origin": "GET https://api.doctavian.com/v1/signatures/envelope/{envelopeId}/get", "dateTime": "2026-07-20T12:00:00.000Z", "externalContext": {}, "userId": "401c3812-db63-4793-8fa7-7bc6a018b0cb"}{ "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/{envelopeId}/get", "dateTime": "2026-07-20T12:00:00.000Z", "userId": "1add0a7d-1b2c-492c-b0b9-d470087ad52f", "operationId": "a365e598d9a7605229cea9b03cfbd7c7"}{ "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/{envelopeId}/get", "dateTime": "2026-07-20T12:00:00.000Z", "userId": "4dcadc22-b1e7-4165-b91e-c2b9e3b4265a", "operationId": "ca47beef60c943e50c5059cd3ed8c3ae"}