This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock
x-api-token: ********************curl --location --request GET 'https://api.signater.com/v1/ecm/envelopes/' \
--header 'x-api-token: <api-key>'{
"id": "eb5675fc-3c01-4f8e-91e6-5531ec565edf",
"createdAtUtc": "2025-11-03T00:13:31.7112681Z",
"createdById": "dee5545c-ca46-4346-83bc-773162a16759",
"createdByName": "John Doe",
"createdByAvatar": "https://example.com/avatar.jpg",
"updatedAtUtc": "2025-11-03T00:13:31.7112691Z",
"lastUpdateById": "97f1cb3a-aef2-484c-8868-35284d227680",
"updatedByName": "John Doe",
"updatedByAvatar": "https://example.com/avatar.jpg",
"ownerId": "e2045a89-0d24-4fe0-b8c4-169601f91561",
"ownerName": "John Doe",
"ownerAvatar": "https://example.com/avatar.jpg",
"language": "EnUs",
"markupOrientation": "Bottom",
"status": "Published",
"hasScheduledPublish": false,
"toBePublishedAtUtc": null,
"vaultId": "86fe02d4-82b9-4735-be98-ad41e0f983f4",
"vaultName": "Example Vault",
"name": "Example Envelope",
"privateDescription": "Private description",
"publicDescription": "Public description",
"message": "Message",
"reviewReminder": false,
"expiresAtUtc": null,
"expirationReminder": false,
"isRemoved": false,
"removedById": null,
"removedBy": null,
"removedAtUtc": null,
"signInOrder": false,
"certifiedAtUtc": null,
"isSandbox": false,
"hasActionsBeingProcessed": false,
"isAiChatForSignersEnabled": false,
"documents": [
{
"id": "cfb47a6e-161e-4da1-bcd8-837850f224a0",
"index": 0,
"origin": "Upload",
"name": "Example Document",
"privateDescription": "Private description",
"publicDescription": "Public description",
"pageSizes": [
{
"page": 1,
"width": 100,
"height": 100
}
]
}
],
"signers": [
{
"id": "05548a2d-e0a9-4c0b-bf3a-7e16a664c352",
"index": null,
"status": "ReadyToReview",
"hadApproved": false,
"approvedAtUtc": null,
"hadRejected": false,
"rejectedAtUtc": null,
"name": "John Doe",
"email": "john.doe@example.com",
"role": "Sign",
"title": "Title",
"passcode": "123456",
"passcodeHint": "1 to 6",
"phoneIdd": 1,
"phoneNumber": "123456789",
"documentType": "GenericIdentification",
"documentValue": "123456789",
"shouldEnforceSmsValidation": true,
"shouldEnforceWhatsAppValidation": true,
"shouldEnforcePixValidation": true,
"shouldEnforceGeolocationValidation": true,
"shouldEnforceCustomDigitalCertificateValidation": true,
"shouldEnforcePasscodeValidation": true,
"shouldEnforceEmailValidation": true,
"signMarks": [
{
"id": "2fe3f023-2150-4dc5-b656-aa60cdeeba43",
"documentId": "cfb47a6e-161e-4da1-bcd8-837850f224a0",
"type": "Signature",
"page": 1,
"x": 10,
"y": 10,
"rotation": 0
}
],
"actions": [
{
"id": "160f19ff-9dce-45f3-acf6-430d8761d409",
"createdAtUtc": "2025-11-03T00:10:31.7112767Z",
"type": "View",
"ip": "127.0.0.1",
"userAgent": "Mozilla/5.0",
"location": "New York, USA"
},
{
"id": "d3e1b7bc-8033-4bbb-8a19-bc33df33aab2",
"createdAtUtc": "2025-11-03T00:10:31.7112777Z",
"type": "EmailMfaRequest",
"ip": "127.0.0.1",
"userAgent": "Mozilla/5.0",
"location": "New York, USA"
}
]
}
]
}