Envelope

​
Definition

An Envelope is a container for documents to be signed by recipients. An envelope can contain one or more documents. The envelope set the flow type, legality level, expiration date, and other settings for the documents to be signed.

​
Schema

id
string

Unique identifier of the envelope

name
string

Name of the envelope

comment
string

Comment for the envelope

pages
integer

Total number of pages in the envelope

flow_type
enum<string>

Flow type of the envelope (REQUEST_SIGNATURE is a request for signature, SIGN_MYSELF is a self-signing flow)

Available options:
REQUEST_SIGNATURE,
SIGN_MYSELF
legality_level
enum<string>

Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes)

Available options:
SES,
QES_EIDAS,
QES_ZERTES
status
enum<string>

Status of the envelope

Available options:
DRAFT,
IN_PROGRESS,
COMPLETED,
EXPIRED,
DECLINED,
VOIDED,
PENDING
created_at
integer

Unix timestamp of the creation date

updated_at
integer

Unix timestamp of the last modification date

expires_at
integer

Unix timestamp of the expiration date

num_recipients
integer

Number of recipients in the envelope

is_duplicable
boolean

Whether the envelope can be duplicated

signing_steps
object[]
documents
object[]
notification
object
QuickstartDocument