Overview
-
API URL:
/api/v1/zoloz/idnetwork/get -
API Description: Queries the details of a record.
Structure
Request parameters
|
Parameters |
Data type |
Max length |
Description |
Example |
|
itemId |
String |
64 |
Required. The data record ID returned by IDN when the record was passed in. |
"AIN20220725875271649639" |
Response parameters
|
Parameters |
Data type |
Description |
Example |
|
result |
Result |
The API request result, which contains the result code, result status, and result message. |
{ "resultStatus":"S", "resultCode":"SUCCESS", "resultMessage":"Success" } |
|
transactionId |
String |
A unique business ID generated by IDN. |
"8365364ceddd411da027cdb15fea92ed" |
|
imageInfo |
ImageInfo |
The returned image data. For more information, see ImageInfo. |
{ "docImage":"eA3AW/6dxn6QAAAABJRU5ErkJggg==...", "faceImage":"p+AY/b2OF/F1CxAAAAAElFTkSuQmCC..." } |
|
basicInfo |
BasicInfo |
The basic information returned. For more information, see BasicInfo. |
{ "idType":"00000001003", "idNumber":"4608211987081189**", "certName":"Tom", "dateOfBirth":"19870811" } |
|
userId |
String |
Merchant-defined user ID. |
"e9830710-0d70" |
|
createTime |
String |
The record creation time, expressed as a 13-digit timestamp. |
"1660728158749" |
ImageInfo
|
Field |
Data type |
Description |
Example |
|
docImage |
String |
Optional. The ID document image. |
"eA3AW/6dxn6QAAAABJRU5ErkJggg==..." |
|
faceImage |
String |
Optional. The face image. |
"p+AY/b2OF/F1CxAAAAAElFTkSuQmCC..." |
BasicInfo
|
Field |
Data Type |
Description |
Example |
|
idType |
String |
The document type. |
"00000001003" |
|
certName |
String |
Name. |
"Tom" |
|
idNumber |
String |
ID number. |
"4608211987081189**" |
|
dateOfBirth |
String |
Date of birth. |
"19870811" |
Sample
Request sample
POST https://ip:port/api/v1/zoloz/idnetwork/get
# POST Body:
{
"itemId":"AIN20220725875271649639"
}Response sample
copy
# Response Body
{
"result":{
"resultStatus":"S",
"resultCode":"SUCCESS",
"resultMessage":"Success"
},
"transactionId":"8365364ceddd411da027cdb15fea92ed",
"imageInfo":{
"docImage":"eA3AW/6dxn6QAAAABJRU5ErkJggg==...",
"faceImage":"p+AY/b2OF/F1CxAAAAAElFTkSuQmCC..."
},
"basicInfo":{
"idType":"00000001003",
"idNumber":"4608211987081189**",
"certName":"Tom",
"dateOfBirth":"19870811"
},
"userId":"e9830710-0d70",
"createTime" : "1660728158749"
}