Create or send an envelope

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 specific fields are required or not.

Fields Payload

Key	Type	Description
original_id	int	The original document you need to use in the envelope.
template_id	int	The template document you need to use in the envelope.
recipient_id	int	The recipient to whom you need to assign the field.
required	boolean	If the field is mandatory to be filled in by the recipient.
position	JSON	Tag to place the signature at a specific position (`fixed`) or next to a specific text (`referenceText`) on the page
mode	string	Two modes are supported: "fixed" or "referenceText". "fixed" - Allows you to place the signature or fields at a particular x,y coordinate in a page. p.s.:- the bottom left of a page is defined as 0,0 "referenceText" - Allows you to place the signature or fields next to a particular text
x	float	The field's horizontal margin from the left side of the document in pixels. Applies only when `mode` is `fixed`.
y	float	The field's vertical margin from the bottom of the document in pixels. Applies only when `mode` is `fixed`.
xOffset	float	The field's horizontal margin from the left side of the reference text in pixels. This represents the top left corner of the field. Applies only when `mode` is `referenceText`.
yOffset	float	The field's vertical margin from the top of the reference text in pixels. This represents the top left corner of the field. Applies only when `mode` is `referenceText`.
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. E.g. {"format": "DD/MM/YYYY"}. Use an empty JSON as value {} for all other field types.
page_number	string	The page_number field takes a string as input. You can provide a range such as : "1:8" - places the fields from pages 1 to 8. "all" - places the fields on all the pages "1:8,12,13" - places the fields on pages 1 to 8, 12 and 13
request_info	JSON	Additional metadata that you can pass and receive via webhooks.

Panel Types for Signature and Initial Fields

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

The API supports passing the panel types in the signature request to support these flows 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" (Allows users to draw using mouse/stylus), "upload" (Allows users to upload an image of the signature/initials) and "type" (Generate an image using the name / a custom provided text).

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.