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": "c8fe28a7-dba2-4e29-85ff-cfce5be5a517",
"createdAtUtc": "2026-08-21T00:54:59.8857163Z",
"createdById": "9a53b3e2-9210-4bc1-9fef-6224cc2887ac",
"createdByName": "John Doe",
"createdByAvatar": "https://example.com/avatar.jpg",
"updatedAtUtc": "2026-08-21T00:54:59.8857175Z",
"lastUpdateById": "53c9e84d-6644-4ac8-b66a-6e6b6954f56e",
"updatedByName": "John Doe",
"updatedByAvatar": "https://example.com/avatar.jpg",
"ownerId": "753189bb-1634-42db-9655-95fbe52c1a27",
"ownerName": "John Doe",
"ownerAvatar": "https://example.com/avatar.jpg",
"language": "EnUs",
"markupOrientation": "Bottom",
"status": "Published",
"hasScheduledPublish": false,
"toBePublishedAtUtc": null,
"vaultId": "58e18cd1-a54e-4915-b6f4-d11352729a3f",
"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,
"jurisdictionCountryCode": null,
"documents": [
{
"id": "e18458e6-bbd0-443f-a130-d5cdfc0e020e",
"index": 0,
"origin": "Upload",
"name": "Example Document",
"privateDescription": "Private description",
"publicDescription": "Public description",
"originalFileSize": 0,
"pageSizes": [
{
"page": 1,
"width": 100,
"height": 100
}
]
}
],
"signers": [
{
"id": "f79a100f-0535-4e00-9293-0fc090cfa126",
"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": "22db71d2-8903-44f8-a583-6d4c0ac5f092",
"documentId": "e18458e6-bbd0-443f-a130-d5cdfc0e020e",
"type": "Signature",
"page": 1,
"x": 10,
"y": 10,
"rotation": 0,
"width": 0,
"height": 0,
"isRequired": false,
"schemaJson": null,
"valueJson": null
}
],
"actions": [
{
"id": "4ed66efa-38c8-41ab-92f7-0af2f171d7cf",
"createdAtUtc": "2026-08-21T00:51:59.8857251Z",
"type": "View",
"ip": "127.0.0.1",
"userAgent": "Mozilla/5.0",
"location": "New York, USA",
"signMarkId": null,
"signMarkType": null,
"signMarkSchemaJson": null,
"valueJson": null
},
{
"id": "58c6e993-615b-426e-9992-349c9235e73f",
"createdAtUtc": "2026-08-21T00:51:59.8857267Z",
"type": "EmailMfaRequest",
"ip": "127.0.0.1",
"userAgent": "Mozilla/5.0",
"location": "New York, USA",
"signMarkId": null,
"signMarkType": null,
"signMarkSchemaJson": null,
"valueJson": null
}
]
}
]
}