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": "37247ae8-8f82-4548-84ee-c08a3143744e",
"createdAtUtc": "2026-10-05T03:30:44.446544Z",
"createdById": "a62db769-a0f1-4359-b2d3-6d082c89a204",
"createdByName": "John Doe",
"createdByAvatar": "https://example.com/avatar.jpg",
"updatedAtUtc": "2026-10-05T03:30:44.4465446Z",
"lastUpdateById": "358f21f8-a1ec-47ef-8f8d-94f69f5043b3",
"updatedByName": "John Doe",
"updatedByAvatar": "https://example.com/avatar.jpg",
"ownerId": "cce92aa6-fbf8-4984-8281-e47b582dc614",
"ownerName": "John Doe",
"ownerAvatar": "https://example.com/avatar.jpg",
"language": "EnUs",
"markupOrientation": "Bottom",
"status": "Published",
"hasScheduledPublish": false,
"toBePublishedAtUtc": null,
"vaultId": "5f2fc932-0de5-4397-ad84-2357877a091d",
"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,
"isLtvEnabled": true,
"redirectUrl": null,
"seal": null,
"documents": [
{
"id": "4601e7a9-2d52-42e4-8852-f63a0c1bf91b",
"index": 0,
"origin": "Upload",
"name": "Example Document",
"privateDescription": "Private description",
"publicDescription": "Public description",
"originalFileSize": 0,
"pageSizes": [
{
"page": 1,
"width": 100,
"height": 100
}
]
}
],
"signers": [
{
"id": "afc3acac-6932-47ac-9641-d483f06a4c80",
"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",
"documentValue": "123456789",
"shouldEnforceSmsValidation": true,
"shouldEnforceWhatsAppValidation": true,
"shouldEnforcePixValidation": true,
"shouldEnforceCustomDigitalCertificateValidation": true,
"shouldEnforcePasscodeValidation": true,
"shouldEnforceEmailValidation": true,
"shouldEnforceSimpleSelfieValidation": true,
"shouldEnforceVerifiedSelfieValidation": true,
"shouldEnforceIdentityDocumentCapture": true,
"shouldEnforceFaceMatch": true,
"emailCommunicationMode": "Full",
"smsCommunicationMode": "Full",
"whatsAppCommunicationMode": "Full",
"signMarks": [
{
"id": "4af1f6b7-258d-45ed-9298-d2fd6a8404a7",
"documentId": "4601e7a9-2d52-42e4-8852-f63a0c1bf91b",
"type": "Signature",
"page": 1,
"x": 10,
"y": 10,
"rotation": 0,
"width": 0,
"height": 0,
"isRequired": false,
"schemaJson": null,
"valueJson": null
}
],
"actions": [
{
"id": "7861a181-f783-4c5d-8171-e7865dba5277",
"createdAtUtc": "2026-10-05T03:27:44.4465488Z",
"type": "View",
"ip": "127.0.0.1",
"userAgent": "Mozilla/5.0",
"location": "New York, USA",
"signMarkId": null,
"signMarkType": null,
"signMarkSchemaJson": null,
"valueJson": null
},
{
"id": "48af37d9-b9f5-490a-bb29-de5e2a003856",
"createdAtUtc": "2026-10-05T03:27:44.4465495Z",
"type": "EmailMfaRequest",
"ip": "127.0.0.1",
"userAgent": "Mozilla/5.0",
"location": "New York, USA",
"signMarkId": null,
"signMarkType": null,
"signMarkSchemaJson": null,
"valueJson": null
}
]
}
]
}