纯服务端(API)接入

更新时间:
复制 MD 格式

本文介绍身份二要素核验API接口。身份二要素指姓名身份证号。接口会对比二者的真实性和一致性。

接口信息

重要

在使用本接口前,请确保已完整阅读接入流程,并开通服务。

  • 接口名: Id2MetaVerify

  • 接口说明:传入姓名和身份证号,返回权威数据源对二要素的校验结果。

  • QPS限量:API独享QPS限量,详情请参见信息核验接口QPS限量说明

  • 服务地址(调用 API 时的 Endpoint):

    地域

    IPv4

    IPv6

    通用

    cloudauth.aliyuncs.com

    cloudauth-dualstack.aliyuncs.com

    北京

    cloudauth.cn-beijing.aliyuncs.com

    cloudauth-dualstack.cn-beijing.aliyuncs.com

    上海

    cloudauth.cn-shanghai.aliyuncs.com

    cloudauth-dualstack.cn-shanghai.aliyuncs.com

    说明
    • 服务地址可选择与业务服务器距离相近的 endpoint ,以降低延迟。

    • 也可以构建列表轮询使用,以提高可用性。

    重要

    信息核验服务暂不支持基于调用次数的硬性封顶或自动停用功能。为有效控制成本并防范高额账单风险,建议在接入产品后及时配置消费告警规则:

    1. 配置消费预警设置高额消费预警阈值,实时监控账单支出情况。

    2. 监控流量包余量:若已购买流量包,请同步设置资源包余量预警,以便及时补充资源或调整调用策略。

    3. 配置业务监控:参见安全管理,监控业务异动,及时识别业务请求波动。

请求参数

名称

类型

是否必选

描述

示例值

ParamType

String

加密方式:

  • normal:明文不加密

  • sm2:SM2加密

    重要

    SM2参数加密的相关信息,请参考参数加密说明

normal

IdentifyNum

String

身份证号。

  • paramType 传入 normal 时:输入身份证号明文。

  • paramType 传入 sm2 时:输入身份证号密文。

说明

受权威源影响,仅支持二代居民身份证的证件号码。

  • 明文:429001********8211

  • 密文:MHsCIEPDt1ycBNSVgA2yKsMnvWGheiI+STWqJLmYWlZnklhnAiEAwq1bk5YVepHwqfMsd9ErlK71OrdXx8E+wfqbzyFCwoMEIM1QdrFeekvQh6fwK7sVXAsNePiNm7Eulqm/zahRosbKBBKgtyhm3SopJ3tO/wALKXQQW+g=

UserName

String

姓名。

  • paramType 传入 normal 时:输入姓名明文。

  • paramType 传入 sm2 时:输入姓名密文。

  • 明文:张三

  • 密文:MG8CIQCxI0wNYbc0c2BRL+7+tSethTXfQC391ZFnszRRcvRZ9AIgekQYhgDtxaDuoRD4bde/5fnFdlUp4YoxlEnIFLLm2mQEILkctuy6Rw6lfAUxBtkpPoPVCJAeD5al/RX8JFUvTACEBAYAgLJjBe0=

响应参数

名称

类型

描述

示例值

RequestId

String

请求ID。

130A2C10-B9EE-4D84-88E3-5384FF039795

Message

String

接口调用返回信息。

重要

此参数仅表示接口是否异常。

success

Code

String

返回码:200表示成功,其他均为失败。

重要
  • 此参数代表是否正确调用了接口,详细的返回码说明请参见服务端错误码

  • 业务核验结果请通过ResultObject中的字段查看。

200

ResultObject

BizCode

String

身份核验结果:

  • 1:校验⼀致

  • 2:校验不⼀致

1

SDK调用示例

重要

集成前请确保您已完整阅读接入流程开通了服务获取AccessKey且正确配置环境变量

关于SDK示例和安装包获取:

  • 您可以在OpenAPI的在线接口调试页面的右侧找到对应的SDK调用示例,并在代码示例的右上角点击SDK安装信息查看SDK的安装信息。

    说明

    注意选择所需的编程语言。

  • 如果您有离线安装的需求,可以进入SDK安装页面选择需要语言SDK,并转到发布地址获取。

  • OpenAPI平台可对接口进行在线调试,并获取SDK示例。

  • 代码示例工程各编程语言调用SDK的示例工程,可作为接入参考。