DocuSign RestAPI设置authoritativeCopy后权威副本操作方法
以下全为可直接落地的操作步骤,不含原理说明:
配置属性后的后续必做操作
- 信封创建阶段设置完
$envelope->setAuthoritativeCopy(true)后,无需执行任何和权威副本相关的额外操作,沿用你现有的信封状态轮询、签署完成回调接收逻辑即可。当信封状态变更为completed(所有签署方完成操作)时,DocuSign会自动生成并存储对应权威副本,无需手动触发存储动作。 - 注意踩坑:
authoritativeCopy属性仅支持在信封首次创建发送前设置,信封进入发送流程后无法修改该属性,发送前请校验参数是否正确。
权威副本调取方法
支持直接通过SDK/API调取,无需登录官网操作
- PHP SDK 调取(直接返回文件流)
核心调用代码:<?php // 替换为你自己初始化完成、已完成鉴权的EnvelopesApi实例 $envelopeApi = new DocuSign\eSign\Api\EnvelopesApi($apiClient); // 入参顺序:账户ID、固定传'combined'拉取合并版文档、目标信封ID、扩展参数 $authoritativeCopyStream = $envelopeApi->getDocument($accountId, 'combined', $envelopeId, [ 'certificate' => 'authoritative_copy' ]); // 拿到$authoritativeCopyStream后可直接输出为PDF、存入自有存储,和普通文件流处理逻辑一致 ?> - 原生RESTAPI 调取
请求方法:GET
请求路径:/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/combined
请求头:携带正常鉴权头Authorization: Bearer {accessToken}
查询参数:追加?certificate=authoritative_copy
接口响应直接返回权威副本PDF二进制流,按普通文件下载逻辑处理即可。
存储时效规则
- 正常付费有效账号下,权威副本和对应信封的其他文件存储周期完全一致,为永久存储,不会被单独提前删除。
- 如果账号到期注销,权威副本会随账号全量数据按平台数据清理规则统一处理,无独立过期时间。
获取渠道说明
- 并非仅能通过DocuSign官网获取:除上述API/SDK调取渠道外,账号管理员可在DocuSign后台已完成信封的详情页手动下载权威副本,两种渠道获取的文件内容完全一致。
- 权限注意:普通签署人默认无权威副本下载权限,仅持有对应信封管理权限的集成密钥、账号管理员可调取,不要给普通用户开放该接口。
内容的提问来源于stack exchange,提问作者Bill in Kansas City
相关产品推荐
相关产品推荐

