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": "string", "createdBy": { "id": "string", "name": "string", "email": "string" }, "uploadDate": "string", "sendDate": "string", "status": "Draft", "subject": "string", "message": "string", "isSignOrder": true, "expireInDays": 0, "firstReminderDays": 0, "repeatingReminderDays": 0, "notifyWhenOpened": true, "notifyWhenSigned": true, "alertDaysBeforeExpiry": 0, "locale": "string", "timezone": "string" }, "documents": [ { "id": "string", "name": "string", "externalContext": {} } ], "originalDocuments": [ { "id": "string", "referenceDocumentId": "string", "name": "string" } ], "recipients": [ { "id": "string", "name": "string", "email": "string", "role": "signer", "status": "string", "signDate": "string", "signOrder": 0, "signGroupId": "string", "userId": "string", "mandatory": true, "hostEmail": "string", "isMFAEnabled": true, "phoneNumber": "string", "externalContext": {} } ], "signGroups": [ { "id": "string", "name": "string", "role": "signer", "status": "string", "signOrder": 0, "mandatory": true } ], "fields": [ { "id": "string", "name": "string", "recipientId": "string", "signGroupId": "string", "documentId": "string", "type": "signature", "value": "string", "page": 0, "height": 0, "width": 0, "positionX": 0, "positionY": 0, "tooltip": "string", "isRequired": true, "properties": { "fontFamily": "string", "fontSize": 0, "color": "string", "bold": true, "italic": true, "underline": true, "textAlign": "string", "placeholder": "string", "isSignedDate": true, "selectionGroup": "string", "selectionValue": "string" }, "signerInfo": {} } ], "comments": {}, "settings": [ {} ], "externalContext": {} } }, "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"}