This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock
x-api-token: ********************{
"vaultId": "17962a14-8440-4160-93ef-3b789a76b171",
"name": "Example Envelope",
"privateDescription": "Private description of the envelope",
"publicDescription": "Public description of the envelope",
"message": "Message of the envelope",
"reviewReminder": true,
"expiresAtUtc": "2026-10-29T03:41:28.9226302Z",
"expirationReminder": true,
"toBePublishedAtUtc": "2026-09-30T03:41:28.9226316Z",
"language": "EnUs",
"markupOrientation": "Bottom",
"signInOrder": true,
"isAiChatForSignersEnabled": true,
"isLtvEnabled": true,
"redirectUrl": "https://example.com/callback",
"sealId": "3b8f1c2e-5a10-4d7b-9e21-0c4a6f8d2b01",
"signers": [
{
"name": "John Doe",
"email": "john.doe@example.com",
"emailCommunicationMode": "Full",
"title": "Lawyer",
"shouldEnforceEmailValidation": true,
"shouldEnforceSmsValidation": true,
"shouldEnforceWhatsAppValidation": true,
"shouldEnforcePixValidation": true,
"shouldEnforceCustomDigitalCertificateValidation": true,
"shouldEnforceSimpleSelfieValidation": true,
"shouldEnforceVerifiedSelfieValidation": true,
"shouldEnforceIdentityDocumentCapture": true,
"shouldEnforceFaceMatch": true,
"phoneIdd": 1,
"phoneNumber": "5555555555",
"smsCommunicationMode": "Full",
"whatsAppCommunicationMode": "Full",
"documentValue": "1234567890",
"shouldEnforcePasscodeValidation": true,
"passcode": "123456",
"passcodeHint": "1 to 6",
"signMarks": [
{
"type": "Rubric",
"documentId": "4481decd-3b0c-4b31-8031-06b9c16e7a70",
"page": 1,
"x": 100,
"y": 50,
"rotation": 0,
"width": 0,
"height": 0,
"isRequired": true,
"schemaJson": null
},
{
"type": "Signature",
"documentId": "4481decd-3b0c-4b31-8031-06b9c16e7a70",
"page": 2,
"x": 200,
"y": 50,
"rotation": 0,
"width": 0,
"height": 0,
"isRequired": true,
"schemaJson": null
}
]
}
],
"documents": [
{
"id": "4481decd-3b0c-4b31-8031-06b9c16e7a70",
"name": "Example Document",
"privateDescription": "Private description of the document",
"publicDescription": "Public description of the document",
"language": "EnUs",
"markupOrientation": "Bottom"
}
]
}curl --location 'https://api.signater.com/v1/ecm/envelopes' \
--header 'x-api-token: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
"vaultId": "17962a14-8440-4160-93ef-3b789a76b171",
"name": "Example Envelope",
"privateDescription": "Private description of the envelope",
"publicDescription": "Public description of the envelope",
"message": "Message of the envelope",
"reviewReminder": true,
"expiresAtUtc": "2026-10-29T03:41:28.9226302Z",
"expirationReminder": true,
"toBePublishedAtUtc": "2026-09-30T03:41:28.9226316Z",
"language": "EnUs",
"markupOrientation": "Bottom",
"signInOrder": true,
"isAiChatForSignersEnabled": true,
"isLtvEnabled": true,
"redirectUrl": "https://example.com/callback",
"sealId": "3b8f1c2e-5a10-4d7b-9e21-0c4a6f8d2b01",
"signers": [
{
"name": "John Doe",
"email": "john.doe@example.com",
"emailCommunicationMode": "Full",
"title": "Lawyer",
"shouldEnforceEmailValidation": true,
"shouldEnforceSmsValidation": true,
"shouldEnforceWhatsAppValidation": true,
"shouldEnforcePixValidation": true,
"shouldEnforceCustomDigitalCertificateValidation": true,
"shouldEnforceSimpleSelfieValidation": true,
"shouldEnforceVerifiedSelfieValidation": true,
"shouldEnforceIdentityDocumentCapture": true,
"shouldEnforceFaceMatch": true,
"phoneIdd": 1,
"phoneNumber": "5555555555",
"smsCommunicationMode": "Full",
"whatsAppCommunicationMode": "Full",
"documentValue": "1234567890",
"shouldEnforcePasscodeValidation": true,
"passcode": "123456",
"passcodeHint": "1 to 6",
"signMarks": [
{
"type": "Rubric",
"documentId": "4481decd-3b0c-4b31-8031-06b9c16e7a70",
"page": 1,
"x": 100,
"y": 50,
"rotation": 0,
"width": 0,
"height": 0,
"isRequired": true,
"schemaJson": null
},
{
"type": "Signature",
"documentId": "4481decd-3b0c-4b31-8031-06b9c16e7a70",
"page": 2,
"x": 200,
"y": 50,
"rotation": 0,
"width": 0,
"height": 0,
"isRequired": true,
"schemaJson": null
}
]
}
],
"documents": [
{
"id": "4481decd-3b0c-4b31-8031-06b9c16e7a70",
"name": "Example Document",
"privateDescription": "Private description of the document",
"publicDescription": "Public description of the document",
"language": "EnUs",
"markupOrientation": "Bottom"
}
]
}'{
"id": "97383280-5cfd-412c-9d12-a2a4d26deec1"
}