如何从信封下载签名文件?

时间:2017-11-28 19:50:31

标签: docusignapi

一旦用户签署了附在信封上的文档,那么开发人员是否可以使用Rest API端点下载该文档?在下载之前,有没有办法判断文件是否已签名?

1 个答案:

答案 0 :(得分:1)

第一部分:确定特定签名者或所有收件人是否已完成/提交信封

要检查特定签名者(收件人)是否已完成对信封的签名,您可以使用List Envelope Recipients请求:

GET /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients

here所示,JSON响应中的signers属性是Envelope的签名者数组,以及每个签名者对象中的status属性表示特定收件人的状态。 签名者的状态已完成表示收件人已签署/已完成/已提交信封。

{
    ...
    "signers": [
        {
            "deliveredDateTime": "2016-10-05T21:18:12.3330000Z",
            "email": "jallard@example.com",
            "isBulkRecipient": "false",
            "name": "Jennie Allard",
            "recipientId": "1",
            "recipientIdGuid": "4575d5e9-7654-467b-b2f5-6c59ca7c43f8",
            "requireIdLookup": "false",
            "routingOrder": "1",
            "signedDateTime": "2016-10-05T21:18:41.6930000Z",
            "status": "completed",
            "userId": "ca45284a-a94e-4ee2-90af-76035bd795b2"
        }
    ]
}

或者,要检查信封的 所有 收件人是否已完成/提交信封,您可以使用Get Envelope请求:

GET /v2/accounts/{accountId}/envelopes/{envelopeId}

如图所示here,响应将是信封对象,该对象中的status属性表示信封的整体状态。完成status 表示所有收件人都已完成/提交了信封。

第二部分:下载已完成的文件

有关检索信封文档的端点,请参阅此页:https://docs.docusign.com/esign/restapi/Envelopes/EnvelopeDocuments/。您可能会使用List Envelope Documents请求获取信封中的文档列表,然后针对您要检索的每个文档发出Get Envelope Document请求。

其他评论

虽然您可以使用我上面描述的REST API请求来定期轮询信封(或收件人)状态,然后在信封(和/或收件人)状态完成时请求文档 - 更多有效的替代方案是使用DocuSign Connect,您可以将其配置为自动将信封状态和文档推送到您在信封达到状态=已完成时指定的端点。