1. 接口描述
接口请求域名： faceid.tencentcloudapi.com 。
完成验证后，用EidToken调用本接口获取结果信息，EidToken生成后三天内（3*24*3,600秒）可多次拉取。
默认接口请求频率限制：100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：GetEidResult。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-01。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| EidToken | 是 | String | E证通流程的唯一标识，调用GetEidToken接口时生成。 示例值：CE661F1A-0F1E-45BD-BE133-34C05CEA76812 |
| InfoType | 否 | String | 指定拉取的结果信息。 - 取值范围： 0：全部。 1：文本类。 2：身份证信息。 3：最佳截图信息。 5：意愿核身朗读模式相关结果。 6：意愿核身问答模式相关结果。 - 例如 13表示拉取文本类、最佳截图信息。 - 默认值：0 示例值：1 |
| BestFramesCount | 否 | Integer | 从活体视频中截取一定张数的最佳帧。 - 默认为0，最大为3，超出3的最多只给3张。 - InfoType需要包含3。 示例值：1 |
| IsCutIdCardImage | 否 | Boolean | 是否对身份证照片进行裁边。 - 默认为false。 - InfoType需要包含2。 示例值：false |
| IsNeedIdCardAvatar | 否 | Boolean | 是否需要从身份证中抠出头像。 - 默认为false。 - InfoType需要包含2。 示例值：false |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Text | DetectInfoText | 文本类信息。 - 基于对敏感信息的保护，验证使用的姓名和身份证号统一通过加密后从EidInfo参数中返回。 - 如需获取请在控制台申请返回身份信息，详见E证通获取实名信息指引。 注意：此字段可能返回 null，表示取不到有效值。 |
| IdCardData | DetectInfoIdCardData | 身份证照片信息。 注意：此字段可能返回 null，表示取不到有效值。 |
| BestFrame | DetectInfoBestFrame | 最佳帧信息。 注意：此字段可能返回 null，表示取不到有效值。 |
| EidInfo | EidInfo | Eid信息。 - 包括商户下用户唯一标识以及加密后的姓名、身份证号信息。 - 解密方式详见E证通获取实名信息指引 注意：此字段可能返回 null，表示取不到有效值。 |
| IntentionVerifyData | IntentionVerifyData | 意愿核身朗读模式相关信息。 - 若未使用意愿核身朗读功能，该字段返回值可以不处理。 注意：此字段可能返回 null，表示取不到有效值。 |
| IntentionQuestionResult | IntentionQuestionResult | 意愿核身问答模式相关信息。 - 若未使用意愿核身问答模式功能，该字段返回值可以不处理。 注意：此字段可能返回 null，表示取不到有效值。 |
| IntentionActionResult | IntentionActionResult | 意愿核身点头确认模式的结果信息。 - 若未使用该意愿核身功能，该字段返回值可以不处理。 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取E证通结果信息成功示例
成功获取E证通结果信息。
输入示例
POST / HTTP/1.1
Host: faceid.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetEidResult
<公共请求参数>
{
"InfoType": "1",
"EidToken": "CE661F1A-0F1E-45BD-BE133-34C05CEA76812"
}输出示例
{
"Response": {
"BestFrame": {
"BestFrame": "/9j/4AAQSk...UVoYn/2Q==",
"BestFrames": [
"/9j/4AAQSk...AT/U//2Q=="
]
},
"EidInfo": {
"DesKey": "",
"EidCode": "OMKhJ5hkbPnA5PKGrzD1oKZ/e8W9w2g1yAOUIry7G/4xMDAw",
"EidSign": "MEQCIDt0Xa...YygK4Fhw==",
"UserInfo": ""
},
"IdCardData": {
"Avatar": "",
"BackWarnInfos": null,
"OcrBack": "",
"OcrFront": "",
"ProcessedBackImage": "",
"ProcessedFrontImage": "",
"WarnInfos": null
},
"IntentionActionResult": null,
"IntentionQuestionResult": {
"AsrResult": null,
"Audios": null,
"FinalResultCode": "",
"FinalResultDetailCode": null,
"FinalResultMessage": null,
"ResultCode": null,
"ScreenShot": null,
"Video": ""
},
"IntentionVerifyData": {
"AsrResult": "",
"AsrResultSimilarity": "",
"ErrorCode": 0,
"ErrorMessage": "",
"IntentionVerifyBestFrame": "",
"IntentionVerifyVideo": ""
},
"RequestId": "29a30ec8-0c15-4566-a5ab-99f88a3f0821",
"Text": {
"CompareLibType": "权威库",
"Comparemsg": "成功",
"Comparestatus": 0,
"ErrCode": 0,
"ErrMsg": "成功",
"Extra": "",
"IdCard": "",
"IdInfoFrom": "其他",
"LiveMsg": "成功",
"LiveStatus": 0,
"LivenessInfoTag": [
"01"
],
"LivenessDetail": [
{
"CompareLibType": "权威库",
"Comparemsg": "成功",
"Comparestatus": 0,
"Errcode": 0,
"Errmsg": "成功",
"Idcard": "",
"IsNeedCharge": true,
"Livemsg": "成功",
"LivenessMode": 4,
"Livestatus": 0,
"Name": "",
"ReqTime": "1730451371368",
"Seq": "092ff8ca-4d1c-4c2122-b513-ec8ced564c9a",
"Sim": "97.31"
}
],
"LivenessMode": 4,
"Location": "",
"Mobile": "",
"NFCBillingCounts": 0,
"NFCRequestIds": null,
"Name": "",
"OcrAddress": "",
"OcrAuthority": "",
"OcrBirth": "",
"OcrGender": "",
"OcrIdCard": "",
"OcrName": "",
"OcrNation": "",
"OcrValidDate": "",
"PassNo": "",
"Sim": "97.31",
"UseIDType": 0,
"VisaNum": ""
}
}
}示例2 获取E证通结果信息失败示例
获取E证通结果信息失败，传入过期BizToken。
输入示例
POST / HTTP/1.1
Host: faceid.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetEidResult
<公共请求参数>
{
"InfoType": "1",
"EidToken": "CE661F1A-0F1E-45B1D-BE133-34C05CEA76812"
}输出示例
{
"Response": {
"Error": {
"Code": "InvalidParameterValue.BizTokenExpired",
"Message": "BizToken过期。"
},
"RequestId": "19f36e49-d419-48a7-b86a-edcb81e71909"
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.DecryptSystemError | 解密失败。 |
| FailedOperation.StsUnAuthErrError | STS未授权。 |
| FailedOperation.UnKnown | 内部未知错误。 |
| InternalError | 内部错误。 |
| InternalError.EncryptSystemError | 加密失败。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue.BizTokenExpired | BizToken过期。 |
| InvalidParameterValue.BizTokenIllegal | BizToken不合法。 |
| UnauthorizedOperation.Arrears | 账号已欠费。 |
| UnauthorizedOperation.NonAuthorize | 账号未实名。 |
| UnauthorizedOperation.Nonactivated | 未开通服务。 |
