Create Envelope

POST /esignglobal/v1/envelope/create

Interface Description

Create a draft envelope.

Request Parameters

Parameter	Type	Required	Description
subject	string	true	Name of the envelope. e.g., Offer Letter
remark	string	false	Envelope message to all recipients, length limit 1000 words.
expireAfterSeconds	long	false	Envelope expiration time, number of seconds after which the envelope expires. Expiration range: 86,400 seconds (1 day) ~ 7,776,000 seconds (90 days)
redirectUrl	string	false	The page signers will be redirected to after completing signing process. The page url should be a valid HTTP address.
callBackUrl	string	false	The callback address to receive envelope events during the signing process. Length limit: 500, should be a valid HTTP address.

Request Example

  {
    "subject": "api subject",
    "remark": "This is a remark",
    "expireAfterSeconds": 888640,
    "redirectUrl": "https://www.example.com"
}

Responses

Parameter

Type

Description

envelopeId

string

Envelope ID

envelopeStatus

int

Envelope Status

0-Draft

1-In Progress

2-Completed

3-Expired

5-Canceled

Response Example

{
    "code": "0",
    "data": {
        "envelopeId": "9fbe6c8190824227bde29136b0145c81",
        "envelopeStatus": 0
    },
    "message": "success"
}