Docusignapi Docusign收件人状态-已通过状态意味着什么?这和完成的一样吗?

Docusignapi Docusign收件人状态-已通过状态意味着什么?这和完成的一样吗?,docusignapi,Docusignapi,我们将文档发送到Docusign进行签名(从我们的应用程序),然后在客户签名后轮询完成状态以下载回文档 但最近我们允许客户端使用ID查找功能进行身份验证。在轮询时,我们可以看到通过的状态,而不是通常的完成状态。这是在客户端成功地进行身份验证并签署文档之后进行的 此已通过状态何时生效?我们是否可以将其视为已完成状态?“已通过”既不是信封级别的状态,也不是收件人级别的状态。相反,在ID检查身份验证的情况下,它是一个状态值,对应于“Get Recipients”API响应的recipientAuthe

我们将文档发送到Docusign进行签名(从我们的应用程序),然后在客户签名后轮询完成状态以下载回文档

但最近我们允许客户端使用ID查找功能进行身份验证。在轮询时,我们可以看到通过的状态,而不是通常的完成状态。这是在客户端成功地进行身份验证并签署文档之后进行的

此已通过状态何时生效?我们是否可以将其视为已完成状态?

“已通过”既不是信封级别的状态,也不是收件人级别的状态。相反,在ID检查身份验证的情况下,它是一个状态值,对应于“Get Recipients”API响应的recipientAuthenticationStatus属性中的IDLookupPresultidQuestionResult。例如,以下是收件人成功通过身份验证的完整信封的“获取收件人”请求/响应:

GET https://{{env}}.docusign.net/restapi/{{version}}/accounts/{{acctId}}/envelopes/ENVELOPE_ID/recipients?include_tabs=false&include_extended=true

{
    "signers": [
        {
            "signInEachLocation": "false",
            "name": "Jane Doe",
            "email": "janesemail@outlook.com",
            "recipientId": "1",
            "recipientIdGuid": "bee5eae6-3e7a-4692-8488-0bf331a817b6",
            "requireIdLookup": "true",
            "idCheckConfigurationName": "ID Check $",
            "userId": "3a8ce8f4-fe2c-479f-bc44-2502cc8d0558",
            "routingOrder": "1",
            "note": "",
            "status": "completed",
            "signedDateTime": "2014-08-14T18:12:50.0530000Z",
            "deliveredDateTime": "2014-08-14T18:09:59.3700000Z",
            "recipientAuthenticationStatus": {
                "idLookupResult": {
                    "status": "Passed",
                    "eventTimestamp": "2014-08-14T18:08:55.6430000Z"
                },
                "idQuestionsResult": {
                    "status": "Passed",
                    "eventTimestamp": "2014-08-14T18:08:55.6430000Z"
                }
            }
        }
    ],
    "agents": [],
    "editors": [],
    "intermediaries": [],
    "carbonCopies": [],
    "certifiedDeliveries": [],
    "inPersonSigners": [],
    "recipientCount": "1",
    "currentRoutingOrder": "1"
}
(请注意,收件人的状态已完成。)

如果您有兴趣在信封完成后检索文档,那么您应该只关注评估信封状态——如果信封状态为“已完成”,则表示所有收件人都已提交了信封(即完成了他们所需的操作)。以下““获取信封状态”请求/响应显示了“已完成”信封的示例(即,状态=已完成)

GET https://{{env}}.docusign.net/restapi/{{version}}/accounts/{{acctId}}/envelopes/ENVELOPE_ID

{
    "status": "completed",
    "documentsUri": "/envelopes/71bcc905-916d-4253-ba4c-7e6d6de519ec/documents",
    "recipientsUri": "/envelopes/71bcc905-916d-4253-ba4c-7e6d6de519ec/recipients",
    "envelopeUri": "/envelopes/71bcc905-916d-4253-ba4c-7e6d6de519ec",
    "emailSubject": "Test w/ ID Check",
    "emailBlurb": "Test Email Body",
    "envelopeId": "71bcc905-916d-4253-ba4c-7e6d6de519ec",
    "customFieldsUri": "/envelopes/71bcc905-916d-4253-ba4c-7e6d6de519ec/custom_fields",
    "notificationUri": "/envelopes/71bcc905-916d-4253-ba4c-7e6d6de519ec/notification",
    "enableWetSign": "false",
    "allowReassign": "false",
    "createdDateTime": "2014-08-14T18:04:34.0900000Z",
    "deliveredDateTime": "2014-08-14T18:09:59.4030000Z",
    "sentDateTime": "2014-08-14T18:05:57.1300000Z",
    "completedDateTime": "2014-08-14T18:12:50.0700000Z",
    "statusChangedDateTime": "2014-08-14T18:12:50.0700000Z",
    "documentsCombinedUri": "/envelopes/71bcc905-916d-4253-ba4c-7e6d6de519ec/documents/combined",
    "certificateUri": "/envelopes/71bcc905-916d-4253-ba4c-7e6d6de519ec/documents/certificate",
    "templatesUri": "/envelopes/71bcc905-916d-4253-ba4c-7e6d6de519ec/templates",
    "purgeState": "unpurged"
}