Create envelope

Creates a new envelope containing one or more documents and associated signers. The envelope can be used for document signing or other related workflows. Upon creation, the envelope will be assigned a unique identifier for future operations such as tracking, signing, or editing. Ensure all required fields, including documents and signers, are provided in the request payload.

Request

Authorization

Add parameter in header

x-api-token

Example:

x-api-token: ********************

Body Params application/json

Example

{
    "vaultId": "111d7997-d64d-417a-ac36-b7b7ec34c572",
    "name": "Example Envelope",
    "privateDescription": "Private description of the envelope",
    "publicDescription": "Public description of the envelope",
    "message": "Message of the envelope",
    "reviewReminder": true,
    "expiresAtUtc": "2025-09-23T00:13:58.6050105Z",
    "expirationReminder": true,
    "toBePublishedAtUtc": "2025-08-25T00:13:58.6050113Z",
    "language": "EnUs",
    "markupOrientation": "Bottom",
    "signInOrder": true,
    "signers": [
        {
            "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": [
                {
                    "type": "Rubric",
                    "documentId": "98f89419-e43d-41c4-ac32-b0d78e0e4416",
                    "page": 1,
                    "x": 100,
                    "y": 50,
                    "rotation": 0
                },
                {
                    "type": "Signature",
                    "documentId": "98f89419-e43d-41c4-ac32-b0d78e0e4416",
                    "page": 2,
                    "x": 200,
                    "y": 50,
                    "rotation": 0
                }
            ]
        }
    ],
    "documents": [
        {
            "id": "98f89419-e43d-41c4-ac32-b0d78e0e4416",
            "name": "Example Document",
            "privateDescription": "Private description of the document",
            "publicDescription": "Public description of the document",
            "language": "EnUs",
            "markupOrientation": "Bottom"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.signater.com/v1/ecm/envelopes' \
--header 'Content-Type: application/json' \
--header 'x-api-token;' \
--data-raw '{
    "vaultId": "111d7997-d64d-417a-ac36-b7b7ec34c572",
    "name": "Example Envelope",
    "privateDescription": "Private description of the envelope",
    "publicDescription": "Public description of the envelope",
    "message": "Message of the envelope",
    "reviewReminder": true,
    "expiresAtUtc": "2025-09-23T00:13:58.6050105Z",
    "expirationReminder": true,
    "toBePublishedAtUtc": "2025-08-25T00:13:58.6050113Z",
    "language": "EnUs",
    "markupOrientation": "Bottom",
    "signInOrder": true,
    "signers": [
        {
            "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": [
                {
                    "type": "Rubric",
                    "documentId": "98f89419-e43d-41c4-ac32-b0d78e0e4416",
                    "page": 1,
                    "x": 100,
                    "y": 50,
                    "rotation": 0
                },
                {
                    "type": "Signature",
                    "documentId": "98f89419-e43d-41c4-ac32-b0d78e0e4416",
                    "page": 2,
                    "x": 200,
                    "y": 50,
                    "rotation": 0
                }
            ]
        }
    ],
    "documents": [
        {
            "id": "98f89419-e43d-41c4-ac32-b0d78e0e4416",
            "name": "Example Document",
            "privateDescription": "Private description of the document",
            "publicDescription": "Public description of the document",
            "language": "EnUs",
            "markupOrientation": "Bottom"
        }
    ]
}'

Request

Request Code Samples

Responses