checkresult

重要说明:

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

概览

  • API URL:/api/v1/zoloz/videoverify/checkresult
  • API 描述:该接口用于获取VideoVerify的最终验证结果。

说明:该接口支持重复调用。SDK完成回调后可查询;如果返回处理中状态,可按业务策略进行轮询。

请求参数

字段名称

数据类型

最大长度

是否必填

默认值

描述

示例值

bizId

String

32

-

调用initialize API时传入的商户业务ID。

"VV2026060500000001"

transactionId

String

64

-

调用initialize API后返回的交易ID。

"G006600016CN2019011400000000957252****"

isReturnImage

String

1

N

是否返回人脸图片数据。取值:

  • Y:返回
  • N:不返回

"Y"

返回参数

字段名称

数据类型

必须返回

描述

示例值

result

Result

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

{

"resultStatus": "S",

"resultCode": "SUCCESS",

"resultMessage": "Success"

}

videoVerifyResult

String

VideoVerify总结果。

  • Success:VideoVerify检测通过。
  • Failure:VideoVerify检测失败,建议拒绝或由人工复核。
  • VoidTimeout:未获取到VideoVerify结果,流程超时。
  • InProcess:正在采集中,可稍后再次查询。

"Success"

extInfo

ExtInfo

活体检测、风控、意愿核身等详细信息,详见ExtInfo

说明:仅当result.resultCodeSUCCESS时返回。

{

"imageContent": "base64 image",

"quality": "99.41563014552693",

"qualityPassed": true,

"willingRetryRecords": "{\"retryRecords\":[{\"status\":\"WRONG_ANSWER\",\"userInput\":\"测试\",\"attemptNumber\":1},{\"status\":\"SUCCESS\",\"userInput\":\"I confirm\",\"attemptNumber\":2}]}",

"willingVerifyVideo": "base64 video"

}

ExtInfo字段说明

字段名称

数据类型

必须返回

描述

示例值

imageContent

String

采集到的人脸图片(Base64编码)。仅当isReturnImageY时返回。

"base64 image"

quality

String

人脸图片质量分,范围0-100,分数越高表示质量越好。

"99.41563014552693"

qualityPassed

Boolean

人脸质量是否通过。

  • true:通过
  • false:不通过

true

willingVerifyVideo

String

意愿核身全流程视频(Base64编码),包含用户朗读语音。

"base64 video"

willingRetryRecords

String

意愿核身结果,内容为JSON字符串,需要服务端二次解析。

参考返回示例

willingRetryRecords字段说明

字段名称

数据类型

必须返回

描述

retryRecords

List<retryRecord>

每轮尝试记录。

retryRecord字段说明

字段名称

数据类型

必须返回

描述

status

String

单轮状态。

  • WRONG_ANSWER
  • NO_RESPONSE
  • SUCCESS
  • FAIL

userInput

String

用户朗读内容经语音识别后返回的文本。

attemptNumber

int

尝试轮次,从1开始计数。最后一轮无论成功或失败,均会被记录。

处理结果

API通用结果码

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

API特有结果码

VideoVerify Checkresult API的结果码见下表。

结果码

结果状态

描述

SUCCESS

S

API调用成功,返回采集与核身结果。

PROCESSING

S

仍在采集或处理中,建议稍后查询。

INVALID_ARGUMENT

F

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

UNUSABLE

F

SDK返回的元信息未通过可用性检查,用户无法使用该能力。

SYSTEM_ERROR

F

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

LIMIT_EXCEEDED

F

超过最大次数限制。

代码示例

请求示例

copy
{
    "bizId": "VV2026060500000001", 
    "transactionId": "G006600016CN2019011400000000957252****", 
    "isReturnImage": "Y"
}

返回示例

copy
{
    "result": {
        "resultStatus": "S", 
        "resultCode": "SUCCESS", 
        "resultMessage": "Success"
    }, 
    "videoVerifyResult": "Success", 
    "extInfo": {
        "imageContent": "base64 image", 
        "quality": "99.41563014552693", 
        "qualityPassed": true, 
        "willingRetryRecords": "{\"retryRecords\":[{\"status\":\"WRONG_ANSWER\",\"userInput\":\"测试\",\"attemptNumber\":1},{\"status\":\"SUCCESS\",\"userInput\":\"I confirm\",\"attemptNumber\":2}]}", 
        "willingVerifyVideo": "base64 video"
    }
}