API 中心
视频服务与安全产品捉虫活动邀您参加！> HOT
文档中心>API 中心>人脸核身>其他接口>获取证件NFC结果

获取证件NFC结果

最近更新时间：2024-11-14 01:39:03

我的收藏

本页目录：

1. 接口描述

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

解析SDK获取到的证件NFC数据，接口传入SDK返回的ReqId，返回证件信息（个别字段为特定证件类型特有）。SDK生成的ReqId五分钟内有效，重复查询仅收一次费。支持身份证类证件（二代身份证、港澳居住证、台湾居住证、外国人永居证）以及旅行类证件（港澳通行证、台湾通行证、台胞证、回乡证）的NFC识别及核验。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：ParseNfcData。
Version 是 String 公共参数，本接口取值：2018-03-01。
Region 否 String 公共参数，本接口不需要传递此参数。
ReqId 是 String 前端SDK返回。
示例值：ECBEC11E6-F05A-40DE-9CC3-C9EF119F55FE1

3. 输出参数

参数名称 类型 描述
ResultCode String 结果码。
- 取值范围：0为首次查询成功，-1为查询失败。
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
IdNum String 身份证号。
注意：此字段可能返回 null，表示取不到有效值。
示例值：11204416541220243X
Name String 姓名。
注意：此字段可能返回 null，表示取不到有效值。
示例值：韦小宝
Picture String 照片。
注意：此字段可能返回 null，表示取不到有效值。
示例值：/9j/4AAQSkZJRg.....s97n//2Q==
BirthDate String 出生日期。
注意：此字段可能返回 null，表示取不到有效值。
示例值：20220222
BeginTime String 有效期起始时间。
注意：此字段可能返回 null，表示取不到有效值。
示例值：20220222
EndTime String 有效期结束时间。
注意：此字段可能返回 null，表示取不到有效值。
示例值：20220222
Address String 住址。
注意：此字段可能返回 null，表示取不到有效值。
示例值：北京市东城区景山前街4号紫禁城敬事房
Nation String 民族。
注意：此字段可能返回 null，表示取不到有效值。
示例值：汉
Sex String 性别。
注意：此字段可能返回 null，表示取不到有效值。
示例值：男
IdType String 类型。
- 取值范围：
01：身份证。
03 ：中国护照。
04 ：军官证。
05 ：武警证。
06：港澳通行证 。
07 ：台胞证 。
08：外国护照 。
09 ：士兵证。
09 ：临时身份证。
11：户口本 。
12 ：警官证 。
13：外国人永久居留证。
14：港澳台居民居住证。
15：回乡证。
16：大陆居民来往台湾通行证。
99：其他证件。
注意：此字段可能返回 null，表示取不到有效值。
示例值：01
EnName String 英文姓名。
注意：此字段可能返回 null，表示取不到有效值。
示例值：lily
SigningOrganization String 签发机关
注意：此字段可能返回 null，表示取不到有效值。
示例值：广东省
OtherIdNum String 港澳台居民居住证，通行证号码。
注意：此字段可能返回 null，表示取不到有效值。
示例值：830000199706020042
Nationality String 旅行证件国籍。
注意：此字段可能返回 null，表示取不到有效值。
示例值：英国
PersonalNumber String 旅行证件机读区第二行 29~42 位。
注意：此字段可能返回 null，表示取不到有效值。
示例值：0602004212071
CheckMRTD String 旅行证件类的核验结果。
- JSON格式如下：
{"result_issuer ":"签发者证书合法性验证结果 ","result_pape r":"证件安全对象合法性验证 结果 ","result_data" :"防数据篡改验证结果 ","result_chip" :"防证书件芯片被复制验证结果"} 。
- 取值范围： 0:验证通过，1: 验证不通过，2: 未验证，3:部分通过，当4项核验结果都为0时，表示证件为真。
注意：此字段可能返回 null，表示取不到有效值。
示例值：{"result_issuer ":"签发者证书合法性验证结果 ","result_pape r":"证件安全对象合法性验证 结果 ","result_data" :"防数据篡改验证结果 ","result_chip" :"防证书件芯片被复制验证结果"}
ImageA String 身份证照片面合成图片。
注意：此字段可能返回 null，表示取不到有效值。
示例值：/9j/4AAQSkZJRg.....s97n//2Q==
ImageB String 身份证国徽面合成图片。
注意：此字段可能返回 null，表示取不到有效值。
示例值：/9j/4AAQSk......j+5QVYZKxU
ResultDescription String 对result code的结果描述。
注意：此字段可能返回 null，表示取不到有效值。
示例值：首次查询成功
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 解析SDK获取到的证件NFC数据

解析SDK获取到的证件NFC数据。

输入示例

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

{
    "ReqId": "eyJyZXFJZCI6IjEyMzEiLCJkZXZpY2VJZCI6IjQ1NiJ9"
}

输出示例

{
    "Response": {
        "Address": "北京市东城区景山前街4号紫禁城敬事房",
        "BeginTime": "20170405",
        "BirthDate": "19890604",
        "CheckMRTD": "",
        "EnName": "",
        "EndTime": "20260704",
        "IdNum": "11204416541220243X",
        "IdType": "",
        "ImageA": "/9j/4AAQSkZJRg.....s97n//2Q==",
        "ImageB": "/9j/4AAQSk...mA7pvm5g==",
        "Name": "韦小宝",
        "Nation": "汉",
        "Nationality": "",
        "OtherIdNum": "",
        "PersonalNumber": "",
        "Picture": "Qk3OlwAAAA...7+/v7+/pAA",
        "RequestId": "cdd7a769-d288-42a5-8e2e-6a5e5c9c08ae",
        "ResultCode": "0",
        "Sex": "男",
        "SigningOrganization": "北京市东城区分局",
        "ResultDescription": "首次查询成功"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.UnKnown 内部未知错误。
InvalidParameterValue 参数取值错误。
UnauthorizedOperation.Arrears 账号已欠费。
UnauthorizedOperation.Nonactivated 未开通服务。
中国站
文档反馈
文档活动
message-icon联系我们
目录