使用 API 与签名角色匹配的文档

Document Matching with Signing Roles using API

我有一个应用程序将调用 DocuSign API 端点,如下所示:

curl --header "Authorization: Bearer ${access_token}" \
     --header "Content-Type: application/json" \
     --data-binary @${request_data} \
     --request POST ${base_path}/v2.1/accounts/${account_id}/envelopes \
     --output $response

我包括一个基本的 JSON 正文和 POST,其中包括两个文档和 2(或 3)个签名者。然后结果通过这个端点传递:

curl --header "Authorization: Bearer ${access_token}" \
     --header "Content-Type: application/json" \
     --data-binary "{\"returnUrl\": \"https://REDACTED FOR SECURITY\"}" \
     --request POST ${base_path}/v2.1/accounts/${account_id}/envelopes/${envelope_id}/views/sender \
     --output $response

此 API 调用 returns a URL 后,将启动默认浏览器并打开 DocuSign 标签编辑屏幕,其中包含显示我们拥有的所有模板匹配项的叠加屏幕建成。 Template Matches 在此屏幕上选择“应用”按钮,几秒钟后,允许用户查看和验证所有应用的标签。这一切都很好...

我的问题是我想以编程方式将签名者角色传递到信封中,以便正确对齐收件人。我也想传入访问代码: Edit Recipient Screen Edit Recipient Screen

这能做到吗?我找不到有关如何传递此信息或将我传递的签名者数据替换为正在应用的模板中定义的角色的详细信息。我们将始终在发送之前启动标签编辑屏幕,以手动验证所有标签是否存在并正确对齐。这是因为我们发送的文档是从不同的系统动态生成的,它们会根据内容在页面上移动项目。模板做得很好,但有 10% 的时间我们必须在发送前手动调整生成的标签。

提前感谢您就如何完成此任务提供的任何帮助或建议...

您需要知道要传递的收件人的模板角色名称,然后执行如下操作:

{
    "templateId": "{GUID_TEMPLATE_ID}",
    "templateRoles": [
        {
            "email": "email@email.com",
            "name": "signer name",
            "roleName": "signer",
            "accessCode" : "123456"
              
        },
    ]
}