Parameter

Data type

Max length

Default Value

Description

Example

bizId

String

32

-

Required. A unique business ID for tracing purposes. For example, the sequence ID from the merchant's business-related database.

Note: The ZOLOZ server does not perform uniqueness checks on the value of this field. For better tracking, it is strongly recommended to enable the merchant server to guarantee the uniqueness of the business ID.

"1658905294198"

userId

String

64

null

Optional. Merchant user ID, or other identifiers that can be used to identify a specific user. For example, mobile phone number, email address and so on. It is strongly recommended to pre-desensitize the value of the userId field; for example, by hashing the value.

"e9830710-0d70"

itemId

String

64

null

Optional. The record ID to be queried; this is the ID of the data record returned by the IDN when it is passed in.

Note: If the value of the itemId field is passed in, the detailed data will be automatically extracted from the database, and the content passed in the imageInfo and basicInfo fields will no longer be used.

"AIN20220707717226249562"

checkAllianceRisk

String

–

N

Optional. Specifies whether to check the affiliate risk.

• Y: Check affiliate merchants at the same time.
• N: Only the current merchant is checked.

“N”

riskDetection

RiskDetection

–

null

Optional. The risk to be queried. For details, see RiskDetection.

{

"riskTypes":[ "IDFAKE", "DUPLICATE",

"BATCH_REGISTER" ],

"timeWindow":{ "startTime":1651882535687, "endTime":1658902665000 }

}

imageInfo

imageInfo

–

null

Required. Specifies the image information to be passed in. For more details, see ImageInfo.

• Currently, only faceImage fields are supported. docImage fields are not supported by the system at the moment.
• The image size should not exceed 5MB.

{ "docImage":"eA3AW/6dxn6QAAAABJRU5ErkJggg==...", "faceImage":"p+AY/b2OF/F1CxAAAAAElFTkSuQmCC..."

}

basicInfo

BasicInfo

–

null

Optional. Basic information about the user. For more details, see BasicInfo.

{

"idType":"00000001003", "idNumber":"46082119870811896X", "certName":"Tom", "dateOfBirth":"19870811"

}

scene

String

32

kyc

• Optional：

• kyc，Indicates the authentication scenario.
• verification，Representing a identity verification scenario.

• Non-mandatory field

Note: The risk type being queried needs to align with the scenario; each risk type will be queried within the data corresponding to its respective scenario.

"kyc"

Field

Data type

Max length

Default Value

Description

Example

riskTypes

List<String>

-

[]

Optional. Specifies the type of risk to be queried. The following three major risk types are supported, and the system will automatically query the sub-risks they contain.

• IDFAKE: Impersonated identity
• DUPLICATE: Duplicate authentication
• BATCH_REGISTER: Batch register

[

"IDFAKE",

"DUPLICATE",

“BATCH_REGISTER” ]

timeWindow

TimeWindow

-

null

Optional. The risk query time window. For more details, see TimeWindow.

{ "startTime":1651882535687, "endTime":1658902665000 }

Field

Data type

Max length

Default Value

Description

Example

startTime

Long

-

null

Optional. Risk query start time, using a 14-digit timestamp.

1651882535687

endTime

Long

-

null

Optional. Risk query end time, using a 14-digit timestamp.

1658902665000

Field

Data type

Max length

Default Value

Description

Example

docImage

String

-

null

Optional. The ID image to be passed in (this field is not support at the moment).

"eA3AW/6dxn6QAAAABJRU5ErkJggg==..."

faceImage

String

-

null

Optional. The face image to be passed in.

"p+AY/b2OF/F1CxAAAAAElFTkSuQmCC..."

Field

Data type

Max length

Default Value

Description

Example

idType

String

32

null

Optional. Specifies the document type. For more information, see Document types supported and OCR results returned.

"00000001003"

certName

String

32

null

Optional. Name.

"Tom"

idNumber

String

32

null

Optional. ID number.

"46082119870811896X"

dateOfBirth

String

-

null

Optional. The date of birth in yyyyMMdd format.

"19870811"

Parameters

Data type

Description

Example

result

Result

API request result with result status, result code and result message.

{

"resultStatus":"S", "resultCode":"SUCCESS", "resultMessage":"Success" }

transactionId

String

A unique business ID generated by the IDN.

"G00000000817636816"

hasRisk

Boolean

Specifies whether risk exists.

• true: Risk exists.
• false: No risk exists.

true

riskDetails

List<RiskDetail>

Risk details present in the current merchant. For more information, see RiskDetail.

[ { "type":"IDFAKE", "subType":"SameFaceDifferentIdNumber", "riskData":[ "AIN20220727890199220364" ] }

allianceRiskDetails

List<RiskDetail>

Alliance risk details. For more information, see RiskDetail.

[ { "type":"IDFAKE", "subType":"SameFaceDifferentIdNumber", "riskData":[ "AIN20220727890976220364" ] }

Field

Data type

Description

Example

type

String

Risk type.

"IDFAKE"

subType

String

Sub-risk type.

"SameFaceDifferentIdNumber"

riskData

List<String>

Risk data with an itemId array.

["AIN20220727890199220364"]