接口描述
获取刷脸地址进行人脸识别认证。该接口可结合电子签名场景使用。
接口地址
/v2/identity/auth/api/individual/{accountId}/face
请求方式
POST
请求头
提供两种安全接入方式,对应参数如何获取,参考文档【请点击】。
方式一:请求签名鉴权(优先推荐)
参数名称 | 类型 | 必选 | 参数说明 |
X-Tsign-Open-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(通过创建个人账号接口获取) |
faceauthMode | string | 是 | body | 指定刷脸认证方式 TENCENT - 腾讯云刷脸认证 ZHIMACREDIT - 支付宝刷脸认证 |
repetition | boolean | 否 | body | 是否允许账号重复实名(默认允许重复实名) |
callbackUrl | string | 是 | body | 认证完成后重定向地址 (可以在用户刷脸完跳转到贵司重定向地址后,调用【查询个人刷脸状态】接口主动查询用户刷脸结果) |
contextId | string | 否 | body | 自定义业务标识 |
notifyUrl | string | 否 | body | 认证结束后异步通知地址(详见"异步通知"章节说明) |
响应参数
展开全部参数参数名称(点击左侧“+”一键展开) | 类型 | 必选 | 参数说明 | |
code | int32 | 是 | 业务码,0表示成功,非0表示异常。 | |
message | string | 是 | 错误信息 请根据 code 来判断错误情况,不应该依赖message匹配,因为 message 可能会调整。 | |
data | object | 否 | 业务信息 | |
flowId | string | 否 | 实名认证流程ID | |
authUrl | string | 否 | 刷脸认证短链接
(如果用户超过链接有效期未操作,需要重新发起新的流程获取新的链接给用户操作) | |
originalUrl | string | 否 | 刷脸认证长链接
(如果用户超过链接有效期未操作,需要重新发起新的流程获取新的链接给用户操作) | |
expire | int64 | 否 | 链接失效时间(Unix时间戳格式,单位:毫秒) |
请求示例
{
"faceauthMode": "ZHIMACREDIT",
"repetition": true,
"callbackUrl":"https://www.xx.cn/",
"contextId": "201908221430111",
"notifyUrl": "http://172.xx.xx.10:8080/notify/msgRecive"
}
响应示例
{
"code": 0,
"message": "成功",
"data": {
"flowId": "938525****5893440",
"authUrl": "https://smlt.tsign.cn/xx",
"originalUrl": "https://openapi.alipay.com/gateway.do?alipay_sdk=alipay-sdk-java-3.4.107.ALL&app_id=2019021563241544&biz_content=%7B%22certify_id%22%3A%22152304085bcbb2b4c495a2e82f87b592%22%7D&charset=GBK&format=json&method=alipay.user.certify.open.certify&sign=hHcebU10ZHdb%2BmBIFYAQLi8CRT%2BShSi7nIJKiAwrO5vxP9wA2I5ah2i86yRs0JlGOB94poJhkW2%2BcdG5DwVZA2UGSj%2B7Go4Y%2BsspeabKCM0s%2FBsT%2BSbnyC3lGRHHr6GhSRa8yd6TqMXTaDA54hlQYBjK1xsaMdEghjWwsqmX4BdwwFGEFW2r9unElw8J18m0xEQFvbBXg7bGuGk0ogDtbqHsZPp9NiNv7F77eCAZoizWrctfJ6HLboTKNUtBG9NWlDfZMCznSy%2FQUczVQjLSBQiUTBKtZ9LVJa2%2BnqD1r%2FvGAWIqimc7jlZdWMEQZYGJjDWNy2zCO1JGVqfh%2BhJUNA%3D%3D&sign_type=RSA2×tamp=2019-10-10+11%%3A22&version=1.0",
"expire": 1570677382238
}
}
错误码
错误码 | 错误描述 | 解决方案 |
30500000 | 操作出错,请联系服务人员处理, ID:XXXX | 请核实入参格式是否正确 |
30500101 | 参数错误:人脸认证方式传参错误 | 请核实faceauthMode入参是否正确 |
30500101 | 参数错误:faceauthMode不能为空 | 请传入正确的刷脸认证方式 |
30500101 | 参数错误:callbackUrl字段不能为空 | 请传入正确的callbackUrl |
30500101 | 参数错误:姓名不能为空 | 请传入正确的姓名 |
30500101 | 参数错误:无效的用户姓名 | 请传入正确的姓名 |
30500101 | 参数错误:无效的用户证件号码 | 请传入正确的证件号码 |
30503107 | 很抱歉,订单余额不足 | 请核实是否有购买认证服务套餐,或登录e签宝官网核实账单记录 |
30500150 | 未找到个人用户基本信息 | 请核实创建个人账号时是否传入正确的个人信息 |
30500152 | 当前账户已实名 | 如需重复实名,需要入参repetition字段 |
30500154 | 个人用户基本信息缺少必要属性:姓名 | 请核实创建个人账户的时候,是否有传入姓名 |
30500154 | 个人用户基本信息缺少必要属性:身份证号 | 请核实创建个人账户的时候,是否有传入身份证号 |
30500156 | 账号不存在,请检查accountId的正确性 | 请核实请求url是否传入正确的accountId |
30503059 | 创建刷脸任务失败:证件号格式有误 | 请核实创建账户时传入的证件号是否正确 |