initialize

重要说明:

  • 所有请求及返回参数均严格以官网API文档为准。
  • API返回结果中可能包含未在文档中定义的字段。这些字段仅供内部调试使用,不保证稳定性及兼容性,请勿在生产环境中依赖这些字段,ZOLOZ保留随时修改或删除这些字段的权利,且无需另行通知。

概览

  • API URL:/api/v1/zoloz/videoverify/initialize
  • API 描述:该接口用于初始化VideoVerify交易。调用成功后,系统将返回唯一的transactionId及客户端启动SDK所需的clientCfg

说明:该接口不支持重复调用。每次新的业务流程必须使用新的bizId重新调用Initialize API,请勿使用相同的bizId重复调用。

请求参数

字段名称

数据类型

最大长度

是否必填

默认值

描述

示例值

bizId

String

32

-

商户侧的业务唯一标识。建议与业务订单、申请单或流水号一一对应,以便追踪业务。

说明ZOLOZ不校验该值的唯一性,商户侧需自行保证该业务ID的唯一性。

"VV2026060500000001"

metaInfo

String

512

-

SDK与用户设备的元信息。原生App模式下该值由ZOLOZ SDK返回,请直接传入,不要进行任何修改。

"{\"apdidToken\":\"xxx\",\"appName\":\"com.example.app\",\"appVersion\":\"1.0.0\",\"bioMetaInfo\":\"3.46.0:0,2\",\"deviceModel\":\"iPhone13,3\",\"deviceType\":\"ios\",\"osVersion\":\"iOS 26.1\"}"

userId

String

64

-

商户侧的用户标识,例如用户ID、手机号、邮箱等。建议在传入前进行哈希或脱敏处理。

"hash_user_001"

sceneCode

String

64

null

业务场景码,用于区分不同业务场景的数据表现,例如loginriskVerifypaymentchangePassword

"changePassword"

productConfig

ProductConfig

-

null

VideoVerify产品的精细化配置参数。具体可配置项,详见ProductConfig

{

"riskMode": "STANDARD"

}

ProductConfig字段说明

字段名称

数据类型

最大长度

是否必填

默认值

描述

示例值

riskMode

String

10

STANDARD

VideoVerify中的多维度风控冷却规则校验,用于拦截可疑交易。取值:

  • CLOSED:关闭风控冷却规则。该等级适用于测试场景,测试进程不受风控规则的影响。
  • STANDARD:推荐的标准等级。
  • LOOSE:相对宽松的等级,可用于低风险场景。
  • STRICT:相对严格的等级,可用于高风险场景。

"STANDARD"

返回参数

字段名称

数据类型

必须返回

描述

示例值

result

Result

API请求结果,包含结果状态、结果码和结果消息。

{

"resultStatus": "S",

"resultCode": "SUCCESS",

"resultMessage": "Success"

}

transactionId

String

ZOLOZ服务器为本次流程生成的交易ID。

说明仅当交易进入处理阶段后系统才会返回transactionId。如果在开始处理交易之前发生错误,系统不会返回transactionId。包括但不限于以下情况:

  • 请求参数非法,例如入参格式错误或缺失必传参数。
  • 请求未能成功到达服务器,例如网络问题或网关故障。
  • 系统限流导致请求被拒绝。

"G006600016CN2019011400000000957252****"

clientCfg

String

客户端配置,包括SDK连接和行为参数。仅当result.resultStatusS时返回。

"..."

处理结果

API通用结果码

有关通用结果码的完整列表,请参见API通用结果码

API特有结果码

VideoVerify Initialize API的结果码见下表。

结果码

结果状态

描述

SUCCESS

S

API调用成功。

HIGH_RISK

F

检测到高风险,用户账号被风控冻结。

DEVICE_NOT_SUPPORT

F

当前设备类型不支持。

OS_NOT_SUPPORT

F

当前操作系统不支持。

SDKVERSION_NOT_SUPPORT

F

当前SDK版本不支持。

INVALID_ARGUMENT

F

输入参数无效。关于无效参数的详细信息,请查看返回的resultMessage

SYSTEM_ERROR

F

系统内部错误。有关错误详情,请查看返回的resultMessage

代码示例

请求示例

copy
{
    "bizId": "VV2026060500000001", 
    "metaInfo": "{\"apdidToken\":\"xxx\",\"appName\":\"com.example.app\",\"appVersion\":\"1.0.0\",\"bioMetaInfo\":\"3.46.0:0,2\",\"deviceModel\":\"iPhone13,3\",\"deviceType\":\"ios\",\"osVersion\":\"iOS 26.1\"}", 
    "userId": "hash_user_001", 
    "sceneCode": "loanGuarantee", 
    "productConfig": {
        "riskMode": "STANDARD"
    }
}

返回示例

copy
{
    "result": {
        "resultStatus": "S", 
        "resultCode": "SUCCESS", 
        "resultMessage": "Success"
    }, 
    "transactionId": "G006600016CN2019011400000000957252****", 
    "clientCfg": "..."
}