Skip to main content

Send Signature Request

Creates and sends a new Signature Request with the submitted documents.

Request Body
file_url string

The URL of a single file to be downloaded and signed. This field is mutually exclusive with file, files, and file_urls. Only one of these fields should be provided in the request.

file binary

A single uploaded file to be sent for signature. This field is mutually exclusive with file_url, files, and file_urls. Only one of these fields should be provided in the request.

file_urls string[]

An array of URLs of files to be downloaded and signed. This field is mutually exclusive with file, files, and file_url. Only one of these fields should be provided in the request.

files binary[]

An array of uploaded files to be sent for signature. This field is mutually exclusive with file, file_url, and file_urls. Only one of these fields should be provided in the request.

signers object[] REQUIRED

Add Signers to your Signature Request.

email_address string REQUIRED
name string REQUIRED
group number

The signing order of signer for the Signature Request with signing_type is ORDER. Required if signing_type is ORDER.

Only signers in 1st Signers group will receive email/notification, signers in subsequent groups will receive email/notification when all signers in previous group has signed.

Group starts incrementing at 1.

The default value for group always is 1 if signing_type is SAME_TIME.

viewers object[]

Add Viewers to your Signature Request.

email_address string REQUIRED
name string REQUIRED
title string REQUIRED

Possible values: 1 ≤ length ≤ 255

The title you want to give the Signature Request.

expires_at unix-epoch REQUIRED

When the Signature Request will expire. This is a unix epoch timestamp (miliseconds). Should be later than today.

use_text_tags boolean

Set to true to enable Text Tag parsing in your document. Your Text Tags will be converted into UI components for the user to interact with. Defaults to false.

signing_type string

Possible values: [SAME_TIME, ORDER]

The signing order for the Signature Request. Defaults to SAME_TIME.

custom_email object

Custom email content for the email sent to signers.

sender_email string

The email address of the sender.

subject_name string

The subject of the email.

title string

The title of the email.

Responses
201

Expected response to a valid request

Schema OPTIONAL
signature_request

Contains information about a Signature Request.

signature_request_id string

The unique identifier for the Signature Request.

created_at string

The time the Signature Request was created.

status string

Possible values: [WAITING_FOR_PROCESSING, FAILED]

The status of the Signature Request.

4xx

Unexpected error

Schema OPTIONAL
error_code string
error_message string