POST
/
envelopes
curl --request POST \
  --url https://restapi.sign.plus/v2/envelopes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "tags": [
    "<string>"
  ],
  "comment": "<string>",
  "ids": [
    "<string>"
  ],
  "statuses": [
    "DRAFT"
  ],
  "folder_ids": [
    "<string>"
  ],
  "only_root_folder": true,
  "date_from": 123,
  "date_to": 123,
  "uid": "<string>",
  "first": 123,
  "last": 123,
  "after": "<string>",
  "before": "<string>",
  "order_field": "CREATION_DATE",
  "ascending": true,
  "include_trash": true
}'
{
  "has_next_page": true,
  "has_previous_page": true,
  "envelopes": [
    {
      "id": "<string>",
      "name": "<string>",
      "comment": "<string>",
      "pages": 123,
      "flow_type": "REQUEST_SIGNATURE",
      "legality_level": "SES",
      "status": "DRAFT",
      "created_at": 123,
      "updated_at": 123,
      "expires_at": 123,
      "num_recipients": 123,
      "is_duplicable": true,
      "signing_steps": [
        {
          "recipients": [
            {
              "id": "<string>",
              "uid": "<string>",
              "name": "<string>",
              "email": "<string>",
              "role": "SIGNER",
              "verification": {
                "type": "SMS",
                "value": "<string>"
              }
            }
          ]
        }
      ],
      "documents": [
        {
          "id": "<string>",
          "name": "<string>",
          "filename": "<string>",
          "page_count": 123,
          "pages": [
            {
              "width": 123,
              "height": 123
            }
          ]
        }
      ],
      "notification": {
        "subject": "<string>",
        "message": "<string>",
        "reminder_interval": 123
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string

Name of the envelope

​
tags
string[]

List of tags

Tag of the envelope

​
comment
string

Comment of the envelope

​
ids
string[]

List of envelope IDs

ID of the envelope

​
statuses
enum<string>[]

List of envelope statuses

Status of the envelope

Available options:
DRAFT,
IN_PROGRESS,
COMPLETED,
EXPIRED,
DECLINED,
VOIDED,
PENDING
​
folder_ids
string[]

List of folder IDs

ID of the folder

​
only_root_folder
boolean

Whether to only list envelopes in the root folder

​
date_from
integer

Unix timestamp of the start date

​
date_to
integer

Unix timestamp of the end date

​
uid
string

Unique identifier of the user

​
first
integer
​
last
integer
​
after
string
​
before
string
​
order_field
enum<string>

Field to order envelopes by

Available options:
CREATION_DATE,
MODIFICATION_DATE,
NAME,
STATUS,
LAST_DOCUMENT_CHANGE
​
ascending
boolean

Whether to order envelopes in ascending order

​
include_trash
boolean

Whether to include envelopes in the trash

Response

200 - application/json
List of envelopes retrieved successfully
​
has_next_page
boolean

Whether there is a next page

​
has_previous_page
boolean

Whether there is a previous page

​
envelopes
object[]
Create new envelope from templateGet envelope