获取实名核身结果信息

最近更新时间:2019-07-24 15:19:31

1. 接口描述

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

完成验证后,用BizToken调用本接口获取结果信息,BizToken生成后三天内(3*24*3,600秒)可多次拉取。

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:faceid.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetDetectInfo
Version String 公共参数,本接口取值:2018-03-01
Region String 公共参数,详见产品支持的 地域列表
BizToken String 人脸核身流程的标识,调用DetectAuth接口时生成。
RuleId String 用于细分客户使用场景,申请开通服务后,可以在腾讯云慧眼人脸核身控制台(https://console.cloud.tencent.com/faceid) 自助接入里面创建,审核通过后即可调用。如有疑问,请加慧眼小助手微信(faceid001)进行咨询。
InfoType String 指定拉取的结果信息,取值(0:全部;1:文本类;2:身份证正反面;3:视频最佳截图照片;4:视频)。
如 134表示拉取文本类、视频最佳截图照片、视频。

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, // 一比一阶段的错误信息
"Location": null, // 地理位置信息
"Extra": "", // DetectAuth结果传进来的Extra信息
"Detail": { // 活体一比一信息详情
"LivenessData": []
}
},
// 身份证正反面照片Base64
"IdCardData": {
"OcrFront": null,
"OcrBack": null
},
// 视频最佳帧截图Base64
"BestFrame": {
"BestFrame": null
},
// 活体视频Base64
"VideoData": {
"LivenessVideo": null
}
}
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取所有类型的信息

输入示例

https://faceid.tencentcloudapi.com/?Action=GetDetectInfo
&RuleId=0
&BizToken=CE661F1A-0F1E-45BD-BE13-34C05CEA7681
&InfoType=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 仅获取文本与身份证照片类型的信息

输入示例

https://faceid.tencentcloudapi.com/?Action=GetDetectInfo
&RuleId=0
&BizToken=CE661F1A-0F1E-45BD-BE13-34C05CEA7681
&InfoType=12
&<公共请求参数>

输出示例

{
  "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 Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.UnKnown 内部未知错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.BizTokenExpired BizToken过期。
InvalidParameterValue.RuleIdNotExist RuleId不存在。
UnauthorizedOperation.Arrears 帐号已欠费。
UnauthorizedOperation.Nonactivated 未开通服务。