Create Envelope

This endpoint is pretty similar to sign/new, but the body structure is a bit different because envelopes works slightly different to common sign operations

An envelope is a PDF formed by multiple PDFs, that is called a PDF portfolio. This operation will only consume one sign operation. Each signer has to read/fill each of the PDFs contained in the envelope, and signs everything at once instead of signing each document separately.

For this reason, this endpoint expects a single object instead of an array of objects.

Parameter	Type	Required	Default	Description
name	string	Yes		The name of the envelope
description	string	No		A description for the envelope
configure	object	No		Configure object. The configure object
receivers	array of objects	Yes		Receiver’s object. The receiver’s object – see receiver’s object –, with the difference that the formElements property has been replaced with formElementsMatrix (a matrix with the form fields of each file). It is possible to add one entry to the matrix for each sent file, those entries follow the same rules / data structure of "formElements" array explained in sign/new endpoint
files	array of objects	Yes	At least two entries	Each file can be sent in base64content or by template_id as in sign/new endpoint
custom_portfolio_cover_base64	string	No	PDF generated by Tecalis Signature	Base 64 encoded PDF. The cover of the PDF portfolio.

When sending 3 files to create an envelope, the formElementsMatrix for one of the receivers may be structured as follows:

"formElementsMatrix": [
                    // doc 1
                        [{
                        "template_id": "631f060a0c85c750720462c2"
                    }],
                    // doc 2 (no fields)      
                        [],
                    // doc 3
                    [
                    {
                        "template_id": "631f05d0e6830e72c16f23e2"
                    },
                        {
                        "uuid": "dde72edc-6f4b-430d-a8fa-fee7515a6108",
                        "type": "textbox",
                        "name": "textbox",
                        "page": 1,
                        "x": 104,
                        "y": -341,
                        "w": 202,
                        "h": 39,
                        "oldW": 180,
                        "oldH": 38,
                        "label": "",
                        "dragCache": {
                            "x": 104,
                            "y": 341
                        },
                        "value": null,
                        "required": false,
                        "disabled": false,
                        "visible": true,
                        "percentages": {
                        "x": 0.08573784006595218,
                        "y": -0.19865452060320402,
                        "w": 0.1665292662819456,
                        "h": 0.022720018485410432
                        },
                        "pdfDisplayerDocumentWidth": 1213,
                        "pdfDisplayerDocumentHeight": 1716.5478991596638
                    }
                    ]
]

Request example

{
    "name": "Envelope",
    "description": "My envelope of files",
    "configure": {},
    "receivers": [
        {
            "email": "[email protected]",
            "formElementsMatrix": [
                [],
                []
            ]
        }
    ],
    "custom_portfolio_cover_base64": null,
    "files": [
        {
            "name": "file1",
            "base64content": "{{file_sample_1}}"
        },
        {
            "name": "file2",
            "base64content": "{{file_sample_2}}"
        }
    ]
}

View in the API