Preview Envelope

GET /esignglobal/v1/envelope/preSignUrl

Interface Description

Developers can retrieve the url to preview the envelope through this API, as long as the envelope has been started.

Mainly used to enable non-recipients to view signed documents and track signing progress in the docking platform.

Request Parameters

Parameter

Type

Required

Description

envelopeId

string

true

Envelope ID

Request Example

GET https://…/esignglobal/v1/envelope/preSignUrl?envelopeId=flow1234567890

Responses

Parameter

Type

Description

envelopeId

string

Envelope ID

envelopeStatus

int

Envelope Status

0-Draft

1-In Progress

2-Completed

3-Expired

5-Canceled

preSignUrl

string

Page address to preview envelope.

Response example

{
    "code": 0,
    "message": "success",
    "data": {
    "envelopeId":"flow1234567890",
      "envelopeStatus":5,
      "preSignUrl":"https://xxxxxxx/xxxxxxxx"
  }
}

 

Interface Description
Request Parameters
Request Example
Responses
Response example