API Reference

POST documents/signing

post
https://api-v2.insuresign.io/documents/signing
Body Params
file
required

Binary of a file to be uploaded.

string
required

Name for the document.

string
required

Message from the sender intended for the participants.

cc
array of objects

List of participants who should receive a carbon copy of the finalized document.

cc
fields
array of objects

List of signature fields to be added to the document.

fields
participants
array of objects
required
length ≥ 1

List of participants who will sign the document.

participants*

Participant in the signing process.

string

Phone number of the signing participant. Email or phone is required.

boolean
Defaults to false

Whether the participant should receive SMS notifications.

date-time
string
required

Name of the signing participant.

string
required

E-mail address of the participant.

boolean
Defaults to false

Whether email notifications should be suppressed.

string
enum

Action to be taken on the document.

Allowed:
templates
array of objects

List of templates containing participants and fields.

templates
string
enum

Action to be taken at the conclusion of the create process.

Allowed:
string
enum

The reminder interval to be set on the document.

Allowed:
boolean

Indicates if the document contains text tags.

boolean

Whether to suppress emails for this document.

string

URL to redirect the signers upon completion.

string

Custom logo URL.

callback
object

Webhook event subscription configuration.

string

Password to protect the document.

boolean

Whether to allow typed signatures on this specific document. This will override group setting. By default value is the same as group setting.

Response

Updated 3 days ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*

Updated 3 days ago