checkresult

2023-07-20 02:29

概览

API URL：/api/v1/zoloz/idrecognition/checkresult
API 描述：该接口用于获取证件识别进程的运行状态和相关的验证结果，包括证件验证结果及详细信息。

说明：该接口支持重复调用，即符合幂等性。

请求参数

字段名称

数据类型

最大长度

是否必填

描述

示例值

bizId

String

是

业务ID，业务的唯一标识，用于追踪业务。例如，商户业务相关数据库中的序列号。

说明：ZOLOZ服务器不检查该字段的值是否唯一。为了更便捷地追踪业务，建议开启商户服务器，并确保业务ID的唯一性。

"2017839040588699"

transactionId

String

是

事务ID，由ZOLOZ ID Recognition initialize API的响应消息中返回。

"G000000005FID20200304000000000001570702"

返回参数

字段名称

数据类型

必须返回

描述

示例值

result

Result

是

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

{

"resultCode": "SUCCESS", "resultMessage": "success", "resultStatus": "S"

}

extInfo

ExtIdInfo

否

证件验证的详细信息。更多信息，请参见ExtIdInfo。

说明：当result.resultStatus的值为S时，才返回该字段。

{

"imageContent": ["base64string.....", "base64string....."], "ocrResult": { "ID_NUMBER": "xxxx", "COUNTRY": "xxxxx", "SEX": "M" }, "spoofResult": { "TAMPER_CHECK": "Y", "MATERIAL_CHECK": "Y", "SCREEN_RECAPTURE_CHECK": "Y" }, "recognitionErrorCode": "", "recognitionResult": "Y" }

ExtIdInfo字段说明

字段名称	数据类型	必须返回	描述	示例值
recognitionResult	String	否	证件验证的结果。 `Y`：证件验证成功。 `N`：证件验证失败。说明：当证件验证完成时，才返回该字段。	"Y"
imageContent	List of String	否	经过Base64编码的身份证件图片（如果有）。说明：当recognitionResult的值为Y时，才返回该字段。	["base64string.....", "base64string....."]
ocrResult	Map	否	OCR识别结果，结果中包含身份相关的信息。不同的身份证件类型识别出来的身份信息集不同，详细请参见RealID和ID Recognition支持的证件类型和返回的OCR结果。说明：当recognitionResult的值为Y时，才返回该字段。	{ "ID_NUMBER": "xxxx", "COUNTRY": "xxxxx", "SEX": "M" }
spoofResult	Map	否	证件防伪分项检测结果，包含篡改、材质和屏幕翻拍等检测结果。详细信息，请参见spoofResult。	{ "TAMPER_CHECK": "Y", "MATERIAL_CHECK": "Y", "SCREEN_RECAPTURE_CHECK": "Y" }
recognitionErrorCode	String	否	证件识别不通过明细。 `NO_REQUIRED_ID`：证件图片不符合指定的证件类型。 `BLUR`：证件图片模糊。 `NO_FACE_DETECTED`：未检测到证件上的人脸。 `NOT_REAL_DOC`：证件防伪检测不通过。 `EXPOSURE`：证件图片过度曝光。 `UNKNOWN`：其他错误。	"BLUR"

spoofResult字段说明

字段名称	数据类型	必须返回	描述	示例值
TAMPER_CHECK	String	是	身份证件是否通过了篡改检测。 `Y`：通过，即检测结果为未被篡改。 `N`：不通过，即检测结果为被篡改。	"Y"
MATERIAL_CHECK	String	是	身份证件是否通过了材质检测。 `Y`：通过。 `N`：不通过，例如检测结果为黑白材质。	"Y"
SCREEN_RECAPTURE_CHECK	String	是	身份证件是否通过了屏幕翻拍检测。 `Y`：通过。 `N`：不通过，即上传的证件被检测为从屏幕上翻拍的证件。	"Y"
SECURITY_FEATURE_CHECK	String	否	身份证件是否通过了防伪安全特征检测。 `Y`：通过。 `N`：不通过。说明：目前仅支持中国香港身份证，用来验证身份证上的一些安全特征以识别假证。	"Y"
INFORMATION_CHECK	String	否	身份证件是否通过了信息校验检测。 `Y`：通过。 `N`：不通过。说明：目前仅支持中国香港身份证，根据政府规定验证身份证上的信息，例如身份证号码。	"Y"

处理结果

根据请求结果执行下一步的响应动作，具体如下：

当result.resultStatus的值为S时，表示调用ZOLOZ checkresult API成功，并返回证件验证结果。
当result.resultStatus的值为F时，表示调用ZOLOZ checkresult API失败。请检查错误码获取有关该错误的更多信息，并分析导致该错误的原因。

API通用结果码

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

API特有结果码

ID Recognition checkresult API的结果码见下表。

结果码	结果状态	描述
SUCCESS	S	API调用成功。
PROCESSING	S	流程正在进行中。
INVALID_ARGUMENT	F	输入参数无效。关于无效参数的详细信息，请查看返回的resultMessage。
SYSTEM_ERROR	F	其他内部错误。有关错误详情，请查看返回的resultMessage。
UNUSABLE	F	用户被冻结策略阻塞。
LIMIT_EXCEEDED	F	超过最大次数限制。

代码示例

请求示例

商户服务端发送的请求代码示例。

copy
{
    "bizId": "2017839040588699",
    "transactionId": "G000000005FID20200304000000000001570702"
}

返回示例

ZOLOZ服务器返回的响应代码示例。

copy
{
  "extInfo": {
    "imageContent": ["base64string.....", "base64string....."],
    "ocrResult": {
      "ID_NUMBER": "xxxx",
      "COUNTRY": "xxxxx",
      "SEX": "M"
    },
    "spoofResult": {
      "TAMPER_CHECK": "Y",
      "MATERIAL_CHECK": "Y",
      "SCREEN_RECAPTURE_CHECK": "Y"
    },
    "recognitionErrorCode": "",
    "recognitionResult": "Y"
  },
  "result": {
    "resultCode": "SUCCESS",
    "resultMessage": "success",
    "resultStatus": "S"
  }
}