获取实名核身结果信息增强版

最近更新时间：2024-03-12 01:31:29

我的收藏

本页目录：

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接口时生成。示例值：CE661F1A-0F1E-45BD-BE13-34C05CEA7681
RuleId	是	String	用于细分客户使用场景，由腾讯侧在线下对接时分配。示例值：0
InfoType	否	String	指定拉取的结果信息，取值（0：全部；1：文本类；2：身份证信息；3：视频最佳截图信息）。如 13表示拉取文本类、视频最佳截图信息。默认值：0 示例值：1
BestFramesCount	否	Integer	从活体视频中截取一定张数的最佳帧（仅部分服务支持，若需使用请与慧眼小助手沟通）。默认为0，最大为10，超出10的最多只给10张。（InfoType需要包含3）示例值：0
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	是否对回包整体进行加密

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，表示取不到有效值。
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": {
        "Text": {
            "ErrCode": 0,
            "ErrMsg": "成功",
            "UseIDType": 0,
            "IdCard": "440111111111111111",
            "Name": "爱新觉罗永琪",
            "OcrNation": null,
            "OcrAddress": null,
            "OcrBirth": null,
            "OcrAuthority": null,
            "OcrValidDate": null,
            "OcrName": "爱新觉罗永琪",
            "OcrIdCard": "440111111111111111",
            "OcrGender": null,
            "IdInfoFrom": "abc",
            "LivenessMode": 0,
            "LiveStatus": 0,
            "LiveMsg": "成功",
            "Comparestatus": 0,
            "Comparemsg": "成功",
            "CompareLibType": "权威库",
            "Sim": "76.52",
            "Location": null,
            "Mobile": null,
            "Extra": "",
            "NFCRequestIds": [
                "abc"
            ],
            "NFCBillingCounts": 0,
            "PassNo": "abc",
            "VisaNum": "abc",
            "LivenessDetail": [
                {
                    "ReqTime": "1577179388135",
                    "Seq": "3d12da91-db34-4e55-81c3-993a41d7ccb7",
                    "Idcard": "440111111111111111",
                    "Name": "爱新觉罗永琪",
                    "CompareLibType": "权威库",
                    "Sim": "76.52",
                    "IsNeedCharge": true,
                    "Errcode": 0,
                    "Errmsg": "成功",
                    "LivenessMode": 0,
                    "Livestatus": 0,
                    "Livemsg": "成功",
                    "Comparestatus": 0,
                    "Comparemsg": "成功"
                }
            ]
        },
        "IdCardData": {
            "ProcessedBackImage": "base64",
            "ProcessedFrontImage": "base64",
            "OcrFront": "base64",
            "OcrBack": "base64",
            "Avatar": "base64",
            "WarnInfos": [],
            "BackWarnInfos": []
        },
        "IntentionVerifyData": {
            "IntentionVerifyVideo": "base64",
            "ErrorCode": 0,
            "ErrorMessage": "成功",
            "AsrResult": "同意",
            "AsrResultSimilarity": "0",
            "IntentionVerifyBestFrame": "base64"
        },
        "IntentionActionResult": {
            "FinalResultDetailCode": 0,
            "FinalResultMessage": "abc",
            "Details": [
                {
                    "Video": "abc",
                    "ScreenShot": [
                        "abc"
                    ]
                }
            ]
        },
        "IntentionQuestionResult": {
            "FinalResultDetailCode": 0,
            "FinalResultMessage": "abc",
            "AsrResult": [
                "同意"
            ],
            "ResultCode": [
                "0"
            ],
            "Audios": [
                "base64"
            ],
            "Video": "base64",
            "ScreenShot": [
                "base64"
            ],
            "FinalResultCode": "0"
        },
        "BestFrame": {
            "BestFrame": "base64",
            "BestFrames": [
                "base64"
            ]
        },
        "VideoData": {
            "LivenessVideo": "base64"
        },
        "Encryption": {
            "Iv": "iv",
            "EncryptList": [
                "Response.Text.Name"
            ],
            "CiphertextBlob": "CiphertextBlob"
        },
        "EncryptedBody": "abc",
        "RequestId": "f52bac9a-0aee-4fe6-8d34-7de4bce89473"
    }
}

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. 错误码

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

错误码	描述
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	未开通服务。

上一篇: 实名核身鉴权下一篇: 获取E证通结果信息