Get Started
Guides
Backend SDKs
API Reference
- POSTCreate new envelope
- POSTCreate new envelope from template
- POSTList envelopes
- GETGet envelope
- DELDelete envelope
- GETGet envelope document
- GETGet envelope documents
- POSTAdd envelope document
- PUTSet envelope dynamic fields
- POSTAdd envelope signing steps
- POSTSend envelope for signature
- POSTDuplicate envelope
- PUTVoid envelope
- PUTRename envelope
- PUTSet envelope comment
- PUTSet envelope notification
- PUTSet envelope expiration date
- PUTSet envelope legality level
- GETGet envelope annotations
- GETGet envelope document annotations
- POSTAdd envelope annotation
- DELDelete envelope annotation
- GETDownload signed documents
- GETDownload certificate of completion
- PUTSet envelope attachment placeholders
- PUTSet envelope attachment settings
- GETGet envelope attachment file
- POST
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": [
{
"name": "<string>",
"email": "<string>",
"role": "SIGNER",
"id": "<string>",
"uid": "<string>",
"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
},
"attachments": {
"settings": {
"visible_to_recipients": true
},
"recipients": [
{
"recipient_id": "<string>",
"recipient_name": "<string>",
"placeholders": [
{
"recipient_id": "<string>",
"id": "<string>",
"name": "<string>",
"hint": "<string>",
"required": true,
"multiple": true,
"files": [
{
"id": "<string>",
"name": "<string>",
"size": 123,
"mimetype": "<string>"
}
]
}
]
}
]
}
}
]
}List 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": [
{
"name": "<string>",
"email": "<string>",
"role": "SIGNER",
"id": "<string>",
"uid": "<string>",
"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
},
"attachments": {
"settings": {
"visible_to_recipients": true
},
"recipients": [
{
"recipient_id": "<string>",
"recipient_name": "<string>",
"placeholders": [
{
"recipient_id": "<string>",
"id": "<string>",
"name": "<string>",
"hint": "<string>",
"required": true,
"multiple": true,
"files": [
{
"id": "<string>",
"name": "<string>",
"size": 123,
"mimetype": "<string>"
}
]
}
]
}
]
}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Name of the envelope
List of tags
Tag of the envelope
Comment of the envelope
List of envelope IDs
ID of the envelope
List of envelope statuses to filter by. Valid values: DRAFT, IN_PROGRESS, COMPLETED, EXPIRED, DECLINED, VOIDED, PENDING.
DRAFT, IN_PROGRESS, COMPLETED, EXPIRED, DECLINED, VOIDED, PENDING List of folder IDs
ID of the folder
Whether to only list envelopes in the root folder
Unix timestamp of the start date
Unix timestamp of the end date
Unique identifier of the user
Field to order envelopes by. Valid values: CREATION_DATE, MODIFICATION_DATE, NAME, STATUS, LAST_DOCUMENT_CHANGE.
CREATION_DATE, MODIFICATION_DATE, NAME, STATUS, LAST_DOCUMENT_CHANGE Whether to order envelopes in ascending order
Whether to include envelopes in the trash
Response
List of envelopes retrieved successfully
Whether there is a next page
Whether there is a previous page
Show child attributes
Show child attributes
Unique identifier of the envelope
Name of the envelope
Comment for the envelope
Total number of pages in the envelope
Flow type of the envelope (REQUEST_SIGNATURE is a request for signature, SIGN_MYSELF is a self-signing flow)
REQUEST_SIGNATURE, SIGN_MYSELF Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes)
SES, QES_EIDAS, QES_ZERTES Status of the envelope
DRAFT, IN_PROGRESS, COMPLETED, EXPIRED, DECLINED, VOIDED, PENDING Unix timestamp of the creation date
Unix timestamp of the last modification date
Unix timestamp of the expiration date
Number of recipients in the envelope
Whether the envelope can be duplicated
Show child attributes
Show child attributes
List of recipients
Show child attributes
Show child attributes
Name of the recipient
Email of the recipient
Role of the recipient (SIGNER signs the document, RECEIVES_COPY receives a copy of the document, IN_PERSON_SIGNER signs the document in person, SENDER sends the document)
SIGNER, RECEIVES_COPY, IN_PERSON_SIGNER Unique identifier of the recipient
Unique identifier of the user associated with the recipient
Show child attributes
Show child attributes
Type of verification the recipient must complete before accessing the envelope.
PASSCODE: requires a code to be entered.SMS: sends a code via SMS.ID_VERIFICATION: prompts the recipient to complete an automated ID and selfie check.
SMS, PASSCODE, ID_VERIFICATION Required for PASSCODE and SMS verification.
PASSCODE: code required by the recipient to sign the document.SMS: recipient's phone number.ID_VERIFICATION: leave empty.
Show child attributes
Show child attributes
Unique identifier of the document
Name of the document
Filename of the document
Number of pages in the document
Requested attachments for the envelope. See Set Attachment Requests guide for more details.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
ID of the recipient
Name of the recipient
Show child attributes
Show child attributes
ID of the recipient
ID of the attachment placeholder
Name of the attachment placeholder
Hint of the attachment placeholder
Whether the attachment placeholder is required
Whether the attachment placeholder can have multiple files
Show child attributes
Show child attributes
ID of the file
Name of the file
Size of the file in bytes
MIME type of the file