有奖捉虫:云通信与企业服务文档专题,速来> HOT

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 用于细分客户使用场景,申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid) 自助接入里面创建,审核通过后即可调用。如有疑问,请添加腾讯云人脸核身小助手进行咨询。
示例值:0
TerminalType String 本接口不需要传递此参数。
IdCard String 身份标识(未使用OCR服务时,必须传入)。
规则:a-z,A-Z,0-9组合。最长长度32位。
Name String 姓名。(未使用OCR服务时,必须传入)最长长度32位。中文请使用UTF-8编码。
RedirectUrl String 认证结束后重定向的回调链接地址。最长长度1024位。
Extra String 透传字段,在获取验证结果时返回。
ImageBase64 String 用于人脸比对的照片,图片的Base64值;
Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
Encryption Encryption 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。
IntentionVerifyText String 意愿核身(朗读模式)使用的文案,若未使用意愿核身(朗读模式),则该字段无需传入。默认为空,最长可接受120的字符串长度。
IntentionQuestions.N Array of IntentionQuestion 意愿核身语音问答模式(即语音播报+语音回答)使用的文案,包括:系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。
Config RuleIdConfig RuleId相关配置
IntentionActions.N Array of IntentionActionConfig 意愿核身(点头确认模式)使用的文案,若未使用意愿核身(点头确认模式),则该字段无需传入。当前仅支持一个提示文本。

3. 输出参数

参数名称 类型 描述
Url String 用于发起核身流程的URL,仅微信H5场景使用。
BizToken String 一次核身流程的标识,有效时间为7,200秒;
完成核身后,可用该标识获取验证结果信息。
示例值:CE661F1A-0F1E-45BD-BE13-34C05CEA7681
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 鉴权操作 前往调试工具

输入示例

POST / HTTP/1.1
Host: faceid.tencentcloudapi.com
Content-Type: application/json
X-TC-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 平台

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

API Inspector

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

SDK

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

命令行工具

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 未开通服务。