tencent cloud

人脸核身

获取Web核验服务结果信息

PDF
聚焦模式
字号
最后更新时间: 2026-04-24 16:16:52

1. 接口描述

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

完成Web核验流程后,用核验令牌(BizToken)调用本接口查询对应核验结果信息。BizToken申请后三天内(259,200秒)有效,可多次调用。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetWebVerificationResultIntl。
Version String 公共参数,本接口取值:2018-03-01。
Region String 公共参数,详见产品支持的 地域列表
BizToken String Web核验令牌,由ApplyWebVerificationBizTokenIntl接口生成。

3. 输出参数

参数名称 类型 描述
ErrorCode Integer 本次流程的最终结果,0为核验通过,是同一人。
其余错误码请参考:Liveness Detection and Face Comparison (Mobile HTML5) Error Codes
注意:此字段可能返回 null,表示取不到有效值。
ErrorMsg String 本次流程的最终结果描述。
注意:此字段可能返回 null,表示取不到有效值。
VerificationDetailList Array of VerificationDetail 本次流程的详细核验结果列表,由于可重试的原因,本次流程可能存在多个核验信息。
注意:此字段可能返回 null,表示取不到有效值。
VideoBase64 String 视频流中采集的视频内容的base64编码字符串,由于可重试的原因,该字段返回最后一次核验采集的数据,如果未采集到视频,则返回null。
注意:此字段可能返回 null,表示取不到有效值。
BestFrameBase64 String 视频流中采集的最佳人脸照片的base64编码字符串,由于可重试的原因,该字段返回最后一次核验采集的数据,如果未采集到最佳人脸照片,则返回null。
注意:此字段可能返回 null,表示取不到有效值。
OCRResult Array of OCRResult 证照识别的结果
注意:此字段可能返回 null,表示取不到有效值。
Extra String 业务透传参数
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取Web核验服务结果信息

输入示例

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

{
    "BizToken": "EE13636D-1985-42CA-BD61-73F4C8B687E6"
}

输出示例

{
    "Response": {
        "ErrorCode": 0,
        "ErrorMsg": "abc",
        "VerificationDetailList": [
            {
                "ErrorCode": 0,
                "ErrorMsg": "abc",
                "LivenessErrorCode": 0,
                "LivenessErrorMsg": "abc",
                "CompareErrorCode": 0,
                "CompareErrorMsg": "abc",
                "ReqTimestamp": 1,
                "Similarity": 0,
                "Seq": "abc"
            }
        ],
        "VideoBase64": "abc",
        "BestFrameBase64": "abc",
        "OCRResult": [
            {
                "IsPass": true,
                "CardImageBase64": "abc",
                "CardInfo": {
                    "HKIDCard": {
                        "CnName": "abc",
                        "EnName": "abc",
                        "IdNum": "abc",
                        "Birthday": "abc",
                        "Sex": "abc"
                    },
                    "MLIDCard": {
                        "Name": "abc",
                        "ID": "abc",
                        "Sex": "abc",
                        "Address": "abc",
                        "Type": "abc",
                        "Birthday": "abc"
                    },
                    "PhilippinesVoteID": {
                        "VIN": "abc",
                        "FirstName": "abc",
                        "LastName": "abc",
                        "Birthday": "abc",
                        "CivilStatus": "abc",
                        "Citizenship": "abc",
                        "Address": "abc",
                        "PrecinctNo": "abc"
                    },
                    "IndonesiaIDCard": {
                        "NIK": "abc",
                        "Nama": "abc",
                        "TempatTglLahir": "abc",
                        "JenisKelamin": "abc",
                        "GolDarah": "abc",
                        "Alamat": "abc",
                        "RTRW": "abc",
                        "KelDesa": "abc",
                        "Kecamatan": "abc",
                        "Agama": "abc",
                        "StatusPerkawinan": "abc",
                        "Perkerjaan": "abc",
                        "KewargaNegaraan": "abc",
                        "BerlakuHingga": "abc",
                        "IssuedDate": "abc",
                        "Provinsi": "abc",
                        "Kota": "abc"
                    },
                    "PhilippinesDrivingLicense": {
                        "Name": "abc",
                        "LastName": "abc",
                        "FirstName": "abc",
                        "MiddleName": "abc",
                        "Nationality": "abc",
                        "Sex": "abc",
                        "Address": "abc",
                        "LicenseNo": "abc",
                        "ExpiresDate": "abc",
                        "AgencyCode": "abc",
                        "Birthday": "abc"
                    },
                    "PhilippinesTinID": {
                        "LicenseNumber": "abc",
                        "FullName": "abc",
                        "Address": "abc",
                        "Birthday": "abc",
                        "IssueDate": "abc"
                    },
                    "PhilippinesSSSID": {
                        "LicenseNumber": "abc",
                        "FullName": "abc",
                        "Birthday": "abc"
                    },
                    "PhilippinesUMID": {
                        "Surname": "abc",
                        "MiddleName": "abc",
                        "GivenName": "abc",
                        "Sex": "abc",
                        "Birthday": "abc",
                        "Address": "abc",
                        "CRN": "abc"
                    }
                },
                "RequestId": "abc"
            }
        ],
        "RequestId": "abc"
    }
}

5. 开发者资源

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.BizTokenExpired BizToken过期。
InvalidParameterValue.BizTokenIllegal BizToken不合法。
OperationDenied 操作被拒绝。

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈