字段名称

数据类型

最大长度

是否必填

默认值

描述

示例值

bizId

String

32B

是

-

业务ID，业务的唯一标识，用于追踪业务。

"trans-abc-1234"

docType

String

32B

是

-

证件类型。

• 支持的C类证件，请参见RealID和ID Recognition支持的证件类型和返回的OCR结果。
• 支持的B类证件，请参见ID Recognition支持的企业类证件和返回的OCR结果。

"00000001003"

frontPageImage

String

5MB

是

-

证件的正面照，支持Base64编码的JPG、JPEG、PNG、BMP格式。

注意：采用纯API模式上传PNG格式的图片时，需要关闭图片的Alpha通道，避免该图片无法在Portal中正常显示，具体原因及方法，请参见常见问题。

"/9j/4AA..[omitted]..PxA="

backPageImage

String

5MB

否

null

证件的背面照，支持Base64编码的JPG、JPEG、PNG、BMP格式。

注意：采用纯API模式上传PNG格式的图片时，需要关闭图片的Alpha通道，避免该图片无法在Portal中正常显示，具体原因及方法，请参见常见问题。

"/9j/4AA..[omitted]..PxA="

字段名称

数据类型

必须返回

描述

示例值

result

Result

是

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

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

transactionId

String

否

事务ID。

"G000000005FID20200304000000000001570702"

recognitionResult

String

否

证件识别总结果。

• Y：证件识别成功。
• N：证件识别失败。

"Y"

recognitionErrorCode

String

否

证件识别不通过明细。

• NO_REQUIRED_ID：证件图片不符合指定的证件类型。
• BLUR：证件图片模糊。
• NO_FACE_DETECTED：未检测到证件上的人脸。
• NOT_REAL_DOC：证件防伪检测不通过。
• EXPOSURE：证件图片过度曝光。
• UNKNOWN：其他错误。

"BLUR"

ocrResult

Map

否

OCR识别结果。详细信息，请参见RealID和ID Recognition支持的证件类型和返回的OCR结果。

{

"ID_NUMBER": "xxxx", "COUNTRY": "xxxxx", "SEX": "M", "LAST_NAME": "xxxxx", "DATE_OF_BIRTH": "xxxxx", "FIRST_NAME": "xxxxx" }

spoofResult

Map

否

证件防伪分项检测结果，包含篡改、材质和屏幕翻拍等检测结果。详细信息，请参见spoofResult。

{

"TAMPER_CHECK": "Y", "MATERIAL_CHECK": "Y", "SCREEN_RECAPTURE_CHECK": "Y" }

字段名称

数据类型

必须返回

描述

示例值

resultCode

String

是

结果码。

• SUCCESS：成功。
• SYSTEM_ERROR：其他内部错误。
• INVALID_ARGUMENT：输入参数无效。

"SUCCESS"

resultStatus

String

是

结果状态。

• S：成功
• F：失败

"S"

resultMessage

String

是

结果描述。

"success"

字段名称

数据类型

必须返回

描述

示例值

TAMPER_CHECK

String

是

身份证件是否通过了篡改检测。

• Y：通过，即检测结果为未被篡改。
• N：不通过，即检测结果为被篡改。

"Y"

MATERIAL_CHECK

String

是

身份证件是否通过了材质检测。

• Y：通过。
• N：不通过，例如检测结果为黑白材质。

"Y"

SCREEN_RECAPTURE_CHECK

String

是

身份证件是否通过了屏幕翻拍检测。

• Y：通过。
• N：不通过，即上传的证件被检测为从屏幕上翻拍的证件。

"Y"