Sign in

v2

latestOpenAPI 3.1.02026-08-064686150.6 KB
Sign

Create Envelope

The Create Envelope endpoint creates a new sign envelope in Nitro.

A sign envelope is the container for signature processes in Nitro. It can include assets such as documents, participants, signature fields, and configuration settings that define how the signing process should behave. With the Create Envelope endpoint, you will create an empty sign envelope you can later add assets to.

post/sign/envelopes

Request body

namestring required

The Envelope's name. It doesn't have to be unique.

mode'sequential' | 'parallel' required

The Signing Mode in an enum that defines the signing order. It has two possible values:

  • sequential: Participants receive notifications one at a time, in the order they were added to the envelope. Each new notification is triggered once the previous participant has completed their signing.
  • parallel: All participants are notified at the same time and can sign the documents in the envelope independently, without waiting for others.

Response

When an envelope is created you will get a unique ID for it. You can add assets to the envelope later by referencing its unique ID using other endpoints in this API.

IDstring uuid

A unique UUIDv4 string that identifies the envelope in the Nitro system.

createdAtstring date-time

UTC timestamp indicating when the envelope was created.

lastModifiedAtstring date-time

UTC timestamp indicating the last time the envelope was updated. Matches createdAt at the time of creation.

namestring

The name of the envelope.

status'drafted' | 'sent' | 'processing' | 'sealed' | 'rejected' | 'cancelled' | 'deleted'

The internal status of the envelope. Defaults to drafted on creation.

mode'sequential' | 'parallel'

Signing mode for the envelope.