本文介绍如何通过调用InitFaceVerify接口发起金融级实人认证请求。
发起认证请求
接口名:InitFaceVerify
全局接入地址:cloudauth.aliyuncs.com(IPv4)或cloudauth-dualstack.aliyuncs.com(IPv6)
请求方法:POST和GET
传输协议:HTTPS
接口说明:每次开始认证前通过本接口获取CertifyId,用来串联认证请求中的各个接口。
QPS限量:API独享QPS限量,详情请参见服务端接口QPS限量说明。
请求参数
名称 | 类型 | 是否必选 | 描述 | 示例值 |
SceneId | Long | 是 | 要接入的认证场景ID。该ID在控制台创建认证场景后自动生成。关于如何创建认证场景,请参见添加认证场景。 | 100000**** |
OuterOrderNo | String | 是 | 您自定义的业务唯一标识,用于后续定位排查问题使用。 支持长度为32位的字母和数字的组合,请确保唯一。 | e0c34a77f5ac40a5aa5e6ed20c35**** |
ProductCode | String | 是 | 要接入的认证方案。取值:
| ID_PRO |
Model | String | 否 | 活体检测类型,取值: 说明 活体检测类型仅支持下列取值,暂不支持自定义动作或组合。
说明
| MOVE_ACTION |
CertType | String | 是 | 用户证件类型。支持的证件类型,请参见方案概述。 不同证件类型,取值均为IDENTITY_CARD。 说明 当ProductCode为ID_PLUS时,CertType为非必填字段。 | IDENTITY_CARD |
CertName | String | 是 | 终端用户的真实姓名。 说明 当ProductCode为ID_PLUS时,CertName为非必填字段。 | 张XX |
CertNo | String | 是 | 终端用户的证件号码。 说明 当ProductCode为ID_PLUS时,CertNo为非必填字段。 | 330103************ |
MetaInfo | String | 是 | MetaInfo环境参数,需要通过客户端SDK获取,详情请参见App(SDK)接入。 |
说明 该示例仅供参考,实际集成中不能直接应用,具体参考SDK集成说明获取。 |
Mobile | String | 否 | 终端用户的手机号码。 | 130******** |
Ip | String | 否 | 终端用户的IP。 | 114.100.XX.XX |
UserId | String | 否 | 您自定义的用户ID(最长100个字符),请保持唯一。 | 123456789 |
CallbackUrl | String | 否 | 认证结果的回调通知地址,回调请求方式默认为GET,回调地址必须以 重要
| https://www.aliyun.com |
CallbackToken | String | 否 | 安全Token,由您自行生成,用于防重复、防篡改校验。 如果设置了该值会在回调地址显示CallbackToken字段。 | NMjvQanQgplBSaEI0sL86WnQplB |
AuthId | String | 否 | 用户授权ID,最大长度为64位字符。 | 92d46b9e9e2d703f2897f350d5bd4149 |
EncryptType | String | 否 | 传入加密算法,目前仅支持SM2国密算法。 开启加密传输后,需传入加密后的CertName和CertNo。如何加密,请参见参数加密说明。 | SM2 |
SuitableType | String | 否 | 适老化配置参数,针对每笔认证请求生效,您可以根据自有App的业务属性、客群分布、操作特性等条件对于每笔认证请求选择不同的参数,包括以下选项,默认为0。
说明
| 0 |
FaceGuardOutput | String | 否 | 人脸保镖标签种类。 DeviceRisk:设备风险标签。
说明 | DeviceRisk |
RarelyCharacters | String | 否 | 是否开启生僻字模式:
说明 生僻字模式仅金融级实人认证方案下App接入场景和PC/H5接入场景支持,其他方案暂不支持。 | Y |
AppQualityCheck | String | 否 | SDK是否开启人脸严格质量检测:
说明
| N |
返回数据
名称 | 类型 | 描述 | 示例值 |
RequestId | String | 请求ID。 | 130A2C10-B9EE-4D84-88E3-5384FF039795 |
Code | String | 返回码,200 指接口响应成功。 您可以在返回Code和Message说明中查看不同 Code 的详细描述。 | 200 |
Message | String | 请求信息的响应消息,对 Code(返回码)的简短描述。 | success |
ResultObject.CertifyId | String | 实人认证唯一标识。客户端通过 verify 函数发起实人认证的时候需传入该参数。 重要
| 91707dc296d469ad38e4c5efa6a0**** |