ZOLOZZOLOZDOCS

checkresult

入口：/api/v1/zoloz/idrecognition/checkresult

ZOLOZ checkresult API 用于请求 ID 识别进程的运行状态和其他相应的结果，包括基本的、详细的证件验证结果。该 API 符合幂等性。

结构

请求参数

字段名称

数据类型

最大长度

描述

bizId

String

32

必填项。出于追踪目的的业务 ID，用来唯一标识某一业务。例如，商户业务相关数据库中的序列号。

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

transactionId

String

64

必填项。事务 ID，由 initialize API 的响应消息返回。

响应参数

字段名称

数据类型

描述

result

Result

必填项。包含了 API 请求结果的信息，例如结果状态和错误码。

extInfo

ExtInfo

证件验证的详细信息。

可选项。当 result.resultStatus 字段的值为 S 时，返回该字段。更多信息，请参见 ExtIdInfo。

结果

结果处理逻辑

根据返回的请求结果，执行相应的动作。有关详细信息，请参阅以下内容：

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

场景错误码

有关常见错误码的完整列表，请参见 错误处理 中常见错误码部分。

API 结果码

checkresult API 的结果码见下表。

结果码

结果状态

描述

SUCCESS

S

事务完成。

PROCESSING

S

尚未完成整个流程。

INVALID_ARGUMENT

F

输入参数无效。关于无效参数的详细信息，请查看结果消息或相关日志。

SYSTEM_ERROR

F

其他内部错误。关于错误详情，请查看返回的结果消息和相关日志。

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"
  }
}

更多信息

ExtIdInfo

ExtIdInfo 数据模型中字段的说明见下表。

字段名称

数据类型

描述

recognitionResult

String

证件验证进程的运行状态。枚举值及其含义如下：

  • Y：证件验证进程运行成功。
  • N: 证件验证进程处理失败。

当证件验证进程成功运行时，则该字段为必填项。

imageContent

List of String

base64 编码的身份证件照（如果有）。仅当证件验证进程成功运行时才返回该字段。

ocrResult

Map

OCR 结果，结果中包含身份相关的信息。

当证件验证进程成功运行时，则该字段为必填项。由于身份证件的类型不同，识别出的身份信息集不同。有关详细信息，请参见 支持的证件类型和返回的 OCR 结果。

spoofResult

Map

可选项。欺诈检查结果，其中包含有关篡改、证件材料真实性和屏幕重新捕获等检查结果的信息。更多详细信息请参见 spoofResult。

recognitionErrorCode

String

可选项。证件验证的错误详细信息。可能的值及其含义如下：

  • NO_REQUIRED_ID：从上传的身份证件照中识别到的 ID 与指定的身份证件类型不匹配。
  • BLUR：上传的身份证件照模糊。
  • NO_FACE_DETECTED：本应在指定身份证件中检测到的人脸，在上传的身份证件照中未能如愿检测到。
  • NOT_REAL_DOC: 上传的身份证件照是伪造的。
  • EXPOSURE：上传的身份证件照曝光过度。
  • UNKNOWN：其他识别错误。

spoofResult

欺诈检查结果中包含的详细信息见下表。

字段名称

数据类型

描述

TAMPER_CHECK

String

必填项。输入的身份证件是否通过篡改检查。

  • N：表示身份证明文件没有通过检查，即检测结果为被篡改。
  • Y：表示身份证明文件通过篡改检查，即检测结果为未被篡改。

MATERIAL_CHECK

String

必填项。身份证件的材料是否通过真实性检查。

  • N：表示身份证件的材料没有通过检查，例如检测结果为黑白。
  • Y：表示身份证件的材料通过真实性检查。

SCREEN_RECAPTURE_CHECK

String

必填项。身份证件是否通过屏幕重新捕获检查。

  • N：表示身份证件没有通过检查，即上传的图片被检测为从屏幕上重新抓拍的图片。
  • Y：表示身份证件通过屏幕重新捕获检查。

SECURITY_FEATURE_CHECK

String

可选项。目前只支持香港身份证。验证身份证上的一些安全功能以识别假证。

INFORMATION_CHECK

String

可选项。目前只支持香港身份证。根据政府规定验证身份证上的信息，例如身份证号码。