risk query
Overview
- API URL:
/api/v1/zoloz/idnetwork/risk/query
- API Description: Provides the capability to query the risks associated with a record.
Structure
Request parameters
RiskDetection
Field | Data type | Max length | Description | Example |
riskTypes | List<String> | - | Optional. Specifies the type of risk to be queried. The following two major risk types are supported, and the system will automatically query the sub-risks they contain.
| [ "IDFAKE", "DUPLICATE" ] |
timeWindow | TimeWindow | - | Optional. The risk query time window. For more details, see TimeWindow. | { "startTime":1651882535687, "endTime":1658902665000 } |
TimeWindow
Field | Data type | Max length | Description | Example |
startTime | Long | - | Optional. Risk query start time, using a 14-digit timestamp. | 1651882535687 |
endTime | Long | - | Optional. Risk query end time, using a 14-digit timestamp. | 1658902665000 |
ImageInfo
Note:
- At least one of either docImage or faceImage fields must be passed in.
- Image size should not exceed 5MB.
- The picture format should be base64.
Field | Data type | Max length | Description | Example |
docImage | String | - | Optional. The ID image to be passed in. | "eA3AW/6dxn6QAAAABJRU5ErkJggg==..." |
faceImage | String | - | Optional. The face image to be passed in. | "p+AY/b2OF/F1CxAAAAAElFTkSuQmCC..." |
BasicInfo
Field | Data type | Max length | Description | Example |
idType | String | 32 | Optional. Specifies the document type. For more information, see Document types supported and OCR results returned. | "00000001003" |
certName | String | 32 | Optional. Name. | "Tom" |
idNumber | String | 32 | Optional. ID number. | "46082119870811896X" |
dateOfBirth | String | - | Optional. The date of birth in | "19870811" |
Response parameters
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 |
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" ] } |
RiskDetail
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"] |
Samples
Request sample
POST /api/v1/zoloz/idnetwork/risk/query HTTP/1.1
Content-Type: application/json; charset=UTF-8
Client-Id: 5X67656YXXXXXX
Request-Time: 2023-05-05T15:08:56+05:30
Signature: algorithm=RSA256, signature=xxxxxxxxxxxx
# Use itemId to query risks
{
"bizId":"1658905294198",
"itemId":"AIN20220707717226249562",
"riskDetection":{
"riskTypes":[
"IDfake",
"DUPLICATE"
]
}
}
# Use local data to query risks
{
"bizId":"1658904703520",
"riskDetection":{
"riskTypes":[
"IDfake",
"DUPLICATE"
]
},
"imageInfo":{
"docImage":"eA3AW/6dxn6QAAAABJRU5ErkJggg==...",
"faceImage":"p+AY/b2OF/F1CxAAAAAElFTkSuQmCC..."
},
"basicInfo":{
"idType":"00000001003",
"idNumber":"46082119870811896X",
"certName":"Tom",
"dateOfBirth":"19870811"
}
}
Response sample
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Response-Time: 2023-05-05T15:08:56+05:30
Signature: algorithm=RSA256, signature=xxxxxxxxxxxxxxxxxx
{
"result":{
"resultStatus":"S",
"resultCode":"SUCCESS",
"resultMessage":"Success"
},
"transactionId":"G00000000xxxxxxx",
"hasRisk":true,
"riskDetails":[
{
"type":"IDFAKE",
"subType":"SameFaceDifferentIdNumber",
"riskData":[
"AIN20220727890199220364"
]
},
{
"type":"IDFAKE",
"subType":"SameIdDifferentFace",
"riskData":[
"AIN20220727890199220387",
"AIN20220727890222174163"
]
}
],
"allianceRiskDetails":[
{
"type":"IDFAKE",
"subType":"SameFaceDifferentIdNumber",
"riskData":[
"AIN20220727890976220364"
]
},
{
"type":"IDFAKE",
"subType":"SameIdDifferentFace",
"riskData":[
"AIN20220727890199220387",
"AIN20220727890222174163"
]
}
]
}