Create or send an envelope

post

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

Send a signature request with multiple documents (original + template)

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.

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.

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.

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

Responses

200200

400400

422422