获取证件NFC数据

最近更新时间:2026-05-25 01:57:34

我的收藏

1. 接口描述

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

获取到证件NFC数据,接口传入NFC SDK返回的Token(十分钟内有效),可返回对应NFC获取的证件信息。支持身份证类证件(二代身份证、港澳居住证、台湾居住证、外国人永居证)以及旅行类证件(港澳通行证、台湾通行证、台胞证、回乡证)的NFC识别及核验。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetWxNFCResult。
Version String 公共参数,本接口取值:2018-03-01。
Region String 公共参数,本接口不需要传递此参数。
NFCToken String

前端 NFC SDK返回的唯一标识ID


示例值:d102c9c8-5423-11f1-97f9-52540044344e

3. 输出参数

参数名称 类型 描述
ResultCode String

NFC计费结果码,NFC识读成功一次则计费一次(同一个NFC请求重复拉取结果不会重复计费)。计费结果码取值范围:
0:识读成功,计费
-1:识读失败,不计费


示例值:0
IdNum String

身份证号


注意:此字段可能返回 null,表示取不到有效值。
示例值:350481***111140011
Name String

姓名


注意:此字段可能返回 null,表示取不到有效值。
示例值:张*
Picture String

证件中的人像照片


注意:此字段可能返回 null,表示取不到有效值。
示例值:/9j/4AAQSkZJRgABAgAAAQAB
IdCardFrontImg String

身份类证件正面照片(人像面)


注意:此字段可能返回 null,表示取不到有效值。
示例值:/9j/4AAQSkZJRgABAgAAAQAB
IdCardBackImg String

身份类证件背面照片(国徽面)


注意:此字段可能返回 null,表示取不到有效值。
示例值:/9j/4AAQSkZJRgABAgAAAQ
BirthDate String

出生日期


注意:此字段可能返回 null,表示取不到有效值。
示例值:20011114
BeginTime String

有效期起始时间


注意:此字段可能返回 null,表示取不到有效值。
示例值:20220905
EndTime String

有效期结束时间


注意:此字段可能返回 null,表示取不到有效值。
示例值:20320905
Address String

住址


注意:此字段可能返回 null,表示取不到有效值。
示例值:福建省***单元***室
Nation String

民族


注意:此字段可能返回 null,表示取不到有效值。
示例值:汉
Sex String

性别


注意:此字段可能返回 null,表示取不到有效值。
示例值:男
IdType String

证件类型

枚举值:

  • 01: 身份证
  • 03: 中国护照
  • 06: 港澳通行证
  • 07: 台胞证
  • 08: 外国护照
  • 13: 外国人永久居留证
  • 14: 港澳台居民居住证
  • 15: 回乡证
  • 16: 大陆居民来往台湾通行证
  • 99: 其他证件

注意:此字段可能返回 null,表示取不到有效值。
示例值:01
EnName String

英文姓名


注意:此字段可能返回 null,表示取不到有效值。
示例值:ZHAN***ZHEN
SigningOrganization String

签发机关


注意:此字段可能返回 null,表示取不到有效值。
示例值:永安市***
OtherIdNum String

港澳台居民居住证,通行证号码


注意:此字段可能返回 null,表示取不到有效值。
示例值:83100019900101123X
Nationality String

旅行证件国籍


注意:此字段可能返回 null,表示取不到有效值。
示例值:CHN
PersonalNumber String

旅行证件机读区第二行 29~42 位


注意:此字段可能返回 null,表示取不到有效值。
示例值:NFMFNFOGA0
CheckMRTD String

证件的验真结果

  • JSON格式如下: {"result_issuer ":"签发者证书合法性验证结果 ","result_paper":"证件安全对象合法性验证结果 ","result_data" :"防数据篡改验证结果 ","result_chip" :"防证书件芯片被复制验证结果"} 。 - 取值范围: 0:验证通过,1: 验证不通过,2: 未验证,3:部分通过,当4项核验结果都为0时,表示证件为真。

注意:此字段可能返回 null,表示取不到有效值。
示例值:0
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 拉取NFC结果

输入示例

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

{
    "NFCToken": "d102c9c8-5423-11f1-97f9-52540044344e"
}

输出示例

{
    "Response": {
        "Address": "福建省**市*************区*幢*单元***室",
        "BeginTime": "",
        "BirthDate": "",
        "CheckMRTD": "",
        "EnName": "ZHAN***ZHEN",
        "EndTime": "",
        "IdCardBackImg": "",
        "IdCardFrontImg": "",
        "IdNum": "350481***111140011",
        "IdType": "",
        "Name": "张*",
        "Nation": "",
        "Nationality": "",
        "OtherIdNum": "",
        "PersonalNumber": "",
        "Picture": "",
        "ResultCode": "-1",
        "Sex": "",
        "SigningOrganization": "永安市***",
        "RequestId": "096513c7-1ee5-4620-a36b-9f5101cd2737"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.InvalidTokenParameter Token不存在
InternalError 内部错误。
InternalError.UnKnown 内部未知错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。