接口描述
流程结束后，获取签署完成的文件以及相关附属材料的下载链接。
- 未签署完成的流程，无法下载相关文件，否则会报错："流程非签署完成状态，不允许下载文档"。
为优化接口开发体验，自 2025年12月11日 起：
- 新增 POST 请求方式，后续新功能将基于此方式开发。
- 原有 GET 请求方式保留，但不再增加新功能，不再推荐使用。
请求方式一：
新接口地址&请求方法（推荐）
接口地址：https://{host}/v3/sign-flow/{signFlowId}/file-download-url
请求方法：POST
请求头格式
具体请求头参数，请查看公共请求头格式。
请求参数
参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明 | |
signFlowId | string | 是 | path | 已完成状态的签署流程ID | |
urlAvailableDate | int | 否 | body | 下载链接有效期，单位：秒。默认：3600秒（60分钟）
补充说明：
| |
internalUrl | boolean | 否 | body | 是否是内网地址，默认：false true - 内网 false - 外网 注：专属云产品才可能用到内网地址，标准都是外网地址 | |
rsaSecret | string | 否 | body | 文件需要加密时使用的RSA公钥（base64编码）
| |
rsaSecretKey | string | 否 | body | RSA公钥版本（开发者自定义唯一标识，可用该字段标识对应的rsaSecret加密版本） 补充说明：
| |
响应参数
展开全部参数参数名称 | 参数类型 | 必选 | 参数说明 | ||
code | int32 | 是 | 业务码，0表示成功，非0表示异常。 | ||
message | string | 否 | 业务信息 请根据 code 来判断错误情况，不应该依赖message 匹配，因为 message 可能会调整。 | ||
data（点击“+”展开详情） | object | 否 | 业务数据 | ||
files（点击“+”展开详情） | array | 否 | 签署文件信息 | ||
fileId | string | 否 | 签署文件ID | ||
fileName | string | 否 | 签署文件名称 | ||
downloadUrl | string | 否 | 已签署文件下载链接（默认有效期为60分钟，过期后可以重新调用接口获取新的下载地址） | ||
attachments（点击“+”展开详情） | array | 否 | 附属材料信息 | ||
fileId | string | 否 | 附属材料文件ID | ||
fileName | string | 否 | 附属材料文件名称 | ||
downloadUrl | string | 否 | 附属材料文件下载链接（默认有效期为60分钟，过期后可以重新调用接口获取新的下载地址） | ||
certificateDownloadUrl | string | 否 | 海外签证书报告下载地址（默认有效期为60分钟，过期后可以重新调用接口获取新的下载地址） 注：默认中国大陆签署不返回值 | ||
aesSecret | string | 否 | 公钥加密后的AES密钥（base64编码） 注：传入rsaSecret和rsaSecretKey时返回 | ||
请求示例
POST https://openapi.esign.cn/v3/sign-flow/b2cb7**3cc54/file-download-url{
"urlAvailableDate": "3600"
}响应示例
{
"code": 0,
"message": "成功",
"data": {
"files": [
{
"fileId": "0e99dee27**b2cd69",
"fileName": "xx企业劳动合同签署.pdf",
"downloadUrl": "https://esignoss.esign.cn/1111563786/8446a910-1252-4712-84e6-5fe17beb7db6/%E5%BC%80%E5%8F%91%E5%89%8D%E5%BF%85%E8%AF%BB.pdf?Expires=1649935695&OSSAccessKeyId=LTAI4G23YViiKnxTC28ygQzF&Signature=xx%3D"
}
],
"attachments": [
{
"fileId": "e2774d28**b4e55180",
"fileName": "入职材料.pdf",
"downloadUrl": "https://esignoss.esign.cn/1111564182/37afade5-84eb-497c-8068-909487f5cc41/%E5%BC%80%E5%8F%91%E5%89%8D%E5%BF%85%E8%AF%BB.pdf?Expires=1649935695&OSSAccessKeyId=LTAI4G23YViiKnxTC28ygQzF&Signature=1KtvhoMUi%2B1k%x%3D"
}
],
"certificateDownloadUrl": null,
"aesSecret": null
}
}错误码
请求方式二：
接口地址&请求方法（不推荐）
接口地址：https://{host}/v3/sign-flow/{signFlowId}/file-download-url
请求方法：GET
请求头格式
具体请求头参数，请查看公共请求头格式。
请求参数
参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明 | |
signFlowId | string | 是 | path | 已完成状态的签署流程ID | |
urlAvailableDate | int | 否 | query | 下载链接有效期，单位：秒。默认：3600秒（60分钟）
补充说明：
| |
响应参数
展开全部参数参数名称 | 参数类型 | 必选 | 参数说明 | ||
code | int32 | 是 | 业务码，0表示成功，非0表示异常。 | ||
message | string | 否 | 业务信息 请根据 code 来判断错误情况，不应该依赖message 匹配，因为 message 可能会调整。 | ||
data（点击“+”展开详情） | object | 否 | 业务数据 | ||
files（点击“+”展开详情） | array | 否 | 签署文件信息 | ||
fileId | string | 否 | 签署文件ID | ||
fileName | string | 否 | 签署文件名称 | ||
downloadUrl | string | 否 | 已签署文件下载链接（默认有效期为60分钟，过期后可以重新调用接口获取新的下载地址） | ||
attachments（点击“+”展开详情） | array | 否 | 附属材料信息 | ||
fileId | string | 否 | 附属材料文件ID | ||
fileName | string | 否 | 附属材料文件名称 | ||
downloadUrl | string | 否 | 附属材料文件下载链接（默认有效期为60分钟，过期后可以重新调用接口获取新的下载地址） | ||
certificateDownloadUrl | string | 否 | 海外签证书报告下载地址（默认有效期为60分钟，过期后可以重新调用接口获取新的下载地址） 【注】默认中国大陆签署不返回值 | ||
请求示例
GET https://openapi.esign.cn/v3/sign-flow/b2cb7**3cc54/file-download-url?urlAvailableDate=3600响应示例
{
"code": 0,
"message": "成功",
"data": {
"files": [
{
"fileId": "0e99dee27**b2cd69",
"fileName": "xx企业劳动合同签署.pdf",
"downloadUrl": "https://esignoss.esign.cn/1111563786/8446a910-1252-4712-84e6-5fe17beb7db6/%E5%BC%80%E5%8F%91%E5%89%8D%E5%BF%85%E8%AF%BB.pdf?Expires=1649935695&OSSAccessKeyId=LTAI4G23YViiKnxTC28ygQzF&Signature=xx%3D"
}
],
"attachments": [
{
"fileId": "e2774d28**b4e55180",
"fileName": "入职材料.pdf",
"downloadUrl": "https://esignoss.esign.cn/1111564182/37afade5-84eb-497c-8068-909487f5cc41/%E5%BC%80%E5%8F%91%E5%89%8D%E5%BF%85%E8%AF%BB.pdf?Expires=1649935695&OSSAccessKeyId=LTAI4G23YViiKnxTC28ygQzF&Signature=1KtvhoMUi%2B1k%x%3D"
}
],
"certificateDownloadUrl": null,
"aesSecret": null
}
}
我要纠错