人脸核身身份证识别及信息核验-API 文档-文档中心-腾讯云

1. 接口描述

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

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

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：IdCardOCRVerification。
Version	是	String	公共参数，本接口取值：2018-03-01。
Region	否	String	公共参数，本接口不需要传递此参数。
IdCard	否	String	身份证号。 - 姓名和身份证号、ImageBase64、ImageUrl三者必须提供其中之一。 - 若都提供了，则按照姓名和身份证号>ImageBase64>ImageUrl的优先级使用参数。示例值：11204416541220243X
Name	否	String	姓名。示例值：韦小宝
ImageBase64	否	String	身份证人像面的 Base64 值。 - 支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。 - 支持的图片大小：所下载图片经Base64编码后不超过 3M。请使用标准的Base64编码方式(带=补位)，编码规范参考RFC4648。示例值：/9j/4AAQSkZJRg.....s97n//2Q==
ImageUrl	否	String	身份证人像面的 Url 地址。 - 支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。 - 支持的图片大小：所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。 - 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。 - 非腾讯云存储的 Url 速度和稳定性可能受一定影响。示例值：https://www.qq.com/image.jpg
Encryption	否	Encryption	敏感数据加密信息。 - 对传入信息（姓名、身份证号）有加密需求的用户可使用此参数，详情请点击左侧链接。

3. 输出参数

参数名称	类型	描述
Result	String	认证结果码，收费情况如下。 - 收费结果码： 0: 姓名和身份证号一致。 -1: 姓名和身份证号不一致。 - 不收费结果码： -2: 非法身份证号（长度、校验位等不正确）。 -3: 非法姓名（长度、格式等不正确）。 -4: 证件库服务异常。 -5: 证件库中无此身份证记录。 -6: 权威比对系统升级中，请稍后再试。 -7: 认证次数超过当日限制。示例值：0
Description	String	业务结果描述。示例值：姓名和身份证号一致
Name	String	用于验证的姓名。示例值：韦小宝
IdCard	String	用于验证的身份证号。示例值：11204416541220243X
Sex	String	OCR得到的性别。注意：此字段可能返回 null，表示取不到有效值。示例值：男
Nation	String	OCR得到的民族。注意：此字段可能返回 null，表示取不到有效值。示例值：汉
Birth	String	OCR得到的生日。注意：此字段可能返回 null，表示取不到有效值。示例值：1654/12/20
Address	String	OCR得到的地址。注意：此字段可能返回 null，表示取不到有效值。示例值：北京市东城区景山前街4号紫禁城敬事房
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

使用照片URL进行核验。

输入示例

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

{
    "ImageUrl": "https://www.qq.com/image.jpg"
}

输出示例

{
    "Response": {
        "Result": "0",
        "Description": "姓名和身份证号一致",
        "Name": "韦小宝",
        "IdCard": "11204416541220243X",
        "Sex": "男",
        "Nation": "汉",
        "Birth": "1654/12/20",
        "Address": "北京市东城区景山前街4号紫禁城敬事房",
        "RequestId": "a62f567c-1eea-4ef3-b51a-a9eb9bd84cd9"
    }
}

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

使用照片Base64进行核验。

输入示例

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

{
    "ImageBase64": "/9j/4AAQSkZJRg.....s97n//2Q=="
}

输出示例

{
    "Response": {
        "Result": "0",
        "Description": "姓名和身份证号一致",
        "Name": "韦**",
        "IdCard": "1****************X",
        "Sex": "男",
        "Nation": "汉",
        "Birth": "1654/12/20",
        "Address": "北京市东城区景山前街4号紫禁城敬事房",
        "RequestId": "022ffdd2-67a2-4177-8946-97bc1c4b3347"
    }
}

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

使用姓名身份证号进行验证。

输入示例

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

{
    "IdCard": "11204416541220243X",
    "Name": "韦小宝"
}

输出示例

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

示例4 身份证识别及信息核验失败示例

身份证识别及信息核验失败。

输入示例

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

{
    "IdCard": "11204416541220243Y",
    "Name": "韦小宝"
}

输出示例

{
    "Response": {
        "Address": "",
        "Birth": "",
        "Description": "非法身份证号（长度、校验位等不正确）",
        "IdCard": "1****************Y",
        "Name": "韦**",
        "Nation": "",
        "RequestId": "c528602c-6574-4dd7-a836-895ff62a13ed",
        "Result": "-2",
        "Sex": ""
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure.InvalidAuthorization	CAM签名/鉴权错误。
FailedOperation.DecryptSystemError	解密失败。
FailedOperation.DownLoadError	文件下载失败。
FailedOperation.EmptyImageError	图片内容为空。
FailedOperation.ImageBlur	图片模糊。
FailedOperation.ImageDecodeFailed	图片解码失败。
FailedOperation.ImageNoIdCard	图片中未检测到身份证。
FailedOperation.ImageSizeTooLarge	图片尺寸过大。
FailedOperation.OcrFailed	Ocr识别失败。
FailedOperation.StsUnAuthErrError	STS未授权。
FailedOperation.UnKnown	内部未知错误。
InvalidParameter	参数错误。
InvalidParameter.UnsupportEncryptField	存在不加密的字段，请参考文档修改。
InvalidParameterValue	参数取值错误。
UnauthorizedOperation.Arrears	账号已欠费。
UnauthorizedOperation.ChargeStatusException	计费状态异常。
UnauthorizedOperation.NonAuthorize	账号未实名。
UnauthorizedOperation.Nonactivated	未开通服务。

身份证识别及信息核验

本页目录：

1. 接口描述

2. 输入参数

3. 输出参数

4. 示例

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

输入示例

输出示例

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

输入示例

输出示例

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

输入示例

输出示例

示例4 身份证识别及信息核验失败示例

输入示例

输出示例

5. 开发者资源

腾讯云 API 平台

API Inspector

SDK

命令行工具

6. 错误码