ID Verification 产品支持全链路日志监控,未完成认证的人脸识别过程,也可通过 TransactionId 自助查询,查询结果可用于分析用户流失原因。此接口不涉及计费。
接口说明
查询认证的完整链路日志。
此接口仅可查询有客户端接入的方案日志,不支持纯服务端接入方案。
采用认证的端侧 SDK 版本需在 1.2.6 及以上(建议使用最新版),Web SDK 需使用最新版。
由于认证过程中日志上报按照操作时间异步上传,请在认证TransectionID的30分钟有效期失效后查询。
ID Verification服务记录默认存储30天,超期系统自动删除,请您在认证结束后的30天内查询认证记录。
接口名:CheckVerifyLog
请求方法:POST
传输协议:HTTPS
服务地址:
说明内网指的是阿里云同地域产品之间的内部通信网络,如果您的业务服务器部署在阿里云的对应地域,可以通过内网域名访问 ID Verification 服务,以获得更安全、稳定的网络通信质量。
ID Verification不同产品方案支持的Region不同,数据之间相互隔离,您需要选择数据所在Reigon下的接口域名,才能成功访问数据。
新加坡
公网:
cloudauth-intl.ap-southeast-1.aliyuncs.com内网:
cloudauth-intl-vpc.ap-southeast-1.aliyuncs.com
印度尼西亚
公网:
cloudauth-intl.ap-southeast-5.aliyuncs.com内网:
cloudauth-intl-vpc.ap-southeast-5.aliyuncs.com
中国香港
公网:
cloudauth-intl.cn-hongkong.aliyuncs.com内网:
cloudauth-intl-vpc.cn-hongkong.aliyuncs.com
在线调试和集成
在调试和集成前,请确保您已完整阅读使用OpenAPI文档,充分了解API接口在OpenAPI平台的调用方式和SDK及其代码的获取方式。
您可以在OpenAPI Explorer中直接运行本接口进行调试,并生成本接口的SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 描述 | 示例值 |
MerchantBizId | String | 是 | 您自定义的业务唯一标识,用于后续排查问题定位。支持长度为32位的字母和数字的组合,请确保唯一。 说明 阿里云服务器不会对该字段的值进行唯一性检查。为了更好地跟踪,强烈建议保证字段唯一性。 | e0c34a77f5ac40a5aa5e6ed20c****** |
TransactionId | String | 是 | 整个认证流程的唯一标识。该值需要调用 Initialize接口 获取。 | 80414a5e6ed20c37ac40a7f55a****** |
返回参数
名称 | 类型 | 描述 | 示例 |
RequestId | String | 请求ID。 | |
Code | String | 返回码。 | |
Message | String | 返回Code的详细描述。 | |
Result | Object | 日志内容,参数详细说明见下文Result表。 |
Result
名称 | 类型 | 是否必含 | 描述 |
VerifyStatus | String | 是 | 认证状态,取值:
|
LogInfo | List<String> | 否 | SDK运行链路日志详情,格式: [
] |
LogInfoEn | List<String> | 否 | SDK运行链路日志详情,英文取值。 此字段格式同LogInfo。 |
Passed | String | 否 说明 仅当 VerifyStatus = 0 时返回。 | 认证最终结果,取值:
|
SubCode | String | 否 说明 仅当 VerifyStatus = 0 时返回。 | 认证结果描述,返回值请参考使用的认证方案接口文档中的SubCode描述。 说明 例如,使用了 eKYC - Web SDK 方案进行了认证,则需参考 eKYC - Web SDK - CheckResult 接口文档中的 SubCode 描述。 |
InterruptPage | String | 否 | 认证中断最后停留页面,取值:
|
InterruptPageEn | String | 否 | 认证中断最后停留页面,英文取值: 当然,以下是将这些取值转换为无序列表的形式:
|
VerifyErrorCode | String | 否 | 认证中断错误码:
|
LogStatisticsInfo | String | 否 | SDK运行日志统计详情 ,JSON字符串格式,内容详见下文LogStatisticsInfo 表 。 |
ExtInfo | String | 否 | 扩展字段(预留) |
LogStatisticsInfo
名称 | 类型 | 含义 | 示例 |
pageStayTimeInfo | Map<String,Long> | 页面停留时长(单位毫秒),页面:
说明 停留时长指每一个页面从渲染展示到跳转至下一个页面或者关闭所经历的时长。 | |
hasFaceOverTimes | Boolean | 活体检测过程中,是否有弹出重试弹窗。 | true |
faceOverTimes | Long | 活体检测过程中,用户点击重试次数。 | 2 |
hasOcrOverTimes | Boolean | OCR是否有重试: 是否存在拍摄证件提交服务端验证不通过,用户点击重拍提交。 | false |
ocrOverTimes | Long | OCR拍摄证件过程中,用户点击重试次数。 | 0 |
hasOcrEdit | Boolean | 在OCR页面中停留时,是否有点击编辑字段信息。 | true |
ocrEditTimes | Long | OCR编辑次数: 用户编辑点击提交服务端校验计一次。 | 1 |
hasOcrEditOverTimes | Boolean | OCR编辑是否有重试 | false |
ocrEditOverTimes | Long | OCR编辑重试次数 | 0 |
hasOcrPermissionRefuse | Boolean | OCR是否被相机拒绝权限 | false |
hasFacePermissionRefuse | Boolean | 活体检测是否被相机拒绝权限 | false |
返回码
HTTP状态码 | Code | Message描述 |
200 | Success | 请求成功。 |
400 | MissingParameter | 参数不能为空。 |
InvalidParameter | 非法参数。 | |
TransactionIdInvalid | 无效Transaction id。 | |
403 | Forbidden.RAMUserAccessDenied | 需要给RAM用户授予AliyunAntCloudAuthFullAccess的操作权限。更多信息,请参见授权RAM用户访问服务。 |
Forbidden.AccountAccessDenied | 确保您开通了ID verifycation,并且保证账户未欠费。 | |
Throttling.Api | API限流拦截。 | |
404 | ProcessNotCompleted | 整个认证流程未完成。 |
500 | InternalError | 系统内部错误,请反馈工程师排查。 |
503 | ServiceUnavailable | 服务不可用,请反馈工程师排查。 |