有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

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

本接口用于校验姓名、身份证号、身份证有效期的真实性和一致性。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CheckIdNameDate。
Version String 公共参数,本接口取值:2018-03-01。
Region String 公共参数,本接口不需要传递此参数。
Name String 姓名
示例值:张三
IdCard String 身份证号
示例值:620xxxxxxxxxxx0321
ValidityBegin String 身份证有效期开始时间,格式:YYYYMMDD。如:20210701
示例值:20160607
ValidityEnd String 身份证有效期到期时间,格式:YYYYMMDD,长期用“00000000”代替;如:20210701
示例值:20250607
Encryption Encryption 敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。

3. 输出参数

参数名称 类型 描述
Result String 认证结果码,收费情况如下。
收费结果码:
0: 一致
-1: 不一致
不收费结果码:
-2: 非法身份证号(长度、校验位等不正确)
-3: 非法姓名(长度、格式等不正确)
-4: 非法有效期(长度、格式等不正确)
-5: 身份信息无效
-6: 证件库服务异常
-7: 证件库中无此身份证记录
示例值:"0"
Description String 业务结果描述。
示例值:核验一致
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 参考示例

输入示例

https://faceid.tencentcloudapi.com/?Action=CheckIdNameDate
&Name=xxxxxxxxxx
&IdCard=xxxx
&ValidityBegin=20160204
&ValidityEnd=20260204
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": "0",
        "Description": "查询成功",
        "RequestId": "8695c53f-776f-4ff5-a66d-84e67b352d20"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.DecryptSystemError 解密失败。
FailedOperation.StsUnAuthErrError STS未授权。
InternalError 内部错误。
InvalidParameter.UnsupportEncryptField 存在不加密的字段,请参考文档修改。
InvalidParameterValue 参数取值错误。
UnauthorizedOperation.Arrears 账号已欠费。
UnauthorizedOperation.ChargeStatusException 计费状态异常。
UnauthorizedOperation.NonAuthorize 账号未实名。
UnauthorizedOperation.Nonactivated 未开通服务。