Finish Envelope

POST/esignglobal/v1/envelope/finish

Interface Description

Manually terminate the signing process. All signers must complete their signatures before the process can be concluded. Once the signing process is completed, no further modifications can be made to any resources.

 

If the docking platform uses the Create and Start Envelope API to create an envelope, there is no need to call this API manually, as the system will automatically trigger it upon completion of the envelope.

Request Parameters

Parameter

Type

Required

Description

envelopeId

string

true

Envelope ID

Request Example

{
  "envelopeId":"flow1234567890"
}

Response parameters

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": "xxxx",
      "envelopeStatus": 2
  },
  "message": "success"
}

 

Interface Description
Request Parameters
Request Example
Response parameters
Response Example