接口请求域名： faceid.intl.tencentcloudapi.com 。
NFC数据核验服务，传入SDK返回的NFCToken以及需要核验的证件字段信息和人像照片，服务将自动把待核验信息与证件NFC解密后数据进行比对，输出核验结果。SDK生成的NFCToken 1小时内内有效，服务将按查询次数收费。
服务目前支持大陆二代身份证、港澳通行证和中国居民护照中关于以下字段以及人像照片的NFC识别及核验：
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：GetNFCResult。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-01。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| NFCToken | 是 | String | 前端 NFC SDK返回的唯一标识ID |
| IdNum | 否 | String | 身份证号/护照号码/港澳通行证 |
| Name | 否 | String | 姓名 |
| Picture | 否 | String | 人像照片的Base64值 |
| BirthDate | 否 | String | 出生日期（格式：YYYYMMDD) |
| BeginTime | 否 | String | 证件有效期起始时间（格式：YYYYMMDD) |
| EndTime | 否 | String | 证件有效期结束时间（格式：YYYYMMDD) |
| Address | 否 | String | 住址 |
| Nation | 否 | String | 民族 |
| Sex | 否 | String | 性别 |
| EnName | 否 | String | 英文姓名 |
| SigningOrganization | 否 | String | 签发机关 |
| Nationality | 否 | String | 国籍 |
| CountryCode | 否 | String | 国家码 |
| MachineReadCode | 否 | String | 护照的机读码 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ChargeCode | String | 计费结果码，NFC识读成功一次计费一次。取值范围： 0：识读成功，计费 -1：识读失败，不计费 |
| IdType | String | 证件类型。 取值范围： 01：身份证。 02 ：中国护照 03：港澳通行证 99：其他证件 注意：此字段可能返回 null，表示取不到有效值 |
| CheckMRTD | String | 证件的验真结果。NFC校验的项目如下： {"result_issuer ":"签发者证书合法性验证结果 ","result_paper":"证件安全对象合法性验证结果 ","result_data" :"防数据篡改验证结果 ","result_chip" :"防证书件芯片被复制验证结果"} 。 取值范围：0:验证通过 1: 验证不通过 2: 未验证 3:部分通过 当四项核验结果都为0时，表示证件为真。 |
| IdNumCompareResult | String | 传入的身份证号/护照号/港澳通行证号与NFC识别的身份证号比对结果。 0：一致 -1：不一致 -2：NFC识读不到，无法比对 |
| NameCompareResult | String | 传入的姓名与NFC识别的姓名比对结果。 0：一致 -1：不一致 -2：NFC识读不到，无法比对 |
| PictureCompareSim | Float | 传入的人脸图片与NFC识别人像照的相似度分数。 - 取值范围 [0.00, 100.00]。 - 推荐相似度大于等于70分时可判断为同一人，客户也可根据具体场景自行调整阈值（阈值70的误通过率为千分之一，阈值80的误通过率是万分之一）。 |
| PictureCompareResult | String | 传入的人脸图片与NFC识别人像照的比对结果。 0：同人（相似度大于等于70分） 1：非同人（相似度小于70分） 2：比对失败（传入图片质量过低） 3：比对失败（传入图片不含人脸或人脸不完整或存在多张人脸） 4：比对失败（传入图片过大或过小） 5：比对失败（NFC识读不到人像照片） 6：比对失败（未传入图片数据） 7：比对失败（其他原因） |
| BirthDateCompareResult | String | 传入的出生日期与NFC识别的出生日期比对结果。 0：一致 -1：不一致 -2：NFC识读不到，无法比对 |
| BeginTimeCompareResult | String | 传入的有效期起始时间与NFC识别的有效期起始时间比对结果。 0：一致 -1：不一致 -2：NFC识读不到，无法比对 |
| EndTimeCompareResult | String | 传入的有效期结束时间与NFC识别的有效期结束时间比对结果。 0：一致 -1：不一致 -2：NFC识读不到，无法比对 |
| AddressCompareResult | String | 传入的住址与NFC识别的住址比对结果。 0：一致 -1：不一致 -2：NFC识读不到，无法比对 |
| NationCompareResult | String | 传入的民族与NFC识别的民族比对结果。 0：一致 -1：不一致 -2：NFC识读不到，无法比对 |
| SexCompareResult | String | 传入的性别与NFC识别的性别比对结果。 0：一致 -1：不一致 -2：NFC识读不到，无法比对 |
| EnNameCompareResult | String | 传入的英文姓名与NFC识别的英文姓名比对结果。 0：一致 -1：不一致 -2：NFC识读不到，无法比对 |
| SigningOrganizationCompareResult | String | 传入的签发机关与NFC识别的签发机关比对结果。 0：一致 -1：不一致 -2：NFC识读不到，无法比对 |
| NationalityCompareResult | String | 传入的国籍与NFC识别的国籍比对结果。 0：一致 -1：不一致 -2：NFC识读不到，无法比对 |
| CountryCodeCompareResult | String | 传入的国家码与NFC识别的国家码比对结果。 0：一致 -1：不一致 -2：NFC识读不到，无法比对 |
| MachineReadCodeCompareResult | String | 传入的机读码与NFC识别的机读码比对结果 0：一致 -1：不一致 -2：NFC识读不到，无法比对 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: faceid.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetNFCResult
<公共请求参数>
{
"NFCToken": "a1cfec70-4b29-11f0-bce7-c66e37472b33",
"IdNum": "111111111111111111",
"Name": "韦小宝",
"EnName": "",
"Picture": "base64",
"BirthDate": "19460815",
"Address": "北京市xxxx",
"Nation": "汉",
"Sex": "男",
"SigningOrganization": "",
"BeginTime": "",
"EndTime": "",
"CountryCode": "",
"Nationality": "",
"MachineReadCode": "343dasd"
}{
"Response": {
"IdType": "0",
"CheckMRTD": "0",
"IdNumCompareResult": "0",
"NameCompareResult": "0",
"PictureCompareSim": 85.5,
"BirthDateCompareResult": "0",
"BeginTimeCompareResult": "0",
"EndTimeCompareResult": "0",
"AddressCompareResult": "0",
"NationCompareResult": "0",
"SexCompareResult": "0",
"EnNameCompareResult": "0",
"SigningOrganizationCompareResult": "0",
"NationalityCompareResult": "0",
"CountryCodeCompareResult": "0",
"MachineReadCodeCompareResult": "0",
"PictureCompareResult": "0",
"ChargeCode": "0",
"RequestId": "fb2675fb-40e6-42ce-a958-d72413197ad1"
}
}云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.CompareLowSimilarity | 比对相似度未达到通过标准。 |
| FailedOperation.CompareSystemError | 调用比对引擎接口出错。 |
| FailedOperation.InvalidTokenParameter | Token不存在 |
| FailedOperation.LifePhotoDetectFaces | 检测到多张人脸。 |
| FailedOperation.LifePhotoDetectFake | 实人比对没通过。 |
| FailedOperation.LifePhotoDetectNoFaces | 未能检测到完整人脸。 |
| FailedOperation.LifePhotoPoorQuality | 传入图片分辨率太低，请重新上传。 |
| FailedOperation.LifePhotoSizeError | 传入图片过大或过小。 |
| InternalError | 内部错误。 |
| InternalError.UnKnown | 内部未知错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
文档反馈