文档

InitFaceVerify-发起认证请求

更新时间:

本文介绍如何通过调用InitFaceVerify接口发起金融级实人认证请求。

发起认证请求

接口名:InitFaceVerify

全局接入地址:cloudauth.aliyuncs.com(IPv4)或cloudauth-dualstack.aliyuncs.com(IPv6)

请求方法:POST和GET。

传输协议:HTTPS。

接口说明:每次开始认证前通过本接口获取CertifyId,用来串联认证请求中的各个接口。

请求参数

名称

类型

是否必选

描述

示例值

SceneId

Long

要接入的认证场景ID。该ID在控制台创建认证场景后自动生成。关于如何创建认证场景,请参见添加认证场景

100000****

OuterOrderNo

String

您自定义的业务唯一标识,用于后续定位排查问题使用。

支持长度为32位的字母和数字的组合,请确保唯一。

e0c34a77f5ac40a5aa5e6ed20c35****

ProductCode

String

要接入的认证方案。取值:

  • ID_PRO:使用ID_PRO认证方案,您的用户仅需要做活体认证。

  • ID_PLUS:使用ID_PLUS认证方案,您的用户需要拍摄身份证和活体认证。

    说明

    如果您的业务需要同步采集身份证信息,可选择ID_PLUS方案。

ID_PRO

Model

String

要进行活体检测的类型。取值:

  • LIVENESS(默认):眨眼动作活体检测。

  • PHOTINUS_LIVENESS:眨眼动作活体+炫彩活体双重检测。

  • MULTI_ACTION:多动作活体检测。当前为眨眼+任意摇头检测。

说明

活体检测模式仅支持运行在Android SDK 1.2.6及以上版本和iOS SDK 1.2.4及以上版本;多动作活体检测模式仅支持运行在Android SDK 1.6.4及以上版本和iOS SDK 1.5.1及以上版本。

LIVENESS

CertType

String

用户证件类型。支持的证件类型,请参见方案概述

不同证件类型,取值均为IDENTITY_CARD

说明

ProductCodeID_PLUS时,CertType为非必填字段。

IDENTITY_CARD

CertName

String

终端用户的真实姓名。

说明

ProductCodeID_PLUS时,CertName为非必填字段。

张XX

CertNo

String

终端用户的证件号码。

说明

ProductCodeID_PLUS时,CertNo为非必填字段。

330103************

MetaInfo

String

MetaInfo环境参数,需要通过客户端SDK获取,详情请参见App(SDK)接入

{"zimVer":"3.0.0","appVersion": "1","bioMetaInfo": "4.1.0:1150****,0","appName": "com.aliyun.antcloudauth","deviceType": "ios","osVersion": "iOS 10.3.2","apdidToken": "","deviceModel": "iPhone9,1"}

说明

该示例仅供参考,实际集成中不能直接应用,具体参考SDK集成说明获取。

Mobile

String

终端用户的手机号码。

130********

Ip

String

终端用户的IP。

114.100.XX.XX

UserId

String

您自定义的用户ID,请保持唯一。

123456789

CallbackUrl

String

认证结果的回调通知地址,回调请求方式默认为GET,回调地址必须以https开头。平台在完成认证后会回调该地址,并自动添加certifyIdpassed字段,passed字段值返回的是subcode值,示例:https://www.aliyun.com?callbackToken=1000004826&certifyId=shaxxxx&passed=200

说明

仅当认证完成(包含认证通过和认证未通过)时才会触发回调,若认证中放弃、异常中断或未进行认证均不会通知。建议您收到回调通知时,若有需要可通过查询接口获取认证详情信息。

https://www.aliyun.com

CallbackToken

String

安全Token,由您自行生成,用于防重复、防篡改校验。

如果设置了该值会在回调地址显示CallbackToken字段。

NMjvQanQgplBSaEI0sL86WnQplB

AuthId

String

用户授权ID,最大长度为64位字符。

92d46b9e9e2d703f2897f350d5bd4149

EncryptType

String

传入加密算法,目前仅支持SM2国密算法。

开启加密传输后,需传入加密后的CertNameCertNo。如何加密,请参见参数加密说明

SM2

SuitableType

String

适老化配置参数,针对每笔认证请求生效,您可以根据自有App的业务属性、客群分布、操作特性等条件对于每笔认证请求选择不同的参数,包括以下选项,默认为0。

  • 0:不开启,表示当前认证请求不开启适老化。

  • 1:开启,表示当前认证请求开启适老化。

  • 2:用户选择。

    支持终端用户选择认证模式,产品引导页提供“开启认证”和“长辈认证模式”两种认证入口,当用户选择“长辈认证模式”系统进入适老化模式。

说明
  • 适老化主要是通过增加语音提示、字体放大、UI优化等方式针对老年人或身体机能存在缺陷的群体提供友好操作体验的认证模式。

  • 仅Navite SDK支持适老化模式,SDK版本需要大于或等于2.2.5。

  • 开启适老化,人脸验证时间会变长。

  • 当移动设备开启系统无障碍模式,SDK不支持开启适老化模式。

0

FaceGuardOutput

String

人脸保镖标签种类。

DeviceRisk:设备风险标签。

    说明
    • 选择输出人脸保镖会产生额外的费用,具体费用,请参见计费概述

    • 如果不需要输出人脸保镖标签,可以不传递参数或者传入空值。

DeviceRisk

RarelyCharacters

String

是否开启生僻字模式。

  • Y:开启。用户认证前会弹出信息输入框,需输入生僻字姓名和身份证号码,同意协议后才能开始认证流程。

  • N:不开启(默认)。

说明

生僻字模式仅金融级实人认证方案下App接入场景和PC/H5接入场景支持,其他方案暂不支持。

Y

返回数据

名称

类型

描述

示例值

RequestId

String

请求ID。

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

Message

String

请求消息的响应信息。

success

Code

String

返回码。关于返回码的具体信息,请参见下文返回Code和Message说明。

200

ResultObject.CertifyId

String

实人认证唯一标识。客户端通过verify()函数发起实人认证的时候需传入该参数。

重要
  • CertifyId字段为计费统计字段,为了方便后续核对账单,请您在本地留存该字段信息。

  • 初始化接口返回的认证CertifyId在30分钟内有效认证仅能提交一次,请在有效期内使用,避免重复使用。

91707dc296d469ad38e4c5efa6a0****

返回Code和Message说明

Code

Message

描述

200

success

成功。

400

参数不能为空

参数不能为空。

401

参数非法

非法参数。传入的姓名、身份证号码长度必须符合国家标准且不得包含英文字母等特殊字符。

402

应用配置不存在

应用配置不存在。

404

认证场景配置不存在

认证场景配置不存在,请先在控制台上创建认证场景。

410

未开通服务

未开通OSS产品或未完成OSS读写授权,请登录控制台完成授权。具体操作,请参见授权金融级实人认证访问OSS存储空间

411

RAM无权限

需要给RAM用户授予AliyunAntCloudAuthFullAccess的操作权限。

412

欠费中

金融级实人认证或OSS存在欠费,请充值后操作。

414

设备类型不支持

当前移动设备不支持刷脸认证,请更换设备后操作。

415

SDK版本不支持

当前认证SDK版本不支持刷脸认证,请升级SDK后操作。

416

系统版本不支持

当前操作系统版本不支持刷脸认证,请升级系统或更换设备操作。

417

无法使用刷脸服务

当前身份信息无可用比对源,导致此错误的原因请参考DescribeFaceVerify认证结果错误码(ResultObject.SubCode)201、202和203的描述说明。

418

刷脸失败次数过多

当天刷脸认证失败次数过多,请明天再试。

说明

一个身份信息在一天内最多可以认证失败20次,无法调整更多的认证失败次数。

500

系统错误

系统内部错误,请通过智能在线联系阿里云工程师协助排查。

  • 本页导读