调用InitSmartVerify接口发起增强版活体验证请求。
接口名:InitSmartVerify。
服务地址:cloudauth.aliyuncs.com
。
请求方法:POST和GET。
传输协议:HTTPS。
接口说明:每次开始认证前调用本接口获取CertifyId,用来串联认证请求中的各个接口。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
SceneId | Long | 是 | 100000xxxx | 认证场景ID。 您必须先在增强版实人认证控制台创建认证场景,才能获得认证场景ID。更多信息,请参见添加认证场景。 |
OuterOrderNo | String | 是 | e0c34a77f5ac40a5aa5e6ed20c35xxxx | 商户请求的唯一标识,由32位字母、数字组合而成。 |
Mode | String | 是 | LOGIN_SAFE | 增强版活体验证的业务场景类型。取值:
|
CertType | String | 是 | IDENTITY_CARD | 证件类型。唯一取值:IDENTITY_CARD,表示身份证。 |
CertName | String | 否 | 张三 | 用户的真实姓名。 |
CertNo | String | 否 | 330103xxxxxxxxxxxx | 用户的证件号码。 |
MetaInfo | String | 是 | {"zimVer":"3.0.0","appVersion": "1","bioMetaInfo": "4.1.0:11501568,0","appName": "com.aliyun.antcloudauth","deviceType": "ios","osVersion": "iOS 10.3.2","apdidToken": "","deviceModel": "iPhone9,1"} | MetaInfo环境参数,需要通过客户端SDK获取。 更多信息,请参见Android客户端接入、iOS客户端接入。 |
Mobile | String | 是 | 130xxxxxxxx | 用户手机号码。 说明 Mode取值为DEVICE_SAFE时,Mobile为非必填字段。 |
Ip | String | 否 | 114.xxx.xxx.xxx | 用户网络IP。 |
UserId | String | 否 | 12345xxxx | 您业务中自定义的用户ID,请保持唯一。 |
callbackUrl | String | 否 | https://www.aliyun.com | 认证结果的回调通知地址,必须以https 开头。平台在完成认证后会回调该地址,并自动添加 certifyId 、passed 和subcode 字段,示例:https://www.aliyun.com?certifyId=xxxx&passed=T&subcode=200 。警告 仅当认证完成(包含认证通过和认证未通过)时才会触发回调,若认证中放弃、异常中断或未进行认证均不会通知。建议您收到回调通知时,若有需要可通过查询接口获取认证详情资料信息。 |
CallbackToken | String | 否 | NMjvQanQgplBSaEI0sL86WnQplB | 安全Token,用于防重复、防篡改校验。如果传入该参数会在回调地址显示CallbackToken字段。 |
FacePictureBase64 | String | 否 | /9j/4AAQSkZJRgABAQAASxxxxxxx | 人脸图片的Base64编码。 说明 您必须选择以下一种方式传入人脸图片:
|
FacePictureUrl | String | 否 | https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/smart/xxxxx/xxxxx.jpeg | 人脸图片的HTTPS或HTTP地址。 说明 您必须选择以下一种方式传入人脸图片:
|
CertifyId | String | 否 | 0bfa7c493f850e5178b9f8613634c9xx | 已通过增强版实人认证得到的CertifyId,认证时的图片作为比对图片。 说明 您必须选择以下一种方式传入人脸图片:
|
OssBucketName | String | 否 | cn-shanghai-aliyun-cloudauth-xxxxx | 已授权OSS空间的Bucket名。 说明 您必须选择以下一种方式传入人脸图片:
|
OssObjectName | String | 否 | smart/xxxxx/xxxxxx.jpeg | 已授权OSS空间的文件名。 说明 您必须选择以下一种方式传入人脸图片:
|
返回数据
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
RequestId | String | 是 | 130A2C10-B9EE-4D84-88E3-5384FF039795 | 请求ID。 |
Message | String | 否 | success | 错误信息。 |
Code | String | 是 | 200 | 返回码。取值:
|
ResultObject.CertifyId | String | 否 | 91707dc296d469ad38e4c5efa6a0xxxx | 认证请求ID,增强版实人认证服务认证请求的唯一标识。 查询认证结果时,必须传入认证请求ID。 警告 CertifyId字段为计费统计字段,为了方便后续核对账单,请您在本地留存该字段信息。 初始化接口返回的认证CertifyId在30分钟有效且仅能认证提交一次,请您在有效期内应用,避免重复使用。 |
示例
请参见Java SDK调用示例。
说明 如果您需要其他语言的SDK代码示例,您可以通过OpenAPI Explorer在线调试工具调试API接口。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
错误码
Code | Message | 描述 |
---|---|---|
200 | success | 接口响应成功。 |
400 | 参数不能为空 | 参数不能为空。 |
401 | 参数非法 | 非法参数。传入的姓名、身份证号码长度必须符合国家标准且不得包含英文字母等特殊字符。 |
404 | 认证场景配置不存在 | 认证场景配置不存在,请先在增强版实人认证控制台上创建认证场景。 更多信息,请参见添加认证场景。 |
410 | 未开通服务 | 未开通OSS产品或未完成OSS读写授权,请登录增强版实人认证控制台完成授权。 |
411 | RAM无权限 | 需要为RAM用户授予AliyunYundunCloudAuthFullAccess的操作权限。 |
412 | 欠费中 | 增强版实人认证或OSS存在欠费,请充值后再进行操作。 |
420 | 数据重复 | 图片传入方式超过一种。支持以下四种传入人脸图片的方式,必须且只能使用其中一种:
|
421 | 传入图片过大 | 图片超过了1 MB,建议压缩图片或更换图片上传方式。 |
422 | 下载图片超时 | 图片下载时间超过了3秒,请排查网络后重新操作。 |
423 | 状态错误 | 传入的CertifyId的认证状态需要为T(表示认证通过),您也可以使用其他方式传入图片。 |
428 | 格式校验错误 | 参数格式校验错误,请调整参数格式。 |
500 | 系统错误 | 系统内部错误,请通过智能在线联系阿里云工程师协助排查。 |