接口请求域名: faceid.intl.tencentcloudapi.com 。
传入姓名和身份证号,校验两者的真实性和一致性。
默认接口请求频率限制:100次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:IdCardVerification。 |
| Version | 是 | String | 公共参数,本接口取值:2018-03-01。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| IdCard | 是 | String | 身份证号。 |
| Name | 是 | String | 姓名。 |
| Encryption | 否 | Encryption | 敏感数据加密信息。 - 对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | String | 认证结果码,收费情况如下。 - 收费结果码: 0: 姓名和身份证号一致 -1: 姓名和身份证号不一致 不收费结果码: -2: 非法身份证号(长度、校验位等不正确) -3: 非法姓名(长度、格式等不正确) -4: 证件库服务异常 -5: 证件库中无此身份证记录 -6: 权威比对系统升级中,请稍后再试 -7: 认证次数超过当日限制 |
| Description | String | 业务结果描述。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: faceid.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: IdCardVerification
<公共请求参数>
{
"IdCard": "11204416541220243X",
"Name": "韦小宝"
}
{
"Response": {
"Result": "0",
"Description": "姓名和身份证号一致",
"RequestId": "94b54cdf-d975-4718-b091-32f8d79d6397"
}
}
POST / HTTP/1.1
Host: faceid.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: IdCardVerification
<公共请求参数>
{
"IdCard": "440305199505132561",
"Name": "刘洋"
}
{
"Response": {
"Result": "-1",
"Description": "姓名和身份证号不一致",
"RequestId": "80c7abb8-4563-4636-98c3-0499f1611a33"
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.InvalidAuthorization | CAM签名/鉴权错误。 |
| FailedOperation.DecryptSystemError | 解密失败。 |
| FailedOperation.StsUnAuthErrError | STS未授权。 |
| FailedOperation.UnKnown | 内部未知错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.UnsupportEncryptField | 存在不加密的字段,请参考文档修改。 |
| InvalidParameterValue | 参数取值错误。 |
| UnauthorizedOperation.Arrears | 账号已欠费。 |
| UnauthorizedOperation.ChargeStatusException | 计费状态异常。 |
| UnauthorizedOperation.NonAuthorize | 账号未实名。 |
| UnauthorizedOperation.Nonactivated | 未开通服务。 |
文档反馈