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;'
{
"id": "2dd9e600-3498-4f0a-b2fc-cdeb588445ce",
"createdAtUtc": "2025-08-24T00:13:58.5878789Z",
"createdById": "580be31a-9453-4386-a0e1-bc2d0803f7cd",
"createdByName": "John Doe",
"createdByAvatar": "https://example.com/avatar.jpg",
"updatedAtUtc": "2025-08-24T00:13:58.58788Z",
"lastUpdateById": "f80ef482-962d-4972-86b0-54fc599c008f",
"updatedByName": "John Doe",
"updatedByAvatar": "https://example.com/avatar.jpg",
"ownerId": "5f309b7a-abe6-45cb-b2c8-9865111ebb48",
"ownerName": "John Doe",
"ownerAvatar": "https://example.com/avatar.jpg",
"language": "EnUs",
"markupOrientation": "Bottom",
"status": "Published",
"hasScheduledPublish": false,
"toBePublishedAtUtc": null,
"vaultId": "04fc6c65-2c7c-4cac-b35f-daae4c75d802",
"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,
"documents": [
{
"id": "3a9730b0-9916-4dc1-9773-a4c809ced24c",
"index": 0,
"origin": "Upload",
"name": "Example Document",
"privateDescription": "Private description",
"publicDescription": "Public description",
"pageSizes": [
{
"page": 1,
"width": 100,
"height": 100
}
]
}
],
"signers": [
{
"id": "de5eab21-4a25-4c5a-9e97-ff498c08532f",
"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": "1e0d62c1-0cee-4cef-9b9f-44c3911a7454",
"documentId": "3a9730b0-9916-4dc1-9773-a4c809ced24c",
"type": "Signature",
"page": 1,
"x": 10,
"y": 10,
"rotation": 0
}
],
"actions": [
{
"id": "689b29cf-9e68-4b65-8ea5-fb607be290fc",
"createdAtUtc": "2025-08-24T00:10:58.587888Z",
"type": "View",
"ip": "127.0.0.1",
"userAgent": "Mozilla/5.0",
"location": "New York, USA"
},
{
"id": "d76dc12e-b355-4115-9f4e-30f0571b16f7",
"createdAtUtc": "2025-08-24T00:10:58.5878889Z",
"type": "EmailMfaRequest",
"ip": "127.0.0.1",
"userAgent": "Mozilla/5.0",
"location": "New York, USA"
}
]
}
]
}