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": "2a4a1e0b-ddfd-4859-9bf3-7e8f94337495",
"createdAtUtc": "2026-05-24T00:35:39.7454269Z",
"createdById": "0312d759-e97d-4453-a6ef-4d61cd832fc9",
"createdByName": "John Doe",
"createdByAvatar": "https://example.com/avatar.jpg",
"updatedAtUtc": "2026-05-24T00:35:39.7454278Z",
"lastUpdateById": "196e8398-8311-47a2-bce9-cb473eccf3ae",
"updatedByName": "John Doe",
"updatedByAvatar": "https://example.com/avatar.jpg",
"ownerId": "e7d60506-c742-407a-998d-7658b446fb7f",
"ownerName": "John Doe",
"ownerAvatar": "https://example.com/avatar.jpg",
"language": "EnUs",
"markupOrientation": "Bottom",
"status": "Published",
"hasScheduledPublish": false,
"toBePublishedAtUtc": null,
"vaultId": "bfe5c27a-b863-4604-87ba-351f6d5ae4d2",
"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": "847c8090-09a9-4d73-a02b-e28678c902be",
"index": 0,
"origin": "Upload",
"name": "Example Document",
"privateDescription": "Private description",
"publicDescription": "Public description",
"originalFileSize": 0,
"pageSizes": [
{
"page": 1,
"width": 100,
"height": 100
}
]
}
],
"signers": [
{
"id": "a1821bb7-5fa9-4604-927f-b7f5cf68bedf",
"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": "60ea87cb-ce95-43ee-b7f0-82f38425199f",
"documentId": "847c8090-09a9-4d73-a02b-e28678c902be",
"type": "Signature",
"page": 1,
"x": 10,
"y": 10,
"rotation": 0,
"width": 0,
"height": 0,
"isRequired": false,
"schemaJson": null,
"valueJson": null
}
],
"actions": [
{
"id": "606b4804-1757-4f3c-b742-0ddc09e91ee1",
"createdAtUtc": "2026-05-24T00:32:39.7454343Z",
"type": "View",
"ip": "127.0.0.1",
"userAgent": "Mozilla/5.0",
"location": "New York, USA",
"signMarkId": null,
"signMarkType": null,
"signMarkSchemaJson": null,
"valueJson": null
},
{
"id": "76e5c863-bf0a-4f6e-a26b-342e7d93d812",
"createdAtUtc": "2026-05-24T00:32:39.7454353Z",
"type": "EmailMfaRequest",
"ip": "127.0.0.1",
"userAgent": "Mozilla/5.0",
"location": "New York, USA",
"signMarkId": null,
"signMarkType": null,
"signMarkSchemaJson": null,
"valueJson": null
}
]
}
]
}