本文介绍通过纯服务端(API)单独接入ID Verification 中 Id2MetaPeriodVerifyIntl 接口的流程。
接口说明
接口名:Id2MetaPeriodVerifyIntl
请求方法:HTTPS POST
接口说明:传入姓名、身份证号、身份证有效期开始日期和到期日期,通过权威源验证其真实性和一致性。
重要仅支持中国内地第二代居民身份证。
QPS限量:API独享QPS限量,详情请参见ID Verification服务端API QPS限量说明。
服务地址:
说明内网访问优势:内网指阿里云同一地域内各产品间的私有通信网络。若您的业务服务器部署于阿里云对应地域,请使用内网域名访问 ID Verification 服务,以获得更安全、稳定的通信质量。
海外访问优化建议:海外网络环境复杂,建议参考服务端网络耗时分析与优化,优化集成方案,降低网络延迟及请求失败概率。
中国香港
公网:
cloudauth-intl.cn-hongkong.aliyuncs.com内网:
cloudauth-intl-vpc.cn-hongkong.aliyuncs.com
在线调试和集成
在调试和集成前,请确保您已完整阅读使用OpenAPI调试和集成服务端API文档,充分了解API接口在OpenAPI平台的调用方式和SDK及其代码的获取方式。
您可以在OpenAPI Explorer中直接运行本接口进行调试,并生成本接口的SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 描述 | 示例值 |
ProductCode | String | 是 | 要接入的产品方案。取值eKYC_Date_MIN。 | eKYC_Date_MIN |
SceneCode | String | 否 | 您自定义的认证场景ID,用于后续控制台输入此场景ID查询相关记录。支持长度为10位的字母、数字或下划线的组合。 | 1234567890 |
MerchantBizId | String | 是 | 自定义的业务唯一标识,用于后续定位排查问题。支持长度为32位的字母和数字的组合,请确保唯一。 | e0c34a77f5ac40a5aa5e6ed20c35**** |
MerchantUserId | String | 否 | 您自定义的用户ID,或者其他可以识别特定用户的标识,例如手机号码、邮箱地址等。强烈建议对该字段的值进行预先脱敏,例如对值进行哈希处理。 | a1b2c3d4e5f64g7h8i9j0k1l2m3n4**** |
DocType | String | 是 | 证件类型,以8位数字组合作为唯一标识。 当前支持中国内地第二代居民身份证,请传入固定值:00000001。 更多说明,请参见证件类型列表。 | 00000001 |
DocName | String | 是 | 用户的姓名。 | 张三 |
DocNo | String | 是 | 用户的证件号码。 | 411xxxxxxxxxxx0001 |
ValidityStartDate | String | 是 | 有效期开始日期,格式:YYYYMMDD。 | 20201001 |
ValidityEndDate | String | 是 | 身份证有效期到期日期,格式:YYYYMMDD。 说明 如果身份证有效期是长期,此参数输入:长期 。 | 20301001 |
返回数据
名称 | 类型 | 描述 | 示例值 | |
HTTP Status Code | Integer | HTTP状态码。 | 200 | |
HTTP Body | RequestId | String | 请求ID。 | 130A2C10-B9EE-4D84-88E3-5384FF03**** |
Code | String | success | ||
Message | String | 返回Code的详细描述。 | success | |
Result.Passed | String | 认证最终结果。取值:
| Y | |
Result.SubCode | String | 认证结果描述。更多信息,请参见ResultObject.SubCode错误码说明。 | 200 | |
返回Code
HTTP状态码 | Code | Message描述 |
200 | Success | 请求成功。 |
400 | MissingParameter | 参数不能为空。 |
InvalidParameter | 非法参数。 | |
401 | Forbidden.ExceptionRepeatedInvoke | 异常重复调用次数超限。 |
403 | Forbidden.RAMUserAccessDenied | 需要给RAM用户授予AliyunAntCloudAuthFullAccess操作权限。更多信息,请参见授权RAM用户访问服务。 |
Forbidden.AccountAccessDenied | 确保您开通了ID verifycation,并且保证账户未欠费。 | |
Throttling.Api | API限流拦截。 | |
500 | InternalError | 系统内部错误,请反馈工程师排查。 |
503 | ServiceUnavailable | 服务不可用,请反馈工程师排查。 |
ResultObject.SubCode错误码说明
错误码 | 是否计费 | 描述和原因建议 |
200 | Yes | 信息核验一致,建议认证通过。 |
202 | Yes | 官方数据库查询不到身份信息。 可能是用户的信息有误或用户的信息为虚假信息,建议用户确认后重新操作。 若用户信息确认正确,建议预留人工审核入口,进行人工审核。 |
223 | Yes | 官方数据库中姓名和身份证不一致或身份证有效期起止时间不一致。 可能是用户的信息有误或用户的信息为虚假信息,建议用户确认后重新操作。 |