Create an envelope RS

Envelopes support sending multiple documents in a single go for signature request.

Initiate a new envelope signature request with fields. You get to choose where exactly in the document each signer has to fill in and sign, the type of fields and if each of those fields are required or not.

Fields Payload

Key

Type

Description

original_id

int

The original document to add the field.

recipient_id

int

The recipient to add the field.

required

boolean

If the field is mandatory to be filled in by the recipient.

page_number

int

The page number that this field should go into. Starts from 1.

If you would like to place the fields in the last page, no matter which document, use the special value -1.

x

float

The field's horizontal margin from the left side of the document in pixels. This represents the bottom left corner of the field.

y

float

The field's vertical margin from the bottom of the document in pixels. This represents the bottom left corner of the field.

height

float

The field's height in pixels. Minimum height should be 32px.

width

float

The field's width in pixels. Minimum width should be 32px.

additional_info

json

Used only in the case of field type date. You can use this to set the required date format of the field. Eg. {"format": "DD/MM/YYYY"}. For all other field types, use an empty JSON as value {}.

Panel Types for Signature and Initial Fields

The esignature laws of certain countries allow their users to only sign on the document using a pen / stylus and do not accept other forms such as as typed signatured generated by the signeasy system / an uploaded image from the user's machine.

To support these flows, the API supports passing the panel types in the signature request using the parameters signature_panel_types and initial_panel_types.

To allow flexibility to the developers according to the esignature laws, the parameter accepts a combination of "draw" (Allow users to draw using mouse / stylus), "upload" (Allow users to upload an image of the signature / initials ) and "type" ( Generate an image using the name / a custom provided text).

Language
Authentication
OAuth2