Hey! These docs are for version 1.0, which is no longer officially supported. Click here for the latest version, 2.1!

Initiate a new 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

email

string

Email address of the recipient who has to fill or sign this field.

type

string

One of text, signature, date, initials, email, name, checkbox.

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 45px.

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 {}.

Language
Authentication
OAuth2