Docusign收件人状态 - Passed状态是什么意思?这与完成相同吗?

时间:2014-08-14 16:53:03

标签: docusignapi

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

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

此通过状态何时发挥作用?我们可以将它们视为等同于已完成吗?

1 个答案:

答案 0 :(得分:2)

" 传递"既不是信封级别状态也不是收件人级别状态。相反,在 ID检查身份验证的情况下,它的状态值对应于中的 idLookupResult idQuestionResult "获取收件人"的接受者身份验证状态属性API响应。例如,这里是"获取收件人"请求/响应已完成的信封,其中接收方成功通过了ID检查身份验证:

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"
}