接入文档

未成年人守护

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

1. 接口描述

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

未成年人守护接口是通过传入手机号或姓名和身份证号,结合权威数据源和腾讯健康守护可信模型,判断该信息是否真实且年满18周岁。腾讯健康守护可信模型覆盖了上十亿手机库源,覆盖率高、准确率高,如果不在库中的手机号,还可以通过姓名+身份证进行兜底验证。

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:MinorsVerification。
Version String 公共参数,本接口取值:2018-03-01。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-guangzhou-open, ap-hongkong, ap-jinan-ec, 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
Type String 参与校验的参数类型。
0:使用手机号进行校验;
1:使用姓名与身份证号进行校验。
Mobile String 手机号,11位数字,
特别提示:
手机号验证只限制在腾讯健康守护可信模型覆盖的数据范围内,与手机号本身在运营商是否实名无关联,不在范围会提示“手机号未实名”,建议客户与传入姓名和身份证号信息组合使用。
IdCard String 身份证号码。
Name String 姓名。

3. 输出参数

参数名称 类型 描述
Result String 结果码,收费情况如下。
收费结果码:
0: 成年
-1: 未成年
-3: 姓名和身份证号不一致

不收费结果码:
-2: 未查询到手机号信息
-4: 非法身份证号(长度、校验位等不正确)
-5: 非法姓名(长度、格式等不正确)
-6: 权威数据源服务异常
-7: 未查询到身份信息
-8: 权威数据源升级中,请稍后再试
Description String 业务结果描述。
AgeRange String 该字段的值为年龄区间。格式为[a,b),
[0,8)表示年龄小于8周岁区间,不包括8岁;
[8,16)表示年龄8-16周岁区间,不包括16岁;
[16,18)表示年龄16-18周岁区间,不包括18岁;
[18,+)表示年龄大于18周岁。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 使用手机号进行检查

输入示例

https://faceid.tencentcloudapi.com/?Action=MinorsVerification
&Type=0
&Mobile=13800138000
&<公共请求参数>

输出示例

{
  "Response": {
    "Result": "-1",
    "Description": "未成年",
    "AgeRange": "[0,8)",
    "RequestId": "c163d210-ed9e-44d0-a4c4-d6bbc1bf6f27"
  }
}

示例2 使用姓名身份证号进行检查

输入示例

https://faceid.tencentcloudapi.com/?Action=MinorsVerification
&Type=1
&IdCard=440111199110100000
&Name=张成年
&<公共请求参数>

输出示例

{
  "Response": {
    "Result": "0",
    "Description": "成年",
    "AgeRange": "[18,+)",
    "RequestId": "7f03975b-957d-47e5-a346-02d7c4b330c6"
  }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.UnKnown 内部未知错误。
InvalidParameter 参数错误。
UnauthorizedOperation.Arrears 帐号已欠费。
UnauthorizedOperation.NonAuthorize 账号未实名。
UnauthorizedOperation.Nonactivated 未开通服务。
目录