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": "284cd9b0-4952-4c68-b076-dc8d8a23e21a",
"createdAtUtc": "2025-11-07T00:13:30.4895908Z",
"createdById": "b990823a-2708-43a4-8401-d58bb41e9719",
"createdByName": "John Doe",
"createdByAvatar": "https://example.com/avatar.jpg",
"updatedAtUtc": "2025-11-07T00:13:30.4895922Z",
"lastUpdateById": "69eef559-c0cf-429c-968e-89bd705d1536",
"updatedByName": "John Doe",
"updatedByAvatar": "https://example.com/avatar.jpg",
"ownerId": "7083a64a-ecef-4666-8957-4e238884f325",
"ownerName": "John Doe",
"ownerAvatar": "https://example.com/avatar.jpg",
"language": "EnUs",
"markupOrientation": "Bottom",
"status": "Published",
"hasScheduledPublish": false,
"toBePublishedAtUtc": null,
"vaultId": "106a1812-cd51-4ff2-add2-39a7d387a838",
"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": "1ee8b407-6365-4719-8626-548049320135",
"index": 0,
"origin": "Upload",
"name": "Example Document",
"privateDescription": "Private description",
"publicDescription": "Public description",
"pageSizes": [
{
"page": 1,
"width": 100,
"height": 100
}
]
}
],
"signers": [
{
"id": "f426a97f-0242-4b39-9e29-8d5517169cea",
"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,
"shouldEnforceCustomDigitalCertificateValidation": true,
"shouldEnforcePasscodeValidation": true,
"shouldEnforceEmailValidation": true,
"signMarks": [
{
"id": "f2df9f8e-62d9-4c03-a25e-3c2a5885cb01",
"documentId": "1ee8b407-6365-4719-8626-548049320135",
"type": "Signature",
"page": 1,
"x": 10,
"y": 10,
"rotation": 0
}
],
"actions": [
{
"id": "b5cc0e1f-15f4-43b4-b2c6-4a1cc3138d04",
"createdAtUtc": "2025-11-07T00:10:30.4896021Z",
"type": "View",
"ip": "127.0.0.1",
"userAgent": "Mozilla/5.0",
"location": "New York, USA"
},
{
"id": "745a80ae-bfaf-490f-9993-be1a84505cfb",
"createdAtUtc": "2025-11-07T00:10:30.4896034Z",
"type": "EmailMfaRequest",
"ip": "127.0.0.1",
"userAgent": "Mozilla/5.0",
"location": "New York, USA"
}
]
}
]
}