Create or send an envelope

post

https://api.signeasy.com/v3/rs/envelope

Send one or more originals and templates to up to 45 signers in a single envelope. Place fields exactly where you need them. And set embedded_signing to true if you want signers to sign inside your own app.

Envelopes are signature requests which are composed of one or many documents and document types (original, template) which are sent to a maximum of 45 signers for receiving signatures.

Create a new signature request with various fields you can programmatically position exactly where you need the signer to fill or sign in the document.

Multifactor Authentication
Advanced authentication, such as OTP to the recipient's mobile number, is available only on the API Advanced Plan. Please contact [email protected] for more details.

Attachments
Requesting additional attachments from recipients, is available only on the API Advanced Plan. Reach support or sales for more details.

Signer Groups
Send an envelope to a group of recipients, where any 'one' from the group can sign the document. Signer group is available only on the API Advanced Plan. Reach support or sales for more details.

Pre-fill by Sender or Earlier Signers
Fill text, checkbox, and combobox fields before the recipient they belong to signs. Give each field a label and a fillable_by. For pre-fill by sender, set fillable_by.sender to true and put the value in prefill_value. For pre-fill by earlier signers, list them in fillable_by.recipients and set is_ordered to true. Both are available only on the API Advanced Plan. Merge fields for templates (merge_fields) stay available on all API plans. Reach support or sales for more details.

Body Params

embedded_signing

boolean

required

Defaults to true

Setting this to true will create an envelope that you can embed into your product. Setting this to false will create an envelope and send a signature request via email to the specified recipients.

is_ordered

boolean

required

Defaults to true

When set to true the recipients will sign the documents in the specified order. The order is the order of the recipients list. Must be true when a field's fillable_by.recipients lets an earlier signer pre-fill it.

message

string

Defaults to Your message here

The message you provide here will be displayed in the signing interface to the signers along with the document.

sources

array of objects

required

A collection of document objects with arbitrary metadata to be used to create the envelope.

sources*

recipients

array of objects

required

A collection of recipient objects to be used to create the envelope. Recipient emails on reserved test domains such as example.com are rejected with 422 signer_email_rejected_as_spam, so use a real inbox you control when testing.

recipients*

array of objects

A collection of email objects to be copied (CC) about the signature request.

recipient_role_mapping

array of objects

A collection of objects with the template source, role, and the recipient email mapped.

recipient_role_mapping

fields_payload

array of objects

Programmatically place fields on the documents based on x-y coordinates or a reference text.

fields_payload

merge_fields

array of objects

Collection of dynamic field objects with data to pre-fill data on templates programmatically. These are merge fields for templates, available on all API plans.

merge_fields

signature_panel_types

array of strings

Can be a combination of "draw", "upload", "type". Based on what is specified, the signature panel will be displayed to the signers at the time of signing. In some countries eSignature laws only allow users to sign documents with a pen or stylus, and they don't accept other forms like typed signatures generated by Signeasy or uploaded images from the user’s device. For such cases, you can specify the panel types you want on your document.

signature_panel_types

initial_panel_types

array of strings

Can be a combination of "draw", "upload", "type". Based on what is specified, the initial panel will be displayed to the signers at the time of signing.

initial_panel_types

request_info

object

Define custom metadata specific to you, which will be returned as-is in the webhook payload. Add any key value pairs (max up to 50).

disabled_signer_actions

array of strings

Disable optional UI actions like Download for your signers when they are viewing the contracts for signing. Currently accepts "download".

disabled_signer_actions

attachments

array of objects

Request attachments from the signers.

attachments

expires_at

date

The date the envelope expires, in YYYY-MM-DD. Its expiry_time is set to 23:59:59 UTC on that day, so the earliest date you can send is tomorrow in UTC. A daily job marks envelopes expired, so the envelope can stay open for up to about a day after its expiry_time. Leave it out and the envelope expires 365 days after you create it.

Responses

Multifactor Authentication

Attachments

Signer Groups

Pre-fill by Sender or Earlier Signers

200200

400Required fields are missing, an ID or the expiry date is invalid, or the JSON is malformed

401Missing, expired, or invalid access token

422A recipient uses a blocked email domain, or the account is out of credits