post
http://{{host}}/sign/envelope/new
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's called a PDF portfolio. You 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, in this endpoint you only send one object instead of an array of objects.
| name (string) | required | the name of the envelope |
| description (string) | optional | a description of the envelope |
| configure (object) | optional | the configure object (check sign/new for a in deep reference) |
| receivers (array of objects) | required | the receivers object (check sign/new for a in deep reference), with the difference that the formElements property has been replaced with formElementsMatrix (a matrix with the form fields of each file). You can add one entry to the matrix for each file you send, those entries follow the same rules / data strucutre of "formElements" array explained in sign/new endpoint |
| files | required, (at least two entries), array of objects | the array of files. Each file can be sent in base64content or by template_id as in sign/new endpoint |
| custom_portfolio_cover_base64 | string (optional) | By default, a cover for the portfolio (a pdf) is generated by Tecalis Signature. If you want to use a custom cover, send here the pdf content encoded in base64. |
formElementsMatrix example
Assuming you are sending 3 files to create an envelope, the formElementsMatrix of one of your signers (receivers) may look like this
"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
}
]
]