InitFaceVerify-发起认证请求

更新时间:
复制为 MD 格式

本文介绍了如何调用InitFaceVerify接口在服务端接入流程中发起认证请求。

接入方式说明

如果采用服务端接入方式,您可以配合SDK调用InitFaceVerify接口发起认证请求,获取CertifyId,唤起客户端上传人脸信息。用户上传人脸信息后,您可以调用DescribeFaceVerify接口查询认证结果

发起认证请求

接口名:InitFaceVerify

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

请求方法:POSTGET

传输协议:HTTPS

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

QPS限量:API独享QPS限量,详情请参见服务端接口QPS限量说明

请求参数

名称

类型

是否必选

描述

示例值

SceneId

Long

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

100000****

OuterOrderNo

String

客户服务端自定义的业务唯一标识,用于后续定位排查问题使用。值最长为32位长度的字母数字组合,请确保唯一。

e0c34a77f5ac40a5aa5e6ed20c353888

ProductCode

String

认证方案。

唯一取值:LR_FR

LR_FR

Model

String

活体检测类型,取值:

说明

活体检测类型仅支持下列取值,暂不支持自定义动作或组合。

  • SILENT_LIVENESS:静默(无任何动作)

  • LIVENESS(默认):眨眼

  • PHOTINUS_LIVENESS:眨眼 + 炫彩

  • MULTI_ACTION:眨眼 + 摇头 (眨眼和摇头顺序随机)

  • MOVE_ACTION:远近移动 + 眨眼

  • MULTI_PHOTINUS:眨眼+摇头(眨眼与摇头顺序随机)+炫彩

  • MOVE_PHOTINUS:远近移动 + 炫彩

说明
  • 默认活体检测类型在下列版本中支持:

    • Android SDK1.2.6及以上

    • iOS SDK1.2.4及以上

    • Harmony SDK1.0.0及以上

  • 其他类型都在Android/iOS/Harmony的最新SDK版本上支持,建议集成最新版本使用。

MOVE_ACTION

UserId

String

您自定义的用户ID(最长100个字符),请保持唯一。

123456789

CertType

String

证件类型。

当前仅支持身份证,必须传入IDENTITY_CARD

说明

该方案中,不验证姓名和证件号码的真实性、一致性。如需验证,请选择实人认证方案。

IDENTITY_CARD

CertName

String

真实姓名。

张三

CertNo

String

证件号码。

330103xxxxxxxxxxxx

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

用户手机号码。

130xxxxxxxx

Ip

String

用户网络IP。

114.xxx.xxx.xxx

CallbackUrl

String

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

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

  • 该值的传入会在调用接口前做可访问校验,如果传入的地址不能在公网访问,会返回401。

  • 接口在回调后务必返回 HTTP 状态码 200,否则会触发重试,3秒内两次回调。

https://www.aliyun.com

CallbackToken

String

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

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

NMjvQanQgplBSaEI0sL86WnQplB

AuthId

String

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

92d46b9e9e2d703f2897f350d5bd4149

SuitableType

String

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

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

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

  • 2:用户选择。

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

说明
  • 适老化参数仅在活体检测类型Model取值 LIVENESS 或者 MULTI_ACTION时生效。

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

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

    Web SDK 支持适老化模式,建议使用最新版本SDK。

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

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

0

AppQualityCheck

String

SDK是否开启人脸严格质量检测:

  • Y:开启

  • N:不开启(默认)

说明
  • 若开启该参数,SDK需集成人脸严格质量检测模块

  • 对戴帽子,带口罩,戴墨镜等常见遮挡场景,客户端会提示重新检测,保证客户端取到更高质量的人脸图片后再进行认证。受严格质量检测影响,会导致用户刷脸成功率下降。

  • 仅支持安卓SDK 2.3.24及以上版本。

N

needMultiFaceCheck

String

终端检测到多人脸时是否拦截,取值:

  • Y:拦截,客户端提示需要重新刷脸。

  • N(默认):不拦截,取刷脸画面中的最大脸发送服务端进行安全检测。

Y

返回数据

名称

类型

描述

示例值

RequestId

String

请求ID。

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

Message

String

返回信息。

success

Code

String

返回码。200表示成功,其他表示失败。关于返回码的具体信息,请参见返回CodeMessage说明

200

ResultObject.CertifyId

String

实人认证唯一标识。

警告

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

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

91707dc296d469ad38e4c5efa6a0****

返回CodeMessage说明

Code

Message

描述

200

success

成功。

400

参数不能为空

参数不能为空。

401

参数非法

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

402

应用配置不存在

应用配置不存在。

404

认证场景配置不存在

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

410

未开通服务

未开通OSS产品或未完成OSS读写授权,请登录控制台完成授权。具体操作,请参见开通及授权OSS存储

411

RAM无权限

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

412

欠费中

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

414

设备类型不支持

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

415

SDK版本不支持

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

416

系统版本不支持

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

500

系统错误

系统内部错误,请反馈工程师排查。