本文中含有需要您注意的重要提示信息,忽略该信息可能对您的业务造成影响,请务必仔细阅读。
本文介绍如何通过调用InitCardVerify接口发起认证请求。
接口信息
在使用本接口前,请确保已完整阅读接入流程,并开通服务。
接口名:InitCardVerify
全局接入地址:cloudauth.aliyuncs.com(IPv4)或cloudauth-dualstack.aliyuncs.com(IPv6)
请求方法:POST和GET
传输协议:HTTPS
接口说明:每次开始认证前通过本接口获取CertifyId,用来串联认证请求中的各个接口。
QPS限量:API独享QPS限量,详情请参见信息核验接口QPS限量说明。
请求参数
名称 | 类型 | 是否必选 | 描述 | 示例值 |
MerchantBizId | String | 是 | 您自定义的业务唯一标识,用于后续定位排查问题使用。 支持长度为32位的字母和数字的组合,请确保唯一。 | e0c34a77f5ac40a5aa5e6ed2******** |
MetaInfo | String | 是 | MetaInfo环境参数,需要通过客户端SDK获取 |
|
CardType | String | 是 | 证件类型,取值:IDENTITY_CARD。 | IDENTITY_CARD |
Model | String | 是 | 核验方式,取值: OCR_VERIFY:OCR识别且认证模式。 | OCR_VERIFY |
VerifyMeta | String | 是 | 核验类型,取值: 身份二要素(姓名+身份证号):ID_2_META。 | ID_2_META |
CardPageNumber | String | 是 | SDK采集卡证页数:
| 2 |
PictureSave | String | 是 | 是否临时存储app采集图片信息:
说明 如果此处选择是,在查询接口支持返回卡证图片信息。 | Y |
CallbackUrl | String | 否 | 认证结果的回调通知地址仅支持 平台在完成认证后会回调该地址,并自动添加 警告 仅当认证完成时才会触发回调,若认证中放弃、异常中断或未进行认证均不会通知。建议您收到回调通知时,若有需要可通过查询接口获取认证详情资料信息。 | https://www.aliyun.com |
CallbackToken | String | 否 | 安全Token,用于防重复、防篡改校验。如果传入该参数会在回调地址显示CallbackToken字段。 | NMjvQanQgplBSaEI0sL86Wn**** |
DocScanMode | String | 否 | 拍照方式枚举(手动/ 自动拍照):
| shoot |
响应结果
名称 | 类型 | 描述 | 示例值 | |
RequestId | String | 请求ID。 | 130A2C10-B9EE-4D84-88E3-5384******** | |
Message | String | 返回信息。 | success | |
Code | String | 返回码:200为成功,其他为失败。 重要
| 200 | |
ResultObject | CertifyId | String | 核验请求ID,核验服务认证请求的唯一标识。 查询认证结果时,必须传入认证请求ID。 警告
| 91707dc296d469ad38e4c5ef******** |
SDK调用示例
集成前请确保您已完整阅读接入流程,开通了服务并获取AccessKey且正确配置环境变量。