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": "18e29372-c85a-448f-83be-b9c8baaae29a",
"createdAtUtc": "2025-09-19T00:12:01.5325404Z",
"createdById": "af4ef18b-6790-4c2f-a35d-520caeb3143e",
"createdByName": "John Doe",
"createdByAvatar": "https://example.com/avatar.jpg",
"updatedAtUtc": "2025-09-19T00:12:01.5325422Z",
"lastUpdateById": "a51507af-2851-40c1-acc6-dd31e067de74",
"updatedByName": "John Doe",
"updatedByAvatar": "https://example.com/avatar.jpg",
"ownerId": "3d7c37bf-b0b1-49dc-95f4-333562bdffc6",
"ownerName": "John Doe",
"ownerAvatar": "https://example.com/avatar.jpg",
"language": "EnUs",
"markupOrientation": "Bottom",
"status": "Published",
"hasScheduledPublish": false,
"toBePublishedAtUtc": null,
"vaultId": "de679c30-9345-42dd-bb12-86af0d6f8d4a",
"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": "aed76b27-227d-4f8a-b828-defd4fb53314",
"index": 0,
"origin": "Upload",
"name": "Example Document",
"privateDescription": "Private description",
"publicDescription": "Public description",
"pageSizes": [
{
"page": 1,
"width": 100,
"height": 100
}
]
}
],
"signers": [
{
"id": "75219b42-bcab-4f6a-89e0-5262d1480291",
"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,
"shouldAllowCustomDigitalCertificateValidation": true,
"shouldEnforceCustomDigitalCertificateValidation": true,
"shouldEnforcePasscodeValidation": true,
"shouldEnforceEmailValidation": true,
"signMarks": [
{
"id": "543b4bc1-0659-4c2e-aace-c393e98a7c80",
"documentId": "aed76b27-227d-4f8a-b828-defd4fb53314",
"type": "Signature",
"page": 1,
"x": 10,
"y": 10,
"rotation": 0
}
],
"actions": [
{
"id": "b00c8af4-cb78-4ed6-8c53-fb00eb5bff95",
"createdAtUtc": "2025-09-19T00:09:01.532555Z",
"type": "View",
"ip": "127.0.0.1",
"userAgent": "Mozilla/5.0",
"location": "New York, USA"
},
{
"id": "5c0619d8-ff78-40db-8120-c30cc77adc86",
"createdAtUtc": "2025-09-19T00:09:01.5325569Z",
"type": "EmailMfaRequest",
"ip": "127.0.0.1",
"userAgent": "Mozilla/5.0",
"location": "New York, USA"
}
]
}
]
}