Envelope
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
The unique identifier of the envelope.
The title of the envelope, which is shown to recipients.
Custom label given to the envelope for easier identification. Labels are for internal use and are not shown to recipients.
A message to include in emails to recipients.
The current status of the envelope.
Available options: draft, processing, in_progress, completed, failed, canceled
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
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
The timestamp format for this envelope.
The sender of the envelope.
An array of up to 10 strings used to classify envelopes and filter webhook notifications.
Each topic can have up to 32 lowercase alphanumeric characters and underscores, and must start with a letter.
A set of up to 10 custom key-value pairs containing metadata about the envelope.
A collection of documents to be signed.
People that signs the documents in an envelope.
File generated as the result of the completion of an envelope.
It remains null until the envelope has been completed.
Contains the values collected from input fields completed by recipients.
Time at which the envelope was created, in ISO 8601 format.
Time at which the envelope was completed by all recipients, in ISO 8601 format.
Was this page helpful?