如何通过REST API预设RecipientIdentityInputOption及映射与标准化问题
关于DocuSign REST API设置RecipientIdentityInputOption的问题解答
一、通过REST API预设RecipientIdentityInputOption的步骤
你已经通过GetAccountIdentityVerification(accountId)获取了账户身份验证工作流ID,接下来可以按照以下方式配置:
- 在创建信封的API请求中,给目标收件人添加
identityVerification字段,将获取到的workflowId填入对应位置。 - 针对
RecipientIdentityInputOption,需要根据所选验证工作流的要求,在inputOptions数组中填充对应参数。示例请求片段如下:
"recipients": { "signers": [ { "email": "recipient@example.com", "name": "Recipient Name", "recipientId": "1", "identityVerification": { "workflowId": "你的工作流ID", "inputOptions": [ { "name": "signerName", "value": "Recipient Name" }, { "name": "signerEmail", "value": "recipient@example.com" } ] } } ] }
二、工作流ID与RecipientIdentityInputOption的映射方式
- 调用
GetAccountIdentityVerification(accountId)返回的每个验证工作流对象中,都包含inputOptions数组,这就是该工作流对应的RecipientIdentityInputOption模板。 - 你可以遍历返回的工作流列表,通过
workflowId或工作流名称定位到目标验证方式,直接复用其inputOptions结构,在创建信封时填充实际值即可。比如短信验证工作流的inputOptions会包含phoneNumber字段,需填入收件人手机号。
三、身份验证列表的标准化问题
身份验证列表并非所有DocuSign账户通用标准化,会受以下因素影响:
- 账户订阅计划:不同等级的计划支持的验证方式范围不同,企业版通常包含更多高级验证选项。
- 账户管理员配置:管理员可在后台启用、禁用或自定义验证工作流。
- 地区合规要求:不同地区的合规政策会限制可用的验证方式,部分地区会强制要求特定身份验证手段。
因此在多账户集成时,必须针对每个账户单独调用GetAccountIdentityVerification获取其可用验证工作流,不能硬编码工作流ID或输入选项,否则会出现兼容性问题。
内容的提问来源于stack exchange,提问作者Jess Marvela
相关产品推荐
相关产品推荐

