字段名称

数据类型

最大长度

是否必填

默认值

描述

示例值

bizId

String

32

是

-

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

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

"2017839040588699"

transactionId

String

64

是

-

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

"G000000005FID20200304000000000001570702"

isReturnImage

String

1

否

Y

是否在响应中返回图片数据。取值：

• Y：在响应中返回图片数据。
• N：不在响应中返回图片数据。

"Y"

extraImageControlList

List<String>

-

否

[]

指定是否返回额外的证件图片。支持的图片类型如下：

• DOC_FRONT_ANGLE：返回从倾斜角度拍摄的证件首页图片。
• DOC_FRONT_FLASH：返回在闪光灯照射下拍摄的证件首页图片。
• DOC_BACK_ANGLE：返回从倾斜角度拍摄的证件背面图片。
• DOC_BACK_FLASH：返回在闪光灯照射下拍摄的证件背面图片。
• CROPPED_FACE_FROM_DOC：返回从采集的证件图片中裁剪出脸部区域的人脸图片。

说明：是否返回额外的图片还取决于这些图片是否已被成功采集，这由集成模式和initialize API中设置的serviceLevel的值决定。

[

"DOC_FRONT_ANGLE",

"DOC_FRONT_FLASH"

]

字段名称

数据类型

必须返回

描述

示例值

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

字段名称

数据类型

必须返回

描述

示例值

recognitionResult

String

否

证件验证的结果。

• Y：证件验证成功。
• N：证件验证失败。

说明：当证件验证完成时，才返回该字段。

"Y"

certType

String

否

证件类型，当证件验证完成时才返回certType字段。

"00600000001"

docEdition

Integer

否

身份证件的版本。

• 1~3：身份证件的版本，详见RealID和ID Recognition支持的证件类型和返回的OCR结果。
• 0：无法对身份证件进行分类或证件类型错误。
• -1：未知错误。

2

imageContent

List<String>

否

经过Base64编码的身份证件图片（如果有）。

说明：当recognitionResult的值为Y时，才返回该字段。

["base64string.....", "base64string....."]

extraImages

Map<String,String>

否

在extraImageControlList中指定的额外需要返回的证件图片。

• Key是在extraImageControlList中指定的值。
• Value是以Base64编码的图片内容。如果未找到请求的图片，则该值为“”。

{ "DOC_FRONT_ANGLE": "/9j/4AA..[omitted]..PxA=" }

ocrResult

Map

否

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

不同的身份证件类型识别出来的身份信息集不同，详细请参见RealID和ID Recognition支持的证件类型和返回的OCR结果。

说明：当recognitionResult的值为Y时，才返回该字段。

{ "ID_NUMBER": "xxxx", "COUNTRY": "xxxxx", "SEX": "M" }

ocrResultDetail

Map<String, OcrResultDetail>

否

OCR识别结果详情，当在initialize API中传入mrzVisualConsistencyCheck时才返回该字段。

参考返回示例

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"

recognitionErrorDescription

String

否

证件识别失败的原因。

""

字段名称

数据类型

必须返回

描述

示例值

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"

结果码

结果状态

描述

SUCCESS

S

API调用成功。

PROCESSING

S

流程正在进行中。

INVALID_ARGUMENT

F

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

SYSTEM_ERROR

F

其他内部错误。有关错误详情，请查看返回的resultMessage。

UNUSABLE

F

用户被冻结策略阻塞。

LIMIT_EXCEEDED

F

超过最大次数限制。