接入文档

身份证识别及信息核验

最近更新时间:2020-11-30 08:18:07

我的收藏

1. 接口描述

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

本接口用于校验姓名和身份证号的真实性和一致性,您可以通过输入姓名和身份证号或传入身份证人像面照片提供所需验证信息。

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:IdCardOCRVerification。
Version String 公共参数,本接口取值:2018-03-01。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-mumbai, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, eu-moscow, na-ashburn, na-siliconvalley, na-toronto
IdCard String 身份证号
姓名和身份证号、ImageBase64、ImageUrl三者必须提供其中之一。若都提供了,则按照姓名和身份证号>ImageBase64>ImageUrl的优先级使用参数。
Name String 姓名
ImageBase64 String 身份证人像面的 Base64 值
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经Base64编码后不超过 3M。请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
ImageUrl String 身份证人像面的 Url 地址
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。
图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
非腾讯云存储的 Url 速度和稳定性可能受一定影响。

3. 输出参数

参数名称 类型 描述
Result String 认证结果码,收费情况如下。
收费结果码:
0: 姓名和身份证号一致
-1: 姓名和身份证号不一致
不收费结果码:
-2: 非法身份证号(长度、校验位等不正确)
-3: 非法姓名(长度、格式等不正确)
-4: 证件库服务异常
-5: 证件库中无此身份证记录
Description String 业务结果描述。
Name String 用于验证的姓名
IdCard String 用于验证的身份证号
Sex String OCR得到的性别
注意:此字段可能返回 null,表示取不到有效值。
Nation String OCR得到的民族
注意:此字段可能返回 null,表示取不到有效值。
Birth String OCR得到的生日
注意:此字段可能返回 null,表示取不到有效值。
Address String OCR得到的地址
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 使用姓名身份证号进行验证

输入示例

https://faceid.tencentcloudapi.com/?Action=IdCardOCRVerification
&IdCard=360*************50
&Name=**杰
&<公共请求参数>

输出示例

{
  "Response": {
    "Result": "0",
    "Description": "姓名和身份证号一致",
    "Name": "**杰",
    "IdCard": "360*************50",
    "Sex": "",
    "Nation": "",
    "Birth": "",
    "Address": "",
    "RequestId": "945c69ad-d86c-47ea-ba33-419b1dc4d242"
  }
}

示例2 使用照片URL进行核验

输入示例

https://faceid.tencentcloudapi.com/?Action=IdCardOCRVerification
&ImageUrl=https://qq.com/a.jpg
&<公共请求参数>

输出示例

{
  "Response": {
    "Result": "0",
    "Description": "姓名和身份证号一致",
    "Name": "**杰",
    "IdCard": "360*************50",
    "Sex": "男",
    "Nation": "汉",
    "Birth": "1986/11/13",
    "Address": "江西省九江市庐山河南路57号01室",
    "RequestId": "a62f567c-1eea-4ef3-b51a-a9eb9bd84cd9"
  }
}

示例3 使用照片Base64进行核验

输入示例

https://faceid.tencentcloudapi.com/?Action=IdCardOCRVerification
&ImageBase64=<base64字符串>
&<公共请求参数>

输出示例

{
  "Response": {
    "Result": "0",
    "Description": "姓名和身份证号一致",
    "Name": "**杰",
    "IdCard": "360*************50",
    "Sex": "男",
    "Nation": "汉",
    "Birth": "1986/11/13",
    "Address": "江西省九江市庐山河南路57号01室",
    "RequestId": "022ffdd2-67a2-4177-8946-97bc1c4b3347"
  }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.DownLoadError 文件下载失败。
FailedOperation.EmptyImageError 图片内容为空。
FailedOperation.ImageBlur 图片模糊。
FailedOperation.ImageDecodeFailed 图片解码失败。
FailedOperation.ImageNoIdCard 图片中未检测到身份证。
FailedOperation.ImageSizeTooLarge 图片尺寸过大。
FailedOperation.OcrFailed Ocr识别失败。
FailedOperation.UnKnown 内部未知错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
UnauthorizedOperation.Arrears 帐号已欠费。
UnauthorizedOperation.NonAuthorize 账号未实名。
UnauthorizedOperation.Nonactivated 未开通服务。
目录