The envelope is the most important resource in SignatureAPI.

An envelope is a container that holds documents to be sent to recipients. It defines and manages the signing process for those documents.

When an envelope is completed, a deliverable is generated and sent to the recipients.

An envelope has many recipients, documents, and deliverables.

Attributes

id
uuid

The unique identifier of the envelope.

title
string

The title of the envelope, which is shown to recipients.

label
string

Custom label given to the envelope for easier identification. Labels are for internal use and are not shown to recipients.

message
string

A message to include in emails to recipients.

status
enum

The current status of the envelope.

Available options: draft, processing, in_progress, completed, failed, canceled

mode
enum

The mode affects both legal status and billing of an envelope. Live mode envelopes are legally binding and incur charges, whereas test mode envelopes are non-binding and are not counted towards billing.

Available options: live, test

routing
enum

The order in which recipients sign the envelope. It can be parallel, where all recipients can sign simultaneously, or sequential, where recipients sign one after another.

Learn more about Recipient Routing

timezone
string

The time zone for this envelope.

timestamp_format
string

The timestamp format for this envelope.

sender
object

The sender of the envelope.

metadata
object

A set of up to 10 custom key-value pairs containing metadata about the envelope.

documents
array of Documents

A collection of documents to be signed.

recipients
array of Recipients

People that signs the documents in an envelope.

deliverable
object

File generated as the result of the completion of an envelope.

It remains null until the envelope has been completed.

created_at
timestamp

Time at which the envelope was created, in ISO 8601 format.

completed_at
timestamp

Time at which the envelope was completed by all recipients, in ISO 8601 format.