This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock
x-api-token: ********************curl --location 'https://api.signater.com/v1/ecm/envelopes/' \
--header 'x-api-token: <api-key>'{
"id": "53d1e121-faf4-4882-ae15-8ae69f78a660",
"createdAtUtc": "2026-05-20T00:37:59.8720338Z",
"createdById": "0c72d03b-2cdf-4984-abcb-ebb2369e03c1",
"createdByName": "John Doe",
"createdByAvatar": "https://example.com/avatar.jpg",
"updatedAtUtc": "2026-05-20T00:37:59.8720348Z",
"lastUpdateById": "bf7c85e3-c6d2-460f-8608-141445f8785f",
"updatedByName": "John Doe",
"updatedByAvatar": "https://example.com/avatar.jpg",
"ownerId": "bd1cefcc-b768-46ce-a588-2a0c38fe73ec",
"ownerName": "John Doe",
"ownerAvatar": "https://example.com/avatar.jpg",
"language": "EnUs",
"markupOrientation": "Bottom",
"status": "Published",
"hasScheduledPublish": false,
"toBePublishedAtUtc": null,
"vaultId": "b111eb85-69f5-4027-a528-de2b51792e25",
"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,
"redirectUrl": null,
"documents": [
{
"id": "511a02ab-8498-4fd8-a604-80cbb8eea1cd",
"index": 0,
"origin": "Upload",
"name": "Example Document",
"privateDescription": "Private description",
"publicDescription": "Public description",
"originalFileSize": 0,
"pageSizes": [
{
"page": 1,
"width": 100,
"height": 100
}
]
}
],
"signers": [
{
"id": "eea904ea-8d95-4eee-ad71-8f6a1a3e0c0f",
"index": null,
"status": "ReadyToReview",
"hadApproved": false,
"approvedAtUtc": null,
"hadRejected": false,
"rejectedAtUtc": null,
"name": "John Doe",
"email": "john.doe@example.com",
"title": "Title",
"passcode": "123456",
"passcodeHint": "1 to 6",
"phoneIdd": 1,
"phoneNumber": "123456789",
"documentType": "GenericIdentification",
"documentValue": "123456789",
"shouldEnforceSmsValidation": true,
"shouldEnforceWhatsAppValidation": true,
"shouldEnforcePixValidation": true,
"shouldEnforceCustomDigitalCertificateValidation": true,
"shouldEnforcePasscodeValidation": true,
"shouldEnforceEmailValidation": true,
"shouldEnforceSimpleSelfieValidation": true,
"emailCommunicationMode": "Full",
"smsCommunicationMode": "Full",
"whatsAppCommunicationMode": "Full",
"signMarks": [
{
"id": "274023b6-1b60-4f6f-9ebb-6ce72b2903cd",
"documentId": "511a02ab-8498-4fd8-a604-80cbb8eea1cd",
"type": "Signature",
"page": 1,
"x": 10,
"y": 10,
"rotation": 0,
"width": 0,
"height": 0,
"isRequired": false,
"schemaJson": null,
"valueJson": null
}
],
"actions": [
{
"id": "4a5c4626-3e07-4a31-922f-cb8cfcd1e0a0",
"createdAtUtc": "2026-05-20T00:34:59.8720422Z",
"type": "View",
"ip": "127.0.0.1",
"userAgent": "Mozilla/5.0",
"location": "New York, USA",
"signMarkId": null,
"signMarkType": null,
"signMarkSchemaJson": null,
"valueJson": null
},
{
"id": "8a3d90d4-e4d4-4a3b-aca4-44311f60659c",
"createdAtUtc": "2026-05-20T00:34:59.8720433Z",
"type": "EmailMfaRequest",
"ip": "127.0.0.1",
"userAgent": "Mozilla/5.0",
"location": "New York, USA",
"signMarkId": null,
"signMarkType": null,
"signMarkSchemaJson": null,
"valueJson": null
}
]
}
]
}