GET /esignglobal/v1/envelope/files/download
Interface Description
File downloads within the envelope are only supported for packaging when the envelope is completed.
Request Parameters
Parameter Name | Type | Required | Description |
envelopeId | string | true | Envelope ID |
downloadType | string | false | File download format type: |
Request Example
GET https://……/esignglobal/v1/envelope/files/download?envelopeId=flow1234567890&downloadType=list
Response Parameters
Parameter Name | Type | Description |
envelopeId | string | Envelope ID |
envelopeStatus | int | Envelope Status 0-Created (Draft) 1-Signing 2-Completed 3-Expired 4-Rejected 5-Voided |
downloadUrl | string | File download address [Note] Valid for 30 minutes. After expiration, please request the interface again to obtain the download address. Returned when downloadType=zip |
envelopeFiles | array | Envelope file collection Envelope file collection [Note] Returned when downloadType=list |
| fileType | string | File Type CONTRACT-Signed Document ATTACHMENT-Attachment CERTIFICATE-Certificate COMBINED-A PDF file merged with "Signed Document" and "Proof of Completion of Signing", returned when "Envelope File Merged Download" is enabled |
| fileName | string | File Name |
| downloadUrl | string | File download address (valid for 60 minutes) |
Response Example
{
"code": "0",
"data": {
"envelopeId": "xxxx",
"downloadUrl": "下载地址",
"envelopeStatus": 2
},
"message": "success"
}
