Download Documents

GET /esignglobal/v1/envelope/files/download

Interface Description

Download signed documents form the envelope, is available only when the envelope is completed.

Request Parameters

Parameter

Type

Required

Description

envelopeId

string

true

Envelope ID

downloadType

stringfalse

File Download Format Types:

● zip (default): Returns a compressed file download link

● list: Returns a file listing 

Request Example

GET https://……/esignglobal/v1/envelope/files/download?envelopeId=flow1234567890&downloadType=list

Responses

Parameter

Type

Description

envelopeId

string

Envelope ID

envelopeStatus

int

Envelope Status

0-Draft

1-In Progress

2-Completed

3-Expired

5-Canceled

downloadUrl

string

Documents Download URL

[Note] It is valid for 30 minutes. Please request the interface to obtain the download url again after expiration.

[Note]:Returned when downloadType=zip.

envelopeFiles

array

Envelope File Collection

[Note]:Returned when downloadType=list.

 

fileType

string

File Type

contract-Signed document

attachment-Attachment

certificate-Certificate

 

fileName

string

File Name

 

downloadUrl

string

File Download URL

[Note] It is valid for 60 minutes.

Response Example

{
    "code": "0",
    "data": {
    "envelopeId": "xxxx",
      "downloadUrl": "下载地址",
      "envelopeStatus": 2
  },
  "message": "success"
}

 

Interface Description
Request Parameters
Request Example
Responses
Response Example