1. 接口描述
接口请求域名： faceid.tencentcloudapi.com 。
完成验证后，用BizToken调用本接口获取结果信息，BizToken生成后三天内（3*24*3,600秒）可多次拉取。
默认接口请求频率限制：50次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：GetDetectInfo。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-01。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| BizToken | 是 | String | 人脸核身流程的标识，调用DetectAuth接口时生成。 示例值：CE661F1A-0F1E-45BD-BE13-34C05CEA7681 |
| RuleId | 是 | String | 用于细分客户使用场景，申请开通服务后，可以在腾讯云慧眼人脸核身控制台（https://console.cloud.tencent.com/faceid） 自助接入里面创建，审核通过后即可调用。如有疑问，请加慧眼小助手微信（faceid001）进行咨询。 示例值：0 |
| InfoType | 否 | String | 指定拉取的结果信息，取值（0：全部；1：文本类；2：身份证正反面；3：视频最佳截图照片；4：视频）。 如 134表示拉取文本类、视频最佳截图照片、视频。 默认值：0 示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DetectInfo | String | JSON字符串。 { // 文本类信息 "Text": { "ErrCode": null, // 本次核身最终结果。0为成功 "ErrMsg": null, // 本次核身最终结果信息描述。 "IdCard": "", // 本次核身最终获得的身份证号。 "Name": "", // 本次核身最终获得的姓名。 "OcrNation": null, // ocr阶段获取的民族 "OcrAddress": null, // ocr阶段获取的地址 "OcrBirth": null, // ocr阶段获取的出生信息 "OcrAuthority": null, // ocr阶段获取的证件签发机关 "OcrValidDate": null, // ocr阶段获取的证件有效期 "OcrName": null, // ocr阶段获取的姓名 "OcrIdCard": null, // ocr阶段获取的身份证号 "OcrGender": null, // ocr阶段获取的性别 "LiveStatus": null, // 活体检测阶段的错误码。0为成功 "LiveMsg": null, // 活体检测阶段的错误信息 "Comparestatus": null,// 一比一阶段的错误码。0为成功 "Comparemsg": null, // 一比一阶段的错误信息 "Sim": null, // 比对相似度 "Location": null, // 地理位置信息 "Extra": "", // DetectAuth结果传进来的Extra信息 "Detail": { // 活体一比一信息详情 "LivenessData": [ { ErrCode: null, // 活体比对验证错误码 ErrMsg: null, // 活体比对验证错误描述 ReqTime: null, // 活体验证时间戳 IdCard: null, // 验证身份证号 Name: null // 验证姓名 } ] } }, // 身份证正反面照片Base64 "IdCardData": { "OcrFront": null, "OcrBack": null }, // 视频最佳帧截图Base64 "BestFrame": { "BestFrame": null }, // 活体视频Base64 "VideoData": { "LivenessVideo": null } } |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取所有类型的信息
输入示例
POST / HTTP/1.1
Host: faceid.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetDetectInfo
<公共请求参数>
{
"InfoType": "0",
"BizToken": "CE661F1A-0F1E-45BD-BE13-34C05CEA7681",
"RuleId": "0"
}输出示例
{
"Response": {
"DetectInfo": "{\"Text\":{\"ErrCode\":null,\"ErrMsg\":null,\"IdCard\":\"\",\"Name\":\"\",\"OcrNation\":null,\"OcrAddress\":null,\"OcrBirth\":null,\"OcrAuthority\":null,\"OcrValidDate\":null,\"OcrName\":null,\"OcrIdCard\":null,\"OcrGender\":null,\"LiveStatus\":null,\"LiveMsg\":null,\"Comparestatus\":null,\"Comparemsg\":null,\"Extra\":\"\",\"Detail\":{\"LivenessData\":[]}},\"IdCardData\":{\"OcrFront\":null,\"OcrBack\":null},\"BestFrame\":{\"BestFrame\":null},\"VideoData\":{\"LivenessVideo\":null}}",
"RequestId": "0f96cf39-a183-485c-ab29-8427ab81f9ae"
}
}示例2 仅获取文本与身份证照片类型的信息
输入示例
POST / HTTP/1.1
Host: faceid.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetDetectInfo
<公共请求参数>
{
"InfoType": "12",
"BizToken": "CE661F1A-0F1E-45BD-BE13-34C05CEA7681",
"RuleId": "0"
}输出示例
{
"Response": {
"DetectInfo": "{\"Text\":{\"ErrCode\":null,\"ErrMsg\":null,\"IdCard\":\"\",\"Name\":\"\",\"OcrNation\":null,\"OcrAddress\":null,\"OcrBirth\":null,\"OcrAuthority\":null,\"OcrValidDate\":null,\"OcrName\":null,\"OcrIdCard\":null,\"OcrGender\":null,\"LiveStatus\":null,\"LiveMsg\":null,\"Comparestatus\":null,\"Comparemsg\":null,\"Extra\":\"\",\"Detail\":{\"LivenessData\":[]}},\"IdCardData\":{\"OcrFront\":null,\"OcrBack\":null}}",
"RequestId": "7be0c0e4-57f5-44c4-b471-21390ca88fb2"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.InvalidAuthorization | CAM签名/鉴权错误。 |
| FailedOperation.UnKnown | 内部未知错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue.BizTokenExpired | BizToken过期。 |
| InvalidParameterValue.RuleIdNotExist | RuleId不存在，请到人脸核身控制台申请。 |
| UnauthorizedOperation.ActivateError | 服务开通异常。 |
| UnauthorizedOperation.Activating | 服务开通中。 |
| UnauthorizedOperation.Arrears | 账号已欠费。 |
| UnauthorizedOperation.NonAuthorize | 账号未实名。 |
| UnauthorizedOperation.Nonactivated | 未开通服务。 |
