Create Envelope

POST /esignglobal/v1/envelope/create

Interface Description

Create an envelope in draft status.

Request Parameters

Parameter Name		Type	Required	Description
subject		string	true	Envelope subject, example: "Offer Letter"
remark		string	false	Envelope remarks, length limit of 1000 characters
signerSettings		object	false	Actions allowed for signers
	allowTransfer	boolean	false	Whether to allow signers to transfer the envelope to others for signing, default is false true- Allow signers within the envelope to have the power to transfer it to others; false- Do not allow signers within the envelope to have the power to transfer it to others;
	allowModifyName	boolean	false	Whether to allow signatories to modify their names, only effective for template signatures, default is false true- Allow signers to modify their names false-Signers are not allowed to modify their names.
tspScope		array	false	Envelope-level TSP scope, default is false. When specified, when adding a signer, you must select the TSP that the signer will use from the specified range. Enumerated values include: vinotek、eSignPersonal、localCertificates、iAmSmart、vnptSmartCa、adacomOneShot、audkenni、belgianIdCard、certEuropeUsbToken、certSignWebSign、chaveMovel、croatianIdCard、czechIdCard、dTrustSignMe、diia、estonianIdCard、estonianMobileId、evrotrust、finnishIdCard、frejaEid、frejaEidSign、gseGestionDeSeguridadElectronica、halcom、harica、idAustriaATrustSignatur、infoCert、ltId、latvianIdCard、latvianEParakstsMobile、lithuanianIdCard、lithuanianMobileId、mscTrustGate、mitId、norwegianBankId、oneId、pscWorldWallet、spid、serproId、simplySign、smartId、swedenBankId、swissId、swisscom、transSped、trustAsia、zealidApp、certMe、certSignUsbToken、eCertChile、eMudhra、itsme、mojeId、emdha。
expireAfterSeconds		long	false	Envelope expiration time: The number of seconds after which the envelope expires. Expiration range: 86,400 seconds (1 day) to 7,776,000 seconds (90 days).
redirectUrl		string	false	Redirect URL upon completion of signing (max length 2048), must be a valid HTTP address.
callBackUrl		string	false	Callback URL (max length 500), must conform to HTTPS/HTTP protocol addresses.

Request example

  {
    "subject": "api subject fdsfasdfafs",
    "remark": "This is a remark",
    "tspScope": ["corpId", "vinotek", "eSignPersonal"],
    "expireAfterSeconds": 888640,
    "redirectUrl": "https://www.example.com"
}

Response parameters

Parameter name

Type

Description

envelopeId

string

Envelope ID

envelopeStatus

int

Envelope status

0 - Created (Draft)

1-Signing

2-Completed

3-Expired

5-Revoked

Response Example

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