Docusignapi 预填充用户';s ID检查-使用templateRoles时DocuSign中的个人信息

Docusignapi 预填充用户';s ID检查-使用templateRoles时DocuSign中的个人信息,docusignapi,Docusignapi,我目前正在使用RESTAPI(…/v2/accounts/someId/信封)请求用户文档。我的应用程序当前请求一个具有相应模板的文档,其中大部分数据都是使用templateRoles键预先填充的。当提示用户进行ID检查时,会再次询问用户我们已有的信息(姓名、地址等)。我们希望预先填写此信息 我已经浏览了文档,但是idCheckInformationInput的示例都没有使用templateRoles。理想情况下,我们不必更改当前api调用的结构,因为它已经相当成熟且经过良好测试。我已尝试添加i

我目前正在使用RESTAPI(…/v2/accounts/someId/信封)请求用户文档。我的应用程序当前请求一个具有相应模板的文档,其中大部分数据都是使用templateRoles键预先填充的。当提示用户进行ID检查时,会再次询问用户我们已有的信息(姓名、地址等)。我们希望预先填写此信息

我已经浏览了文档,但是idCheckInformationInput的示例都没有使用templateRoles。理想情况下,我们不必更改当前api调用的结构,因为它已经相当成熟且经过良好测试。我已尝试添加idCheckInformationInput键,但ID检查仍返回为空

我们目前的呼吁是:

…/v2/账户/someId/信封

data => {
   "allowMarkup":false,
   "allowReassign":false,
   "allowRecipientRecursion":false,
   "asynchronous":false,
   "authoritativeCopy":false,
   "autoNavigation":false,
   "brandId":"xxxx",
   "compositeTemplates":null,
   "customFields":null,
   "emailBlurb":"",
   "emailSubject":"Secure Authorization Document",
   "enableWetSign":false,
   "enforceSignerVisibility":false,
   "envelopeIdStamping":false,
   "eventNotification":{
      "envelopeEvents":[
         {
            "envelopeEventStatusCode":"completed",
            "includeDocuments":false
         },
         {
            "envelopeEventStatusCode":"declined",
            "includeDocuments":false
         },
         {
            "envelopeEventStatusCode":"voided",
            "includeDocuments":false
         }
      ],
      "loggingEnabled":true,
      "includeCertificateWithSoap":false,
      "includeDocuments":false,
      "includeTimeZone":false,
      "includeSenderAccountAsCustomField":false,
      "recipientEvents":[

      ],
      "requireAcknowledgment":true,
      "signMessageWithX509Cert":false,
      "soapNameSpace":"",
      "url":"xxxx/external/signing/eventnotification",
      "useSoapInterface":false
   },
   "signingLocation":"Online",
   "status":"sent",
   "templateId":"xxxx",
   "templateRoles":[
      {
         "accessCode":null,
         "clientUserId":"xxxx",
         "email":"xxxx@xxxx.com",
         "emailNotification":null,
         "name":"a a a",
         "recipientId":"1",
         "roleName":"Client",
         "tabs":{
            "checkboxTabs":[
               {
                  "name":"Checkbox",
                  "selected":false,
                  "tabLabel":"ExchangeEtcEmployed"
               },{...}
            ],
            "radioGroupTabs":[

            ],
            "textTabs":[
               {
                  "name":"Text",
                  "tabLabel":"\\*DOB",
                  "value":"1/1/1980"
               }, {...}

            ]
         },
         "idCheckConfigurationName": "ID Check $",
         "idCheckInformationInput":{ //new key possibly in the wrong spot
            "addressInformationInput":{
               "addressInformation":{
                  "street1":"aaa",
                  "street2":"",
                  "city":"San Francisco",
                  "state":"CA",
                  "zip":"94102"
               },
               "displayLevelCode":"Editable"
            },
            "dobInformationInput":{
               "dateOfBirth":"1/1/1980",
               "displayLevelCode":"Editable"
            },
            "ssn4InformationInput":{
               "ssn4":"4444",
               "displayLevelCode":"Editable"
            }
         }
      }
   ]
}
我还注意到,如果我添加requireIdLookup:true,并关闭docusign端的标志(manage->template->roles->Identity->Identity Check=ID Check$),则不会显示ID检查。让它显示的唯一方法是检查它,它总是返回空的

编辑: 我最近尝试使用指定的格式,但结果与以前相同:

{
   "allowMarkup":false,
   "allowReassign":false,
   "allowRecipientRecursion":false,
   "asynchronous":false,
   "authoritativeCopy":false,
   "autoNavigation":false,
   "brandId":"xxxx",
   "compositeTemplates":[
      {
         "inlineTemplates":[
            {
               "sequence":"1",
               "recipients":{
                  "signers":[
                     {
                        "accessCode":null,
                        "clientUserId":"xxxx",
                        "email":"xxx@xxx.com",
                        "emailNotification":null,
                        "name":"a a a",
                        "recipientId":"1",
                        "roleName":"Client",
                        "tabs":{
                           "checkboxTabs":[...],
                           "radioGroupTabs":[...],
                           "textTabs":[...]
                        },
                        "idCheckInformationInput":{
                           "addressInformationInput":{
                              "addressInformation":{
                                 "street1":"aaa",
                                 "street2":"",
                                 "city":"San Francisco",
                                 "state":"CA",
                                 "zip":"94105"
                              },
                              "displayLevelCode":"Editable"
                           },
                           "dobInformationInput":{
                              "dateOfBirth":"1/1/1980",
                              "displayLevelCode":"Editable"
                           },
                           "ssn4InformationInput":{
                              "ssn4":"xxxx",
                              "displayLevelCode":"Editable"
                           }
                        },
                        "requireIdLookup":true,
                        "idCheckConfigurationName":"ID Check $"
                     }
                  ]
               }
            }
         ],
         "serverTemplates":[
            {
               "sequence":"1",
               "templateId":"xxx"
            }
         ]
      }
   ],
   "customFields":null,
   "emailBlurb":"",
   "emailSubject":"Secure Authorization Document",
   "enableWetSign":false,
   "enforceSignerVisibility":false,
   "envelopeIdStamping":false,
   "eventNotification":{...},
   "signingLocation":"Online",
   "status":"sent",
   "templateId":null,
   "templateRoles":null
}
编辑2: 我能够让它与compositeTemplates格式一起工作,尽管我不得不删除roleName。将roleName设置为“Client”时,它严格遵循“Client”(收件人和路由模式)模板的“Roles”部分中定义的内容,并忽略传递的RequiredLookup密钥以及任何IDCheckInfo输入。删除角色还会阻止文档的任何输入被标签数据填充——考虑到标签是特定于角色的,这是有意义的


理想情况下,我可以使用templateRoles版本,但我很乐意使用compositeTemplates与角色一起工作。您应该能够在给定模板的角色模式的标识列下指定ID Check$,然后在传入IDCHECKINFOROMATIONInput时填写ID Check。

在我看来,idCheckInformationInput位于正确的位置,但是您缺少idCheckConfigurationName和REQUIREDLOOKUP条目。请检查下面的文档片段和下面的小样本:


在我看来,idCheckInformationInput位于正确的位置,但是您缺少idCheckConfigurationName和RequiredLookup条目。请检查下面的文档片段和下面的小样本:


为了实现这一点,我需要切换到compositeTemplates格式,并且为了解决roleName的问题,我必须在收件人和路由模式的cog下拉列表中取消选中“发件人无法编辑收件人”,该模式在您单击模板的角色时启动

为了使这项功能正常工作,我需要切换到compositeTemplates格式,并且为了解决角色名的问题,我必须在收件人和路由模式的cog下拉列表中取消选中“发件人无法编辑收件人”,该模式在您单击模板的角色时启动

我试过这两种方法,RequiredLookup是根据请求的模板在DocuSign上定义的,所以不应该在这里添加它(尽管我试过以确保它不会以某种方式工作)。不管怎样,身份证都会显示出来,所以这不重要,只是没有填写。另外,您是如何决定“ID Check$”的idCheckConfigurationName的?这是否需要与特定的内容相匹配?如果只是这样,那也没用。您可以在文档中看到,它不像我的那样嵌套在templateRoles下,尽管我没有signers部分。它需要与您想要使用的身份验证(ID检查、SMS、电话等)的名称匹配。如果登录到web控制台并尝试使用auth创建信封,则可以看到身份验证选项的名称。Lexis Nexis身份验证的默认idCheckConfigurationName为“ID Check$”。我认为可能是这样,但这是我们正在使用并添加的ID Check名称,无法修复它。不过还是要感谢。通过删除已定义的roleName并切换到compositeTemplates格式,实现了这一点,尽管这自然会破坏其他功能(预填充的模板输入和预配置的ID检查切换)。我已经尝试了这两种功能,RequiredLookup在DocuSign上定义,具体取决于请求的模板,所以不应该在这里添加它(尽管我尝试了它以确保它不会以某种方式工作)。不管怎样,身份证都会显示出来,所以这不重要,只是没有填写。另外,您是如何决定“ID Check$”的idCheckConfigurationName的?这是否需要与特定的内容相匹配?如果只是这样,那也没用。您可以在文档中看到,它不像我的那样嵌套在templateRoles下,尽管我没有signers部分。它需要与您想要使用的身份验证(ID检查、SMS、电话等)的名称匹配。如果登录到web控制台并尝试使用auth创建信封,则可以看到身份验证选项的名称。Lexis Nexis身份验证的默认idCheckConfigurationName为“ID Check$”。我认为可能是这样,但这是我们正在使用并添加的ID Check名称,无法修复它。不过还是要感谢。通过删除已定义的角色名并切换到compositeTemplates格式,实现了这一功能,尽管这自然会破坏其他功能(预填充的模板输入和预配置的ID检查切换)。我尝试了使用“RequiredLookup”和不使用“RequiredLookup”:“true”,两种方式都会显示空白的ID检查。RequiredLookup是在docusign的站点上按模板级别指定的。我尝试过使用和不使用“RequiredLookup”:“true”,两种方式都会显示一个空白的ID检查。RequiredLookup是在docusign网站的每个模板级别上指定的。
"name":"a a a",
"recipientId":"1",
"roleName":"Client",
 ...
"requireIdLookup" :"true",
"idCheckConfigurationName": "ID Check $",
  "idCheckInformationInput": {
    "addressInformationInput": {
      "addressInformation": {
        "street1": "sample string 1",
        "street2": "sample string 2",
        "city": "sample string 3",
        "state": "sample string 4",
        "zip": "sample string 5",
        "zipPlus4": "sample string 6"
      },
      "displayLevelCode": "sample string 1",
      "receiveInResponse": "sample string 2"
    },