ZKBio CVSecurity 3rd Party API User Manual
Uploaded by
Daniloj BastidasZKBio CVSecurity 3rd Party API User Manual
Uploaded by
Daniloj BastidasUSER MANUAL
ZKBio CVSecurity 3rd Party API
Version: 1.1
Date: May , 2024
Software Version: ZKBio CVSecurity 6.0.0 or above Version
Important Statements
Firstly, thank you for choosing our product. Before using the product, please read this manual carefully
to avoid any unnecessary damage. Proper operation of the product will result in better performance
and faster verification.
None of the content of this document shall be copied or delivered in any forms or by any means
without the prior written consent of our company.
The product described in the manual may include the software whose copyrights are shared by the
licensors, including our company. No one shall copy, distribute, revise, modify, extract, decompile,
disassemble, decrypt, reverse engineering, lease, transfer, sub-license the software, or perform other
acts of copyright infringement, unless such restrictions are prohibited by applicable laws or such
actions are approved by respective copyright holders.
Information provided in this manual may differ from actual technical specifications due to the
constant development of products. Our company claims no responsibility for any disputes arising
out of any discrepancy between actual technical parameters and those described in this
document. The document is subject to change without prior notice.
Table of Contents
Important Statements .................................................................................................................................... I
1. Interface Description ................................................................................................................................. 8
1.1 Authorize APl Level ...........................................................................................................................8
1.2 Interface Parameter ....................................................................................................................... 10
2. Interface Details ....................................................................................................................................... 11
2.1 Access Control Interface ................................................................................................................ 11
2.1.1 Delete Person Level [accLevel/deleteLevel] ...................................................................... 11
2.1.2Get Level by Id [accLevel/get byId{id}] ............................................................................... 11
2.1.3 Get Level by Name [accLevel/get ByName{name}] ........................................................... 12
2.1.4 Get Access Level/list [accLevel/list] ....................................................................................13
2.1.5 Sync Level Info to Device [accLevel/syncLevel] .................................................................13
2.1.6 Sync Person Level [accLevel/syncPerson] ..........................................................................14
2.1.7 Get Access Level/List (With total number)[/api/v2/accLevel/list] .....................................15
2.2 Elevator Control Level Interface .....................................................................................................16
2.2.1 Delete person Level [eleLevel/deleteLevel] .......................................................................16
2.2.2 Get Ele Level by Id[eleLevel/getById/{id} ........................................................................... 16
2.2.3 Get Ele Level by Name[eleLevel/getByName/{name} ....................................................... 17
2.2.4 Get Ele Level Group List[[eleLevel/list] ...............................................................................17
2.2.5 Sync Ele Level Group Info to Device[eleLevel/syncLevel] ................................................. 18
2.2.6 Sync Person Ele Level [eleLevel/syncPerson] .....................................................................19
2.2.7 Get Elevator access level list(With total number) [/api/v2/eleLevel/list] ..........................19
2.3 Park Authorization Interface .......................................................................................................... 20
2.3.1 Authorize Park Black and White List [parkAuthorize/addBlackWhite] ............................. 20
2.3.2 Delete Park Black and White List[parkAuthorize/delBlackWhite] .....................................21
2.3.3 Edit park Black and White List[parkAuthorize/editBlackWhite] ........................................21
2.4 Card Interface .................................................................................................................................22
2.4.1 Get Card List by Pin [card/getCards/{pin}] ......................................................................... 22
ZKBio CVSecurity API User Manual Page |1
2.4.2 Set Person Card Info[card/set] ............................................................................................22
2.5 Department Interface .................................................................................................................... 23
2.5.1 Add /Edit Department[department/add] .......................................................................... 23
2.5.2 Delete Department by Code [department/delete/{code}] ............................................... 24
2.5.3 Get Department Info by Code [department/get/{code}] .................................................. 24
2.6 Media Interface .............................................................................................................................. 26
2.6.1 Add or Update Media Info[adMedia/add] ......................................................................... 26
2.6.2 Delete Media by Name[adMedia/delete/{name}] ............................................................. 26
2.6.3 Get Media Object by Name[adMedia/get/{name}] ........................................................... 27
2.7 Area Interface .................................................................................................................................28
2.7.1 Get Area Object by Area Code[area/get/{code}] ............................................................... 28
2.7.2 Get Area List [area/list] ........................................................................................................29
2.8 Person Interface of Att Area .......................................................................................................... 30
2.8.1 Delete Area Person [attAreaPerson/delete] .......................................................................30
2.8.2 Set Area Person [attAreaPerson/set] .................................................................................. 30
2.9 Access Control Device Interface .....................................................................................................31
2.9.1 Get Device List [device/accList] ..........................................................................................31
2.9.2 Get Device Info by Sn [device/getAcc/{sn}] ....................................................................... 32
2.9.3 Get Device List(With total number) [api/v2/device/list] ....................................................33
2.10 Ele Device Interface ......................................................................................................................34
2.10.1 Get Ele Device List [eleDevice/eleList] ............................................................................. 34
2.10.2 Get Ele Device Info by Sn [eleDevice/getEle/{sn}] ........................................................... 35
2.10.3 Get Ele Device List(With total number) [api/v2/eleDevice/eleList] ................................ 36
2.11 Door Interface .............................................................................................................................. 38
2.11.1 Get the State of All Doors [door/all DoorState] ............................................................... 38
2.11.2 Get Door State by Door Id [door/doorState ById] ........................................................... 40
2.11.3 Get Door State by the Sn of Device [door/doorStateBy{Sn}] .......................................... 42
2.11.4 Get Door Info by Door Id [door/get] ................................................................................ 43
2.11.5 Get Door List [door/list] .................................................................................................... 44
ZKBio CVSecurity API User Manual Page |2
2.11.6 Remote Close by Door Id [door/remoteCloseById] ......................................................... 45
2.11.7 Remote Close by Door Name [door/remoteCloseByName] ............................................45
2.11.8 Remote Open by Door Id [door/remoteOpenById] .........................................................46
2.11.9 Remote Open by Door Name[door/remoteOpenByName] ............................................ 46
2.11.10 Get Door List(With total number) [api/v2/door/list] ..................................................... 47
2.12 Floor interface .............................................................................................................................. 48
2.12.1 Get Floor Info List[floor/list] ..............................................................................................48
2.12.2 Remote Close by Floor Id[floor/remoteCloseById] ..........................................................49
2.12.3 Remote Open by Floor Id[floor/remoteOpenById] ......................................................... 50
2.12.4 Get Floor Info List(With total number) [api/v2/floor/list] ................................................ 50
2.13 Person Interface ........................................................................................................................... 52
2.13.1 Add/ Edit Person Info [person/add] ................................................................................. 52
2.13.2 Delete Person Info by Pin [person/delete/{pin}] ..............................................................53
2.13.3 Get person Info by Pin [person/get/{pin}]Get person Info by Pin [person/get/{pin}] .... 54
2.13.4 Get personnel information according to the PIN array and the department code array55
2.13.5 Get dynamic QR code by personal identification number ..............................................58
2.13.6 Resignation ....................................................................................................................... 59
2.13.7 Add / Edit personnel basic information ........................................................................... 60
2.13.8 Update personnel Photo by PIN .......................................................................................63
2.13.9 Get personnel information according to the PIN array and the department code
array(With total number) .............................................................................................................64
2.13.10 Reinstatement .................................................................................................................68
2.14 Access Control Reader Interface .................................................................................................. 71
2.14.1 Get Access Control Reader Info List[reader/accList] ........................................................71
2.14.2 Get Access Control Reader Info by Reader Id [reader/getAcc] ....................................... 72
2.15 Visitor Reservation Interface ........................................................................................................73
2.15.1 Add Visitor Reservation[visReservation/add] .................................................................. 73
2.15.2 Delete Visitor Reservation[visReservation/del] ................................................................74
2.16 Visitor Level Interface .................................................................................................................. 75
2.16.1 Get Visitor Level Group List[visLevel/list] .........................................................................75
ZKBio CVSecurity API User Manual Page |3
2.17 Visitor Registration Check Out Interface ......................................................................................76
2.17.1 Add Visitor Registration[visRegistration/add] ................................................................. 76
2.17.2 Visitor Check Out [visRegistration/exit] ........................................................................... 77
2.17.3 Get Visitor Dynamic QR code ........................................................................................... 78
2.18 Access Control transaction Interface ........................................................................................... 78
2.18.1 Get Transaction by Device Sn [transaction/device/{deviceSn}] ......................................78
2.18.2 Get Transaction by Device SN(With total number) [v2/transaction/device/{deviceSn}]80
2.18.3 Get Access Transaction List[transaction/list] ................................................................... 83
2.18.4 Get Access Transaction List(With total number)[api/v2/transaction/list] ...................... 85
2.18.5 Get Access Real-Time Monitoring Transaction[transaction/monitor] ............................ 88
2.18.6 Get Door Transaction by Pin [transaction/person/{pin}] .................................................90
2.18.7 Get Door Transaction by Pin (With total number)[api/v2/transaction/person/{pin}] .... 92
2.18.8 Get Personnel First In and Last Out record by Pin [transaction/firstInAndLastOut/{pin}]95
2.18.9 Get Personnel First In and Last Out record by Pin(With total number)
[api/v2/transaction/firstInAndLastOut/{pin}] ............................................................................. 96
2.18.10 Obtain door transaction, daily transaction, personnel access transactions
[transaction/getDoorTransactions] .............................................................................................98
2.18.11 Obtain door transaction, daily transaction, personnel access transactions(With total
number) [api/v2/transaction/getDoorTransactions] ............................................................... 100
2.18.12 Get Doors transaction details [transaction/getDoorTransactionDetail] .....................104
2.18.13 Get Access transactions by event id [api/transaction/getById/{id}] ........................... 105
2.19 Elevator Transaction Interface ................................................................................................... 107
2.19.1 Get Elevator Transaction [eleTransaction/list] ...............................................................107
2.19.2 Get Elevator Transaction(With total number) [api/v2/eleTransaction/list] .................. 109
2.20 Park Transaction Interface ......................................................................................................... 112
2.20.1 Get Car Entry/Exit record pictures [parkTransaction/getParkRecordPicture] .............. 112
2.20.2 Get Park Check-in Transaction [parkTransaction/listParkRecordin] ............................. 112
2.20.3 Get park Check-Out Transaction[parkTransaction/listParkRecordout] ........................ 114
2.21 Att Transaction Interface ........................................................................................................... 116
2.21.1 Get Att Transaction [transaction/listAttTransaction] .................................................... 116
ZKBio CVSecurity API User Manual Page |4
2.22 Att Device Interface ....................................................................................................................119
2.22.1 Get Att Device [device/getAtt] ....................................................................................... 119
2.23 Apply for abnormal attendance ................................................................................................. 120
2.23.1Apply for Re-clock-in ....................................................................................................... 120
2.23.2 Apply for overtime ..........................................................................................................120
2.23.3 Ask for leave .................................................................................................................... 121
2.23.4 Get leave type list ............................................................................................................123
2.23.5 Upload leave picture .......................................................................................................124
2.23.6 Calculate the total duration of leave ..............................................................................124
2.24 Edit Attendance personnel information ................................................................................... 126
2.24.5 Edit Personal information ............................................................................................... 126
2.25 Person BioTemplate Interface ....................................................................................................128
2.25.1 Add Personnel BioTemplate ...........................................................................................128
2.25.2 Delete By PersonId And TemplateNo .............................................................................128
2.25.3 Delete Personnel BioTemplate By PersonId .................................................................. 129
2.25.4 Get Personnel BioTemplate By PersonId ....................................................................... 130
2.26 Temperature transactions Interface .......................................................................................... 132
2.26.1 Get Hep Transaction [api/hep/transaction/list] .............................................................132
2.26.2 Get Mask and Temperature Real-Time Monitor events [api//hep/transaction/monitor]134
2.27 Edit FaceKiosk Personal information .......................................................................................... 136
2.27.1 Edit Personal information ............................................................................................... 136
2.28 FaceKiosk Area Personal .............................................................................................................137
2.28.1Delete Area Personnel ..................................................................................................... 137
2.28.2Add Area Personnel ......................................................................................................... 138
2.28.3 Get a list of attendance zones ........................................................................................ 138
2.29 FaceKiosk Device Interface .........................................................................................................140
2.29.1 Get Facekiosk device list [api/device/attAdDeviceList] .................................................140
2.30 Entrance Control Device Interface ............................................................................................. 142
2.30.1 Get entrance control device list [api/psgdDvice/list] ....................................................142
ZKBio CVSecurity API User Manual Page |5
2.30.2 Get entrance control device info by SN [/api/psgDevice/getBySn] ..............................143
2.30.3 Get entrance control device list(with total number) [api/v2/psgDevice/list] .............. 144
2.31 Entrance Control Gate Interface ................................................................................................ 145
2.31.1 Get the State of All gates [psgGate/allGateState] ......................................................... 145
2.31.2 Get Entrance Control Gate State by Gate Id [psgGate/gateStateById] .........................146
2.31.3 Get Entrance Control Gate State by the SN of Device [psgGate/gateStateBySn] ........ 148
2.31.4 Get Entrance Control Gate Info by gate Id [psgGate/getById] ..................................... 149
2.31.5 Get Entrance Control Gate List [api/psgGate/list] ......................................................... 150
2.31.6 Get Entrance Control Gate List(With total number) [api/v2/psgGate/list] ................... 151
2.31.7 Remote Open by Gate Id [psgGate/remoteOpenById] ................................................. 152
2.31.8 Remote Open by Gate Name [psgGate/remoteOpenByName] ....................................152
2.32 Entrance Control Gate Interface ................................................................................................ 153
2.32.1 Delete Person Level [psgLevel/deleteLevel] ..................................................................153
2.32.2 Get Gate Control Level by Id [psgLevel/getById/{id}] ................................................... 153
2.32.3 Get Entrance Access Level by Name [psgLevel/getByName/{name}] .......................... 154
2.32.4 Get Entrance Control Access Level [/psgLevel/list] ....................................................... 155
2.32.5 Sync Level Info to Device [psgLevel/syncLevel] ............................................................ 155
2.32.6 Sync Person Level [/psgLevel/syncPerson] ....................................................................156
2.32.7 Get Entrance Control Access Level(With total number) [api/v2/psgLevel/list] ............157
2.33 Entrance Control Gate Reader Interface ....................................................................................158
2.33.1 Get Entrance Control Gate Reader Info List[psgReader/list] .........................................158
2.33.2 Get Entrance Control Gate Reader Info List(With total number)[api/v2/psgReader/list]159
2.33.3 Get Entrance Control Gate Reader Info by Reader Id [psgReader/getById] ................. 160
2.34 Entrance Control Device transaction Interface ..........................................................................161
2.34.1 Get Entrance Control Transaction by Device Sn [psgTransaction/device/{deviceSn}] 161
2.34.2 Get Entrance Control Gate Transaction List[psgTransaction/list] .................................163
2.34.3 Get Entrance Control Device Real-Time Monitoring
Transaction[psgTransaction/monitor] ......................................................................................165
2.34.4 Get Personnel Entrance Control Access Transaction by Pin [transaction/person/{pin}]167
ZKBio CVSecurity API User Manual Page |6
2.34.5 Get Entrance Control Transaction by Device Sn(With total number)
[api/v2/psgTransaction/device/{deviceSn}] ............................................................................. 168
2.34.6 Get Entrance Control Gate Transaction List(With total
number)[api/v2/psgTransaction/list] ........................................................................................171
2.34.7 Get Personnel Entrance Control Access Transaction by Pin(With total number)
[api/v2/psgTransaction/person/{pin}] ...................................................................................... 173
3. Appendix ................................................................................................................................................176
3.1 Error Code .................................................................................................................................... 176
ZKBio CVSecurity API User Manual Page |7
1. Interface Description
ZKBio CVSecurity API is dedicated to the platform data connection for the third-party system. The
third-party system can read and set business data flexibly, which effectively reduces the complexity of
the third-party system business integration and provides convenient, fast standard connection mode
and data structure.
1.1 Authorize APl Level
The API Authorization menu will only be displayed after the API license is activated. Open the
corresponding authorized API menu and add the corresponding API client information as shown
below:
Based on the standard http interface definition style, in consistent with RESTFUL API style, supports https.
Parameter descriptions are as following:
ZKBio CVSecurity API User Manual Page |8
serverIP: ZKBio CVSecurity server or computer IP, such as: 192.168.1.100;
serverPort: The server port of ZKBio CVSecurity, such as: 8088;
access_token: API access token is to check whether the requested permission is allowed or denied. All
request should pass through a valid token, such as: apitoken;
ZKBio CVSecurity API User Manual Page |9
1.2 Interface Parameter
{
"code": 0,
Public Response
"message": "string",
Result
"data": {}
}
Public Response code: error code, less than 0 means failure, more than 0 means success;
Result Parameter msg: Error message
Description data: can refer to each interface description
Sn: device serial number
Pin: pin
Basic Parameter pageSize: page size;
Description pageNo: page no;
ZKBio CVSecurity API User Manual P a g e | 10
2. Interface Details
2.1 Access Control Interface
2.1.1 Delete Person Level [accLevel/deleteLevel]
http://serverIP:serverPort/api/accLevel/deleteLevel?pin={pin}&levelI
Post Request URL
ds={levelIds}&access_token={apitoken}
Request Mode POST
Request Content None
Pin: pin, required
Request Parameter Level Ids: level group id List, multiple comma separated, required,
Description string; such as
402856aa6c3bbde1016c3bc2329200ff,402856aa6c3bbde1016c3bc2
32930100
Response Result Refer to public response results
Response Result
Public response parameter description
Description
2.1.2Get Level by Id [accLevel/get byId{id}]
http://serverIP:serverPort/api/accLevel/getById/{id}?access_token={
Post Request URL
apitoken}
Request Mode GET
Request Content None
Request Parameter Id: level group id, required, string; such as
Description “402856aa6c3bbde1016c3bc2329200ff”
{
"code": 0,
Response Result "message": "success",
"data": {
"id": “402856aa6c3bbde1016c3bc2329200ff”,
ZKBio CVSecurity API User Manual P a g e | 11
"name": "public level group"
}
}
Data: level group object;
Response Result
Id: level group id;
Description
Name: level group name;
2.1.3 Get Level by Name [accLevel/get ByName{name}]
http://serverIP:serverPort/api/accLevel/getByName/{name}?access_
Post Request URL
token={apitoken}
Request Mode GET
Request Content None
Request Parameter
Name: level group name, required;
Description
{
"code": 0,
"message": "success",
"data": {
Response Result
"id": “402856aa6c3bbde1016c3bc2329200ff”,
"name": "public level group"
}
}
Data: level group object;
Response Result Id: level group id, string; such as
Description ‘402856aa6c3bbde1016c3bc2329200ff’
Name: level group name;
ZKBio CVSecurity API User Manual P a g e | 12
2.1.4 Get Access Level/list [accLevel/list]
http://serverIP:serverPort/api/accLevel/list?pageNo={pageNo}&pag
Post Request URL
eSize={pageSize}&access_token={apitoken}
Request Mode GET
Request Content None
PageNo: page no, required, the value must be greater than 0;
Request Parameter
Description pageSize, the number of each page, required, must be greater than
0
{
"code": 0,
"message": "success",
"data": [
{
Response Result
"id": “402856aa6c3bbde1016c3bc2329200ff”,
"name": "public level group"
}
]
}
Data: level group array list;
Response Result Id: level group id, string; such as
Description “402856aa6c3bbde1016c3bc2329200ff”
Name: level group name;
2.1.5 Sync Level Info to Device [accLevel/syncLevel]
http://serverIP:serverPort/api/accLevel/syncLevel?levelId={levelId}&
Post Request URL
access_token={apitoken}
Request Mode POST
Request Content None
ZKBio CVSecurity API User Manual P a g e | 13
Request Parameter Level Id: level group id, required, string; such as
Description “402856aa6c3bbde1016c3bc2329200ff”
Refer to public response result, for any other result please refer to
Response Result
Appendix-Error code
Response Result
Public response parameter description
Description
2.1.6 Sync Person Level [accLevel/syncPerson]
http://serverIP:serverPort/api/accLevel/syncPerson?pin={pin}&levelI
Post Request URL
ds={levelIds}&access_token={apitoken}
Request Mode POST
Request Content None
Level Ids: level group id list, multiple comma separated, required,
Request Parameter string; such as “402856aa6c3bbde1016c3bc2329200ff”
Description
Pin: pin, required
Refer to public response result, other can refer to Appendix-Error
Response Result
code
Response Result
Public response parameter description
Description
ZKBio CVSecurity API User Manual P a g e | 14
2.1.7 Get Access Level/List (With total number)[/api/v2/accLevel/list]
http://serverIP:serverPort/api/v2/accLevel/list?pageNo={pageN
Post Request URL
o}&pageSize={pageSize}&access_token={apitoken}
Request Mode GET
Request Content None
PageNo: page no, required, the value must be greater than 0;
Request Parameter
Description pageSize, the number of each page, required, must be greater than
0
{
"code": 0,
"message": "success",
"data": {
"page": 0,
"size": 1,
"total": 1,
Response Result "data": [{
"id": "8a888e238474d72d018474d8cba8065a",
"name": "General"
}],
"offset": 0,
"lastPage": true
}
}
page: the page number of the current request;
size: the amount of data requested for the current page number;
Response Result total: the total number;
Description data: access levels arrays;
id: access level id; such as: "8a888e238474d72d018474d8cba8065a"
name: access level name;
ZKBio CVSecurity API User Manual P a g e | 15
2.2 Elevator Control Level Interface
2.2.1 Delete person Level [eleLevel/deleteLevel]
http://serverIP:serverPort/api/eleLevel/deleteLevel?pin={pin}&levelI
Post Request URL
ds={levelIds}&access_token={apitoken}
Request Mode POST
Request Content None
Pin: pin, required
Request Parameter
Description level Ids: level Ids: level group id List, multiple comma separated,
required, string; such as “402856aa6c3bbde1016c3bc2329200ff”
Response Result Refer to public Response Result
Response Result
public response parameter description
Description
2.2.2 Get Ele Level by Id[eleLevel/getById/{id}
http://serverIP:serverPort/api/eleLevel/getById/{id}?access_token={
Post Request URL
apitoken}
Request Mode get
Request Content None
Request Parameter id: level group, required, string; such as:
Description “402856aa6c3bbde1016c3bc2329200ff”
{
"code": 0,
"message": "success",
Response Result
"data": {
"id": “402856aa6c3bbde1016c3bc2329200ff”,
"name": "public level group"
ZKBio CVSecurity API User Manual P a g e | 16
}
}
data: level group object;
Response Result
id: level group id;
Description
name: level group name;
2.2.3 Get Ele Level by Name[eleLevel/getByName/{name}
http://serverIP:serverPort/api/eleLevel/getByName/{name}?access_t
Post Request URL
oken={apitoken}
Request Mode GET
Request Content None
Request Parameter
name: level group name, required;
Description
{
"code": 0,
"message": "success",
"data": {
Response Result
"id": “402856aa6c3bbde1016c3bc2329200ff”,
"name": "public level group"
}
}
data: level group object;
Response Result
id: level group id;
Description
name: level group name;
2.2.4 Get Ele Level Group List[[eleLevel/list]
http://serverIP:serverPort/api/eleLevel/list?pageNo={pageNo}&page
Post Request URL
Size={pageSize}&access_token={apitoken}
ZKBio CVSecurity API User Manual P a g e | 17
Request Mode GET
Request Content None
Request Parameter pageNo: page, required, must be greater than 0
Description pageSize: The number of per page, required, must be greater than 0
{
"code": 0,
"message": "success",
"data": [
{
Response Result
"id": “402856aa6c3bbde1016c3bc2329200ff”,
"name": "public level group"
}
]
}
data: level group array list;
Response Result
id: level group id;
Description
name: level group name;
2.2.5 Sync Ele Level Group Info to Device[eleLevel/syncLevel]
http://serverIP:serverPort/api/eleLevel/syncLevel?levelId={levelId}&
Post Request URL
access_token={apitoken}
Request Mode POST
Request Content None
Request Parameter levelid: level group, required, string; such as:
Description “402856aa6c3bbde1016c3bc2329200ff”
Refer to public response result, other can refer to Appendix-Error
Response Result
code
Response Result
public response parameter description
Description
ZKBio CVSecurity API User Manual P a g e | 18
2.2.6 Sync Person Ele Level [eleLevel/syncPerson]
http://serverIP:serverPort/api/eleLevel/syncPerson?pin={pin}&levelI
Post Request URL
ds={levelIds}&access_token={apitoken}
Request Mode POST
Request Content None
LevelIds: level group id list, multiple comma separated, required,
Request Parameter string; such as：“402856aa6c3bbde1016c3bc2329200ff”
Description
pin: pin, required;
Refer to public response result, other can refer to Appendix-Error
Response Result
code
Response Result
public response parameter description
Description
2.2.7 Get Elevator access level list(With total number) [/api/v2/eleLevel/list]
http://serverIP:serverPort/api/v2/accLevel/list?pageNo={pageNo}&p
Post Request URL
ageSize={pageSize}&access_token={apitoken}
Request Mode GET
Request Content None
PageNo: page no, required, the value must be greater than 0;
Request Parameter
Description pageSize, the number of each page, required, must be greater than
0
{
"code": 0,
"message": "success",
"data": {
Response Result
"page": 0,
"size": 1,
"total": 1,
"data": [{
ZKBio CVSecurity API User Manual P a g e | 19
"id": "8a888e238474d72d018474d8cba8065a",
"name": "General"
}],
"offset": 0,
"lastPage": true
}
}
page: the page number of the current request;
size: the amount of data requested for the current page number;
Response Result total: the total number;
Description data: access levels arrays;
id: access level id; such as: "8a888e238474d72d018474d8cba8065a"
name: access level name;
2.3 Park Authorization Interface
2.3.1 Authorize Park Black and White List [parkAuthorize/addBlackWhite]
http://serverIP:serverPort/api/parkAuthorize/addBlackWhite?type={t
Post Request URL ype}&carNumber={carNumber}&fromTime={fromTime}&toTime={to
Time}&access_token={apitoken}
Request Mode POST
Request Content None
type: Black and White List type, 0: White List, 1:Black list
Request Parameter carNumber: license plate number, such as: A32212
Description fromTime: start time, 2018-08-17
toTime: end time, 2019-08-16
Refer to public response result, other can refer to Appendix-Error
Response Result
code
Response Result
public response parameter description
Description
ZKBio CVSecurity API User Manual P a g e | 20
2.3.2 Delete Park Black and White List[parkAuthorize/delBlackWhite]
http://serverIP:serverPort/api/parkAuthorize/delBlackWhite?carNum
Post Request URL
ber={carNumber}&access_token={apitoken}
Request Mode POST
Request Content None
Request Parameter
carNumber: license plate number, such as: A32212
Description
Refer to public response result, other can refer to Appendix-Error
Response Result
code
Response Result
public response parameter description
Description
2.3.3 Edit park Black and White List[parkAuthorize/editBlackWhite]
http://serverIP:serverPort/api/parkAuthorize/editBlackWhite?type={t
Post Request URL ype}&carNumber={carNumber}&oldCarNumber={oldCarNumber}&f
romTime={fromTime}&toTime={toTime}&access_token={apitoken}
Request Mode POST
Request Content None
type: Black and White List type, 0: White List, 1:Black list
carNumber: new license plate number, such as A32212
Request Parameter
oldCarNumber: old license plate number, such as A32212
Description
fromTime: start tim, 2018-08-17(White List need to be filled in)
toTime: end time 2019-08-16(White List need to be filled in)
Refer to public response result, other can refer to Appendix-Error
Response Result
code
Response Result
public response parameter description
Description
ZKBio CVSecurity API User Manual P a g e | 21
2.4 Card Interface
2.4.1 Get Card List by Pin [card/getCards/{pin}]
http://serverIP:serverPort/api/card/getCards/{pin}?access_token={a
Post Request URL
pitoken}
Request Mode GET
Request Content None
Request Parameter
pin: pin, required;
Description
{
"code": 0,
"message": "success",
"data": [
{
Response Result "pin": "1234",
"cardNo": "111",
"cardType": "0"
}
]
}
data: card number List;
pin: pin;
Response Result cardNo: card no;
Description
cardType: card type, 0 : master card, 1: sub card, a person only uses
one card when the system does not open the function of one more
card
2.4.2 Set Person Card Info[card/set]
Post Request URL http://serverIP:serverPort/api/card/set?access_token={apitoken}
ZKBio CVSecurity API User Manual P a g e | 22
Request Mode POST
{
"pin": "1234",
Request Content "cardNo": "212121",
"cardType": "0"
}
Pin: pin, required
Request Parameter cardNo: card number, required;
Description cardType: card type, 0: master card, 1: sub card, the system does not
open multi-card function, sub card setting invalid
Refer to public response result, other can refer to Appendix-Error
Response Result
code
Response Result
public response parameter description
Description
2.5 Department Interface
2.5.1 Add /Edit Department[department/add]
http://serverIP:serverPort/api/department/add?access_token={apit
Post Request URL
oken}
Request Mode POST
{
"name": "department name",
Request Content "code": "456",
"parentCode": "123"
}
Name: department name, required;
Request Parameter
code: department code, required;
Description
parentCode: parent department number;
Refer to public response result, other can refer to Appendix-Error
Response Result
code
ZKBio CVSecurity API User Manual P a g e | 23
Response Result
public response parameter description
Description
2.5.2 Delete Department by Code [department/delete/{code}]
http://serverIP:serverPort/api/department/delete/{code}?access_tok
Post Request URL
en={apitoken}
Request Mode DELETE
Request Content None
Request Parameter
code: department code, required;
Description
Refer to public response result, other can refer to Appendix-Error
Response Result
code
Response Result
public response parameter description
Description
2.5.3 Get Department Info by Code [department/get/{code}]
http://serverIP:serverPort/api/department/get/{code}?access_token
Post Request URL
={apitoken}
Request Mode GET
Request Content None
Request Parameter
Code: department code, required;
Description
{
"code": 0,
Response Result
"message": "success",
"data": {
"name": "4444",
ZKBio CVSecurity API User Manual P a g e | 24
"code": "3333",
"parentCode": "2"
}
}
Data: department object
Response Result Name: department name;
Description Code: department code;
parentCode: parent department code
ZKBio CVSecurity API User Manual P a g e | 25
2.6 Media Interface
2.6.1 Add or Update Media Info[adMedia/add]
http://serverIP:serverPort/api/adMedia/add&access_token={apitoke
Post Request URL
n}
Request Mode POST
File: "bayue.png",
Request Content
mediaName: "Media name" (be included in a form data to submit)
File: Media file, required
Request Parameter
Description mediaName:media name, required (be included in form data to
send)
Refer to public response result, other can refer to Appendix-Error
Response Result
code
Response Result
public response parameter description
Description
2.6.2 Delete Media by Name[adMedia/delete/{name}]
http://serverIP:serverPort/api/adMedia/delete/{name}&access_toke
Post Request URL
n={apitoken}
Request Mode DELETE
Request Content None
Request Parameter
Name: media name, required;
Description
Refer to public response result, other can refer to Appendix-Error
Response Result
code
Response Result
public response parameter description
Description
ZKBio CVSecurity API User Manual P a g e | 26
2.6.3 Get Media Object by Name[adMedia/get/{name}]
http://serverIP:serverPort/api/adMedia/get/{name}&access_token={
Post Request URL
apitoken}
Request Mode GET
Request Content None
Request Parameter
name: media name, required;
Description
{
"code": 0,
"message": "success",
"data": [
{
"id": “402856aa6c3bbde1016c3bc2329200ff”,
Response Result "mediaName": "111",
"mediaSize": "21KB",
"mediaSuffix": "png",
"mediaType": "1",
"mediaPath": ""/att/picture/1535520932078.png""
}
]
}
Data: media object
Id: media id; such as：“402856aa6c3bbde1016c3bc2329200ff”
Response Result mediaName: media name;
Description mediaSize: media size;
mediaType: media type; 1: picture; 2: video
mediaPath: media path
ZKBio CVSecurity API User Manual P a g e | 27
2.7 Area Interface
2.7.1 Get Area Object by Area Code[area/get/{code}]
http://serverIP:serverPort/api/attAreaPerson/area/get/{code}?code=
Post Request URL
1&access_token={apitoken}
Request Mode GET
Request Content None
Request Parameter
Code: department code, required;
Description
{
"code": 0,
"message": "success",
"data": {
Response Result
"id": 1,
"code": "402856aa6c3bbde1016c3bc2329200ff ",
"name": "area name"
}
}
Data: area object;
Response Result Id: area id;
Description Code: area code;
name: area name;
ZKBio CVSecurity API User Manual P a g e | 28
2.7.2 Get Area List [area/list]
http://serverIP:serverPort/api/attAreaPerson/area/list?pageNo=1&pag
Post Request URL
eSize=5&access_token={apitoken}
Request Mode GET
Request Content None
Request Parameter pageNo: page, required, must be greater than 0
Description pageSize, the number of each page, required, must be greater than 0
{
"code": 0,
"message": "success",
"data": [
{
"id": “402856aa6c3bbde1016c3bc2329200ff”,
"code": "1",
Response Result "name": "area name"
},
{
"id": “402856aa6c3bbde1016c3bc211e5005a”,
"code": "2",
"name": "2"
}
]
}
Data: area object List;
Response Result Id: area id;
Description code: area code;
name: area name;
ZKBio CVSecurity API User Manual P a g e | 29
2.8 Person Interface of Att Area
2.8.1 Delete Area Person [attAreaPerson/delete]
http://serverIP:serverPort/api/attAreaPerson/delete?access_token={a
Post Request URL
pitoken}
Request Mode DELETE
{
"code": "1",
Request Content
"pins": "5"
}
Request Parameter Code: area code, required;
Description Pins: pin, required
Refer to public response result, other can refer to Appendix-Error
Response Result
code
Response Result
public response parameter description
Description
2.8.2 Set Area Person [attAreaPerson/set]
http://serverIP:serverPort/api/attAreaPerson/set?access_token={apito
Post Request URL
ken}
Request Mode POST
{
"code": "1",
Request Content
"pins": ["5"]
}
Request Parameter Code: area code, required;
Description Pins: pin, required
Refer to public response result, other can refer to Appendix-Error
Response Result
code
ZKBio CVSecurity API User Manual P a g e | 30
Response Result
public response parameter description
Description
2.9 Access Control Device Interface
2.9.1 Get Device List [device/accList]
http://serverIP:serverPort/api/device/accList?pageNo=1&pageSize=2
Post Request URL
0&access_token={apitoken}
Request Mode GET
Request Content None
Request Parameter pageNo: pageno, required, the value must be greater than0;
Description pageSize: the number of each page, required, must be greater than 0
{
"code": 0,
"message": "success",
"data": [
{
"id": “402856aa6c3bbde1016c3bc2329200ff”,
"sn": "0564140100195",
"name": "192.168.218.104",
Response Result "type": "inBIO160",
"state": "1",
"module": "acc"
},
{
"id": “402856aa6c3bbde1016c3bc211e50059”,
"sn": "0566141900209",
"name": "192.168.218.11",
"type": "inBIO460",
ZKBio CVSecurity API User Manual P a g e | 31
"state": "1",
"module": "acc"
}
]
}
Data: device array list;
Id: device id;
Response Result Sn: device sn;
Description Name: device name;
state: device state, 1 enabled, 0 disabled;
Module: module, access, attendance, elevator;
2.9.2 Get Device Info by Sn [device/getAcc/{sn}]
http://serverIP:serverPort/api/device/getAcc?sn={sn}&access_token={
Post Request URL
apitoken}
Request Mode GET
Request Content None
Request Parameter
Description Sn:device sn, required;
{
"code": 0,
"message": "success",
"data": {
"id": “402856aa6c3bbde1016c3bc2329200ff”,
"sn": "5662012052868",
Response Result
"name": "192.168.214.15",
"type": "inibo460",
"state": "0",
"module": "acc"
}
}
ZKBio CVSecurity API User Manual P a g e | 32
Data: device object;
Id: device id;
Sn: device sn
Response Result
Name: device name;
Description
Type: device model type;
state: device state, 1enabled, 0 disabled;
Module: module, access, attendance, elevator;
2.9.3 Get Device List(With total number) [api/v2/device/list]
http://serverIP:serverPort/api/device/accList?pageNo=1&pageSize=2
Post Request URL
0&access_token={apitoken}
Request Mode GET
Request Content None
Request Parameter pageNo: pageno, required, the value must be greater than0;
Description pageSize: the number of each page, required, must be greater than 0
{
"code": 0,
"message": "success",
"data": {
"page": 0,
"size": 1,
"total": 1,
Response Result "data": [{
"id": "8a888e238478c3a6018478e40ee40a64",
"sn": "CJI4200960003",
"name": "10.8.14.142",
"type": "SpeedFace-V5L",
"status": "1",
"module": "acc"
}],
ZKBio CVSecurity API User Manual P a g e | 33
"offset": 0,
"lastPage": true
}
}
data: response result
Page: request page number
Size: data number of current request
Total: total number
Response Result data: device array list;
Description Id: device id;
Sn: device sn;
Name: device name;
state: device state, 1 enabled, 0 disabled;
Module: module, access, attendance, elevator;
2.10 Ele Device Interface
2.10.1Get Ele Device List [eleDevice/eleList]
http://serverIP:serverPort/api/eleDevice/eleList?pageNo=1&pageSize
Post Request URL
=20&access_token={apitoken}
Request Mode GET
Request Content None
Request Parameter pageNo: page no, required, the value must be greater than 0;
Description pageSize, the number of each page, required, must be greater than 0
{
"code": 0,
"message": "success",
Response Result
"data": [
{
"id": “402856aa6c3bbde1016c3bc2329200ff”,
ZKBio CVSecurity API User Manual P a g e | 34
"sn": "0564140100195",
"name": "192.168.218.104",
"type": "EC-100",
"state": "1",
"module": "ele"
},
{
"id": “402856aa6c3bbde1016c3bc210d90016”,
"sn": "0566141900209",
"name": "192.168.218.11",
"type": "EC-100",
"state": "1",
"module": "ele"
}
]
}
Data: Device array List;
Id: device id;
Sn: device serial number;
Response Result
Name: device name;
Description
Type: device model name;
state: state: device state, 1 enabled, 0 disabled;
Module: module, access, attendance, elevator;
2.10.2Get Ele Device Info by Sn [eleDevice/getEle/{sn}]
http://serverIP:serverPort/api/eleDevice/getEle?sn={sn}&access_toke
Post Request URL
n={apitoken}
Request Mode GET
Request Content None
Request Parameter Sn: device sn, required;
ZKBio CVSecurity API User Manual P a g e | 35
Description
{
"code": 0,
"message": "success",
"data": {
"id": “402856aa6c3bbde1016c3bc2329200ff”,
"sn": "5662012052868",
Response Result
"name": "192.168.214.15",
"type": "EC-100",
"state": "0",
"module": "ele"
}
}
Data: device object;
id: device id;
sn: device sn;
Response Result
name: device name;
Description
type: device model name;
state: state: device state, 1 enabled, 0 disabled;
Module: module, access, attendance, elevator;
2.10.3Get Ele Device List(With total number) [api/v2/eleDevice/eleList]
http://serverIP:serverPort/api/v2/eleDevice/eleList?pageNo=1&pageS
Post Request URL
ize=20&access_token={apitoken}
Request Mode GET
Request Content None
Request Parameter pageNo: page no, required, the value must be greater than 0;
Description pageSize, the number of each page, required, must be greater than 0
{
Response Result
"code": 0,
ZKBio CVSecurity API User Manual P a g e | 36
"message": "success",
"data": {
"page": 0,
"size": 1,
"total": 1,
"data": [{
"id": "8a888e238478c3a6018478ea9cdc0b9c",
"sn": "6013150300019",
"name": "10.8.14.251",
"type": "EC-100",
"status": "1",
"module": "ele"
}],
"offset": 0,
"lastPage": true
}
}
data: response result;
Page: current request page number;
Size: data number of current request;
Total: total number;
data: device array list;
Response Result
Id: device id;
Description
Sn: device sn;
Name: device name;
Type: device model name;
state: device state, 1 enabled, 0 disabled;
Module: module, access, attendance, elevator;
ZKBio CVSecurity API User Manual P a g e | 37
2.11 Door Interface
2.11.1Get the State of All Doors [door/all DoorState]
http://serverIP:serverPort/api/door/allDoorState?timestamp={timesta
Post Request URL
mp}&access_token={apitoken}
Request Mode GET
Request Content None
Timestamp: timestamp, millisecond, such as 1494467276539,
Request Parameter
required; Access frequency cannot be too high, it is recommended to
Description
obtain at least 10 seconds or more;
{
"code": 0,
"message": "success",
"data": [
{
"id": door id, string; such as:
“402856aa6c3bbde1016c3bc210d90016”
"name": "door name",
"deviceId": device id, string; such as:
“402856aa6c3bbde1016c3bc211e5005a”
"connect": device connection state (0 offline, 1online, 2 disabled),
Response Result "sensor": sensor state (unknown, no sensor, off, open),
"alarm": alarm state (none, alarm, timeout, be opened accidentally,
tampering, duress password opening, duress fingerprint opening,
duress opening, normal open alarm, low battery voltage, replace
battery, illegal operation, backup power, unknown)
"relay": relay state (off, open, unknown)
},
{
"id": “402856aa6c3bbde1016c3bc211e50059”,
"name": "192.168.218.11-1",
"deviceId": “402856aa6c3bbde1016c3bc211e5005a”,
"connect": "1",
ZKBio CVSecurity API User Manual P a g e | 38
"sensor": "no sensor",
"alarm": "None",
"relay": "off"
},
{
"id": “402856aa6c3bbde1016c3bc211e5005a”,
"name": "192.168.218.11-2",
"deviceId": “402856aa6c3bbde1016c3bc211e5005a”,
"connect": "1",
"sensor": "no sensor",
"alarm": "none",
"relay": "off"
},
{
"id": “402856aa6bff4b1a016bff5374800c0e”,
"name": "192.168.218.11-3",
"deviceId":”402856aa6bff4b1a016bff5374800c0e”,
"connect": "1",
"sensor": "no sensor",
"alarm": "None",
"relay": "off"
},
{
"id": “402856aa6c083827016c08582f8f0012”,
"name": "192.168.218.11-4",
"deviceId": “402856aa6c3bbde1016c3bc211e5005a”,
"connect": "1",
"sensor": "No sensor",
"alarm": "None",
"relay": "off"
}
]
}
ZKBio CVSecurity API User Manual P a g e | 39
Data: door state array List;
Id: door id;
Name: door name;
DeviceId: device id;
Connection: connection state, 0 offline, 1online, 2 disabled;
Response Result Sensor: sensor description (unknown, no sensor, off, open)
Description
Alarm: alarm description (none, alarm, timeout, be opened
accidentally, tampering, duress password opening, duress fingerprint
opening, duress opening, normal open alarm, low battery voltage,
replace battery, illegal operation, backup power, unknown)
relay: Relay state (off, open, unknown)
2.11.2Get Door State by Door Id [door/doorState ById]
http://serverIP:serverPort/api/door/doorStateById?doorId=1×t
Post Request URL
amp={timestamp}&access_token={apitoken}
Request Mode GET
Request Content None
Timestamp: timestamp, millisecond, such as 1494467276539,
Request Parameter
required; Access frequency cannot be too high, it is recommended
Description
to obtain at least 10 seconds or more;
{
"code": 0,
"message": "success",
"data": {
"id": door id, string; such as: 402856aa6c083827016c08582f8f0012
Response Result "name": "door name",
"deviceId": device id, string; such
as: ”402856aa6c3bbde1016c3bc211e5005a”
"connect": device connection state,
"sensor": sensor state description,
"alarm": alarm state description,
ZKBio CVSecurity API User Manual P a g e | 40
"relay": relay state
}
}
data: door state object
id: door id;
name: door name;
deviceId: device id;
connect: connection state (0 offline, 1 online, 2 disabled);
Response Result sensor: sensor description (unknown, no sensor, off, open);
Description
alarm: alarm state (none, alarm, timeout, be opened accidentally,
tampering, duress password opening, duress fingerprint opening,
duress opening, normal open alarm, low battery voltage, replace
battery, illegal operation, backup power, unknown)
relay: Relay state (off, open, unknown)
ZKBio CVSecurity API User Manual P a g e | 41
2.11.3 Get Door State by the Sn of Device [door/doorStateBy{Sn}]
http://serverIP:serverPort/api/door/doorStateBySn?deviceSn={sn}
Post Request URL
×tamp={timestamp}&access_token={apitoken}
Request Mode GET
Request Content None
Timestamp: timestamp, millisecond, such as 1494467276539,
Request Parameter required; Access frequency cannot be too high, it is recommended
Description to obtain at least 10 seconds or more;
Sn: device sn
{
"code": 0,
"message": "success",
"data": {
"id": door id, string; such as:
“402856aa6c083827016c08582f8f0012”,
"name": "door name",
Response Result
"deviceId": device id,
"connect": device state description,
"sensor": sensor state description,
"alarm": alarm state description
"relay": relay state description
}
}
data: door state object;
id: door id;
name: door name;
Response Result deviceId: device id;
Description connect: device connection state (0 offline, 1 online, 2 disabled);
sensor: sensor state (unknown, no sensor, off, open);
alarm: alarm state (none, alarm, timeout, be opened accidentally,
tampering, duress password opening, duress fingerprint opening,
duress opening, normal open alarm, low battery voltage, replace
ZKBio CVSecurity API User Manual P a g e | 42
battery, illegal operation, backup power, unknown)
relay: relay state (off, open, unknown)
2.11.4Get Door Info by Door Id [door/get]
http://serverIP:serverPort/api/door/get?id={id}&access_token={a
Post Request URL
pitoken}
Request Mode GET
Request Content None
Request Parameter
id: door id;
Description
{
"code": 0,
"message": "success",
"data": {
Response Result "id": “402856aa6c083827016c08582f8f0012”,
"name": "192.168.214.15-1",
"deviceId":”402856aa6c3bbde1016c3bc211e5005a”,
}
}
data: door info object;
Response Result id: doorid;
Description name: door name;
deviceId: deviceid;
ZKBio CVSecurity API User Manual P a g e | 43
2.11.5 Get Door List [door/list]
http://serverIP:serverPort/api/door/list?pageNo=1&pageSize=20&
Post Request URL
access_token={apitoken}
Request Mode GET
Request Content None
PageNo: page, required, the value must be greater than 0;
Request Parameter
Description pageSize, the number of each page, required, must be greater
than 0
{
"code": 0,
"message": "success",
"data": [
{
"id": “402856aa6c083827016c08582f8f0012”,
"name": "192.168.214.15-1",
"deviceId":”402856aa6c3bbde1016c3bc211e5005a”,
},
{
"id": “402856aa6c08e7e4016c090be94a000a”,
Response Result "name": "192.168.214.15-2",
"deviceId": “402856aa6c3bbde1016c3bc211e5005a”,
},
{
"id": “402856aa6c08e7e4016c092400580021”,
"name": "192.168.214.15-3",
"deviceId": “402856aa6c3bbde1016c3bc211e5005a”,
},
{
"id": “402856aa6c3baabb016c3bb37365000a”,
"name": "192.168.214.15-4",
"deviceId": “402856aa6c3baabb016c3bb37365000a”
ZKBio CVSecurity API User Manual P a g e | 44
}
]
}
data: door array list;
Response Result id: doorid;
Description name: door name;
deviceId: device id;
2.11.6Remote Close by Door Id [door/remoteCloseById]
http://serverIP:serverPort/api/door/remoteoffById?doorId={doorId
Post Request URL
}&access_token={apitoken}
Request Mode POST
Request Content None
Request Parameter doorId: door id, required, string; such as:
Description “402856aa6c3baabb016c3bb37365000a”
Refer to public response result, other can refer to Appendix-Error
Response Result
code
Response Result
public response parameter description
Description
2.11.7 Remote Close by Door Name [door/remoteCloseByName]
http://serverIP:serverPort/api/door/remoteoffByName?doorName
Post Request URL
={doorName}&access_token={apitoken}
Request Mode POST
Request Content None
Request Parameter
doorName: door name, required;
Description
Response Result Refer to public response result, other can refer to Appendix-Error
ZKBio CVSecurity API User Manual P a g e | 45
code
Response Result
public response parameter description
Description
2.11.8Remote Open by Door Id [door/remoteOpenById]
http://serverIP:serverPort/api/door/remoteOpenById?doorId={doorId
Post Request URL
}&interval={interval}&access_token={apitoken}
Request Mode POST
Request Content None
doorId: door id, required, string; such as:
Request Parameter “402856aa6c3baabb016c3bb37365000a”,
Description
Interval: door opening time, seconds, required;
Refer to public response result, other can refer to Appendix-Error
Response Result
code
Response Result
public response parameter description
Description
2.11.9 Remote Open by Door Name[door/remoteOpenByName]
http://serverIP:serverPort/api/door/remoteOpenByName?doorName=
Post Request URL
{doorName}&interval={interval}&access_token={apitoken}
Request Mode POST
Request Content None
Request Parameter doorName: door name, required;
Description interval: door opening time, seconds, required;
Refer to public response result, other can refer to Appendix-Error
Response Result
code
Response Result
public response parameter description
Description
ZKBio CVSecurity API User Manual P a g e | 46
2.11.10 Get Door List(With total number) [api/v2/door/list]
http://serverIP:serverPort/api/v2/door/list?pageNo=1&pageSize=2
Post Request URL
0&access_token={apitoken}
Request Mode GET
Request Content None
PageNo: page, required, the value must be greater than 0;
Request Parameter
Description pageSize, the number of each page, required, must be greater
than 0
{
"code": 0,
"message": "success",
"data": {
"page": 0,
"size": 1,
"total": 1,
"data": [{
Response Result
"id": "8a888e238478c3a6018478e40f230aae",
"name": "10.8.14.142-1",
"deviceId": "8a888e238478c3a6018478e40ee40a64"
}],
"offset": 0,
"lastPage": true
}
}
data: result;
Page: current request page;
Response Result Size: current data number of crrrent request page;
Description Total: total number;
data: door array list;
id: door id;
ZKBio CVSecurity API User Manual P a g e | 47
name: door name;
deviceId: device id;
2.12 Floor interface
2.12.1Get Floor Info List[floor/list]
http://serverIP:serverPort/api/floor/list?pageNo=1&pageSize=20&acces
Post Request URL
s_token={apitoken}
Request Mode GET
Request Content None
Request Parameter PageNo: page, required, the value must be greater than 0;
Description pageSize, the number of each page, required, must be greater than 0
{
"code": 0,
"message": "success",
"data": [
{
"id": “402856aa6c08e7e4016c092400580021”,
"floorNo":1,
"name": "192.168.214.15-1",
"deviceId":”402856aa6c3c5063016c3cb3a0360005”,
Response Result
},
{
"id": “402856aa6c08e7e4016c090be94a000a”,
"floorNo":2,
"name": "192.168.214.15-2",
"deviceId": “402856aa6c3c5063016c3cb3a0360005”
},
{
"id": “402856aa6c083827016c08582f8f0012”,
ZKBio CVSecurity API User Manual P a g e | 48
"floorNo":3,
"name": "192.168.214.15-3",
"deviceId": “402856aa6c3c5063016c3cb3a0360005”,
},
{
"id": “402856aa6c3baabb016c3bb37365000a”,
"floorNo":4,
"name": "192.168.214.15-4",
"deviceId":”402856aa6c3c5063016c3cb3a0360005”,
}
]
}
data: floor array list;
id: floor id;
Response Result
floorNo: floor no;
Description
name: floor name;
deviceId: device id;
2.12.2 Remote Close by Floor Id[floor/remoteCloseById]
http://serverIP:serverPort/api/floor/remoteoffById?floorId={floorId}&
Post Request URL
access_token={apitoken}
Request Mode POST
Request Content None
Request Parameter floorId: floorid, required, string; such
Description as: ”402856aa6c3c5063016c3cb3a0360005”
Refer to public response result, other can refer to Appendix-Error
Response Result
code
Response Result
public response parameter description
Description
ZKBio CVSecurity API User Manual P a g e | 49
2.12.3 Remote Open by Floor Id[floor/remoteOpenById]
http://serverIP:serverPort/api/floor/remoteOpenById?floorId={floorId
Post Request URL
}&interval={interval}&access_token={apitoken}
Request Mode POST
Request Content None
floorId: floor id, required, string; such as:
Request Parameter “402856aa6c3c5063016c3cb3a0360005”
Description
interval: door opening time, seconds, required;
Refer to public response result, other can refer to Appendix-Error
Response Result
code
Response Result
public response parameter description
Description
2.12.4Get Floor Info List(With total number) [api/v2/floor/list]
http://serverIP:serverPort/api/floor/list?pageNo=1&pageSize=20&acces
Post Request URL
s_token={apitoken}
Request Mode GET
Request Content None
Request Parameter PageNo: page, required, the value must be greater than 0;
Description pageSize, the number of each page, required, must be greater than 0
{
"code": 0,
"message": "success",
"data": {
Response Result "page": 0,
"size": 3,
"total": 10,
"data": [
{
ZKBio CVSecurity API User Manual P a g e | 50
"id": "8a888e238478c3a6018478ea9cf40bc1",
"floorNo": 1,
"name": "10.8.14.251(1)",
"deviceId": "8a888e238478c3a6018478ea9cdc0b9c"
},
{
"id": "8a888e238478c3a6018478ea9cf40bc2",
"floorNo": 2,
"name": "10.8.14.251(2)",
"deviceId": "8a888e238478c3a6018478ea9cdc0b9c"
},
{
"id": "8a888e238478c3a6018478ea9cf40bc3",
"floorNo": 3,
"name": "10.8.14.251(3)",
"deviceId": "8a888e238478c3a6018478ea9cdc0b9c"
}
],
"offset": 0,
"lastPage": false
}
}
data: result;
Page: current request page;
Size: current data number of crrrent request page;
Total: total number;
Response Result
data: floor array list;
Description
id: floor id;
floorNo: floor no;
name: floor name;
deviceId: device id;
ZKBio CVSecurity API User Manual P a g e | 51
2.13 Person Interface
2.13.1Add/ Edit Person Info [person/add]
Post Request URL http://serverIP:serverPort/api/person/add?access_token={apitoken}
Request Mode POST
{
"pin": "1234",
"deptCode": "1",
"name": "name",
"lastName": "person name (English)",
"gender": "F",
Request Content
"cardNo": "card no",
"personPhoto":“picture-base64”,
"accLevelIds": "access level group ids",
"accStartTime": "the start time of person valid access ",
"accEndTime": "the end time of person valid access "
}
Pin: pin, required
deptCode: department code;
name: name;
lastName: person name (English)
gender: gender, male, female;
cardNo: card no;
Request Parameter
Description personPhoto :personnel comparison picture. “picture turn into
base64 format”
accLevelIds: access level groupid List, multiple comma separated,
string; such as :
402856aa6c3c5063016c3cb3a0360005,402856aa6bff4b1a016bff537
4800c0e,402856aa6c3baabb016c3bb37365000a;
accStartTime: access start time, such as :2017-08-04 15:45:00;
accEndTime: access end time, such as :2017-08-04 23:59:59;
Response Result Refer to public response result, other can refer to Appendix-Error
ZKBio CVSecurity API User Manual P a g e | 52
code
Response Result
public response parameter description
Description
2.13.2Delete Person Info by Pin [person/delete/{pin}]
http://serverIP:serverPort/api/person/delete/{pin}?access_token={a
Post Request URL
pitoken}
Request Mode DELETE
Request Content None
Request Parameter
pin: pin, required;
Description
Refer to public response result, other can refer to Appendix-Error
Response Result
code
Response Result
public response parameter description
Description
ZKBio CVSecurity API User Manual P a g e | 53
2.13.3 Get person Info by Pin [person/get/{pin}]Get person Info by Pin
[person/get/{pin}]
http://serverIP:serverPort/api/person/get/{pin}?access_token={apit
Post Request URL
oken}
Request Mode GET
Request Content None
Request Parameter
pin: pin, required;
Description
{
"code": 0,
"message": “success”,
"data": {
"pin": "pin",
"deptCode": department code,
"deptName": "department name",
Response Result
"name": "name",
"lastName": "person name (English)",
"gender": "gender",
"cardNo": “card no”
}
}
data: person data info;
pin: pin;
gender: gender, M: male, F: female;
Response Result deptCode: department code;
Description deptName: department name;
name: name;
lastName: person name (English);
cardNo: card no;
ZKBio CVSecurity API User Manual P a g e | 54
2.13.4 Get personnel information according to the PIN array and the
department code array
http://serverIP:serverPort/api/person/getPersonList?access_token={
Post Request URL apitoken}
POST
Request Mode
{
"pins": "1,2,3",
"deptCodes": "1,2",
Request Content
"pageNo":1,
"pageSize":10
pageNo: page number.(Page number is necessary and must be
greater than zero.)
Request Parameter
Description pageSize: Number of entries per page is necessary and must be
greater than zero.；
"code": 0,
"message": “success”,
"data": {
Response Result
"pin": "PIN Personal identification number",
"deptCode": “Department Code”,
"deptName": "Department Name",
ZKBio CVSecurity API User Manual P a g e | 55
"name": "First Name",
"lastName": "Last Name",
"gender": "Gender",
"cardNo": Card number,
"personPhoto": Personal photo( base64 photo),
"vislightPhoto":Facial recognition photo(base64 photo),
"vislightPhotoPath":
"/upload/pers/user/cropface/789789/789789.jpg"
data：Personnel information date；
pin：Personal identification number；
gender：gender，M is male，F is female；
deptCode：Department Code；
Response Result deptName：Department Name；
Description
name：First Name；
lastName: Last Name；
cardNo：Card number；
personPhoto：personal photo (base64 photo)；
ZKBio CVSecurity API User Manual P a g e | 56
vislightPhoto：Facial recognition photo (base64 photo)；
vislightPhotoPath：Facial recognition photo path；
ZKBio CVSecurity API User Manual P a g e | 57
2.13.5 Get dynamic QR code by personal identification number
http://serverIP:serverPort/api/person/getQrCode/{pin}?access_toke
Post Request URL n={apitoken}
POST
Request Mode
{
"pin": "123"
Request Content
}
Request Parameter pin：Personal identification number and it is necessary
Description
{
"code":0,
"message": "success",
Response Result
"data":
"2#6SQLIaSLhprGhpkCgFrhHfdyZXFJxK2DLy+oLVoImoI="
Response Result data：dynamic QR code (base64 data)；
Description
ZKBio CVSecurity API User Manual P a g e | 58
2.13.6 Resignation
http://serverIP:serverPort/api/person/leave?access_token={apitoke
Post Request URL n}
POST
Request Mode
{
"leaveDate": "2019-06-10",
"leaveType": "1",
Request Content
"pin": "123"
leaveDate:Leave Date
Request Parameter leaveType:Leave Type
Description
pin：Personal identification number and it is necessary
"code":0,
"message": "success",
Response Result
"data": null
http://serverIP:serverPort/api/person/leave?access_token={apitoke
Response Result
Description n}
ZKBio CVSecurity API User Manual P a g e | 59
2.13.7 Add / Edit personnel basic information
http://serverIP:serverPort/api/person/addPersonnelBasicInfo?access
Post Request URL _token={apitoken}
POST
Request Mode
{
"pin": "1234567",
"deptCode": "1",
"birthday": "2016-07-15",
"cardNo": "123456789",
"certNumber": "123456",
"certType": "2",
"email": "[email protected]",
"gender": "F",
Request Content
"hireDate": " 2019-06-10",
"isDisabled": false,
"isSendMail": true,
"lastName": "lastName",
"mobilePhone": "15123456789",
"name": "max",
"personPwd": "123456",
"ssn": "111111",
"supplyCards": "987643",
ZKBio CVSecurity API User Manual P a g e | 60
}
pin：Personal identification number and it is necessary；
deptCode：Department Code；
name：First Name；
lastName：Last Name；
gender：Gender，M: male，F: female；
cardNo：card number. Only cardNO is setted as an empty string the
card number be deleted.If it is not set, the original card number will
be maintained. The format is: "cardno":
birthday：Birthday；
Request Parameter
Description
certNumber: Certificate number；
certType: certificate type.1：Second generation ID card，2：Passport，
3：Driver's License，4：Work Permit，5：Citizen Card，6： Driver's
License；1000：Xiamen Social Security Card，1001：Hong Kong,
Macao passport；
email: Email address, such as [email protected]；
hireDate: employee's entry date,such as：" 2019-06-10"；
isDisabled: whether it is a prohibited list. True: Yes; False: No
isSendMail: whether to send mail. True: send; False: do not send;
ZKBio CVSecurity API User Manual P a g e | 61
mobilePhone: phone number,such as："15123456789",
personPwd: device authentication password such as："123456"；
ssn: social security number;
supplyCards: Secondary cards. To use this function, you need to set
up one person multiple cards in the personnel parameter setting.
You can set multiple cards, which are separated by commas,such
as："987643，2233452"；
Refer to the general response results, others refer to Appendix -
Response Result Exception Dictionary
General response parameter description
Response Result
Description
ZKBio CVSecurity API User Manual P a g e | 62
2.13.8 Update personnel Photo by PIN
http://serverIP:serverPort/api/person/updatePersonnelPhoto
Post Request URL
?access_token={apitoken}
POST
Request Mode
"pin": "1234567",
Request Content
"personPhoto": "string",
pin：Personal identification number and it is necessary；
Request Parameter personPhoto: Personnel photos and it is in Base64 format.If no value is
Description
transferred, no processing will be performed
Refer to the general response results, others refer to Appendix -
Response Result Exception Dictionary
General response parameter description
Response Result
Description
ZKBio CVSecurity API User Manual P a g e | 63
2.13.9 Get personnel information according to the PIN array and the
department code array(With total number)
http://serverIP:serverPort/api/v2/person/getPersonList?access_toke
Post Request URL n={apitoken}
POST
Request Mode
{
"pins": "1,2,3",
"deptCodes": "1,2",
Request Content
"pageNo":1,
"pageSize":10
pageNo: page number.(Page number is necessary and must be
greater than zero.)
Request Parameter
Description pageSize: Number of entries per page is necessary and must be
greater than zero.；
"code": 0,
"message": "success",
"data": {
Response Result
"page": 0,
"size": 1,
"total": 1,
ZKBio CVSecurity API User Manual P a g e | 64
"data": [{
"id": "8a888e238488391e018488e253ba016d",
"pin": "1",
"deptCode": "1",
"deptName": "department name",
"name": "seven",
"lastName": "",
"gender": "F",
"birthday": "2022-11-18",
"cardNo": "1111111",
"supplyCards": "",
"personPhoto": "",
"selfPwd": "e10adc3949ba59abbe56e057f20f883e",
"isSendMail": false,
"mobilePhone": "18094041582",
"personPwd": "",
"carPlate": null,
"email": "",
"ssn": null,
"accLevelIds": "8a888e2384847238018484748507065a",
"accStartTime": null,
"accEndTime": null,
"certType": "",
ZKBio CVSecurity API User Manual P a g e | 65
"certNumber": "",
"photoPath": "",
"hireDate": null,
"isDisabled": false,
"vislightPhoto": "",
"vislightPhotoPath":
"/upload/pers/user/cropface/1/1.jpg"
}],
"offset": 0,
"lastPage": true
data: the result returned;
page: The page number of the current request;
size: The number of data requested by the current page number;
total: total quantity;
data：Personnel information date；
pin：Personal identification number；
gender：gender，M is male，F is female；
Response Result
Description
deptCode：Department Code；
deptName：Department Name；
name：First Name；
lastName: Last Name；
cardNo：Card number；
supplyCards: secondary cards;
ZKBio CVSecurity API User Manual P a g e | 66
birthday : date of birth;
selfPwd: self-service password;
personPhoto: person's headshot base64 photo;
vislightPhoto: comparison photo (base64 photo);
vislightPhotoPath: path of the comparison photo;
isSendMail: whether mailbox notification;
mobilePhone: mobile phone number;
personPwd: device authentication password;
carPlate: car plate;
email: email address;
ssn : social security number;
accLevelIds: access control privilege group id;
accStartTime: access control privilege effective time from
accEndTime: access control rights validity time Stop
certType: type of document (2: ID card, 3: passport, 4: driver's
licence, 5: work permit, 6: citizen card, 7: driving licence, 8: other,
1000: Xiamen social security card)
certNumber: certificate number
photoPath: photo path (base64)
hireDate: entry time (2019-06-10)
isDisabled: disabled list
ZKBio CVSecurity API User Manual P a g e | 67
2.13.10 Reinstatement
http://serverIP:serverPort/api/person/reinstated?access_token={api
Post Request URL token}
POST
Request Mode
{
"pin": "1234567",
"deptCode": "1",
"birthday": "2016-07-15",
"carPlate": "987654",
"cardNo": "123456789",
"certNumber": "123456",
"certType": "2",
"email": "[email protected]",
Request Content
"gender": "F",
"hireDate": " 2019-06-10",
"isDisabled": false,
"isSendMail": true,
"lastName": "lastName",
"mobilePhone": "15123456789",
"name": "max",
"personPhoto": "string",
"personPwd": "123456",
ZKBio CVSecurity API User Manual P a g e | 68
"ssn": "111111",
"supplyCards": "987643",
"accEndTime": "2019-07-14 08:56:00",
"accLevelIds": "access level id",
"accStartTime": "2023-07-14 08:56:00"
pin: personnel number, required;
deptCode: department number;
name: name;
lastName: the name of the person, only useful in English;
gender: gender, M male, F female;
cardNo: card number; only when set cardNo as an empty string will
be deleted, do not set as to maintain the original card number, the
format is: "cardNo":" ";".
birthday: birthday date;
Request Parameter
Description carPlate: car plate number; Multiple license plates are divided by
English commas, such as "A12345,B12345"
When setting carPlate as an empty string, the license plate will be
deleted, and it is not regarded as keeping the original license plate,
with the format: "carPlate": “” ;
certNumber: the number of the certificate;
certType: certificate type, 2: second-generation ID card, 3: passport,
4: driver's licence, 5: work permit, 6: citizen card, 7: driver's licence;
1000: Xiamen social security card, 1001: Hong Kong and Macao
Travel Permit;
ZKBio CVSecurity API User Manual P a g e | 69
email: email address, 如 [email protected];
hireDate: the date the person was hired, e.g., " 2019-06-10";
isDisabled: whether the list is banned, true: yes; false: no
isSendMail: whether to send mail, true: send; false: do not send;
mobilePhone: mobile phone number, e.g., "15123456789",
personPhoto: person photo, base64 format;
personPwd: device authentication password, e.g., "123456";
ssn: social security number;
supplyCards: secondary cards, to use this feature, you need to
enable multiple cards for one person in the personnel parameter
settings, you can set more than one, more than one separated by
commas, such as: "987643, 2233452";
accLevelIds: access control rights group id collection, more than one
with comma separated, such as:
402856aa6c3c3c5063016c3cb3a0360005,402856aa6bff4b1a016bff5
374800c0e,402856aa6c3baabb016c3bb37365000a .;
accStartTime: access control effective start time, e.g. 2017-08-04
15:45:00;
accEndTime: access control valid end time, e.g., 2017-08-04
23:59:59;
Refer to public response result, other can refer to Appendix-Error
Response Result
code
Response Result
public response parameter description
Description
ZKBio CVSecurity API User Manual P a g e | 70
2.14 Access Control Reader Interface
2.14.1Get Access Control Reader Info List[reader/accList]
http://serverIP:serverPort/api/reader/accList?pageNo=1&pageSize=
Post Request URL
20&access_token={apitoken}
Request Mode GET
Request Content None
PageNo: page, required, the value must be greater than 0;
Request Parameter
Description pageSize, the number of each page, required, must be greater than
0
{
"code": 0,
"message": "success",
"data": [
{
"id": “402856aa6c3baabb016c3bb37365000a”,
"doorId": “402856aa6bff4b1a016bff5374800c0e”,
"name": "192.168.214.15-1-in",
"readerNo": 1,
"readerState": 0
Response Result
},
{
"id": “402856aa6c3c5063016c3cb3a0360005”,
"doorId": “402856aa6bff4b1a016bff5374800c0e”,
"name": "192.168.214.15-1-out",
"readerNo": 2,
"readerState": 1
}
]
}
Response Result Data: reader array List;
ZKBio CVSecurity API User Manual P a g e | 71
Description Id: reader id;
DoorId: door id;
Name: reader name;
ReaderNo: readerNo;
ReaderState: reader state, 0: in, 1: out;
2.14.2Get Access Control Reader Info by Reader Id [reader/getAcc]
http://serverIP:serverPort/api/reader/getAcc?id={id}&access_token=
Post Request URL
{apitoken}
Request Mode GET
Request Content None
Request Parameter
id: reader id, required;
Description
{
"code": 0,
"message": "success",
"data": {
"id": “402856aa6c3c5063016c3cb3a0360005”,
Response Result "doorId": “402856aa6bff4b1a016bff5374800c0e”,
"name": "192.168.214.15-1-in",
"readerNo": 1,
"readerState": 0
}
}
data: reader info object;
id: reader id;
Response Result doorId: doorid;
Description name: reader name;
readerNo: reader no;
readState: reader state, 0: in, 1:out;
ZKBio CVSecurity API User Manual P a g e | 72
2.15 Visitor Reservation Interface
2.15.1Add Visitor Reservation[visReservation/add]
http://serverIP:serverPort/api/visReservation/add?access_token={a
Post Request URL
pitoken}
Request Mode POST
{
"persPersonPin": "5",
"certType": "3",
"certNum": "4512",
"visitEmpName": "Mary",
Request Content "visitEmpPhone": "13015648651",
"company": "ZKTeco",
"visitReason": "visit",
"visitDate": "2018-08-31 14:40:00"
“visitEndDate”: "2018-08-31 23:59:59"
}
persPersonPin: interviewee pin, required;
certType: certificate type, required; details:
{
2:national ID card; 3:Passport; 4:Driver's license; 5:Work Permit;
6:Real-name card; 7:driving license; 8:others;
}
Request Parameter
certNum: certificate no, required;
Description
visitEmpName: interviewee name, required;
visitEmpPhone: visitor phone;
company: company;
visitReason: visit reason, required;
visitDate: visit date,yyyy-MM-dd mm:hh:ss, required;
visitEndDate: visit date,yyyy-MM-dd mm:hh:ss, required;
Response Result Refer to public response result, other can refer to Appendix-Error
ZKBio CVSecurity API User Manual P a g e | 73
code
Response Result
public response parameter description
Description
2.15.2Delete Visitor Reservation[visReservation/del]
http://serverIP:serverPort/api/visReservation/del?certType={certTy
Post Request URL pe}&certNum={certNum}&visitDate={visitDate}&access_token={a
pitoken}
Request Mode POST
Request Content None
certType: certificate type, required; details:
{
2: national ID card; 3: Passport; 4: Driver's license; 5:Work
Permit;
6: Real-name card; 7: driving license; 8:others;
Request Parameter
Description }
certNum: certificate no, required;
visitDate: visit date, required;
[The system will find out the only visitor reservation information
and delete it according to the certificate type, ID number, and visit
date]
Refer to public response result, other can refer to Appendix-Error
Response Result
code
Response Result
public response parameter description
Description
ZKBio CVSecurity API User Manual P a g e | 74
2.16 Visitor Level Interface
2.16.1Get Visitor Level Group List[visLevel/list]
http://serverIP:serverPort/api/visLevel/list?pageNo={pageNo}&pa
Post Request URL
geSize={pageSize}&access_token={apitoken}
Request Mode GET
Request Content None
PageNo: page, required, the value must be greater than 0;
Request Parameter
Description pageSize, the number of each page, required, must be greater
than 0
{
"code": 0,
"message": "success",
"data": [
{
Response Result
"id": “402856aa6bff4b1a016bff5374800c0e”,
"name": "public level group"
}
]
}
data: level group array list;
Response Result
id: level group id;
Description
name: level groupname;
ZKBio CVSecurity API User Manual P a g e | 75
2.17 Visitor Registration Check Out Interface
2.17.1Add Visitor Registration[visRegistration/add]
http://serverIP:serverPort/api/visRegistration/add?&access_token
Post Request URL
={apitoken}
Request Mode POST
{
"persPersonPin": "1",
"certType": "8",
"certNum": "456888",
"visEmpName": "max",
"visitEmpPhone": "",
"company": "",
Request Content
"visitReason": "visit",
"visitorCount": "1",
"startTime": "2018-08-31 14:40:00",
"endTime": "2018-08-31 23:59:59",
"cardNo": "",
"visLevels": ""
}
"persPersonPin":"Interviewee pin”, required
certType: certificate type,required;details:
{
2:national ID card; 3:Passport; 4:Driver's license; 5:Work
Permit;
Request Parameter 6:Real-name card; 7:driving license; 8:others;
Description
}
"certNum": visitor certificate no, required
"visitEmpName": visitor name, required
"visitEmpPhone": visitor mobile phone,
"company" : company,
ZKBio CVSecurity API User Manual P a g e | 76
"visitReason": visit reason, required
visitorCount: the number of visitors, required
startTime: start time,yyyy-MM-dd mm:hh:ss, required
endTime: end time, yyyy-MM-dd mm:hh:ss, required
cardNo: card no
visLevels: visitor level group id, string; such as:
402856aa6bff4b1a016bff5374800c0e,402856aa6c3c5063016c3c
b3a0360005
Refer to public response result, other can refer to Appendix-Error
Response Result
code
Response Result
public response parameter description
Description
2.17.2Visitor Check Out [visRegistration/exit]
http://serverIP:serverPort/api/visRegistration/exit?certType={cert
Post Request URL
Type}&certNum={certNum}&access_token={apitoken}
Request Mode POST
Request Content None
certType:certificate type,required;details:
{
2: national ID card;3:Passport;4:Driver's license;5:Work
Request Parameter Permit;
Description
6: real-name card;7:driving license;8:others;
}
"certNum": visitor certificate no, required
Refer to public response result, other can refer to Appendix-Error
Response Result
code
Response Result
public response parameter description
Description
ZKBio CVSecurity API User Manual P a g e | 77
2.17.3Get Visitor Dynamic QR code
http://serverIP:serverPort/api/visRegistration/getQrCode/{pin}?ac
Post Request URL
cess_token={apitoken}
Request Mode POST
{
Request Content
“pin”: “80000001”
Request Parameter
Pin: visitor number, required
Description
{
"code": 0,
Response Result "data": {},
"message": "string"
}
Response Result
Data: visitor’s dynamic qr code, base 64 data;
Description
2.18 Access Control transaction Interface
2.18.1Get Transaction by Device Sn [transaction/device/{deviceSn}]
http://serverIP:serverPort/api/transaction/device/{deviceSn}?pag
Post Request URL
eNo=1&pageSize=20&acc_token={apitoken}
Request Mode GET
Request Content None
PageNo: pageNo, required, the value must be greater than 0;
Request Parameter PageSize: required, the value must be greater than 0, not more
Description than 1000 per page;
DeviceSn: device sn;
ZKBio CVSecurity API User Manual P a g e | 78
{
"code": 0,
"message": "success",
"data": [
{
"id": “402856aa6c3c5063016c3cb3a0360005”,
"eventTime": "2017-08-04 15:59:12",
"pin": "",
"name": "",
"lastName": "",
"deptName": "",
"areaName": "area name",
"cardNo": "",
"devSn": "5662012052868",
"verifyModeName": "others",
"eventName": "enable device",
Response Result "eventPointName": "",
"readerName": "Main door-In Reader",
"devName": "192.168.214.15",
"logId": 11734
},
{
"id": “402856aa6c028430016c02d48ac10003”,
"eventTime": "2017-08-04 15:58:49",
"pin": "",
"name": "",
"lastName": "",
"deptName": "",
"areaName": " area name",
"cardNo": "",
"devSn": "5662012052868",
"verifyModeName": "others",
"eventName": "connect server successfully",
ZKBio CVSecurity API User Manual P a g e | 79
"eventPointName": "",
"readerName": "others",
"devName": "192.168.214.15",
"logId": 11733
}
]
}
data: transaction array list;
id: “402856aa6c032ca3016c03351d2600fd”;
eventTime: record device trigger time;
pin: pin;
name: person name;
lastName: person name, (English);
deptName: department name;
areaName: area name;
Response Result
Description cardNo: card no;
devSn: device sn;
verifyModeName: verification mode name;
eventName: transaction description;
eventPointName: transaction point name;
readerName: reader name;
devName: device name;
logId: transaction index value, there will be a value if device
support it;
2.18.2Get Transaction by Device SN(With total number)
[v2/transaction/device/{deviceSn}]
http://serverIP:serverPort/api/v2/transaction/device/{deviceSn}?p
Post Request URL
ageNo=1&pageSize=20&acc_token={apitoken}
Request Mode GET
Request Content None
ZKBio CVSecurity API User Manual P a g e | 80
PageNo: pageNo, required, the value must be greater than 0;
PageSize: required, the value must be greater than 0, not more
than 1000 per page;
Request Parameter
Description DeviceSn: device sn;
startDate：startDate, [not required]
endDate：endDate, [not required]
{
"code": 0,
"message": "success",
"data": {
"page": 0,
"size": 2,
"total": 39,
"data": [{
"id": "8a888e2385a383f80185a4ccbe870037",
"eventTime": "2023-01-12 15:05:56",
"pin": "57",
"name": "",
"lastName": "",
Response Result "deptName": "Department Name",
"areaName": "Area Name",
"cardNo": "",
"devSn": "7633223440032",
"verifyModeName": "Face",
"eventName": "Normal Verify Open",
"eventPointName": "10.8.14.210-1",
"readerName": "10.8.14.210-1-Out",
"accZone": null,
"devName": "10.8.14.210",
"logId": 161,
"eventNo": 0,
"eventLevel": 0,
"doorName": "10.8.14.210-1",
ZKBio CVSecurity API User Manual P a g e | 81
"capturePhotoBase64": ""
},
{
"id": "8a888e2385a383f80185a4ccbe840036",
"eventTime": "2023-01-12 15:05:54",
"pin": "57",
"name": "",
"lastName": "",
"deptName": "Department Name",
"areaName": "Area Name",
"cardNo": "",
"devSn": "7633223440032",
"verifyModeName": "Face",
"eventName": "Normal Verify Open",
"eventPointName": "10.8.14.210-1",
"readerName": "10.8.14.210-1-Out",
"accZone": null,
"devName": "10.8.14.210",
"logId": 160,
"eventNo": 0,
"eventLevel": 0,
"doorName": "10.8.14.210-1",
"capturePhotoBase64": ""
}
],
"offset": 0,
"lastPage": false
}
}
data: result
Response Result page: the page number of the current request;
Description size: the number of data requested by the current page number;
total: total number;
ZKBio CVSecurity API User Manual P a g e | 82
data: transaction array list;
id: “402856aa6c032ca3016c03351d2600fd”;
eventTime: record device trigger time;
pin: pin;
name: person name;
lastName: person name, (English);
deptName: department name;
areaName: area name;
cardNo: card no;
devSn: device sn;
verifyModeName: verification mode name;
eventName: transaction description;
eventPointName: transaction point name;
readerName: reader name;
devName: device name;
logId: transaction index value, there will be a value if device
support it;
eventNo: event number
eventLevel: event level
doorName: door name
capturePhotoBase64: captured photo of the door (base64)
2.18.3Get Access Transaction List[transaction/list]
http://serverIP:serverPort/api/transaction/list?pageNo=1&pageSi
Post Request URL
ze=20&access_token={apitoken}
Request Mode GET
Request Content None
personPin:personPin, [not required]
Request Parameter
startDate：startDate, [not required]
Description
endDate：endDate, [not required]
ZKBio CVSecurity API User Manual P a g e | 83
PageNo: page no, required, the value must be greater than 0;
pageSize, the number of each page, required, must be greater
than 0, not more than 1000 per page;
{
"code": 0,
"message": "success",
"data": [
{
"id":”402856aa6c032ca3016c03362ec10104”,
"eventTime": "2017-08-04 15:59:12",
"pin": "",
"name": "",
"lastName": "",
"deptName": "",
"areaName": " area name",
"cardNo": "",
"devSn": "5662012052868",
"verifyModeName": "others",
Response Result "eventName": "enable device",
"eventPointName": "",
"readerName": "others",
"accZone": null,
"devName": "192.168.214.15",
"logId": 11734
},
{
"id": “402856aa6c082c51016c082ef4e70001”,
"eventTime": "2017-08-04 15:58:49",
"pin": "",
"name": "",
"lastName": "",
"deptName": "",
"areaName": "area name",
"cardNo": "",
ZKBio CVSecurity API User Manual P a g e | 84
"devSn": "5662012052868",
"verifyModeName": "others",
"eventName": "connect server successfully",
"eventPointName": "",
"readerName": "others",
"accZone": null,
"devName": "192.168.214.15",
"logId": 11733
}
]
}
data: transaction array list;
id:5;
eventTime: record device trigger time;
pin: pin;
name: person name;
lastName: person name, (English);
deptName: department name;
areaName: area name;
Response Result cardNo: card no;
Description devSn: device sn;
verifyModeName: verification mode name;
eventName: transaction description;
eventPointName: transaction point name;
readerName: reader name;
accZone: access area name;
devName: device name;
logId: transactionindex value, there will be a value if device
support it;
2.18.4Get Access Transaction List(With total number)[api/v2/transaction/list]
Post Request URL http://serverIP:serverPort/api/v2/transaction/list?personPin={per
sonPin}&startDate={startDate}&endDate={endDate}&pageNo=1&
ZKBio CVSecurity API User Manual P a g e | 85
pageSize=20&access_token={apitoken}
Request Mode GET
Request Content None
personPin:personPin, [not required]
startDate：startDate, [not required]
Request Parameter endDate：endDate, [not required]
Description
PageNo: page no, required, the value must be greater than 0;
pageSize, the number of each page, required, must be greater
than 0, not more than 1000 per page;
{
"code": 0,
"message": "success",
"data": {
"page": 0,
"size": 2,
"total": 39,
"data": [{
"id": "8a888e2385a383f80185a4ccbe870037",
"eventTime": "2023-01-12 15:05:56",
"pin": "57",
Response Result "name": "",
"lastName": "",
"deptName": "Department Name",
"areaName": "Area Name",
"cardNo": "",
"devSn": "7633223440032",
"verifyModeName": "Face",
"eventName": "Normal Verify Open",
"eventPointName": "10.8.14.210-1",
"readerName": "10.8.14.210-1-Out",
"accZone": null,
"devName": "10.8.14.210",
ZKBio CVSecurity API User Manual P a g e | 86
"logId": 161,
"eventNo": 0,
"eventLevel": 0,
"doorName": "10.8.14.210-1",
"capturePhotoBase64": ""
},
{
"id": "8a888e2385a383f80185a4ccbe840036",
"eventTime": "2023-01-12 15:05:54",
"pin": "57",
"name": "",
"lastName": "",
"deptName": "Department Name",
"areaName": "Area Name",
"cardNo": "",
"devSn": "7633223440032",
"verifyModeName": "Face",
"eventName": "Normal Verify Open",
"eventPointName": "10.8.14.210-1",
"readerName": "10.8.14.210-1-Out",
"accZone": null,
"devName": "10.8.14.210",
"logId": 160,
"eventNo": 0,
"eventLevel": 0,
"doorName": "10.8.14.210-1",
"capturePhotoBase64": ""
}
],
"offset": 0,
"lastPage": false
}
}
ZKBio CVSecurity API User Manual P a g e | 87
data: result
page: the page number of the current request;
size: the number of data requested by the current page number;
total: total number;
data: transaction array list;
id: “402856aa6c032ca3016c03351d2600fd”;
eventTime: record device trigger time;
pin: pin;
name: person name;
lastName: person name, (English);
deptName: department name;
areaName: area name;
Response Result
Description cardNo: card no;
devSn: device sn;
verifyModeName: verification mode name;
eventName: transaction description;
eventPointName: transaction point name;
readerName: reader name;
devName: device name;
logId: transaction index value, there will be a value if device
support it;
eventNo: event number
eventLevel: event level
doorName: door name
capturePhotoBase64: captured photo of the door (base64)
2.18.5Get Access Real-Time Monitoring Transaction[transaction/monitor]
http://serverIP:serverPort/api/transaction/monitor?timestamp={
Post Request URL
timestamp}&access_token={apitoken}
Request Mode GET
Request Content None
ZKBio CVSecurity API User Manual P a g e | 88
Timestamp: timestampmillisecond, such as 1494467276539,
required; Access frequency cannot be too high, it is
Request Parameter
recommended to obtain at least 10 seconds or more; there is no
Description
need to change after timestamp value set the first request, it is
allowed to keep using the first request
{
"code": 0,
"message": "success",
"data": [
{
"eventTime": "2017-05-15 16:35:41",
"pin": "",
"areaName": " area name",
"cardNo": "9606650",
Response Result
"devSn": “0564140100195”,
"verifyModeName": "card or fingerprint",
"eventName": "card is not registered",
"eventPointName": "192.168.218.11-1",
"readerName": "192.168.218.11-1- out",
"devName": "192.168.218.11(0566141900209)"
}
]
}
data:transaction monitoring record array List;
eventTime: record device trigger time;
pin:pin;
areaName: area name;
cardNo: card no;
Response Result
devSn: device sn;
Description
verifyModeName: verification mode name;
eventName: transaction description;
eventPointName: transaction point name;
readerName: reader name;
devName: device name;
ZKBio CVSecurity API User Manual P a g e | 89
2.18.6Get Door Transaction by Pin [transaction/person/{pin}]
http://serverIP:serverPort/api/transaction/person/{pin}?pageNo
Post Request URL
=1&pageSize=20&access_token={apitoken}
Request Mode GET
Request Content None
PageNo: page no, required, the value must be greater than 0;
Request Parameter pageSize, the number of each page, required, must be greater
Description than 0, not more than 1000 per page;
pin: pin, required;
{
"code": 0,
"message": "success",
"data": [
{
"id": “402856aa6c17518e016c175385fd0001”,
"eventTime": "2017-08-04 15:59:12",
"pin": "",
"name": "",
"lastName": "",
Response Result "deptName": "",
"areaName": "area name",
"cardNo": "",
"devSn": "5662012052868",
"verifyModeName": "others",
"eventName": " enable device",
"eventPointName": "",
"readerName": "others",
"devName": "192.168.214.15",
"logId": 11734
},
ZKBio CVSecurity API User Manual P a g e | 90
{
"id": 5,
"eventTime": "2017-08-04 15:58:49",
"pin": "",
"name": "",
"lastName": "",
"deptName": "",
"areaName": "area name",
"cardNo": "",
"devSn": "5662012052868",
"verifyModeName": "others",
"eventName": "connect server successfully",
"eventPointName": "",
"readerName": "others",
"devName": "192.168.214.15",
"logId": 11733
}
]
}
data:transaction array list;
id:5;
eventTime: record device trigger time;
pin: pin;
name: name;
lastName: person name (English);
Response Result deptName: department name;
Description areaName: area name;
cardNo: card no;
devSn: device sn;
verifyModeName: verification mode name;
eventName: transaction description;
eventPointName: transaction point name;
readerName: reader name;
ZKBio CVSecurity API User Manual P a g e | 91
accZone: access area name;
devName: device name;
logId: transactionindex value, there will be a value if device
support it;
2.18.7Get Door Transaction by Pin (With total
number)[api/v2/transaction/person/{pin}]
http://serverIP:serverPort/api/v2/transaction/person/{pin}?page
Post Request URL
No=1&pageSize=20&access_token={apitoken}
Request Mode GET
Request Content None
personPin:personPin, [not required]
startDate：startDate, [not required]
Request Parameter endDate：endDate, [not required]
Description
PageNo: page no, required, the value must be greater than 0;
pageSize, the number of each page, required, must be greater
than 0, not more than 1000 per page;
{
"code": 0,
"message": "success",
"data": {
"page": 0,
"size": 2,
Response Result "total": 39,
"data": [{
"id": "8a888e2385a383f80185a4ccbe870037",
"eventTime": "2023-01-12 15:05:56",
"pin": "57",
"name": "",
"lastName": "",
ZKBio CVSecurity API User Manual P a g e | 92
"deptName": "Department Name",
"areaName": "Area Name",
"cardNo": "",
"devSn": "7633223440032",
"verifyModeName": "Face",
"eventName": "Normal Verify Open",
"eventPointName": "10.8.14.210-1",
"readerName": "10.8.14.210-1-Out",
"accZone": null,
"devName": "10.8.14.210",
"logId": 161,
"eventNo": 0,
"eventLevel": 0,
"doorName": "10.8.14.210-1",
"capturePhotoBase64": ""
},
{
"id": "8a888e2385a383f80185a4ccbe840036",
"eventTime": "2023-01-12 15:05:54",
"pin": "57",
"name": "",
"lastName": "",
"deptName": "Department Name",
"areaName": "Area Name",
"cardNo": "",
"devSn": "7633223440032",
"verifyModeName": "Face",
"eventName": "Normal Verify Open",
"eventPointName": "10.8.14.210-1",
"readerName": "10.8.14.210-1-Out",
"accZone": null,
"devName": "10.8.14.210",
"logId": 160,
"eventNo": 0,
ZKBio CVSecurity API User Manual P a g e | 93
"eventLevel": 0,
"doorName": "10.8.14.210-1",
"capturePhotoBase64": ""
}
],
"offset": 0,
"lastPage": false
}
}
data: result
page: the page number of the current request;
size: the number of data requested by the current page number;
total: total number;
data: transaction array list;
id: “402856aa6c032ca3016c03351d2600fd”;
eventTime: record device trigger time;
pin: pin;
name: person name;
lastName: person name, (English);
deptName: department name;
areaName: area name;
Response Result
Description cardNo: card no;
devSn: device sn;
verifyModeName: verification mode name;
eventName: transaction description;
eventPointName: transaction point name;
readerName: reader name;
devName: device name;
logId: transaction index value, there will be a value if device
support it;
eventNo: event number
eventLevel: event level
doorName: door name
capturePhotoBase64: captured photo of the door (base64)
ZKBio CVSecurity API User Manual P a g e | 94
2.18.8Get Personnel First In and Last Out record by Pin
[transaction/firstInAndLastOut/{pin}]
http://serverIP:serverPort/api/transaction/firstInAndLastOu
Post Request URL
t/{pin}?pageNo=1&pageSize=20&access_token={apitoken}
Request Mode GET
Request Content None
PageNo: page no, required, the value must be greater than 0;
pageSize, the number of each page, required, must be greater
than 0, not more than 1000 per page;
Request Parameter
Description pin: pin, required;
startDate：startDate, [not required]
endDate：endDate, [not required]
{
"code": 0,
"message": "success",
"data": [
{
"id": "40285ab374521d14017452820eb50005",
"pin": "147",
"name": "",
Response Result "lastName": "",
"readerNameIn":
"192.168.218.183-1-Out",
"firstInTime": "2020-09-03 13:48:07",
"readerNameOut": null,
"lastOutTime": null,
"deptCode": "1",
"deptName": "Department Name"
}
ZKBio CVSecurity API User Manual P a g e | 95
]
}
data:transaction array list;
id:5;
pin: pin;
name: name;
lastName: person name (English);
Response Result deptCode：department code；
Description
deptName: department name;
readerNameIn：First In reader name；
firstInTime：First In Time;
readerNameOut：Last Out reader name；
lastOutTime：Last Out Time；
2.18.9Get Personnel First In and Last Out record by Pin(With total number)
[api/v2/transaction/firstInAndLastOut/{pin}]
http://serverIP:serverPort/api/v2/transaction/firstInAndLastOut/{
Post Request URL
pin}?pageNo=1&pageSize=20&access_token={apitoken}
Request Mode GET
Request Content None
PageNo: page no, required, the value must be greater than 0;
pageSize, the number of each page, required, must be greater
than 0, not more than 1000 per page;
Request Parameter
Description pin: pin, required;
startDate：startDate, [not required]
endDate：endDate, [not required]
{
"code": 0,
Response Result
"message": "success",
"data": {
ZKBio CVSecurity API User Manual P a g e | 96
"page": 0,
"size": 2,
"total": 1,
"data": [{
"id": "8a888e238599329401859ae866b4005d",
"pin": "50",
"name": "",
"lastName": "",
"readerNameIn": "10.8.14.142-1-Out",
"firstInTime": "2012-11-04 00:05:58",
"readerNameOut": "10.8.14.142-1-Out",
"lastOutTime": "2012-11-04 03:11:52",
"deptCode": "1",
"deptName": "Department Name"
}],
"offset": 0,
"lastPage": true
}
}
data: result
page: the page number of the current request;
size: the number of data requested by the current page number;
total: total number;
data:transaction array list;
id:5;
Response Result pin: pin;
Description name: name;
lastName: person name (English);
deptCode：department code；
deptName: department name;
readerNameIn：First In reader name；
firstInTime：First In Time;
readerNameOut：Last Out reader name；
ZKBio CVSecurity API User Manual P a g e | 97
lastOutTime：Last Out Time；
2.18.10 Obtain door transaction, daily transaction, personnel access
transactions [transaction/getDoorTransactions]
http://serverIP:serverPort/api/transaction/getDoorTransacti
Post Request URL
ons?access_token={apitoken}
Request Mode POST
{
"devSn": "5662012052868",
"startTime": "2021-11-19 18:00:00"",
"endTime": "2021-11-19 18:00:00",
"filter": "Name",
Request Content "type": "normal",
"eventNo": "0",
"personPin": "320022",
"pageNo": "1",
"pageSize": "100",
}
devsn: Device Serial Number [Not required]
startTime:Start Time [Not required]
endTime: End Time [Not required]
filter: Filter conditions [Not required, filter by name, last name,
PIN] (Fuzzy query)
Request Parameter
type: Event Type [Not required, alarm events, normal event,
Description
warning events]
eventNo: Events Number [Not required]
personPin: personnel ID number[Not required] [Accurate Query]
page: page number
pageSize: record number of current page
ZKBio CVSecurity API User Manual P a g e | 98
{
"ret": "ok",
"msg": "operation succeed",
"data": [
{
"id": "402856a7695c716301695c81290d0006",
"eventNo": 8,
"eventName": "remote opening",
"eventTime": "2019-03-08 16:52:38",
"doorName": "192.168.214.197-1",
"personPin": "",
"personName": "",
"areaName": "Area Name",
"personLastName": "",
"eventLevel": "0"
},
Response Result {
"id": "402856a7695c716301695c7fe7620004",
"eventNo": 8,
"eventName": "remote opening",
"eventTime": "2019-03-08 16:51:14",
"doorName": "192.168.214.197-1",
"personPin": "",
"personName": "",
"areaName": "Area Name",
"personLastName": "",
"eventLevel": "0"
}
],
"i18nArgs": null,
"page": 1,
"pageSize": 10,
"total": 2,
ZKBio CVSecurity API User Manual P a g e | 99
"success": true
}
{
"ret": "fail",
"msg": "failed info",
"data": null,
"i18nArgs": null
}
data: transaction array list；
Id: event id
Response Result eventNo: event number
Description eventName: event name
eventTime: event time
eventLevel: 0 normal 1 warning 2 alarm
2.18.11 Obtain door transaction, daily transaction, personnel access
transactions(With total number)
[api/v2/transaction/getDoorTransactions]
http://serverIP:serverPort/api/v2/transaction/getDoorTransactio
Post Request URL
ns?access_token={apitoken}
Request Mode POST
"content": {
"devSn": "7633223440032",
"startTime": "2023-1-13 18:00:00",
"endTime": "2023-1-14 18:00:00",
Request Content "filter": "",
"type": "normal",
"eventNo": "0",
"personPin": "59",
"pageNo": "1",
ZKBio CVSecurity API User Manual P a g e | 100
"pageSize": "2"
}
devsn: Device Serial Number [Not required]
startTime:Start Time [Not required]
endTime: End Time [Not required]
filter: Filter conditions [Not required, filter by name, last name,
PIN] (Fuzzy query)
Request Parameter
type: Event Type [Not required, alarm events, normal event,
Description
warning events]
eventNo: Events Number [Not required]
personPin: personnel ID number[Not required] [Accurate Query]
page: page number
pageSize: record number of current page
{
"ret": "ok",
"msg": "Operation Succeed",
"data": {
"page": 0,
"size": 2,
"total": 2,
"data": [{
"id": "8a888e2385adc3af0185af769dab0031",
"eventTime": "2023-01-14 16:47:36",
Response Result "pin": "59",
"name": "",
"lastName": "",
"deptName": "Department Name",
"areaName": "Area Name",
"cardNo": "",
"devSn": "7633223440032",
"verifyModeName": "Palm",
"eventName": "Normal Verify Open",
"eventPointName": "10.8.14.210-1",
"readerName": "10.8.14.210-1-Out",
ZKBio CVSecurity API User Manual P a g e | 101
"accZone": null,
"devName": "10.8.14.210",
"logId": 167,
"eventNo": 0,
"eventLevel": 0,
"doorName": "10.8.14.210-1",
"capturePhotoBase64": ""
},
{
"id": "8a888e2385adc3af0185af769d9b0030",
"eventTime": "2023-01-14 16:47:35",
"pin": "59",
"name": "",
"lastName": "",
"deptName": "Department Name",
"areaName": "Area Name",
"cardNo": "",
"devSn": "7633223440032",
"verifyModeName": "Face",
"eventName": "Normal Verify Open",
"eventPointName": "10.8.14.210-1",
"readerName": "10.8.14.210-1-Out",
"accZone": null,
"devName": "10.8.14.210",
"logId": 166,
"eventNo": 0,
"eventLevel": 0,
"doorName": "10.8.14.210-1",
"capturePhotoBase64": ""
}
],
"offset": 0,
"lastPage": true
},
ZKBio CVSecurity API User Manual P a g e | 102
"i18nArgs": null,
"success": true
}
{
"ret": "fail",
"msg": "failed message",
"data": null,
"i18nArgs": null
}
data: result
page: the page number of the current request;
size: the number of data requested by the current page number;
total: total number;
data: transaction array list;
id: “402856aa6c032ca3016c03351d2600fd”;
eventTime: record device trigger time;
pin: pin;
name: person name;
lastName: person name, (English);
deptName: department name;
areaName: area name;
Response Result
Description cardNo: card no;
devSn: device sn;
verifyModeName: verification mode name;
eventName: transaction description;
eventPointName: transaction point name;
readerName: reader name;
devName: device name;
logId: transaction index value, there will be a value if device
support it;
eventNo: event number
eventLevel: event level
doorName: door name
capturePhotoBase64: captured photo of the door (base64)
ZKBio CVSecurity API User Manual P a g e | 103
2.18.12 Get Doors transaction details [transaction/getDoorTransactionDetail]
http://serverIP:serverPort/api/transaction/getDoorTransacti
Post Request URL
onDetail?access_token={apitoken}
Request Mode POST
{
Request Content "id": "402856a7695c716301695c81290d0006",
}
{
"content":{
Request Parameter
id：event ID
Description
}
}
{
"ret": "ok",
"msg": "operation succeed",
"data": {
"id": "402856a7694641ff0169468394b2000d",
"eventNo": 8, event id
"eventName": "remote opening", event name
"eventTime": "2019-03-04 10:23:40", event time
"doorName": null, door name
Response Result
"personPin": null, personnel ID
"personName": null, First Name
"areaName": "Area 1", Area Name
"personLastName": null, Last Name
"devName": "192.168.214.197", Device Name
"cardNo": null, Card Number
"readerName": "others", reader name
"verifyModeName": "others" Verification mode
},
ZKBio CVSecurity API User Manual P a g e | 104
"i18nArgs": null,
"success": true
}
{
"ret": "fail",
"msg": "failed info",
"data": null,
"i18nArgs": null
}
data:transaction array list;
id: event id;
Response Result
eventNo: event number
Description
eventName: event name
eventTime: event time
2.18.13 Get Access transactions by event id [api/transaction/getById/{id}]
http://serverIP:serverPort/api/transaction/getById/{id}?access_to
Post Request URL
ken={apitoken}
Request Mode GET
Request Content None
Request Parameter id: event id, required; eg:
Description “8a888e8f83f376e50183f4019fb70bcf”
{
"code": 0,
"message": "success",
"data": {
Response Result "id": "8a888e8f83f376e50183f4019fb70bcf",
"eventTime": "2022-10-17 17:53:22",
"pin": "2210174",
"name": "Leo",
"lastName": "Hou",
ZKBio CVSecurity API User Manual P a g e | 105
"deptName": "RD",
"areaName": "Area",
"cardNo": "",
"devSn": "CJI2194860001",
"verifyModeName": "Face",
"eventName": "Normal Verify Open",
"eventPointName": "10.8.14.181-1",
"readerName": "10.8.14.181-1-出",
"accZone": null,
"devName": "10.8.14.181",
"logId": 4521,
"eventNo": 0,
"eventLevel": 0,
"doorName": "10.8.14.181-1",
"capturePhotoBase64": "/9j/4AAQSkZJRgAB..."
}
}
id: “402856aa6c032ca3016c03351d2600fd”;
eventTime: record device trigger time;
pin: pin;
name: person name;
lastName: person name, (English);
deptName: department name;
areaName: area name;
cardNo: card no;
Response Result
Description devSn: device sn;
verifyModeName: verification mode name;
eventName: transaction description;
eventPointName: transaction point name;
readerName: reader name;
devName: device name;
logId: transaction index value, there will be a value if device
support it;
eventNo: event number
ZKBio CVSecurity API User Manual P a g e | 106
eventLevel: event level
doorName: door name
capturePhotoBase64: captured photo of the door (base64)
2.19 Elevator Transaction Interface
2.19.1Get Elevator Transaction [eleTransaction/list]
http://serverIP:serverPort/api/eleTransaction/list?pageNo=1&pa
Post Request URL
geSize=20&access_token={apitoken}
Request Mode GET
Request Content None
personPin:personPin, [not required]
startDate:startDate, [not required]
endDate:endDate, [not required]
Request Parameter
Description PageNo: page no, required, the value must be greater than 0;
pageSize, the number of each page, required, must be greater
than 0, not more than 1000 per page;
{
"code": 0,
"message": "success",
"data": [
{
Response Result "id": “402856aa6c1778b3016c1a695c860013”,
"eventTime": "2017-08-04 15:59:12",
"pin": "",
"name": "",
"lastName": "",
"deptName": "",
ZKBio CVSecurity API User Manual P a g e | 107
"areaName": "area name",
"cardNo": "",
"devSn": "5662012052868",
"verifyModeName": "others",
"eventName": "enable device",
"eventPointName": "",
"readerName": "others",
"accZone": null,
"devName": "192.168.214.15",
"logId": 11734
},
{
"id": 402856aa6c1778b3016c1a695c860016,
"eventTime": "2017-08-04 15:58:49",
"pin": "",
"name": "",
"lastName": "",
"deptName": "",
"areaName": "areaname",
"cardNo": "",
"devSn": "5662012052868",
"verifyModeName": "others",
"eventName": "connect server successfully",
"eventPointName": "",
"readerName": "others",
"devName": "192.168.214.15",
"logId": 11733
}
]
}
data: transaction array list;
Response Result
id: 5;
Description
eventTime: record device trigger time;
ZKBio CVSecurity API User Manual P a g e | 108
pin: pin;
name: name;
lastName: person name (English);
deptName: department name;
areaName: area name;
cardNo: card no;
devSn: device sn;
verifyModeName: verification mode name;
eventName: transaction description;
eventPointName: transaction point name;
readerName: reader name;
devName: device name;
logId: transaction index value, there will be a value if device
support it;
2.19.2Get Elevator Transaction(With total number)
[api/v2/eleTransaction/list]
http://serverIP:serverPort/api/v2/eleTransaction/list?personPin=
Post Request URL {personPin}&startDate={startDate}&endDate={endDate}&pageN
o=1&pageSize=20&access_token={apitoken}
Request Mode GET
Request Content None
personPin:personPin, [not required]
startDate:startDate, [not required]
Request Parameter endDate:endDate, [not required]
Description PageNo: page no, required, the value must be greater than 0;
pageSize, the number of each page, required, must be greater
than 0, not more than 1000 per page;
{
"code": 0,
Response Result
"message": "success",
"data": {
ZKBio CVSecurity API User Manual P a g e | 109
"page": 1,
"size": 2,
"total": 2,
"data": [{
"id":“402856 aa6c1778b3016c1a695c860013”,
"eventTime": "2017-08-04 15:59:12",
"pin": "",
"name": "",
"lastName": "",
"deptName": "",
"areaName": "Area",
"cardNo": "",
"devSn": "5662012052868",
"verifyModeName": "Other",
"eventName": "Device Started",
"eventPointName": "",
"readerName": "Other",
"accZone": null,
"devName": "192.168.214.15",
"logId": 11734
},
{
"id":“402856 aa6c1778b3016c1a695c860016”,
"eventTime": "2017-08-04 15:58:49",
"pin": "",
"name": "",
"lastName": "",
"deptName": "",
"areaName": "Area",
"cardNo": "",
"devSn": "5662012052868",
"verifyModeName": "Other",
"eventName": "Connect to Server",
"eventPointName": "",
ZKBio CVSecurity API User Manual P a g e | 110
"readerName": "Other",
"devName": "192.168.214.15",
"logId": 11733
}
],
"offset": 1,
"lastPage": true
}
}
data: result
page: the page number of the current request;
size: the number of data requested by the current page number;
total: total number;
data: event record array collection;
id: "402856aa6c1778b3016c1a695c860016",
eventTime: recording device trigger time;
pin: personnel number;
name: name of the personnel;
lastName: the name of the personnel, only useful in English;
Response Result
Description deptName: department name;
areaName: area name;
cardNo: card number;
devSn: device serial number;
verifyModeName: verify mode name;
eventName: event description;
eventPointName: event departure point name;
readerName: name of the reader head;
devName: device name;
logId: event index value, only have value according to whether
the device supports it or not;
ZKBio CVSecurity API User Manual P a g e | 111
2.20 Park Transaction Interface
2.20.1Get Car Entry/Exit record pictures
[parkTransaction/getParkRecordPicture]
http://serverIP:serverPort/api/parkTransaction/getParkRecordPic
Post Request URL ture?recordId={recordId}&recordType={recordType}&access_tok
en={apitoken}
Request Mode GET
Request Content None
Request Parameter recordId: Car entry/exit records ID number, [Required];
Description recordType: Car Enty/Exit park lot, [Required], 1: Entry 2: Exit
{
"code": 0,
"message": "success",
Response Result
"data":”/9j/4AAQSkZJRgABAQAAAQABAAD/2wDFAAMCAgMCA
gMDAwMEAwMEBQgFBQQEB=”
}
Response Result
data: Picture , base 64;
Description
2.20.2Get Park Check-in Transaction [parkTransaction/listParkRecordin]
http://serverIP:serverPort/api/v2/parkTransaction/listParkRecord
Post Request URL
in?pageNo=1&pageSize=20&access_token={apitoken}
Request Mode GET
Request Content None
Request Parameter carNumber:carNumber, [not required]
ZKBio CVSecurity API User Manual P a g e | 112
Description startDate:startDate, [not required]
endDate:endDate, [not required]
PageNo: page no, required, the value must be greater than 0;
pageSize, the number of each page, required, must be greater
than 0, not more than 1000 per page;
{
"code": 0,
"message": "success",
"data": [
{
"id": “402856aa6c1778b3016c1a695c860016”,
"parkAreaName": " park area",
"name": " driver name",
"carNumber": "car licence plate number",
"carTypeName": "car type",
"channelName": "channel name",
"channelState": " in and out state",
"eventType": "transaction type",
"checkInTime": "check-in time"
Response Result
},
{
"id": “402856aa6c1778b3016c1a695c860018”,
"parkAreaName": "park area",
"name": " driver name",
"carNumber": "car licence plate number",
"carTypeName": "car type",
"channelName": "channel name",
"channelState": "in and out state",
"eventType": "transactiontype",
"checkInTime": "check-in time"
}
]
}
ZKBio CVSecurity API User Manual P a g e | 113
data: transaction array list;
id: “402856aa6c1778b3016c1a695c860018”,
parkAreaName: park area;
name: driver name;
Response Result carNumber: car licence plate number;
Description carTypeName: car type;
channelName: channel name;
channelState: in and out state;
eventType: transaction type;
checkInTime: check-in time
2.20.3Get park Check-Out Transaction[parkTransaction/listParkRecordout]
http://serverIP:serverPort/api/v2/parkTransaction/listParkRecord
Post Request URL
out?pageNo=1&pageSize=20&access_token={apitoken}
Request Mode GET
Request Content None
carNumber:carNumber, [not required]
startDate:startDate, [not required]
Request Parameter endDate:endDate, [not required]
Description PageNo: page no, required, the value must be greater than 0;
pageSize, the number of each page, required, the value must be
greater than 0, not more than 1000 per page;
{
"code": 0,
"message": "success",
"data": [
Response Result {
"id": “402856aa6c1778b3016c1a695c860018”,
"parkAreaName": "park area",
"name": "driver name",
"carNumber": "car licence plate number",
ZKBio CVSecurity API User Manual P a g e | 114
"carTypeName": " car type",
"channelName": "channel name",
"channelState": "in and out state",
"eventType": "transaction type",
"checkOutTime": "check-out time"
},
{
"id": “402856aa6c1e1def016c1e2073e80001”,
"parkAreaName": "park area",
"name": "driver name",
"carNumber": "car licence plate number",
"carTypeName": "car type",
"channelName": "channel name",
"channelState": "in and out state",
"eventType": "transaction type",
"checkOutTime": "check-out time"
}
]
}
data: transaction array list;
id: “402856aa6c1e1def016c1e2073e80001”,
parkAreaName: park area;
name: driver name;
Response Result carNumber: car licence plate number;
Description carTypeName: car type;
channelName: channel name;
channelState: in and out state;
eventType: transaction type;
checkOutTime: check-out time
ZKBio CVSecurity API User Manual P a g e | 115
2.21 Att Transaction Interface
2.21.1Get Att Transaction [transaction/listAttTransaction]
http://serverIP:serverPort/api/transaction/listAttTransaction?pag
Post Request URL
eNo=1&pageSize=20&access_token={apitoken}
Request Mode GET
Request Content None
personPin:personPin, [not required]
startDate:startDate, [not required]
Request Parameter endDate:endDate, [not required]
Description PageNo: page no, required, the value must be greater than 0;
pageSize, the number of each page, required, the value must be
greater than 0, not more than 1000 per page;
{
"code": 0,
"message": "success",
"data": [
{
"id": “402856aa6c3c5063016c3cb5a88f001b”,
"eventTime": "2017-08-04 15:59:12",
"pin": "",
"name": "",
Response Result
"lastName": "",
"deptName": "",
"areaName": "areaname",
"cardNo": "",
"devSn": "5662012052868",
"verifyModeName": "others",
"eventName": "enable device",
"eventPointName": "",
"readerName": "others",
ZKBio CVSecurity API User Manual P a g e | 116
"accZone": null,
"devName": "192.168.214.15",
"logId": 11734
},
{
"id": “402856aa6c3c5063016c3cb5f7150021”,
"eventTime": "2017-08-04 15:58:49",
"pin": "",
"name": "",
"lastName": "",
"deptName": "",
"areaName": "areaname",
"cardNo": "",
"devSn": "5662012052868",
"verifyModeName": "others",
"eventName": " connected to the server successfully",
"eventPointName": "",
"readerName": "others",
"accZone": null,
"devName": "192.168.214.15",
"logId": 11733
}
]
}
data: transaction array List;
id: “402856aa6c3c5063016c3cb5cfa2001d”;
eventTime: Record device trigger time;
pin: pin;
Response Result
name: name;
Description
lastName: person name (English);
deptName: department name;
areaName: area name;
cardNo: card no;
ZKBio CVSecurity API User Manual P a g e | 117
devSn: device sn;
verifyModeName: verification mode name;
eventName: transaction description;
eventPointName: transaction point name;
readerName: reader name;
accZone: access area name;
devName: device name;
logId: transaction index value, there will be a value if device
support it;
ZKBio CVSecurity API User Manual P a g e | 118
2.22 Att Device Interface
2.22.1 Get Att Device [device/getAtt]
http://serverIP:serverPort/api/device/getAtt?sn={sn}&ac
Post Request URL
cess_token={apitoken}
Request Mode GET
Request Content None
Request Parameter
sn: Device Serial Number,[required]
Description
{
"code": 0,
"message": "success",
"data": {
"id": "402856aa6c3bbde1016c3bc210d90016",
"sn": "CEXB193160012",
Response Result
"name": "CEXB193160012",
"type": "ZK-S1007",
"status": "0",
"module": "att"
}
}
data: Device object;
id: Device id；
sn: Device Serial Number；
Response Result name: Device Name；
Description
type: Device Model Name；
statu: Device Status, 1 Enable, 0 Disabled;
module: Module, acc AccessControl, att Attendance, ele
Elevator；
ZKBio CVSecurity API User Manual P a g e | 119
2.23 Apply for abnormal attendance
2.23.1Apply for Re-clock-in
http://serverIP:serverPort/api/attApply/applySign?access_token
Post Request URL ={apitoken}
POST
Request Mode
{
"personPin": 1,
"remark": "api",
Request Content
"signDatetime": "2021-11-19 18:00:00"
personPin (string): personal number
Request Parameter remark (string): remarks
Description
signDatetime(string): Re-clock-in time
"code":0,
"message":"success",
Response Result
"data":null
Response Result
Description
2.23.2 Apply for overtime
http://serverIP:serverPort/api/attApply/applyOvertime?access_t
Post Request URL
ZKBio CVSecurity API User Manual P a g e | 120
oken={apitoken}
POST
Request Mode
{
"endDatetime": "2021-11-19 18:00:00",
"personPin": 1,
Request Content
"remark": "api",
"startDatetime": "2021-11-19 13:00:00"
endDatetime (string): End Time
personPin (string): Personal Number
Request Parameter
Description remark (string): Remarks
startDatetime (string): start time
"code":0,
"message":"success",
Response Result
"data":null
Response Result
Description
2.23.3 Ask for leave
http://serverIP:serverPort/api/attApply/applyLeave?access_token
Post Request URL ={apitoken}
POST
Request Mode
ZKBio CVSecurity API User Manual P a g e | 121
{
"endDatetime": "2021-11-19 18:00:00",
"leaveImagePath": "string",
"leaveTypeNo": "L1",
Request Content
"personPin": 1,
"remark": "api",
"startDatetime": "2021-11-19 13:00:00"
endDatetime (string):End time
leaveImagePath (string):
Leave photo path（For details/api/attApply/uploadLeaveImage）
leaveTypeNo (string):
Request Parameter
Description Leave type number(For details/api/attApply/getLeaveTypeList）
personPin (string): Personal number
remark (string): Remark
startDatetime (string): Start time
"code":0,
"message":"success",
Response Result
"data":null
Response Result
ZKBio CVSecurity API User Manual P a g e | 122
Description
2.23.4 Get leave type list
http://serverIP:serverPort/api/attApply/getLeaveTypeList?access
Post Request URL _token={apitoken}
GET
Request Mode
Request Content
Request Parameter
Description
{
"code": 0,
"message": "success",
"data": [{
"leaveTypeNo": "L1",
"leaveTypeName": "personal leave"
},
Response Result
{
"leaveTypeNo": "L2",
"leaveTypeName": "marriage leave"
leaveTypeNo: Leave type number
Response Result
Description leaveTypeName: Leave type name
ZKBio CVSecurity API User Manual P a g e | 123
2.23.5 Upload leave picture
http://serverIP:serverPort/api/attApply/uploadLeaveImage?acce
Post Request URL ss_token={apitoken}
POST
Request Mode
{
"base64Image": "base64Image"
Request Content
}
base64Image (string): picture Base64code
Request Parameter
Description
{
"code":0,
"message":"success",
Response Result
"data":"/fileresource/att/leave/image/2021-12-03/1638503394
663.jpg"
Response Result data：picture path
Description
2.23.6 Calculate the total duration of leave
http://serverIP:serverPort/api/attApply/getApplyTimeLong?acce
Post Request URL ss_token={apitoken}
POST
Request Mode
{
Request Content
ZKBio CVSecurity API User Manual P a g e | 124
"endDatetime": "2021-11-19 18:00:00",
"leaveImagePath": "string",
"leaveTypeNo": "L1",
"personPin": 1,
"remark": "api",
"startDatetime": "2021-11-19 13:00:00"
endDatetime (string): End time
leaveImagePath (string, optional):
Leave photo path（For details/api/attApply/uploadLeaveImage）
leaveTypeNo (string):
Request Parameter
Description Leave type number（For details/api/attApply/getLeaveTypeList）
personPin (string): personal number
remark (string,): Remark
startDatetime (string): Start time
{ "code": 0, "message": "success", "data": null }
Response Result
Response Result
Description
ZKBio CVSecurity API User Manual P a g e | 125
2.24 Edit Attendance personnel information
2.24.5 Edit Personal information
http://serverIP:serverPort /api/attPerson/editAttPerson?access_t
Post Request URL oken={apitoken}
POST
Request Mode
{
"isAttendance": false,
"perDevAuth": 0,
Request Content
"personPin": 1,
"verifyMode": 0
isAttendance (boolean): Attendance or not（true is Yes、false is
Not）
perDevAuth (integer):
Device operation authority（0 is opdinary person、2 is registrar、
6 is administrators 、14 is super administrators）
Request Parameter
Description
personPin (string):personal number
verifyMode (integer):
Verification method（0=Automatic recognition、1=Fingerprint
only 、 2=User ID only 、 3=Password only 、 4=Card only 、
5=Fingerprint or password、6=Fingerprint or card、7=Card or
ZKBio CVSecurity API User Manual P a g e | 126
password 、 8=User ID and fingerprint 、 9=Fingerprint and
password、10=Card and fingerprint、11=Card and password、
12=Fingerprint and password and card 、 13=User ID and
fingerprint and password、14=(User ID and fingerprint)or(card
and fingerprint)、15=Face、16=Face and fingerprint、17=Face
and password、18=Face and card、19=Face and fingerprint and
password、20=Face and fingerprint and password、21=Finger
vein、22=Finger vein and password、23=Finger vein and card、
24=Finger vein and password and card 、 25=Palm prints 、
26=Palm prints and card、27=Palm prints and face、28=Palm
prints and fingerprint 、 29=Palm prints and fingerprint and
face）
{ "code": 0, "message": "success", "data": null }
Response Result
Response Result
Description
ZKBio CVSecurity API User Manual P a g e | 127
2.25 Person BioTemplate Interface
2.25.1 Add Personnel BioTemplate
http://serverIP:serverPort/api/bioTemplate/add?access_token={
Post Request URL
apitoken}
Request Mode Post
{
"personId": "666",
"validType": "1",
Request Content
"template": "fsfsfsfsfsfsfsfsfsfsfsfsfsfsfs",
"templateNo": "3"
}
personId: personnel ID, required;
Request Parameter validType: 1:common, 3:duress, required;
Description Template: personnel fingerprint template, required;
templateNo: finger number, required,range[0-9];
{
"code": 0,
Response Result "message": "success",
"data": null
}
Response Result
public response parameter description
Description
2.25.2 Delete By PersonId And TemplateNo
http://serverIP:serverPort/api/bioTemplate/getFgListByPin/{pin}?acc
Post Request URL
ess_token={apitoken}
Request Mode Delete
ZKBio CVSecurity API User Manual P a g e | 128
Request Content none
Request Parameter pin: personnel ID, required;
Description templateNo: finger number, required, range[0-9];
{
"code": 0,
Response Result "message": "success",
"data": null
}
Response Result
public response parameter description
Description
2.25.3 Delete Personnel BioTemplate By PersonId
http://serverIP:serverPort/api/bioTemplate/deleteById/*?access
Post Request URL
_token={apitoken}&pin={personnelID}
Request Mode Delete
Request Content none
Request Parameter
pin: personnel ID, required;
Description
{
"code": 0,
Response Result "message": "success",
"data": null
}
Response Result
public response parameter description
Description
ZKBio CVSecurity API User Manual P a g e | 129
2.25.4 Get Personnel BioTemplate By PersonId
http://serverIP:serverPort/api/bioTemplate/getFgListByPin/{pin}
Post Request URL
?access_token={apitoken}
Request Mode Get
Request Content none
Request Parameter
pin: personnel ID, required;
Description
{
"code": 0,
"message": "success",
"data": [
{
"id": 2,
"personId": "666",
"validType": 1,
"bioType": 1,
Response Result "version": "10",
"template": "fsfsfs",
"templateNo": "3",
"templateNoIndex": 0
},
{
"id": 3,
"personId": "666",
"validType": 1,
"bioType": 1,
ZKBio CVSecurity API User Manual P a g e | 130
"version": "10",
"template": "fsfsfstt",
"templateNo": "5",
"templateNoIndex": 0
}
]
}
id: dataBase table personnel fingerprint template id;
personId: personnel ID;
validType: 1:common, 3:duress;
Response Result bioType: 1:common, 2:fingerprint;
Description version: fingerprint version
template: personnel fingerprint template;
templateNo: finger number;
templateNoIndex: fingerprintNo index;
ZKBio CVSecurity API User Manual P a g e | 131
2.26 Temperature transactions Interface
2.26.1 Get Hep Transaction [api/hep/transaction/list]
http://serverIP:serverPort/api/hep/transaction/list?personPin={perso
Post Request URL nPin}&startDate={startDate}&endDate={endDate}&pageNo=1&pageSi
ze=20&access_token={apitoken}
Request Mode GET
Request Content None
personPin: Pin（Not required）
startDate: StartTime（Not required, query by time, work with
endtime）
Request Parameter endDate: EndTime（Not required，query by time, work with
Description starttime）
PageNo: page no, required, the value must be greater than 0;
pageSize: the number of each page, required, the value must be
greater than 0, not more than 1000 per page;
{
"code": 0,
"message": "success",
"data": [
{
"id": "402855a6723b91d101723b9e3edf0004",
"eventTime": "2020-05-22 17:01:50",
Response Result "pin": "0",
"name": "UnregisterUser",
"lastName": "",
"deptName": "NULL",
"areaName": "Area Name",
"cardNo": null,
"devSn": "CKJF201260077",
"verifyModeName": null,
ZKBio CVSecurity API User Manual P a g e | 132
"eventName": "acc_newEventNo_68",
"eventPointName": "",
"readerName": null,
"accZone": null,
"devName": "192.168.213.160",
"logId": null,
"eventNumber": "511",
"photoPath":
"/upload/event/photo/CKJF201260077/20200522170150.jpg",
"maskFlag": "1",
"temperature": 36.56,
"status": "Normal"
},
}
data： transaction array list;
id：”402856aa6c3c5063016c3cb5cfa2001d”；record id
eventTime： Record device trigger time;
pin：pin；
name： name；
lastName： person name (English);
deptName：department name;
areaName：area name;
cardNo：card no;
Response Result
Description devSn：device sn;
verifyModeName：verification mode name;
eventName：transaction description;
eventPointName：transaction point name;
readerName：reader name;
accZone：access area name;
devName：device name;
logId：transaction index value, there will be a value if device
support it;
eventNumber：event record number
ZKBio CVSecurity API User Manual P a g e | 133
photoPath：Instant capture photo storage path
maskFlag：weather wear a mask (0: unmasks, 1: wear mask, Null:
Undetected)
temperature：temperature
status：body temperature status（normal，abnormal，
unmeasured）
2.26.2 Get Mask and Temperature Real-Time Monitor events
[api//hep/transaction/monitor]
http://serverIP:serverPort/api/hep/transaction/monitor?tim
Post Request URL
estamp={timestamp}&access_token={apitoken}
Request Mode GET
Request Content None
Timestamp: Timestamp, millisecond, such as 1494467276539,
required; Access frequency cannot be too high, it is
Request Parameter
recommended to obtain at least 10 seconds or more; there is no
Description
need to change after timestamp value set the first request, it is
allowed to keep using the first request
{
"code": 0,
"message": "success",
"data": [{
"id": "",
"eventTime": "2020-07-03 16:57:16",
Response Result "pin": "1",
"name": "seven",
"lastName": "wu",
"deptName": "Department Name",
"areaName": "Area Name",
"cardNo": null,
"devSn": "CKJF201260077",
ZKBio CVSecurity API User Manual P a g e | 134
"eventName": "Normal Verify Open",
"eventPointName": "192.168.218.202-1",
"devName": "192.168.218.202",
"eventNumber": "315",
"photoPath":
"/upload/event/photo/CKJF201260077/20200703165716-1.jpg",
"maskFlag": "1",
"temperature": 36.6,
"status": "Normal"
}]
}
data： transaction array list;
id：”empty”；There has empty event id in real time monitor.
eventTime： Record device trigger time;
pin：pin；
name： name；
lastName： person family name (English);
deptName：department name;
areaName：area name;
cardNo：card no;
Response Result devSn：device sn;
Description
eventName：transaction description;
eventPointName：transaction point name;
devName：Device name;
eventNumber：event record number;
photoPath：Instant capture photo storage path;
maskFlag：weather wear a mask (0: unmasks, 1: wear mask, Null:
Undetected)
temperature：temperature
status：body temperature status（normal，abnormal，
unmeasured）
ZKBio CVSecurity API User Manual P a g e | 135
2.27 Edit FaceKiosk Personal information
2.27.1 Edit Personal information
http://serverIP:serverPort /api/attPerson/editInsPerson?access_t
Post Request URL oken={apitoken}
POST
Request Mode
{
"category": 0,
"perDevAuth": 0,
Request Content
"personPin": 1
category (string): ID category（0=Ordinary staff、1VIP、=Blacklist）
perDevAuth (integer): Device operation authority（ 0=Ordinary
Request Parameter
Description staff,14=super administrators ）
personPin (string): Personal number
{ "code": 0, "message": "success", "data": null }
Response Result
ZKBio CVSecurity API User Manual P a g e | 136
2.28 FaceKiosk Area Personal
2.28.1Delete Area Personnel
http://serverIP:serverPort/api/insAreaPerson/delAreaPerson?acc
Post Request URL ess_token={apitoken}
POST
Request Mode
{
"code": 1,
Request Content
"pins": "1,2,3"
code(string): Area code (For
details/api/insAreaPerson/getAreaList)
Request Parameter
Description pins (string): Personnel number collection(Multiple personnel
are separated by ',')
"code":0,
"message":"success",
Response Result
"data": null
Response Result
Description
ZKBio CVSecurity API User Manual P a g e | 137
2.28.2Add Area Personnel
http://serverIP:serverPort/api/insAreaPerson/setAreaPerson?acc
Post Request URL ess_token={apitoken}
POST
Request Mode
{
"code": 1,
Request Content
"pins": "1,2,3"
code (string): Area code(For
details/api/insAreaPerson/getAreaList)
Request Parameter
Description pins (string): personnel number collection(Multiple personnel
are separated by ',')
"code":0,
"message":"success",
Response Result
"data": null
Response Result
Description
2.28.3 Get a list of attendance zones
http://serverIP:serverPort/api/insAreaPerson/getAreaList?pageN
Post Request URL o=1&pageSize=10&access_token={apitoken}
ZKBio CVSecurity API User Manual P a g e | 138
GET
Request Mode
Request Content
Request Parameter
Description
{
"code":0,
"message":"success",
"data": [
{ "id": "402855b27d4b9eb4017d4ba051690002",
Response Result
"code": "1",
"name": "Area name"
}]
id: Area ID
Response Result code: Area code
Description
name: Area name
ZKBio CVSecurity API User Manual P a g e | 139
2.29 FaceKiosk Device Interface
2.29.1 Get Facekiosk device list [api/device/attAdDeviceList]
http://serverIP:serverPort/api/device/attAdDeviceList?page
Post Request URL
No=1&pageSize=20&access_token={apitoken}
Request Mode GET
Request Content None
pageNo: pageno, required, the value must be greater than0;
Request Parameter
Description pageSize: the number of each page, required, must be greater
than 0
{
"code": 0,
"message": "success",
"data": [
{
"id": "402848327562dedd01756d555c726227",
"sn": "6271203100008",
"name": "FaceKiosk-1",
"type": "Robot-Pad",
"status": "1",
Response Result "module": "ins"
},
{
"id": "4028483274b4eeb40174d3e117bf4329",
"sn": "174559110004",
"name": "174559110004",
"type": "ZK-S1050",
"status": "1",
"module": "ins"
}
]
ZKBio CVSecurity API User Manual P a g e | 140
}
Data: device array list;
Id: device id;
Sn: device sn;
Response Result
Description Name: device name;
state: device state, 1 enabled, 0 disabled;
Module: module, acc- Access, att-Attendance,ele- Elevator,
ins-FaceKiosk;
ZKBio CVSecurity API User Manual P a g e | 141
2.30 Entrance Control Device Interface
2.30.1 Get entrance control device list [api/psgdDvice/list]
http://serverIP:serverPort/api/psgDevice/list?pageNo=1&page
Post Request URL
Size=20&access_token={apitoken}
Request Mode GET
Request Content None
Request Parameter pageNo: pageno, required, the value must be greater than0;
Description pageSize: the number of each page, required, must be greater than 0
{
"code": 0,
"message": "success",
"data": [
{
"id": “8a888e8f820060eb018200e487a50a67”,
"sn": "0564140100195",
Response Result "name": "192.168.218.104",
"type": "PGIC10",
"state": "1",
"module": "psg",
"gateType": "0"
}
]
}
Data: device array list;
Id: device id;
Response Result
Sn: device sn;
Description
Name: device name;
state: device state, 1 enabled, 0 disabled;
ZKBio CVSecurity API User Manual P a g e | 142
Module: module, access, attendance, elevator;
Type: device type name;
gateType: Entrance Control device type, 0-unknow(device is not
connected to entrance control terminals); 1-Tripod Turnstile; 2-Flap
Barrier; 3-Swing Barrier
2.30.2 Get entrance control device info by SN [/api/psgDevice/getBySn]
http://serverIP:serverPort/api/psgDevice/getBySn?sn={sn}&acc
Post Request URL
ess_token={apitoken}
Request Mode GET
Request Content None
Request Parameter
Description Sn:device sn, required;
{
"code": 0,
"message": "success",
"data": {
"id": "8a888e8f820060eb018200e487a50a67",
"sn": "CKN4213360081",
Response Result "name": "10.8.14.234",
"type": "InBio-PGates",
"status": "1",
"module": "psg",
"gateType": "0"
}
}
Data: device object;
Response Result Id: device id;
Description Sn: device sn;
Name: device name;
ZKBio CVSecurity API User Manual P a g e | 143
Type: device model type;
state: device state, 1enabled, 0 disabled;
Module: module, psg: entrance control module;
gateType: Entrance Control device type, 0-unknow(device is not
connected to entrance control terminals); 1-Tripod Turnstile; 2-Flap
Barrier; 3-Swing Barrier
2.30.3 Get entrance control device list(with total number)
[api/v2/psgDevice/list]
http://serverIP:serverPort/api/v2/psgDevice/list?pageNo=1&pa
Post Request URL
geSize=20&access_token={apitoken}
Request Mode GET
Request Content None
Request Parameter pageNo: pageno, required, the value must be greater than0;
Description pageSize: the number of each page, required, must be greater than 0
{
"code": 0,
"message": "success",
"data": {
"page": 0,
"size": 1,
"total": 1,
"data": [{
Response Result
"id": "8a888e238488391e018488703e4b0012",
"sn": "CKN3214660034",
"name": "10.8.14.249",
"type": "InBio-PGates",
"status": "1",
"module": "psg",
"gateType": "0"
}],
ZKBio CVSecurity API User Manual P a g e | 144
"offset": 0,
"lastPage": true
}
}
data: the returned result;
page: the current page number requested;
size: the number of data requested by the current page number;
total: the total number;
Data: device array list;
Id: device id;
Response Result Sn: device sn;
Description
Name: device name;
state: device state, 1 enabled, 0 disabled;
Module: module, access, attendance, elevator;
Type: device type name;
gateType: Entrance Control device type, 0-unknow(device is not
connected to entrance control terminals); 1-Tripod Turnstile; 2-Flap
Barrier; 3-Swing Barrier
2.31 Entrance Control Gate Interface
2.31.1 Get the State of All gates [psgGate/allGateState]
http://serverIP:serverPort/api/psgGate/allGateState?access_token={a
Post Request URL
pitoken}
Request Mode GET
Request Content None
Request Parameter
None
Description
{
Response Result "code": 0,
"message": "success",
ZKBio CVSecurity API User Manual P a g e | 145
"data": [
{
"id": "8a888e8f820060eb018200e488650abb",
"name": "10.8.14.234-1",
"deviceId": "8a888e8f820060eb018200e487a50a67",
"connect": "1",
"gateState": "0",
"alarm": "0",
"relay": "0"
}
]
}
Data: entrance control gate state array List;
Id: gate id;
Name: entrance control device name;
DeviceId: device id;
Connection: connection state, 0 offline, 1online, 2 disabled;
Response Result gateState: gate state (0 offline-device is not connect to entrance
Description control gate, defaul:0, 1 Online, 2 Disabled, 3 Lockdown)
Alarm: alarm description (0-none, 1-be opened accidentally,
2-tampering, 3-duress password opening,4- duress fingerprint
opening, 5-duress opening,6-Infraed ray exception, 7=gate error,
None-unknown)
relay: Relay state (0-off, 1-Exit open,2-Entry Open, None-unknown)
2.31.2 Get Entrance Control Gate State by Gate Id
[psgGate/gateStateById]
http://serverIP:serverPort/api/psgGate/gateStateById?gateId={gateI
Post Request URL
d}&access_token={apitoken}
Request Mode GET
ZKBio CVSecurity API User Manual P a g e | 146
Request Content None
Request Parameter gateId:Entrance Control gate id，example：
Description "8a888e8f820060eb018200e488650abb"
{
"code": 0,
"message": "success",
"data": [
{
"id": "8a888e8f820060eb018200e488650abb",
"name": "10.8.14.234-1",
Response Result "deviceId": "8a888e8f820060eb018200e487a50a67",
"connect": "1",
"gateState": "0",
"alarm": "0",
"relay": "0"
}
]
}
Data: entrance control gate state array List;
Id: gate id;
Name: entrance control device name;
DeviceId: device id;
Connection: connection state, 0 offline, 1online, 2 disabled;
Response Result
Description gateState: gate state (0 offline-device is not connect to entrance
control gate, defaul:0, 1 Online, 2 Disabled, 3 Lockdown)
Alarm: alarm description (0-none, 1-be opened accidentally,
2-tampering, 3-duress password opening,4- duress fingerprint
opening, 5-duress opening,6-Infraed ray exception, 7=gate error,
None-unknown)
relay: Relay state (0-off, 1-Exit open,2-Entry Open, None-unknown)
ZKBio CVSecurity API User Manual P a g e | 147
2.31.3 Get Entrance Control Gate State by the SN of Device
[psgGate/gateStateBySn]
http://serverIP:serverPort/api/psgGate/gateStateBySn?device
Post Request URL
Sn={sn}&access_token={apitoken}
Request Mode GET
Request Content None
Request Parameter
Sn: device sn
Description
{
"code": 0,
"message": "success",
"data": [
{
"id": "8a888e8f820060eb018200e488650abb",
"name": "10.8.14.234-1",
"deviceId":
Response Result
"8a888e8f820060eb018200e487a50a67",
"connect": "0",
"gateState": "0",
"alarm": "0",
"relay": "0"
}
]
}
Data: entrance control gate state array List;
Id: gate id;
Name: entrance control device name;
Response Result
Description DeviceId: device id;
Connection: connection state, 0 offline, 1online, 2 disabled;
gateState: gate state (0 offline-device is not connect to entrance
control gate, defaul:0, 1 Online, 2 Disabled, 3 Lockdown)
ZKBio CVSecurity API User Manual P a g e | 148
Alarm: alarm description (0-none, 1-be opened accidentally,
2-tampering, 3-duress password opening,4- duress fingerprint
opening, 5-duress opening,6-Infraed ray exception, 7=gate error,
None-unknown)
relay: Relay state (0-off, 1-Exit open,2-Entry Open, None-unknown)
2.31.4 Get Entrance Control Gate Info by gate Id [psgGate/getById]
http://serverIP:serverPort/api/psgGate/getById?id={id}&acce
Post Request URL
ss_token={apitoken}
Request Mode GET
Request Content None
Request Parameter
id: gate id;
Description
{
"code": 0,
"message": "success",
"data": {
Response Result "id": "8a888e8f820060eb018200e488650abb",
"name": "10.8.14.234-1",
"deviceId": "8a888e8f820060eb018200e487a50a67"
}
}
data: gate info object;
Response Result id: gate id;
Description name: gate name;
deviceId: entrance control device id;
ZKBio CVSecurity API User Manual P a g e | 149
2.31.5 Get Entrance Control Gate List [api/psgGate/list]
http://serverIP:serverPort/api/psgGate/list?pageNo=1&pageSize=
Post Request URL
20&access_token={apitoken}
Request Mode GET
Request Content None
PageNo: page, required, the value must be greater than 0;
Request Parameter
Description pageSize, the number of each page, required, must be greater
than 0
{
"code": 0,
"message": "success",
"data": [
{
Response Result "id": "8a888e8f820060eb018200e488650abb",
"name": "10.8.14.234-1",
"deviceId": "8a888e8f820060eb018200e487a50a67"
}
]
}
data: entrance control gate array list;
Response Result id: gate id;
Description name: gate name;
deviceId: device id;
ZKBio CVSecurity API User Manual P a g e | 150
2.31.6 Get Entrance Control Gate List(With total number)
[api/v2/psgGate/list]
http://serverIP:serverPort/api/v2/psgGate/list?pageNo=1&p
Post Request URL
ageSize=20&access_token={apitoken}
Request Mode GET
Request Content None
PageNo: page, required, the value must be greater than 0;
Request Parameter
Description pageSize, the number of each page, required, must be greater
than 0
{
"code": 0,
"message": "success",
"data": {
"page": 0,
"size": 2,
"total": 1,
"data": [{
Response Result
"id": "8a888e238488391e018488703f0a0066",
"name": "10.8.14.249-1",
"deviceId": "8a888e238488391e018488703e4b0012"
}],
"offset": 0,
"lastPage": true
}
}
data: the returned result;
Response Result page: the current page number requested;
Description size: the number of data requested by the current page number;
total: the total number;
ZKBio CVSecurity API User Manual P a g e | 151
data: entrance control gate array list;
id: gate id;
name: gate name;
deviceId: device id;
2.31.7 Remote Open by Gate Id [psgGate/remoteOpenById]
http://serverIP:serverPort/api/psgGate/remoteOpenById?gateId={
Post Request URL
gateId}&openType={openType}&access_token={apitoken}
Request Mode POST
Request Content None
gateId：Gate id, required；Example：
Request Parameter "8a888e8f820060eb018200e488650abb"
Description
openType：Open gate type, 1-Open(Entry), 2-Open(Exit)
Refer to public response result, other can refer to Appendix-Error
Response Result
code
Response Result
public response parameter description
Description
2.31.8 Remote Open by Gate Name [psgGate/remoteOpenByName]
http://serverIP:serverPort/api/psgGate/remoteOpenByName?gate
Post Request URL Name={gateName}&openType={openType}&access_token={apit
oken}
Request Mode POST
Request Content None
Request Parameter gateName: entrance control gate name, required;
Description openType：Open gate type, 1-Open(Entry), 2-Open(Exit)
Refer to public response result, other can refer to Appendix-Error
Response Result
code
ZKBio CVSecurity API User Manual P a g e | 152
Response Result
public response parameter description
Description
2.32 Entrance Control Gate Interface
2.32.1 Delete Person Level [psgLevel/deleteLevel]
http://serverIP:serverPort/api/psgLevel/deleteLevel?pin={pin
Post Request URL
}&levelIds={levelIds}&access_token={apitoken}
Request Mode POST
Request Content None
Pin: pin, required
Request Parameter Level Ids: level group id List, multiple comma separated, required,
Description string; such as
402856aa6c3bbde1016c3bc2329200ff,402856aa6c3bbde1016c3bc2
32930100
Response Result Refer to public response results
Response Result
Public response parameter description
Description
2.32.2 Get Gate Control Level by Id [psgLevel/getById/{id}]
http://serverIP:serverPort/api/psgLevel/getById/{id}?access_token=
Post Request URL
{apitoken}
Request Mode GET
Request Content None
Request Parameter Id: level group id, required, string; such as
Description “402856aa6c3bbde1016c3bc2329200ff”
{
"code": 0,
Response Result
"message": "success",
"data": {
ZKBio CVSecurity API User Manual P a g e | 153
"id": “402856aa6c3bbde1016c3bc2329200ff”,
"name": "public level group"
}
}
Data: level group object;
Response Result
Id: level group id;
Description
Name: level group name;
2.32.3 Get Entrance Access Level by Name [psgLevel/getByName/{name}]
http://serverIP:serverPort/api/psgLevel/getByName/{name}?access_
Post Request URL
token={apitoken}
Request Mode GET
Request Content None
Request Parameter
Name: level group name, required;
Description
{
"code": 0,
"message": "success",
"data": {
Response Result
"id": “402856aa6c3bbde1016c3bc2329200ff”,
"name": "public level group"
}
}
Data: level group object;
Response Result Id: level group id, string; such as
Description ‘402856aa6c3bbde1016c3bc2329200ff’
Name: level group name;
ZKBio CVSecurity API User Manual P a g e | 154
2.32.4 Get Entrance Control Access Level [/psgLevel/list]
http://serverIP:serverPort/api/psgLevel/list?pageNo={pageNo}&pag
Post Request URL
eSize={pageSize}&access_token={apitoken}
Request Mode GET
Request Content None
PageNo: page no, required, the value must be greater than 0;
Request Parameter
Description pageSize, the number of each page, required, must be greater than
0
{
"code": 0,
"message": "success",
"data": [
{
Response Result
"id": “402856aa6c3bbde1016c3bc2329200ff”,
"name": "public level group"
}
]
}
Data: level group array list;
Response Result Id: level group id, string; such as
Description “402856aa6c3bbde1016c3bc2329200ff”
Name: level group name;
2.32.5 Sync Level Info to Device [psgLevel/syncLevel]
http://serverIP:serverPort/api/psgLevel/syncLevel?levelId={levelId}&
Post Request URL
access_token={apitoken}
Request Mode POST
Request Content None
Request Parameter Level Id: level group id, required, string; such as
ZKBio CVSecurity API User Manual P a g e | 155
Description “402856aa6c3bbde1016c3bc2329200ff”
Refer to public response result, for any other result please refer to
Response Result
Appendix-Error code
Response Result
Public response parameter description
Description
2.32.6 Sync Person Level [/psgLevel/syncPerson]
http://serverIP:serverPort/api/psgLevel/syncPerson?pin={pin}&levelI
Post Request URL
ds={levelIds}&access_token={apitoken}
Request Mode POST
Request Content None
Level Ids: level group id list, multiple comma separated, required,
Request Parameter string; such as “402856aa6c3bbde1016c3bc2329200ff”
Description
Pin: pin, required
Refer to public response result, other can refer to Appendix-Error
Response Result
code
Response Result
Public response parameter description
Description
ZKBio CVSecurity API User Manual P a g e | 156
2.32.7 Get Entrance Control Access Level(With total number)
[api/v2/psgLevel/list]
http://serverIP:serverPort/api/v2/psgLevel/list?pageNo={pageNo}&
Post Request URL
pageSize={pageSize}&access_token={apitoken}
Request Mode GET
Request Content None
PageNo: page no, required, the value must be greater than 0;
Request Parameter
Description pageSize, the number of each page, required, must be greater than
0
{
"code": 0,
"message": "success",
"data": {
"page": 0,
"size": 2,
"total": 1,
"data": [
Response Result {
"id": “402856aa6c3bbde1016c3bc2329200ff”,
"name": "public level group"
}
],
"offset": 0,
"lastPage": true
}
}
data: the returned result;
Response Result page: the current page number requested;
Description size: the number of data requested by the current page number;
total: the total number;
ZKBio CVSecurity API User Manual P a g e | 157
Data: level group array list;
Id: level group id, string; such as
“402856aa6c3bbde1016c3bc2329200ff”
Name: level group name;
2.33 Entrance Control Gate Reader Interface
2.33.1 Get Entrance Control Gate Reader Info List[psgReader/list]
http://serverIP:serverPort/api/psgReader/list?pageNo=1&pageSize=
Post Request URL
20&access_token={apitoken}
Request Mode GET
Request Content None
PageNo: page, required, the value must be greater than 0;
Request Parameter
Description pageSize, the number of each page, required, must be greater than
0
{
"code": 0,
"message": "success",
"data": [
{
"id": "8a888e8f820060eb018200e488660abc",
"gateId": "8a888e8f820060eb018200e488650abb",
"name": "10.8.14.234-1-入",
Response Result
"readerNo": 1,
"readerState": 0
},
{
"id": "8a888e8f820060eb018200e488660abd",
"gateId": "8a888e8f820060eb018200e488650abb",
"name": "10.8.14.234-1-出",
"readerNo": 2,
ZKBio CVSecurity API User Manual P a g e | 158
"readerState": 1
}
]
}
Data: reader array List;
Id: reader id;
Response Result gateId: entrance control gate id;
Description Name: reader name;
ReaderNo: readerNo;
ReaderState: reader state, 0: in, 1: out;
2.33.2 Get Entrance Control Gate Reader Info List(With total
number)[api/v2/psgReader/list]
http://serverIP:serverPort/api/v2/psgReader/list?pageNo=1&pageSi
Post Request URL
ze=20&access_token={apitoken}
Request Mode GET
Request Content None
PageNo: page, required, the value must be greater than 0;
Request Parameter
Description pageSize, the number of each page, required, must be greater than
0
{
"code": 0,
"message": "success",
"data": {
"page": 0,
Response Result "size": 2,
"total": 2,
"data": [{
"id": "8a888e238488391e018488703f0b0067",
"gateId": "8a888e238488391e018488703f0a0066",
"name": "10.8.14.249-1-入",
ZKBio CVSecurity API User Manual P a g e | 159
"readerNo": 1,
"readerState": 0
},
{
"id": "8a888e238488391e018488703f0b0068",
"gateId": "8a888e238488391e018488703f0a0066",
"name": "10.8.14.249-1-出",
"readerNo": 2,
"readerState": 1
}
],
"offset": 0,
"lastPage": true
}
}
data: the returned result;
page: the current page number requested;
size: the number of data requested by the current page number;
total: the total number;
Response Result Data: reader array List;
Description Id: reader id;
gateId: entrance control gate id;
Name: reader name;
ReaderNo: readerNo;
ReaderState: reader state, 0: in, 1: out;
2.33.3 Get Entrance Control Gate Reader Info by Reader Id
[psgReader/getById]
http://serverIP:serverPort/api/psgReader/getById?id={id}&access_to
Post Request URL
ken={apitoken}
ZKBio CVSecurity API User Manual P a g e | 160
Request Mode GET
Request Content None
Request Parameter
id: reader id, required;
Description
{
"code": 0,
"message": "success",
"data": {
"id": “402856aa6c3c5063016c3cb3a0360005”,
Response Result "gateId": “402856aa6bff4b1a016bff5374800c0e”,
"name": "192.168.214.15-1-in",
"readerNo": 1,
"readerState": 0
}
}
data: reader info object;
id: reader id;
Response Result Gate Id: gate id;
Description name: reader name;
readerNo: reader no;
readState: reader state, 0: in, 1:out;
2.34 Entrance Control Device transaction Interface
2.34.1 Get Entrance Control Transaction by Device Sn
[psgTransaction/device/{deviceSn}]
http://serverIP:serverPort/api/psgTransaction/device/{deviceSn}?
Post Request URL
pageNo=1&pageSize=20&access_token={apitoken}
Request Mode GET
ZKBio CVSecurity API User Manual P a g e | 161
Request Content None
PageNo: pageNo, required, the value must be greater than 0;
PageSize: required, the value must be greater than 0, not more
Request Parameter than 1000 per page;
Description DeviceSn: device sn;
startDate: stat time, not required;
endDate: end time, not required;
{
"code": 0,
"message": "success",
"data": [
{
"id": "8a888e8f821044f3018210ce84150029",
"eventTime": "2022-07-18 18:15:42",
"pin": "",
"name": "",
"lastName": "",
"deptName": "",
"areaName": "Area Name",
"cardNo": "",
Response Result
"devSn": "CKN4213360081",
"verifyModeName": "Others",
"eventName": "The entrance control gate is not
connected",
"eventPointName": "10.8.14.234-1",
"readerName": "Others",
"devName": "10.8.14.234",
"logId": 3603,
"eventNo": 110,
"gateType": 0
}
]
}
ZKBio CVSecurity API User Manual P a g e | 162
data: transaction array list;
id: event id, “402856aa6c032ca3016c03351d2600fd”;
eventTime: record device trigger time;
pin: pin;
name: person name;
lastName: person last name, (English);
deptName: department name;
areaName: area name;
cardNo: card no;
Response Result devSn: device sn;
Description
verifyModeName: verification mode name;
eventName: transaction description;
eventPointName: transaction point name;
readerName: reader name;
devName: device name;
logId: transaction index value, there will be a value if device
support it;
eventNo: Event Number;
gateType: Gate Type, 0-Unknown(Device is not connected to
Gate);1-Tripod Turnstyle; 2-Flap Barrier;3-Swing Barrier
2.34.2 Get Entrance Control Gate Transaction List[psgTransaction/list]
http://serverIP:serverPort/api/psgTransaction/list?personPin={pe
Post Request URL rsonPin}&startDate={startDate}&endDate={endDate}&pageNo=1
&pageSize=20&access_token={apitoken}
Request Mode GET
Request Content None
personPin:personPin, [not required]
startDate：startDate, [not required]
Request Parameter
Description endDate：endDate, [not required]
PageNo: page no, required, the value must be greater than 0;
pageSize, the number of each page, required, must be greater
ZKBio CVSecurity API User Manual P a g e | 163
than 0, not more than 1000 per page;
{
"code": 0,
"message": "success",
"data": [
{
"id": "8a888e8f821044f3018210ce84150029",
"eventTime": "2022-07-18 18:15:42",
"pin": "",
"name": "",
"lastName": "",
"deptName": "",
"areaName": "Area Name",
Response Result "cardNo": "",
"devSn": "CKN4213360081",
"verifyModeName": "Other",
"eventName": "The Gate is not connected",
"eventPointName": "10.8.14.234-1",
"readerName": "Others",
"devName": "10.8.14.234",
"logId": 3603,
"eventNo": 110,
"gateType": 0
}
]
}
data: transaction array list;
id:5;
eventTime: record device trigger time;
Response Result
pin: pin;
Description
name: person name;
lastName: last name;
deptName: department name;
ZKBio CVSecurity API User Manual P a g e | 164
areaName: area name;
cardNo: card no;
devSn: device sn;
verifyModeName: verification mode name;
eventName: transaction description;
eventPointName: transaction point name;
readerName: reader name;
devName: device name;
logId: transactionindex value, there will be a value if device
support it;
eventNo: Event Number;
gateType: Gate Type, 0-Unknown(Device is not connected to
Gate);1-Tripod Turnstyle; 2-Flap Barrier;3-Swing Barrier
2.34.3 Get Entrance Control Device Real-Time Monitoring
Transaction[psgTransaction/monitor]
http://serverIP:serverPort/api/psgTransaction/monitor?timesta
Post Request URL
mp={timestamp}&access_token={apitoken}
Request Mode GET
Request Content None
Timestamp: timestampmillisecond, such as 1494467276539,
required; Get frequency cannot be too high, it is recommended
Request Parameter
to obtain at least 10 seconds or more; there is no need to
Description
change after timestamp value set the first request, it is allowed
to keep using the first request
{
"code": 0,
"message": "success",
Response Result "data": [
{
"id": null,
"eventTime": "2022-07-18 18:13:33",
ZKBio CVSecurity API User Manual P a g e | 165
"pin": "",
"name": "",
"lastName": "",
"deptName": "",
"areaName": "Area Name",
"cardNo": "",
"devSn": "CKN4213360081",
"verifyModeName": "Other",
"eventName": "Gate is not connected",
"eventPointName": "10.8.14.234-1",
"readerName": "Other",
"devName": "10.8.14.234",
"logId": 3601,
"eventNo": 110,
"gateType": 0
}
]
}
data:transaction monitoring record array List;
Id: event id(Not stored in database yet, so it is null)
eventTime: record device trigger time;
pin:pin;
areaName: area name;
cardNo: card no;
devSn: device sn;
Response Result verifyModeName: verification mode name;
Description
eventName: transaction description;
eventPointName: transaction point name;
readerName: reader name;
devName: device name;
logId: transactionindex value, there will be a value if device
support it;
eventNo: Event Number;
gateType: Gate Type, 0-Unknown(Device is not connected to
ZKBio CVSecurity API User Manual P a g e | 166
Gate);1-Tripod Turnstyle; 2-Flap Barrier;3-Swing Barrier
2.34.4 Get Personnel Entrance Control Access Transaction by Pin
[transaction/person/{pin}]
http://serverIP:serverPort/api/psgTransaction/person/{pin}?page
Post Request URL
No=1&pageSize=20&access_token={apitoken}
Request Mode GET
Request Content None
PageNo: page no, required, the value must be greater than 0;
pageSize, the number of each page, required, must be greater
than 0, not more than 1000 per page;
Request Parameter
Description pin: pin, required;
startDate：startDate, [not required]
endDate：endDate, [not required]
{
"code": 0,
"message": "success",
"data": [
{
"id": "8a888e8f821044f3018210ce84150029",
"eventTime": "2022-07-18 18:15:42",
"pin": "",
Response Result
"name": "",
"lastName": "",
"deptName": "",
"areaName": "Area Name",
"cardNo": "",
"devSn": "CKN4213360081",
"verifyModeName": "Other",
"eventName": "The Gate is not connected",
ZKBio CVSecurity API User Manual P a g e | 167
"eventPointName": "10.8.14.234-1",
"readerName": "Others",
"devName": "10.8.14.234",
"logId": 3603,
"eventNo": 110,
"gateType": 0
}
]
}
data:transaction monitoring record array List;
Id: event id(Not stored in database yet, so it is null)
eventTime: record device trigger time;
pin:pin;
areaName: area name;
cardNo: card no;
devSn: device sn;
verifyModeName: verification mode name;
Response Result
Description eventName: transaction description;
eventPointName: transaction point name;
readerName: reader name;
devName: device name;
logId: transactionindex value, there will be a value if device
support it;
eventNo: Event Number;
gateType: Gate Type, 0-Unknown(Device is not connected to
Gate);1-Tripod Turnstyle; 2-Flap Barrier;3-Swing Barrier
2.34.5 Get Entrance Control Transaction by Device Sn(With total
number) [api/v2/psgTransaction/device/{deviceSn}]
http://serverIP:serverPort/api/v2/psgTransaction/device/{deviceS
Post Request URL
n}?pageNo=1&pageSize=20&access_token={apitoken}
Request Mode GET
ZKBio CVSecurity API User Manual P a g e | 168
Request Content None
PageNo: pageNo, required, the value must be greater than 0;
PageSize: required, the value must be greater than 0, not more
Request Parameter than 1000 per page;
Description DeviceSn: device sn;
startDate: stat time, not required;
endDate: end time, not required;
{
"code": 0,
"message": "success",
"data": {
"page": 1,
"size": 2,
"total": 1,
"data": [{
"id": "8a888e8f821044f3018210ce84150029",
"eventTime": "2022-07-18 18:15:42",
"pin": "",
"name": "",
"lastName": "",
Response Result
"deptName": "",
"areaName": "Area Name",
"cardNo": "",
"devSn": "CKN4213360081",
"verifyModeName": "Others",
"eventName": "The gate is not connected",
"eventPointName": "10.8.14.234-1",
"readerName": "Other",
"devName": "10.8.14.234",
"logId": 3603,
"eventNo": 110,
"gateType": 0
}],
ZKBio CVSecurity API User Manual P a g e | 169
"offset": 0,
"lastPage": true
}
}
data: the returned result;
page: the current page number requested;
size: the number of data requested by the current page number;
total: the total number;
data: transaction array list;
id: event id, “402856aa6c032ca3016c03351d2600fd”;
eventTime: record device trigger time;
pin: pin;
name: person name;
lastName: person last name, (English);
deptName: department name;
Response Result areaName: area name;
Description
cardNo: card no;
devSn: device sn;
verifyModeName: verification mode name;
eventName: transaction description;
eventPointName: transaction point name;
readerName: reader name;
devName: device name;
logId: transaction index value, there will be a value if device
support it;
eventNo: Event Number;
gateType: Gate Type, 0-Unknown(Device is not connected to
Gate);1-Tripod Turnstyle; 2-Flap Barrier;3-Swing Barrier
ZKBio CVSecurity API User Manual P a g e | 170
2.34.6 Get Entrance Control Gate Transaction List(With total
number)[api/v2/psgTransaction/list]
http://serverIP:serverPort/api/v2/psgTransaction/list?personPin={
Post Request URL personPin}&startDate={startDate}&endDate={endDate}&pageNo
=1&pageSize=20&access_token={apitoken}
Request Mode GET
Request Content None
personPin:personPin, [not required]
startDate：startDate, [not required]
Request Parameter endDate：endDate, [not required]
Description
PageNo: page no, required, the value must be greater than 0;
pageSize, the number of each page, required, must be greater
than 0, not more than 1000 per page;
{
"code": 0,
"message": "success",
"data": {
"page": 1,
"size": 1,
"total": 1,
"data": [{
"id": "8a888e8f821044f3018210ce84150029",
Response Result
"eventTime": "2022-07-18 18:15:42",
"pin": "",
"name": "",
"lastName": "",
"deptName": "",
"areaName": "Area",
"cardNo": "",
"devSn": "CKN4213360081",
"verifyModeName": "Others",
ZKBio CVSecurity API User Manual P a g e | 171
"eventName": "The gate is not connected",
"eventPointName": "10.8.14.234-1",
"readerName": "Other",
"devName": "10.8.14.234",
"logId": 3603,
"eventNo": 110,
"gateType": 0
}],
"offset": 0,
"lastPage": true
}
}
data: the returned result;
page: the current page number requested;
size: the number of data requested by the current page number;
total: the total number;
data: transaction array list;
id:5;
eventTime: record device trigger time;
pin: pin;
name: person name;
lastName: last name;
Response Result deptName: department name;
Description areaName: area name;
cardNo: card no;
devSn: device sn;
verifyModeName: verification mode name;
eventName: transaction description;
eventPointName: transaction point name;
readerName: reader name;
devName: device name;
logId: transactionindex value, there will be a value if device
support it;
eventNo: Event Number;
ZKBio CVSecurity API User Manual P a g e | 172
gateType: Gate Type, 0-Unknown(Device is not connected to
Gate);1-Tripod Turnstyle; 2-Flap Barrier;3-Swing Barrier
2.34.7 Get Personnel Entrance Control Access Transaction by
Pin(With total number) [api/v2/psgTransaction/person/{pin}]
http://serverIP:serverPort/api/v2/psgTransaction/person/{pin}?p
Post Request URL
ageNo=1&pageSize=20&access_token={apitoken}
Request Mode GET
Request Content None
PageNo: page no, required, the value must be greater than 0;
pageSize, the number of each page, required, must be greater
than 0, not more than 1000 per page;
Request Parameter
Description pin: pin, required;
startDate：startDate, [not required]
endDate：endDate, [not required]
{
"code": 0,
"message": "success",
"data": {
"page": 1,
"size": 1,
"total": 1,
"data": [{
Response Result
"id": "8a888e8f821044f3018210959f620007",
"eventTime": "2022-07-18 17:13:36",
"pin": "1",
"name": "",
"lastName": "",
"deptName": "",
"areaName": "Area Name",
"cardNo": "",
ZKBio CVSecurity API User Manual P a g e | 173
"devSn": "CKN4213360081",
"verifyModeName": "Others",
"eventName": "Connection abort",
"eventPointName": "",
"readerName": "Other",
"devName": "10.8.14.234",
"logId": -1,
"eventNo": 700,
"gateType": 0
}],
"offset": 0,
"lastPage": true
}
}
data: the returned result;
page: the current page number requested;
size: the number of data requested by the current page number;
total: the total number;
data:transaction monitoring record array List;
Id: event id(Not stored in database yet, so it is null)
eventTime: record device trigger time;
pin:pin;
areaName: area name;
Response Result cardNo: card no;
Description
devSn: device sn;
verifyModeName: verification mode name;
eventName: transaction description;
eventPointName: transaction point name;
readerName: reader name;
devName: device name;
logId: transactionindex value, there will be a value if device
support it;
eventNo: Event Number;
gateType: Gate Type, 0-Unknown(Device is not connected to
ZKBio CVSecurity API User Manual P a g e | 174
Gate);1-Tripod Turnstyle; 2-Flap Barrier;3-Swing Barrier
ZKBio CVSecurity API User Manual P a g e | 175
3. Appendix
3.1 Error Code
-1 Program error
-10 The department number or name cannot be empty
-12 The department name has already existed
-13 The department number does not exist
-14 Cannot be set as parent department
-15 Cannot delete department
-20 Pin number cannot be empty
-22 The person does not exist
-23 The card number has been used
-24 The level group does not exist
-25 No person under the access level
-26 The password has been used
-27 Invalid personnel photo
-29 PIN exception
-31 The personnel fingerprint already existed!
-32 Input wrong validtype!
-33 Fingerprint template index range is from 0-9!
-34 templateNo not existed!
-40 Authorize access failure
-41 Delete access level failure
-42 Personnel ID or access level id is null
-43 Access level id can’t be null
ZKBio CVSecurity API User Manual P a g e | 176
-44 Door id can’t be null
-45 Door open duration between 1~254 seconds.
-46 Door name can’t be null
-47 Door doesn’t exist
-48 Device serial number can’t be null
-70 Advertisement doesn’t exist
-71 Didn’t support this format
-80 Area didn’t exist
-81 Pins not allowed to be null
-82 Pins length not allowed over 500
-83 Area ID can’t be null
-90 PageNo or pageSize cannot be set less than or equal to 0
-91 PageSize is greater than 1000
-92 PageSize and pageNo cannot be empty
-100 Time format error
-101 Start time cannot be greater than end time
-200 SN is required
-201 Floor Id is required
-202 The door opening time is required
-203 The door opening time needs to be greater than 0
-220 Operation type error
-221 Black and white list type error
-222 Time parameter error
-223 Car license plate is incorrect
-240 Host(visitor) pin cannot be empty
ZKBio CVSecurity API User Manual P a g e | 177
-241 Visitor certificate type cannot be empty
-242 Visitor certificate number cannot be empty
-243 Visitor name cannot be empty
-244 You have made a reservation
-245 No need to make a reservation during the visit
-246 Visit reason cannot be empty
-247 Visit date cannot be empty
-248 No eligible visitor reservation information
-249 Date format error
-250 Invalid certificate type
-251 Please fill in the correct national ID number
-252 Please fill in the correct date
-253 The employee does not exist
-254 User in the block list
-255 Registration has been completed. Please do not register again
-256 Visitor unregistered, cannot be sign-out
-257 Visitor information doesn’t exist
-258 Visitor Number Count Must bigger than 0
-259 The operation object is not selected
-260 The visited department info doesn’t exist
-261 Contains special characters
-262 The photo is not qualified.
-263 Reader ID cannot empty
-264 Did not exist this reader
-265 The Open Gate Type cannot empty
ZKBio CVSecurity API User Manual P a g e | 178
-266 Open Gate Type incorrect
ZKBio CVSecurity API User Manual P a g e | 179
You might also like
- ZKBio CVSecurity - 3rd Party API User Manual - 20221226 - v1.0No ratings yetZKBio CVSecurity - 3rd Party API User Manual - 20221226 - v1.0133 pages
- CAN and FPGA Communication Engineering: Implementation of a CAN Bus based Measurement System on an FPGA Development KitFrom EverandCAN and FPGA Communication Engineering: Implementation of a CAN Bus based Measurement System on an FPGA Development KitNo ratings yet
- Mathematics of Finance Canadian 8th Edition Brown Kopp Solution Manual100% (48)Mathematics of Finance Canadian 8th Edition Brown Kopp Solution Manual41 pages
- ZKBioSecurity V5000 - 3.0.0 3rd Party API User Manual V1.4 - 20200810No ratings yetZKBioSecurity V5000 - 3.0.0 3rd Party API User Manual V1.4 - 2020081080 pages
- Tan Tiong Tick Vs American Apothecaries Co., Et Al100% (2)Tan Tiong Tick Vs American Apothecaries Co., Et Al5 pages
- Computer Networks Introduction ComputerNo ratings yetComputer Networks Introduction Computer23 pages
- PMP Professional Diploma by Dr. Ahmed Alsenosy: Summary by Student Thuraya Alkabani - March, 2023No ratings yetPMP Professional Diploma by Dr. Ahmed Alsenosy: Summary by Student Thuraya Alkabani - March, 202375 pages
- 3.2.2.5m Lab - Configuring VLANs and Trunking ANSWERS91% (33)3.2.2.5m Lab - Configuring VLANs and Trunking ANSWERS11 pages
- Companies and Environmental Impact: Identification and Visualization of Key Ecological IndicatorsFrom EverandCompanies and Environmental Impact: Identification and Visualization of Key Ecological IndicatorsNo ratings yet
- Benefits of semantic data models. A study in the European goods transport industryFrom EverandBenefits of semantic data models. A study in the European goods transport industryNo ratings yet
- Smart Card Applications: Design models for using and programming smart cardsFrom EverandSmart Card Applications: Design models for using and programming smart cardsNo ratings yet
- Analyzing Food Security Using Household Survey Data: Streamlined Analysis with ADePT SoftwareFrom EverandAnalyzing Food Security Using Household Survey Data: Streamlined Analysis with ADePT SoftwareNo ratings yet
- Prediction of Burnout: An Artificial Neural Network ApproachFrom EverandPrediction of Burnout: An Artificial Neural Network ApproachNo ratings yet
- Mobile Telecommunication Customer Loyalty in Nigeria: Determining factorsFrom EverandMobile Telecommunication Customer Loyalty in Nigeria: Determining factorsNo ratings yet
- Business Object Modeling (BOM) workbook: A pattern-based approach to creating, managing and using an enterprise data modelFrom EverandBusiness Object Modeling (BOM) workbook: A pattern-based approach to creating, managing and using an enterprise data modelNo ratings yet
- Greening Your Home: Sustainable Options for Every System In Your HouseFrom EverandGreening Your Home: Sustainable Options for Every System In Your House4/5 (1)
- The Linux Terminal for Advanced Users - The Command Line Made Easy: First EditionFrom EverandThe Linux Terminal for Advanced Users - The Command Line Made Easy: First EditionNo ratings yet
- Blog Smarter, Not Harder: SEO, Blogging, and AI Strategies to Skyrocket Your TrafficFrom EverandBlog Smarter, Not Harder: SEO, Blogging, and AI Strategies to Skyrocket Your TrafficNo ratings yet
- Copyright for Dummies. Your guide to copyright in Russia.From EverandCopyright for Dummies. Your guide to copyright in Russia.No ratings yet
- Presentations with LaTeX: Which package, which command, which syntax?From EverandPresentations with LaTeX: Which package, which command, which syntax?No ratings yet
- Corporate Management, Corporate Social Responsibility and Customers: An Empirical InvestigationFrom EverandCorporate Management, Corporate Social Responsibility and Customers: An Empirical InvestigationNo ratings yet
- How Useful is the Information Ratio to Evaluate the Performance of Portfolio Managers?From EverandHow Useful is the Information Ratio to Evaluate the Performance of Portfolio Managers?No ratings yet
- Programming the Photon: Getting Started with the Internet of ThingsFrom EverandProgramming the Photon: Getting Started with the Internet of Things5/5 (1)
- Beyond the Gap: How Countries Can Afford the Infrastructure They Need while Protecting the PlanetFrom EverandBeyond the Gap: How Countries Can Afford the Infrastructure They Need while Protecting the PlanetNo ratings yet
- Web 2.0 and the Health Care Market: Health Care in the era of Social Media and the modern InternetFrom EverandWeb 2.0 and the Health Care Market: Health Care in the era of Social Media and the modern InternetNo ratings yet
- Drafting Purchase Price Adjustment Clauses in M&A: Guarantees, retrospective and future oriented Purchase Price Adjustment ToolsFrom EverandDrafting Purchase Price Adjustment Clauses in M&A: Guarantees, retrospective and future oriented Purchase Price Adjustment ToolsNo ratings yet
- Purchasing Power Parities and the Real Size of World Economies: A Comprehensive Report of the 2011 International Comparison ProgramFrom EverandPurchasing Power Parities and the Real Size of World Economies: A Comprehensive Report of the 2011 International Comparison ProgramNo ratings yet
- Purchasing Power Parities and the Real Size of World EconomiesFrom EverandPurchasing Power Parities and the Real Size of World EconomiesNo ratings yet
- United under SAP: The process of eliminating information islands for ThyssenKrupp in China (Zhongshan)From EverandUnited under SAP: The process of eliminating information islands for ThyssenKrupp in China (Zhongshan)No ratings yet
- Entering the Brazilian Market: A guide for LEAN ConsultantsFrom EverandEntering the Brazilian Market: A guide for LEAN ConsultantsNo ratings yet
- Pollution Prevention: Methodology, Technologies and PracticesFrom EverandPollution Prevention: Methodology, Technologies and PracticesNo ratings yet
- Just ›A Machine for Doing Business‹?: Sociomaterial Configurations of the Intranet in a Post-merger Telecommunications CompanyFrom EverandJust ›A Machine for Doing Business‹?: Sociomaterial Configurations of the Intranet in a Post-merger Telecommunications CompanyNo ratings yet
- CLO Liquidity Provision and the Volcker Rule: Implications on the Corporate Bond MarketFrom EverandCLO Liquidity Provision and the Volcker Rule: Implications on the Corporate Bond MarketNo ratings yet
- Communication and Control in Electric Power Systems: Applications of Parallel and Distributed ProcessingFrom EverandCommunication and Control in Electric Power Systems: Applications of Parallel and Distributed ProcessingNo ratings yet
- FE Mechanical Exam Prep Complete Study Guide for the Fundamentals of Engineering with Practice Questions and Proven Strategies to Conquer the ExamFrom EverandFE Mechanical Exam Prep Complete Study Guide for the Fundamentals of Engineering with Practice Questions and Proven Strategies to Conquer the ExamNo ratings yet
- Practical Handbook for the Marketing of Foreign Investment Funds in Germany: A legal overviewFrom EverandPractical Handbook for the Marketing of Foreign Investment Funds in Germany: A legal overviewNo ratings yet
- Programming the Intel Galileo: Getting Started with the Arduino -Compatible Development BoardFrom EverandProgramming the Intel Galileo: Getting Started with the Arduino -Compatible Development Board5/5 (1)
- Formulation for Observed and Computed Values of Deep Space Network Data Types for NavigationFrom EverandFormulation for Observed and Computed Values of Deep Space Network Data Types for NavigationNo ratings yet
- Killtest: Ki J GT 3 WCNKV ($ GVVGT 5 GtxkegNo ratings yetKilltest: Ki J GT 3 WCNKV ($ GVVGT 5 Gtxkeg13 pages
- Activity 3 - Law of Conservation of Energy (Experiment) PDFNo ratings yetActivity 3 - Law of Conservation of Energy (Experiment) PDF3 pages
- Bungo Stray Dogs Most Popular Ship - Căutare GoogleNo ratings yetBungo Stray Dogs Most Popular Ship - Căutare Google1 page
- AnalogIntegratedCircuts LAB MANUAL by Prabhu Kumar SurarapuNo ratings yetAnalogIntegratedCircuts LAB MANUAL by Prabhu Kumar Surarapu80 pages
- M800-M80-E80 Series Instruction Manual Ib1501274engkNo ratings yetM800-M80-E80 Series Instruction Manual Ib1501274engk794 pages
- Instant Download Nonlinear Evolution Equations 1st Edition Songmu Zheng PDF All Chapters100% (1)Instant Download Nonlinear Evolution Equations 1st Edition Songmu Zheng PDF All Chapters61 pages
- Script For Facilitating Learning SessionNo ratings yetScript For Facilitating Learning Session4 pages
- ANDERSEN, Simon Calmar - How To Improve The Outcome of State Welfare ServicesNo ratings yetANDERSEN, Simon Calmar - How To Improve The Outcome of State Welfare Services17 pages
- Sample Exam Questions With Answers: Burda & WyploszNo ratings yetSample Exam Questions With Answers: Burda & Wyplosz8 pages
- June 2005 Architects' Licensure ExaminationNo ratings yetJune 2005 Architects' Licensure Examination12 pages
