刷脸接口描述
获取个人实名认证地址,页面中集成了人脸识别认证、银行卡认证以及手机认证三种认证方式,用户可以自主选择其中一种认证方式。该接口可结合电子签名场景使用。
【注意事项】
(1)实名认证请提前为用户创建账号,【点击】前往创建个人账号;
(2)如果贵司需要在微信小程序中使用e签宝提供的人脸识别认证方式,请在开发接入前先联系微信小程序工作人员了解小程序上架审核政策并协商,以免造成开发完成应用上架时审核失败“不允许接入第三方人脸识别服务”。
接口地址
/v2/identity/auth/web/{accountId}/indivIdentityUrl
请求方式
POST
请求头
提供两种安全接入方式,对应参数如何获取,参考文档【请点击】。
方式一:请求签名鉴权(优先推荐)
参数名称 | 类型 | 必选 | 参数说明 |
X-Tsign-Open-App-Id | string | 是 | 应用ID |
X-Tsign-Dns-App-Id | string | 否 | 应用ID。在微信小程序中对接,该参数必传;其他场景无需添加该参数 |
Content-Type | string | 是 | application/json;charset=UTF-8 |
X-Tsign-Open-Ca-Timestamp | string | 是 | API 调用者传递时间戳,值为当前时间的毫秒数,也就是从1970年1月1日起至今的时间转换为毫秒,时间戳有效时间为15分钟,为了防重放攻击 |
Accept | string | 是 | 建议统一填写 */* |
X-Tsign-Open-Ca-Signature | string | 是 | 签名字符串 |
Content-MD5 | string | 否 | 当请求 Body 非 Form 表单时,可以计算 Body 的 MD5 值传递给云网关进行 Body MD5 校验。建议当请求 Body 非 Form 表单时,加上此请求头。 |
X-Tsign-Open-Auth-Mode | string | 是 | 选择请求方式进行鉴权,固定值:Signature |
方式二:OAuth2.0鉴权(不推荐使用)
当安全接入选择OAuth2.0鉴权方式,请点击查阅详情。
请求参数
展开全部参数参数名称(点击左侧“+”一键展开) | 参数类型 | 必选 | 参数位置 | 参数说明 | |
accountId | string | 是 | path | 个人账号ID,通过创建个人账号接口获取 | |
authType | string | 否 | body | 指定默认认证类型(打开认证页面所展示的第一个认证类型) PSN_BANK4_AUTHCODE - 个人银行卡四要素认证 PSN_TELECOM_AUTHCODE - 个人运营商三要素认证 PSN_FACEAUTH_BYURL - 个人刷脸认证 | |
availableAuthTypes | list | 否 | body | 指定页面显示认证方式
| |
authAdvancedEnabled | list | 否 | body | 指定通过银行卡认证或运营商认证方式时,是否使用详情版,如指定则核验失败可返回具体不匹配信息,传空默认为普通版。
【注】详情版:需要单独购买,具体购买方式请咨询e签宝工作人员; 普通版:信息比对核验失败,不会返回具体的不匹配信息。 | |
receiveUrlMobileNo | string | 否 | body | 接收实名认证链接短信通知的手机号。传入手机号会发送邀请实名认证短信通知到该用户,并收取一次短信费用,不传入则不发送,不产生短信费用 | |
repeatIdentity | boolean | 否 | body | 是否允许重复实名,默认允许 | |
indivInfo | object | 否 | body | 个人实名认证的基本信息 | |
bankCardNo | string | 否 | body | 个人银行卡号(仅支持银联卡) | |
certNo | string | 否 | body | 个人证件号 | |
certType | string | 否 | body | 个人证件类型 INDIVIDUAL_CH_IDCARD - 中国大陆身份证 INDIVIDUAL_CH_TWCARD - 台湾来往大陆通行证(台胞证) INDIVIDUAL_CH_HONGKONG_MACAO - 港澳来往大陆通行证(回乡证) INDIVIDUAL_PASSPORT - 护照 | |
mobileNo | string | 否 | body | 个人手机号 | |
name | string | 否 | body | 个人姓名 | |
configParams | object | 否 | body | 认证配置信息 | |
indivUneditableInfo | list | 否 | body | 设置个人认证页面上不可修改的基本信息。传空表示可以修改
【注】创建e签宝个人账号时传入了姓名和证件号,则页面上姓名和证件号固定不可修改; 创建e签宝个人账号时未传入姓名和证件号,则可通过此参数指定页面上姓名和证件号是否可修改。 | |
contextInfo | object | 否 | body | 业务方交互上下文信息,有统计需求或者分账需求必填部分参数 | |
contextId | string | 否 | body | 自定义业务标识 | |
notifyUrl | string | 否 | body | 发起方接收实名认证状态变更通知的地址,异步通知参考【请点击】 | |
origin | string | 否 | body | 认证发起来源,默认值为 BROWSER BROWSER - 浏览器 APP - 移动端APP | |
redirectUrl | string | 否 | body | 认证结束后页面跳转地址,【点击】查看如何跳转回APP | |
showResultPage | boolean | 否 | body | 认证完成是否显示结果页,默认值为 true true - 显示结果,false - 不显示结果 |
响应参数
展开全部参数参数名称(点击左侧“+”一键展开) | 类型 | 必选 | 参数说明 | |
code | int32 | 是 | 业务码,0表示成功,非0表示异常。 | |
message | string | 是 | 错误信息 请根据 code 来判断错误情况,不应该依赖message匹配,因为 message 可能会调整。 | |
data | object | 否 | 业务信息 | |
flowId | string | 否 | 认证流程ID | |
shortLink | string | 否 | 个人实名认证短链接(链接有效期30天) 沙箱环境域名:https://smlt.tsign.cn 正式环境域名:https://t.tsign.cn | |
url | string | 否 | 个人实名认证长链接(链接有效期30天) 沙箱环境域名:https://smlfront.esign.cn 正式环境域名:https://idverify.esign.cn |
请求示例
{
"authType": "PSN_BANK4_AUTHCODE",
"availableAuthTypes":["PSN_TELECOM_AUTHCODE","PSN_BANK4_AUTHCODE","PSN_FACEAUTH_BYURL"],
"authAdvancedEnabled":["PSN_BANK4_AUTHCODE","PSN_TELECOM_AUTHCODE"],
"contextInfo": {
"contextId": "57cc9602****61e9f8443xxx",
"notifyUrl": "http://xx.xx.86.172:8081/asyn/notify",
"origin": "BROWSER",
"redirectUrl": "http://www.xx.cn/",
"showResultPage": true
},
"indivInfo": {
"name": "**",
"certType": "INDIVIDUAL_CH_IDCARD",
"certNo": "362428xxxxxxxx0010",
"mobileNo": "186xxxx0000",
"bankCardNo": "62271234xxx1234123"
},
"configParams": {
"indivUneditableInfo": ["name", "certNo", "mobileNo", "bankCardNo"]
},
"repeatIdentity": true
}
响应示例
{
"code": 0,
"data": {
"flowId": "806735635690817xxx",
"shortLink": "https://testt.tsign.cn/AzPS1T0LtMqU",
"url": "http://testfront.tsign.cn:8890/identity/login?param=RjnJDvu5CYdgGzn5fC9z2iCGY0T2ytSFx08ZyMLVXwvkma7PPiwuic8hqMsyl5QdwbXxpdhLYs9EdWbklEHn8CQaTs8XW5K1DM2WmzI0imNASHNnCMZ3s42GMiwY02RdqHZ%2FS4sZCs%2F2c5mMPrDFwGHW72sv2yQ4h4IQH44%2BGJTwry6eCP3W49kd11lDEEtSnL737p7bh%2FhYvKrDSEYGdnfsLCvbxnd4bjzH1GcE7acg4%2BZXNZaQn23Nnvb2ZPhF7bSwFk7tZ6S4E7dbAECBeA%3D%3D"
},
"message": "成功"
}
错误码
错误码 | 错误描述 | 解决方案 |
30500000 | 操作出错,请联系服务人员处理, ID:XXXX | 请核实入参格式是否正确 |
30500101 | 参数错误:输入名称与账号不匹配 | 请核实传入的姓名和创建账号时的姓名是否一致 |
30500101 | 参数错误:输入证件号与账号不匹配 | 请核实传入的证件号和创建账号时的证件号是否一致 |
30500156 | 账号不存在,请检查accountId的正确性 | 请核实请求url是否传入正确的accountId |
30500150 | 未找到个人用户基本信息 | 请核实创建个人账号id时是否有传入个人基本信息 |
30500152 | 当前账户已实名 | 如需重复实名,需要入参repeatIdentity字段 |
30500201 | 当前应用未配置该类型的认证方式 | 当前appid没有配置接口入参指定的认证方式 |
30500202 | 当前无可使用的认证方式 | 当前appid没有配置认证方式 |