add
概览
- API URL:/api/v1/zoloz/idnetwork/add
- API 描述:该接口用于新增一条记录,即将记录入库。
请求参数
字段名称 | 数据类型 | 最大长度 | 是否必填 | 默认值 | 描述 | 示例值 |
bizId | String | 32 | 是 | - | 业务ID,业务的唯一标识,用于追踪业务。例如,商户业务相关数据库中的序列号。 说明:ZOLOZ服务器不检查该字段的值是否唯一。为了更便捷地追踪业务,建议开启商户服务器,并确保业务ID的唯一性。 | "1658894076638" |
userId | String | 64 | 否 | - | 商户的用户ID或其他可用于识别某一用户的标识,例如手机号码、电子邮件地址等。 建议对userId字段的值进行预脱敏,例如进行哈希处理。 | "e9830710-0d70" |
riskDetection | RiskDetection | - | 否 | - | 风险检测。详细信息,请参见RiskDetection。 说明:存量历史数据批量入库时,为了提高入库执行效率,入库时可以不传该字段,先跳过风险检测,仅保存数据。后续可以通过risk query接口查询当前入库数据存在的风险。 | { "riskTypes":[ "IDFAKE", "DUPLICATE" ], "timeWindow":{ "startTime":1651882535687, "endTime":1658902665000 } } |
checkAllianceRisk | String | - | 否 | N | 是否查询联盟风险。取值如下:
| "N" |
imageInfo | ImageInfo | - | 是 | - | 待传入的图片信息。详细信息,请参见ImageInfo。 说明:
| { "docImage":"eA3AW/6dxn6QAAAABJRU5ErkJggg==...", "faceImage":"p+AY/b2OF/F1CxAAAAAElFTkSuQmCC..." } |
basicInfo | BasicInfo | - | 否 | - | 用户的基本信息。详细信息,请参见BasicInfo。 说明:传入的basicInfo字段的值尽可能详细,风险检测阶段会比对传入的基础信息。 | { "idType":"00000001003", "idNumber":"46082119870811896X", "certName":"李四", "dateOfBirth":"19870811" } |
referenceId | String | 64 | 否 | - | 引用ID,其他业务返回的ID值。 | "8365364ceddd411da027cdb15fea92ed" |
RiskDetection字段说明
字段名称 | 数据类型 | 最大长度 | 是否必填 | 默认值 | 描述 | 示例值 |
riskTypes | List<String> | - | 否 | - | 待查询的风险类型。支持以下两大类风险,系统会自动查询其包含的子风险。
| [ "IDFAKE", "DUPLICATE" ] |
timeWindow | TimeWindow | - | 否 | - | 风险查询时间窗口。详细信息,请参见TimeWindow。 | { "startTime":1651882535687, "endTime":1658902665000 } |
TimeWindow字段说明
字段名称 | 数据类型 | 最大长度 | 是否必填 | 默认值 | 描述 | 示例值 |
startTime | Long | - | 否 | - | 风险查询起始时间,采用14位时间戳。 | 1651882535687 |
endTime | Long | - | 否 | - | 风险查询结束时间,采用14位时间戳。 | 1658902665000 |
ImageInfo字段说明
说明:
- docImage和faceImage字段至少需传入一个。
- 图片大小不超过5MB。
字段名称 | 数据类型 | 最大长度 | 是否必填 | 默认值 | 描述 | 示例值 |
docImage | String | - | 否 | - | 待传入的证件图片。 | "eA3AW/6dxn6QAAAABJRU5ErkJggg==..." |
faceImage | String | - | 否 | - | 待传入的人脸图片。 | "p+AY/b2OF/F1CxAAAAAElFTkSuQmCC..." |
BasicInfo字段说明
字段名称 | 数据类型 | 最大长度 | 是否必填 | 默认值 | 描述 | 示例值 |
idType | String | 32 | 否 | - | 证件类型。支持的证件类型,请参见支持的证件类型和返回的OCR结果。 | "00000001003" |
certName | String | 32 | 否 | - | 姓名。 | "李四" |
idNumber | String | 32 | 否 | - | 证件号码。 | "46082119870811896X" |
dateOfBirth | String | - | 否 | - | 出生日期,格式为 | "19870811" |
返回参数
字段名称 | 数据类型 | 描述 | 示例值 |
result | API请求结果,包含结果状态、结果码和结果消息。 | { "resultStatus":"S", "resultCode":"SUCCESS", "resultMessage":"Success" } | |
transactionId | String | IDN生成的唯一业务ID。 | "G00000000817636816" |
itemId | String | 本次新增数据的记录ID。 注意:请您保存好该记录ID,后续进行记录查询、风险查询、删除记录都需要使用该记录ID。 | "AIN20220727890204890950" |
hasRisk | Boolean | 是否存在风险。
| true |
riskDetails | List<RiskDetail> | 风险详情。详细信息,请参见RiskDetail。 | [ { "type":"IDFAKE", "subType":"SameFaceDifferentIdNumber", "riskData":[ "AIN20220727890199220364" ] } |
allianceRiskDetails | List<RiskDetail> | 联盟风险详情。详细信息,请参见RiskDetail。 | [ { "type":"IDFAKE", "subType":"SameFaceDifferentIdNumber", "riskData":[ "AIN20220727890976220364" ] } |
RiskDetail字段说明
字段名称 | 数据类型 | 描述 | 示例值 |
type | String | 风险类型。 | "IDFAKE" |
subType | String | 子风险类型。 | "SameFaceDifferentIdNumber" |
riskData | List<String> | 风险数据,内容为itemId数组。 | ["AIN20220727890199220364"] |
代码示例
请求示例
POST /api/v1/zoloz/idnetwork/add 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
{
"bizId":"1658894076638",
"riskDetection":{
"riskTypes":[
"IDFAKE",
"DUPLICATE"
],
"timeWindow":{
"startTime":1651882535687,
"endTime":1658902665000
}
},
"imageInfo":{
"docImage":"eA3AW/6dxn6QAAAABJRU5ErkJggg==...",
"faceImage":"p+AY/b2OF/F1CxAAAAAElFTkSuQmCC..."
},
"basicInfo":{
"idType":"00000001003",
"idNumber":"46082119870811896X",
"certName":"李四",
"dateOfBirth":"19870811"
},
"userId":"e9830710-0d70",
"referenceId":"8365364ceddd411da027cdb15fea92ed"
}
返回示例
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"
},
"itemId":"AIN20220727890204890950",
"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"
]
}
]
}