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" |
返回参数
字段名称 | 数据类型 | 必须返回 | 描述 | 示例值 |
result | 是 | API请求结果,包含结果状态、结果码和结果消息。 | { "resultStatus": "S", "resultCode": "SUCCESS", "resultMessage": "Success" } | |
videoVerifyResult | String | 是 | VideoVerify 总结果。Success:意愿核身主流程及所有已开启的校验通过。Failure:人脸主流程失败,或 willingResult、faceConsistencyResult、deeperResult 任一为 Failure。InProcess:采集或处理中;VoidTimeout:流程超时;VoidCancelled:用户取消。保留对应生命周期状态。API result 为 SUCCESS 不代表核验通过。 | "Success" |
extInfo | ExtInfo | 否 | 活体检测、风控、意愿核身等详细信息,详见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" } |
willingResult | String | 否 | 意愿核身子结果,Success 或 Failure。依据上传的最终意愿结果计算,不受人脸一致性或 Deeper 结果覆盖;重试中间的失败不覆盖最终成功。处理中、取消或超时时不返回。 | "Success" |
faceConsistencyResult | String | 否 | 开启 checkFaceConsistency=Y 且已有持久化结果时返回,处理中不返回。Success:人脸一致性校验通过;Failure:人脸一致性校验不通过。 | "Success" |
deeperResult | String | 否 | Deeper 开启且已有结果时返回,Success 或 Failure。extInfo 内保留同名字段以兼容既有接入。 | "Success" |
deeperResultDescription | String | 否 | 仅 deeperResult=Failure 时返回失败说明。extInfo 内保留同名字段以兼容既有接入。 | "..." |
ExtInfo字段说明
字段名称 | 数据类型 | 必须返回 | 描述 | 示例值 |
imageContent | String | 否 | 采集到的人脸图片(Base64编码)。仅当 | "base64 image" |
quality | String | 否 | 人脸图片质量分,范围0-100,分数越高表示质量越好。 | "99.41563014552693" |
qualityPassed | Boolean | 是 | 人脸质量是否通过。
| true |
willingVerifyVideo | String | 否 | 意愿核身全流程视频(Base64编码),包含用户朗读语音。 | "base64 video" |
willingRetryRecords | String | 否 | 意愿核身结果,内容为JSON字符串,需要服务端二次解析。 | 参考返回示例 |
deeperResult | String | 否 | 返回的Deeper结果。当
| "Success" |
deeperResultDescription | String | 否 | Deeper检测结果的详细描述,当 | "" |
willingRetryRecords字段说明
字段名称 | 数据类型 | 必须返回 | 描述 |
retryRecords | List<retryRecord> | 否 | 每轮尝试记录。 |
retryRecord字段说明
字段名称 | 数据类型 | 必须返回 | 描述 |
status | String | 否 | 单轮状态。
|
userInput | String | 否 | 用户朗读内容经语音识别后返回的文本。 |
attemptNumber | int | 否 | 尝试轮次,从1开始计数。最后一轮无论成功或失败,均会被记录。 |
处理结果
API通用结果码
有关通用结果码的完整列表,请参见API通用结果码。
API特有结果码
VideoVerify Checkresult API的结果码见下表。
结果码 | 结果状态 | 描述 |
SUCCESS | S | API调用成功,返回采集与核身结果。 |
PROCESSING | S | 仍在采集或处理中,建议稍后查询。 |
INVALID_ARGUMENT | F | 输入参数无效。关于无效参数的详细信息,请查看返回的 |
UNUSABLE | F | SDK返回的元信息未通过可用性检查,用户无法使用该能力。 |
SYSTEM_ERROR | F | 系统内部错误。有关错误详情,请查看返回的 |
LIMIT_EXCEEDED | F | 超过最大次数限制。 |
UNABLE_GET_IMAGE | F | 人脸一致性校验所需的图片素材缺失或为空,核验结果为 Failure。 |
代码示例
请求示例
{
"bizId": "VV2026060500000001",
"transactionId": "G006600016CN2019011400000000957252****",
"isReturnImage": "Y"
}返回示例
{
"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",
"deeperResult": "Success",
"deeperResultDescription": ""
}
}本返回示例对应初始化 checkFaceConsistency=Y、productConfig.deeperMode=STANDARD。可选子结果可能不返回,不应将缺失结果默认为通过或失败。willingRetryRecords 为 JSON 字符串,除 retryRecords 外也可能包含 finalResult。