接口请求域名: faceid.intl.tencentcloudapi.com 。
本接口用于校验姓名、身份证号、身份证有效期的真实性和一致性。
默认接口请求频率限制:20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CheckIdNameDate。 |
| Version | 是 | String | 公共参数,本接口取值:2018-03-01。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| Name | 是 | String | 姓名。 |
| IdCard | 是 | String | 身份证号。 |
| ValidityBegin | 是 | String | 身份证有效期开始时间。 - 格式:YYYYMMDD,如:20210701。 |
| ValidityEnd | 是 | String | 身份证有效期到期时间。 格式:YYYYMMDD,长期用“00000000”代替,如:20210701。 |
| Encryption | 否 | Encryption | 敏感数据加密信息。 - 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | String | 认证结果码,收费情况如下。 - 收费结果码: 0: 一致。 -1: 不一致。 - 不收费结果码: -2: 非法身份证号(长度、校验位等不正确)。 -3: 非法姓名(长度、格式等不正确)。 -4: 非法有效期(长度、格式等不正确)。 -5: 身份信息无效。 -6: 证件库服务异常。 -7: 证件库中无此身份证记录。 -8: 认证次数超过当日限制,请次日重试。 |
| Description | String | 业务结果描述。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
https://faceid.intl.tencentcloudapi.com/?Action=CheckIdNameDate
&Name=韦小宝
&IdCard= 11204416541220243X
&ValidityBegin=20160204
&ValidityEnd=20260204
&<公共请求参数>
{
"Response": {
"Result": "0",
"Description": "一致",
"RequestId": "8695c53f-776f-4ff5-a66d-84e67b352d20"
}
}
https://faceid.intl.tencentcloudapi.com/?Action=CheckIdNameDate
&Name=韦小宝
&IdCard= 11204416541220243X
&ValidityBegin=20160204
&ValidityEnd=20260204
&<公共请求参数>
{
"Response": {
"Description": "不一致",
"RequestId": "af4075de-427f-48a5-85cb-2be5b3751b76",
"Result": "-1"
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.DecryptSystemError | 解密失败。 |
| FailedOperation.StsUnAuthErrError | STS未授权。 |
| InternalError | 内部错误。 |
| InvalidParameter.UnsupportEncryptField | 存在不加密的字段,请参考文档修改。 |
| InvalidParameterValue | 参数取值错误。 |
| UnauthorizedOperation.Arrears | 账号已欠费。 |
| UnauthorizedOperation.ChargeStatusException | 计费状态异常。 |
| UnauthorizedOperation.NonAuthorize | 账号未实名。 |
| UnauthorizedOperation.Nonactivated | 未开通服务。 |
文档反馈