1. 接口描述
接口请求域名: faceid.tencentcloudapi.com 。
完成验证后,用BizToken调用本接口获取结果信息,BizToken生成后三天内(3*24*3,600秒)可多次拉取。
默认接口请求频率限制:100次/秒。
                推荐使用 API Explorer
            
            点击调试
        
                API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
            
        2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 | 
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:GetDetectInfoEnhanced。 | 
| Version | 是 | String | 公共参数,本接口取值:2018-03-01。 | 
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 | 
| BizToken | 是 | String | 人脸核身流程的标识,调用DetectAuth接口时生成。 示例值:CF742D11-BD49-4704-A33F-B9372D6322D6  | 
| RuleId | 是 | String | 用于细分客户使用场景,由腾讯侧在线下对接时分配。 示例值:5  | 
| InfoType | 否 | String | 指定拉取的结果信息。 - 取值(0:全部;1:文本类;2:身份证信息;3:视频最佳截图信息)。 - 例如 13 表示拉取文本类、视频最佳截图信息。 - 默认值:0 示例值:13  | 
| BestFramesCount | 否 | Integer | 从活体视频中截取一定张数的最佳帧。 - 仅部分服务支持,若需使用请与慧眼小助手沟通。 - 默认值为0,最大值为10,超出10的最多只给10张。 - InfoType需要包含3。 示例值:1  | 
| IsCutIdCardImage | 否 | Boolean | 是否对身份证照片进行裁边。 - 默认为false。 - InfoType需要包含2。 示例值:false  | 
| IsNeedIdCardAvatar | 否 | Boolean | 是否需要从身份证中抠出头像。 - 默认为false。 - InfoType需要包含2。 示例值:false  | 
| IsEncrypt | 否 | Boolean | 已弃用。 示例值:false  | 
| Encryption | 否 | Encryption | 是否需要对返回中的敏感信息进行加密。 - 只需指定加密算法Algorithm即可,其余字段传入默认值。 - 敏感信息包括:Response.Text.IdCard、Response.Text.Name、Response.Text.OcrIdCard、Response.Text.OcrName。  | 
| IsEncryptResponse | 否 | Boolean | 是否对回包整体进行加密。 示例值:false  | 
| IsReturnAllVideo | 否 | Boolean | 是否需要返回认证中间过程的刷脸重试视频,默认不开启,多段视频需要存储到COS空间中,因此开启后还需要额外开启数据存储服务才可生效。详见数据存储指引。 示例值:false  | 
3. 输出参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| Text | DetectInfoText | 人脸核身识别结果及文本类信息。 注意:此字段可能返回 null,表示取不到有效值。  | 
| IdCardData | DetectInfoIdCardData | 身份证照片信息。 注意:此字段可能返回 null,表示取不到有效值。  | 
| BestFrame | DetectInfoBestFrame | 最佳帧信息。 注意:此字段可能返回 null,表示取不到有效值。  | 
| VideoData | DetectInfoVideoData | 视频信息。 注意:此字段可能返回 null,表示取不到有效值。  | 
| Encryption | Encryption | 敏感数据加密信息。 注意:此字段可能返回 null,表示取不到有效值。  | 
| IntentionVerifyData | IntentionVerifyData | 意愿核身朗读模式结果信息。 - 若未使用意愿核身功能,该字段返回值可以不处理。 注意:此字段可能返回 null,表示取不到有效值。  | 
| IntentionQuestionResult | IntentionQuestionResult | 意愿核身问答模式结果。 - 若未使用该意愿核身功能,该字段返回值可以不处理。 注意:此字段可能返回 null,表示取不到有效值。  | 
| IntentionActionResult | IntentionActionResult | 意愿核身点头确认模式的结果信息。 - 若未使用该意愿核身功能,该字段返回值可以不处理。 注意:此字段可能返回 null,表示取不到有效值。  | 
| EncryptedBody | String | 加密后的数据。 注意:此字段可能返回 null,表示取不到有效值。 示例值:0hMvx6fX6n...gXE0adJA==  | 
| IsVerifyIntention | Boolean | 本次请求是否配置开启意愿校验。  false:未开启意愿校验 true:已开启意愿校验 说明:若请求开启了意愿校验,可结合IntentionVerifyType中具体使用的校验模式从对应的出参Result中获取最终的核验结果;若请求没有开启意愿校验,则可在出参Text中获取最终的核验结果。 示例值:false  | 
| IntentionVerifyType | String | 本次请求意愿校验使用的具体模式。 0:问答模式 1:点头确认模式 2:朗读模式 若未使用意愿核身功能,该字段返回值可以不处理。 注意:此字段可能返回 null,表示取不到有效值 示例值:0  | 
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 | 
4. 示例
示例1 获取结果信息成功示例
输入示例
POST / HTTP/1.1
Host: faceid.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetDetectInfoEnhanced
<公共请求参数>
{
    "InfoType": "1",
    "BizToken": "CE661F1A-0F1E-45BD-BE13-34C05CEA7681",
    "RuleId": "0"
}
输出示例
{
    "Response": {
        "BestFrame": {
            "BestFrame": "/9j/4AAQSk...JKD2A//9k=",
            "BestFrames": [
                "/9j/4AAQSk...002dgP/9k=",
                "/9j/4AAQSk...vx+YH/2Q==",
                "/9j/4AAQSk...n6fj5Af//Z",
                "/9j/4AAQSk...dzlFFagf/Z"
            ]
        },
        "EncryptedBody": "",
        "Encryption": {
            "Algorithm": "",
            "CiphertextBlob": "",
            "EncryptList": [],
            "Iv": "",
            "TagList": []
        },
        "IdCardData": {
            "Avatar": null,
            "BackWarnInfos": null,
            "OcrBack": null,
            "OcrFront": null,
            "ProcessedBackImage": null,
            "ProcessedFrontImage": null,
            "WarnInfos": null
        },
        "IntentionActionResult": null,
        "IntentionQuestionResult": {
            "AsrResult": [],
            "Audios": [],
            "FinalResultCode": null,
            "FinalResultDetailCode": null,
            "FinalResultMessage": null,
            "ResultCode": [],
            "ScreenShot": [],
            "Video": null
        },
        "IntentionVerifyData": {
            "AsrResult": null,
            "AsrResultSimilarity": null,
            "ErrorCode": null,
            "ErrorMessage": null,
            "IntentionVerifyBestFrame": null,
            "IntentionVerifyVideo": null
        },
        "IsVerifyIntention": false,
        "IntentionVerifyType": "",
        "RequestId": "91173d84-e461-4da4-a270-2b8d48a2e136",
        "Text": {
            "CompareLibType": "权威库",
            "Comparemsg": "成功",
            "Comparestatus": 0,
            "ErrCode": 0,
            "ErrMsg": "成功",
            "Extra": "",
            "IdCard": "11204416541220243X",
            "IdInfoFrom": "其他",
            "LiveMsg": "成功",
            "LiveStatus": 0,
            "LivenessDetail": [
                {
                    "CompareLibType": "权威库",
                    "Comparemsg": "成功",
                    "Comparestatus": 0,
                    "Errcode": 0,
                    "Errmsg": "成功",
                    "Idcard": "11204416541220243X",
                    "IsNeedCharge": true,
                    "Livemsg": "成功",
                    "LivenessMode": 1,
                    "Livestatus": 0,
                    "Name": "韦小宝",
                    "ReqTime": "1730444265275",
                    "Seq": "1f330eea-f5db-4726-a7b4-38cdf1aefb02",
                    "Sim": "95.51"
                }
            ],
            "LivenessInfoTag": null,
            "LivenessMode": 1,
            "Location": null,
            "Mobile": "",
            "NFCBillingCounts": 0,
            "NFCRequestIds": [],
            "Name": "韦小宝",
            "OcrAddress": null,
            "OcrAuthority": null,
            "OcrBirth": null,
            "OcrGender": null,
            "OcrIdCard": "",
            "OcrName": "",
            "OcrNation": null,
            "OcrValidDate": null,
            "PassNo": null,
            "Sim": "95.51",
            "UseIDType": 0,
            "VisaNum": null
        },
        "VideoData": {
            "LivenessVideo": "AAAAGGZ0eX...VyYWxidW0h"
        }
    }
}
示例2 获取结果信息失败示例
输入示例
POST / HTTP/1.1
Host: faceid.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetDetectInfoEnhanced
<公共请求参数>
{
    "InfoType": "2",
    "BizToken": "4237FAC9-1AE4-4954-B495-FB07D91141CA",
    "RuleId": "0"
}
输出示例
{
    "Response": {
        "Error": {
            "Code": "InvalidParameter",
            "Message": "非法BizToken。"
        },
        "RequestId": "0832c071-0c3e-4a1f-b7d3-4910221a1e18"
    }
}
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: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
 
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 | 
|---|---|
| FailedOperation.DecryptSystemError | 解密失败。 | 
| FailedOperation.EncryptSystemError | 加密失败。 | 
| FailedOperation.StsUnAuthErrError | STS未授权。 | 
| FailedOperation.UnKnown | 内部未知错误。 | 
| InvalidParameter | 参数错误。 | 
| InvalidParameterValue.BizTokenExpired | BizToken过期。 | 
| InvalidParameterValue.RuleIdNotExist | RuleId不存在,请到人脸核身控制台申请。 | 
| UnauthorizedOperation.ActivateError | 服务开通异常。 | 
| UnauthorizedOperation.Activating | 服务开通中。 | 
| UnauthorizedOperation.Arrears | 账号已欠费。 | 
| UnauthorizedOperation.NonAuthorize | 账号未实名。 | 
| UnauthorizedOperation.Nonactivated | 未开通服务。 |