The envelope object

Envelopes are signature requests which are composed of one or many documents which are sent to a maximum of 16 signers for receiving signatures.

{
      "status":"incomplete",
      "owner_first_name":"Jack",
      "originals": [
        {
         "id": 33299021,
         "name": "LP Signing Contract Document" 
        },
        {
          "id" 33122312,
          "name": "LP Signing Contract Lease Document"
        }
      ],
      "recipients":[
         {
            "status":"not_viewed",
            "first_name":"",
            "last_name":"",
            "order_id":1,
            "last_modified_time":1505464109,
            "recipient_user_id":2,
            "recipient_id":7,
            "created_time":1505464109,
            "email":"[email protected]"
         },
         {
            "status":"not_viewed",
            "first_name":"",
            "last_name":"",
            "order_id":2,
            "last_modified_time":1505464109,
            "recipient_user_id":3,
            "recipient_id":8,
            "created_time":1505464109,
            "email":"[email protected]"
         }
      ],
      "owner_email":"[email protected]",
      "owner_last_name":"Barb",
      "next":7,
      "created_time":1505464109,
      "last_modified_time":1505464109,
      "has_markers":0,
      "is_ordered":0,
      "id":4936759,
      "owner_user_id": 1
   }

Attributes

Type

Description

created_time

time

The time in epoch, when the signature request was initiated and the pending file created.

id

integer

The unique ID of the pending file.

is_ordered

integer

Flag indicating if the signing sequence would be ordered or not.

0: Parallel signing, the recipients can sign in any order
1: Sequential signing, the recipients can only sign when it is their turn to sign.

last_modified_time

time

The time in epoch, when the pending file was last modified.

logo

url

Link to the logo of the user, in case white labelling was turned on.

next

integer

The ID of the recipient who is in order to sign the document next.

This will be null in case of parallel signing.

owner_email

email

The email address of the signature request initiator.

owner_first_name

string

The first name of the signature request initiator.

owner_last_name

string

The last name of the signature request initiator.

owner_company

string

The company details of the signature request initiator.

has_markers

boolean

Flag indicating if there were fields added to the document before sending or not.

recipients.created_time

time

The time in epoch, when this recipient was added to the signature request.

recipients.email

email

The email address of the recipient.

recipients.first_name

string

The first name of the recipient.

recipients.last_name

string

The last name of the recipient.

recipients.last_modified_time

time

The time in epoch, when the recipient last acted on the signature request (viewed, signed, declined etc).

recipients.order_id

integer

Used only in sequential signing. Indicates the signing order for this recipient.

recipients.recipient_id

integer

Unique ID for this recipient. Unique only for this signature request. Use this ID to figure out who is the next signer.

recipients.status

string

One of viewed, not_viewed, declined, finalized.

Read more about each one of them here.

status

string

One of incomplete, complete, recipient_declined, canceled.

Read more about each one of them here.

originals.id

integer

The identifier of one of the original documents in the envelope request.

originals.name

string

The name of one of the original documents in the envelope request.