This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock
x-api-token: ********************
{
"vaultId": "fa821124-78e0-489b-93d1-42ae89efe109",
"name": "Example Envelope",
"privateDescription": "Private description of the envelope",
"publicDescription": "Public description of the envelope",
"message": "Message of the envelope",
"reviewReminder": true,
"expiresAtUtc": "2025-10-17T00:11:51.1310515Z",
"expirationReminder": true,
"toBePublishedAtUtc": "2025-09-18T00:11:51.1310527Z",
"language": "EnUs",
"markupOrientation": "Bottom",
"signInOrder": true,
"isAiChatForSignersEnabled": true,
"signers": [
{
"id": "b248c2f1-9c0f-4893-b0c0-4d0f417e5182",
"name": "John Doe",
"email": "john.doe@example.com",
"allowEmailCommunication": false,
"role": "Sign",
"title": "Lawyer",
"shouldEnforceEmailValidation": true,
"shouldEnforceSmsValidation": true,
"shouldEnforceWhatsAppValidation": true,
"shouldEnforcePixValidation": true,
"shouldEnforceGeolocationValidation": true,
"shouldAllowCustomDigitalCertificateValidation": true,
"shouldEnforceCustomDigitalCertificateValidation": true,
"phoneIdd": 1,
"phoneNumber": "5555555555",
"allowPhoneSmsCommunication": false,
"allowPhoneWhatsAppCommunication": false,
"documentType": "GenericIdentification",
"documentValue": "1234567890",
"shouldEnforcePasscodeValidation": true,
"passcode": "123456",
"passcodeHint": "1 to 6",
"signMarks": [
{
"id": "f891bec3-d48d-4755-9f12-47c998fe83c1",
"type": "Rubric",
"documentId": "d18acdb1-78cc-4502-8c0a-d15adaca701b",
"page": 1,
"x": 150,
"y": 50,
"rotation": 0
},
{
"id": null,
"type": "Signature",
"documentId": "d18acdb1-78cc-4502-8c0a-d15adaca701b",
"page": 2,
"x": 200,
"y": 50,
"rotation": 0
}
]
}
],
"documents": [
{
"id": "d18acdb1-78cc-4502-8c0a-d15adaca701b",
"name": "Example Document",
"privateDescription": "Private description of the document",
"publicDescription": "Public description of the document",
"language": "EnUs",
"markupOrientation": "Bottom"
}
]
}
curl --location --request PUT 'https://api.signater.com/v1/ecm/envelopes/' \
--header 'x-api-token: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
"vaultId": "fa821124-78e0-489b-93d1-42ae89efe109",
"name": "Example Envelope",
"privateDescription": "Private description of the envelope",
"publicDescription": "Public description of the envelope",
"message": "Message of the envelope",
"reviewReminder": true,
"expiresAtUtc": "2025-10-17T00:11:51.1310515Z",
"expirationReminder": true,
"toBePublishedAtUtc": "2025-09-18T00:11:51.1310527Z",
"language": "EnUs",
"markupOrientation": "Bottom",
"signInOrder": true,
"isAiChatForSignersEnabled": true,
"signers": [
{
"id": "b248c2f1-9c0f-4893-b0c0-4d0f417e5182",
"name": "John Doe",
"email": "john.doe@example.com",
"allowEmailCommunication": false,
"role": "Sign",
"title": "Lawyer",
"shouldEnforceEmailValidation": true,
"shouldEnforceSmsValidation": true,
"shouldEnforceWhatsAppValidation": true,
"shouldEnforcePixValidation": true,
"shouldEnforceGeolocationValidation": true,
"shouldAllowCustomDigitalCertificateValidation": true,
"shouldEnforceCustomDigitalCertificateValidation": true,
"phoneIdd": 1,
"phoneNumber": "5555555555",
"allowPhoneSmsCommunication": false,
"allowPhoneWhatsAppCommunication": false,
"documentType": "GenericIdentification",
"documentValue": "1234567890",
"shouldEnforcePasscodeValidation": true,
"passcode": "123456",
"passcodeHint": "1 to 6",
"signMarks": [
{
"id": "f891bec3-d48d-4755-9f12-47c998fe83c1",
"type": "Rubric",
"documentId": "d18acdb1-78cc-4502-8c0a-d15adaca701b",
"page": 1,
"x": 150,
"y": 50,
"rotation": 0
},
{
"id": null,
"type": "Signature",
"documentId": "d18acdb1-78cc-4502-8c0a-d15adaca701b",
"page": 2,
"x": 200,
"y": 50,
"rotation": 0
}
]
}
],
"documents": [
{
"id": "d18acdb1-78cc-4502-8c0a-d15adaca701b",
"name": "Example Document",
"privateDescription": "Private description of the document",
"publicDescription": "Public description of the document",
"language": "EnUs",
"markupOrientation": "Bottom"
}
]
}'