人脸核身实名核身鉴权

1. 接口描述

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

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

默认接口请求频率限制：100次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DetectAuth。
Version	是	String	公共参数，本接口取值：2018-03-01。
Region	否	String	公共参数，本接口不需要传递此参数。
RuleId	是	String	业务流程ID。 - 用于细分客户使用场景, 可为业务配置不同的业务流程。 - 申请开通服务后，登录腾讯云慧眼人脸核身控制进行创建，审核通过后即可调用。 - 如有疑问，请添加腾讯云人脸核身小助手进行咨询。示例值：1
TerminalType	否	String	本接口不需要传递此参数。
IdCard	否	String	验证人的身份证号码。 - 是否必传基于控制台申请业务流程时配置的提示。示例值：11204416541220243X
Name	否	String	验证人的姓名。 - 是否必传基于控制台申请业务流程时配置的提示。 - 最长长度32位。中文请使用UTF-8编码。示例值：韦小宝
RedirectUrl	否	String	认证结束后重定向的回调链接地址。 - 最长长度1024位。示例值：https://www.qq.com
Extra	否	String	透传字段，在获取验证结果时返回。示例值：Orderid=f904f4cf75db4f8fdc4f942c7f7a
ImageBase64	否	String	用于人脸比对的图像数据，使用base64编码。 - Base64编码后的图片数据大小不超过3M。 - 仅支持jpg、png格式。 - 请使用标准的Base64编码方式(带=补位)，编码规范参考RFC4648。示例值：/9j/4AAQSkZJRg.....s97n//2Q==
Encryption	否	Encryption	敏感数据加密信息。对传入信息（姓名、身份证号）有加密需求的用户可使用此参数，详情请点击左侧链接。
IntentionVerifyText	否	String	意愿核身（朗读模式）使用的文案。 - 若未使用意愿核身（朗读模式），则该字段无需传入。 - 最长可接受120的字符串长度。
IntentionQuestions.N	否	Array of IntentionQuestion	意愿核身（语音播报+语音回答模式）使用的文案。 - 包括：系统语音播报的文本、需要核验的标准文本。 - 问答模式支持1-10轮（不超过10轮）的意愿确认。
IntentionActions.N	否	Array of IntentionActionConfig	意愿核身（点头确认模式）使用的文案。 - 若未使用意愿核身（点头确认模式），则该字段无需传入。 - 点头确认模式支持1-10轮（不超过10轮）的意愿确认。
Config	否	RuleIdConfig	意愿核身流程配置。

3. 输出参数

参数名称	类型	描述
Url	String	用于发起核身流程的URL，仅微信H5场景使用。示例值：https://faceid.qq.com?token=81EEF678-28EE-4759-A82E-6CBBBE6BC442
BizToken	String	一次核验流程的唯一标识。 - 有效时间为7,200秒，超过有效期再进行人脸核验会报错，请在有效期内进行核验。 - 完成人脸核验后，需根据此标识调用获取实名核身结果信息增强版获取用户最终验证结果信息。示例值：81EEF6178-28EE-4759-A823E-6CBBBE6BC442
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 微信小程序获取BizToken成功示例

输入示例

POST / HTTP/1.1
Host: faceid.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DetectAuth
<公共请求参数>

{
    "RuleId": "0",
    "IdCard": "11204416541220243X",
    "Name": "韦小宝"
}

输出示例

{
    "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"
    }
}

示例2 H5获取BizToken成功示例

输入示例

POST / HTTP/1.1
Host: faceid.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DetectAuth
<公共请求参数>

{
    "RuleId": "0",
    "IdCard": "11204416541220243X",
    "Name": "韦小宝",
    "Extra": "Orderid=f904f4cf75db4f8fdc4f942c7f7a",
    "RedirectUrl": "http://www.qq.com"
}

输出示例

{
    "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"
    }
}

示例3 获取BizToken失败示例

输入示例

POST / HTTP/1.1
Host: faceid.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DetectAuth
<公共请求参数>

{
    "RuleId": "999",
    "IdCard": "11204416541220243X",
    "Name": "韦小宝"
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "InvalidParameterValue.RuleIdNotExist",
            "Message": "RuleId不存在，请到人脸核身控制台申请。"
        },
        "RequestId": "e90c9abf-dcb3-4efa-97fc-5c4501b8182c"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure.InvalidAuthorization	CAM签名/鉴权错误。
FailedOperation.DecryptSystemError	解密失败。
FailedOperation.UnKnown	内部未知错误。
InvalidParameter	参数错误。
InvalidParameter.UnsupportEncryptField	存在不加密的字段，请参考文档修改。
InvalidParameterValue.RuleIdDisabled	该ruleid已被您停用，请确认后重试。
InvalidParameterValue.RuleIdNotExist	RuleId不存在，请到人脸核身控制台申请。
UnauthorizedOperation.ActivateError	服务开通异常。
UnauthorizedOperation.Activating	服务开通中。
UnauthorizedOperation.Arrears	账号已欠费。
UnauthorizedOperation.NonAuthorize	账号未实名。
UnauthorizedOperation.Nonactivated	未开通服务。

云服务器

云硬盘

容器服务

负载均衡

弹性伸缩

云函数

私有网络

专线接入

API 网关

批量计算

对象存储

微服务平台 TSF

文件存储

全站加速网络

消息队列 CKafka 版

日志服务

云数据库 MySQL

云数据库 MariaDB

云数据库 SQL Server

云数据库 PostgreSQL

云数据库 Redis®

内容分发网络 CDN

云数据库 Memcached

云数据库 MongoDB

TDSQL MySQL版

数据传输服务

全球应用加速

腾讯云可观测平台

云拨测

腾讯云区块链服务平台 TBaaS

主机安全

访问管理

标签

DDoS 防护

Web 应用防火墙

密钥管理系统

操作审计

域名注册

SSL 证书

移动推送

短信

数据万象

NLP 服务

云点播

云市场

云加密机

云安全中心

云开发 CloudBase

口语评测（基础版）

人脸识别

文字识别

图像识别

腾讯云数据仓库 TCHouse-P

集团账号管理

Elasticsearch Service

流计算 Oceanus

媒体处理

云直播

云联络中心

机器翻译

物联网通信

人脸融合

弹性 MapReduce

游戏数据库 TcaplusDB

游戏多媒体引擎

腾讯云 BI

实时音视频

TI-ONE 训练平台

渠道合作伙伴

数据安全审计

5G入云服务

云数据库 KeeWiDB

微瓴同业开放平台

消息队列 RocketMQ 版

腾讯云数据仓库 TCHouse-C

数据安全治理中心

设备安全

实时互动-教育版

智能视图计算平台

云压测