实名核身鉴权

最近更新时间:2019-07-24 15:19:31

1. 接口描述

接口请求域名: faceid.tencentcloudapi.com 。

每次调用人脸核身SaaS化服务前,需先调用本接口获取BizToken,用来串联核身流程,在验证完成后,用于获取验证结果信息。

默认接口请求频率限制:5次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:faceid.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DetectAuth
Version String 公共参数,本接口取值:2018-03-01
Region String 公共参数,详见产品支持的 地域列表
RuleId String 用于细分客户使用场景,申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid) 自助接入里面创建,审核通过后即可调用。如有疑问,请加慧眼小助手微信(faceid001)进行咨询。
TerminalType String 本接口不需要传递此参数。
IdCard String 身份标识(与公安权威库比对时必须是身份证号)。
规则:a-zA-Z0-9组合。最长长度32位。
Name String 姓名。最长长度32位。中文请使用UTF-8编码。
RedirectUrl String 认证结束后重定向的回调链接地址。最长长度1024位。
Extra String 透传字段,在获取验证结果时返回。
ImageBase64 String 用于人脸比对的照片,图片的BASE64值;
BASE64编码后的图片数据大小不超过3M,仅支持jpg、png格式。

3. 输出参数

参数名称 类型 描述
Url String 用于发起核身流程的URL,仅微信H5场景使用。
BizToken String 一次核身流程的标识,有效时间为7,200秒;
完成核身后,可用该标识获取验证结果信息。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 鉴权操作

输入示例

https://faceid.tencentcloudapi.com/?Action=DetectAuth
&RuleId=0
&<公共请求参数>

输出示例

{
  "Response": {
    "BizToken": "CE661F1A-0F1E-45BD-BE13-34C05CEA7681",
    "Url": "https://open.weixin.qq.com/connect/oauth2/authorize?appid=wx2cca36a86d5035ae&redirect_uri=http%3A%2F%2Fopen.faceid.qq.com%2Fv1%2Fapi%2FgetCode%3FbizRedirect%3Dhttp%253A%252F%252Ffaceid.qq.com%252Fapi%252Fauth%252FgetOpenidAndSaveToken%253Ftoken%253DCE661F1A-0F1E-45BD-BE13-34C05CEA7681&response_type=code&scope=snsapi_base&state=&component_appid=wx9802ee81e68d6dee#wechat_redirect",
    "RequestId": "f904f4cf-75db-4f8f-a5ec-dc4f942c7f7a"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.UnKnown 内部未知错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.RuleIdNotExist RuleId不存在。
UnauthorizedOperation.Arrears 帐号已欠费。
UnauthorizedOperation.Nonactivated 未开通服务。