Iris ID
API docs by Redocly

Iris ID REST API

Introduction

This document describes the programming interface for various Iris ID devices to provide developers with the capability of implementing a custom applications to manage users and configurations in the devices. Users are the enrollees with demographic and biometric information. Users API can be used to obtain the list of users and to add, update or delete user data in the devices. Config API can be used to read and update various configurations and settings in the devices.

Supported devices:

iT100 iBAR600E


Preparation

Network bands must match.
The device activation requires two independent passphrases—the Site Key and the API Key.
SiteKey : Encryption key for biometric template encryptions.
ApiKey : A token to authenticate the HTTPS Requests.

If Sitekey is set differently for each device, iris may not be recognized by other devices.
Apikey varies from device to device, you need to check and deliver it to each device.

HTTP Status Code

HTTP Status Code Summary
* 200 Ok. If the request is successful
* 400 Bad request. If the request cannot be processed
* 401 Unauthorized. If the authentication key is wrong
* 404 Not found. If a request resource does not exist

HTTPS support

All APIs should use and require HTTPS.

Warning

User information must be put in every device to work.
Transaction logs cannot be transmitted if the network connection is disconnected. At that time, you have to manually take the transaction log.
If you want to receive corrections, you can use Subscription. (Subscribe types are User, Transaction Log, Config, Heartbeat)

users

User Management

Get user records with the consent information

GET /v1/users/consent
iT100


Returns the list user records with the consent information.

Rerurns null when there are no users that match the query parameter.

Sample Queries:
`\users` for all users
`\users?userIDs=1` for user with User ID 1
query Parameters
userIDs
Array of strings

Array of User IDs to be queried. Empty array would return the list of all users.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/users/consent?userIDs=1,2' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
[
  • {
    }
]

Get User List

GET /v1/users
iT100


Returns the list users for the User IDs passed in query parameter. List of all users is returned when the User ID array is empty.

Rerurns null when there are no users that match the query parameter.

Sample Queries:
`\users` for all users
`\users?userIDs=1` for user with User ID 1
query Parameters
userIDs
Array of strings

Array of User IDs to be queried. Empty array would return the list of all users.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/users?userIDs=1,2' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
[
  • {
    }
]

Modify User

PUT /v1/users
iT100


Modifies an existing user's demographic and biometric information. User record to be modified is identified by guid in User structure passed in the request body.
`Required all json field`
If you skip json field, that field is default value ( like 0 , null). So we require all field.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
guid
required
string

Globally Unique Identifier for users. System Generated. 20-character string.

userID
required
string

Unique and assigned by the administrator/operators.

active
boolean

true for active user and false for pending user (no biometrics information)

status
required
string
Enum: "active" "pending" "inactive"

user's status

lIrisCode
string

512-byte left iris template (base64 encoded string)

rIrisCode
string

512-byte right iris template (base64 encoded string)

faceCode
string

2121-byte face template (base64 encoded string)

title
string

User's title

firstName
string

User's first name

lastName
string

User's last name

emailAddr
string

User's email address

phoneNum
string

User's phone number

Array of objects (Card)

User's cards serial number

role
string

User type - Administrator or User. It will be augmented in the future.

department
string

User's department

adminID
string

Identifier of the administrator

adminPassword
string

Password of the administrator

recogMode
string
Enum: "Iris" "Face" "Fusion" "FaceOrIris" "FaceAndIris" "Card" "FaceOrCard" "IrisOrCard" "FusionOrCard" "FaceAndIrisOrCard" "FaceOrIrisOrCard" "FaceAndCard" "IrisAndCard" "FusionAndCard" "FaceAndIrisAndCard" "FaceOrIrisAndCard"

User recognition mode

faceImg
string <byte>

Face image - 220 x 294 JPEG

faceSmallImg
string <byte>

Small face image for thumbnail - 60 x 60 JPEG

lIrisImg
string <byte>

Left iris image for thumbnail (not for matching)

rIrisImg
string <byte>

Right iris image for thumbnail (not for matching)

enrollTimestamp
integer

Time and Date of Enrollment

userDefined1
string

User's userDefined1

userDefined2
string

User's userDefined2

userDefined3
string

User's userDefined3

userDefined4
string

User's userDefined4

userDefined5
string

User's userDefined5

userConsent
boolean

User consent. 'True' when user consent is agreed. 'False' when user consent is disagreed.

userConsentCreateTime
number <int64>

Unix timestamp at which user consent is created

userConsentUpdateTime
number <int64>

Unix timestamp at which user consent is updated

Responses

Request samples

Content type
application/json
{
  • "guid": "string",
  • "userID": "string",
  • "active": true,
  • "status": "active",
  • "lIrisCode": "string",
  • "rIrisCode": "string",
  • "faceCode": "string",
  • "title": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "emailAddr": "string",
  • "phoneNum": "string",
  • "cards": [
    ],
  • "role": "string",
  • "department": "string",
  • "adminID": "string",
  • "adminPassword": "string",
  • "recogMode": "Iris",
  • "faceImg": "string",
  • "faceSmallImg": "string",
  • "lIrisImg": "string",
  • "rIrisImg": "string",
  • "enrollTimestamp": 0,
  • "userDefined1": "string",
  • "userDefined2": "string",
  • "userDefined3": "string",
  • "userDefined4": "string",
  • "userDefined5": "string",
  • "userConsent": true,
  • "userConsentCreateTime": 0,
  • "userConsentUpdateTime": 0
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Add User

POST /v1/users
iT100


Enrolls a new user in the device. Demographic and Biomteric information for the user to be added should be passed in the request body in JSON format as documented below.
`Required all json field`
If you skip json field, that field is default value ( like 0 , null). So we require all field.
`Max limit users : 500` (Our device guarantee count)
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
Array
guid
required
string

Globally Unique Identifier for users. System Generated. 20-character string.

userID
required
string

Unique and assigned by the administrator/operators.

active
boolean

true for active user and false for pending user (no biometrics information)

status
required
string
Enum: "active" "pending" "inactive"

user's status

lIrisCode
string

512-byte left iris template (base64 encoded string)

rIrisCode
string

512-byte right iris template (base64 encoded string)

faceCode
string

2121-byte face template (base64 encoded string)

title
string

User's title

firstName
string

User's first name

lastName
string

User's last name

emailAddr
string

User's email address

phoneNum
string

User's phone number

Array of objects (Card)

User's cards serial number

role
string

User type - Administrator or User. It will be augmented in the future.

department
string

User's department

adminID
string

Identifier of the administrator

adminPassword
string

Password of the administrator

recogMode
string
Enum: "Iris" "Face" "Fusion" "FaceOrIris" "FaceAndIris" "Card" "FaceOrCard" "IrisOrCard" "FusionOrCard" "FaceAndIrisOrCard" "FaceOrIrisOrCard" "FaceAndCard" "IrisAndCard" "FusionAndCard" "FaceAndIrisAndCard" "FaceOrIrisAndCard"

User recognition mode

faceImg
string <byte>

Face image - 220 x 294 JPEG

faceSmallImg
string <byte>

Small face image for thumbnail - 60 x 60 JPEG

lIrisImg
string <byte>

Left iris image for thumbnail (not for matching)

rIrisImg
string <byte>

Right iris image for thumbnail (not for matching)

enrollTimestamp
integer

Time and Date of Enrollment

userDefined1
string

User's userDefined1

userDefined2
string

User's userDefined2

userDefined3
string

User's userDefined3

userDefined4
string

User's userDefined4

userDefined5
string

User's userDefined5

userConsent
boolean

User consent. 'True' when user consent is agreed. 'False' when user consent is disagreed.

userConsentCreateTime
number <int64>

Unix timestamp at which user consent is created

userConsentUpdateTime
number <int64>

Unix timestamp at which user consent is updated

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "result": 0,
  • "userIDs": [ ],
  • "resultDetail": [
    ]
}

Delete User

DELETE /v1/users
iT100


Removes an existing user from the device. User to be removed is identified by User ID passed as query parammeter in URL.

Sample Query:
`\users?userIDs=1` to delete user with User ID 1
`Max limit users : 500` (Our device guarantee count)
query Parameters
userIDs
required
Array of strings

Users IDs for the users to be deleted

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Responses

Request samples 

curl --location --request DELETE
 'https://it100-simulator.irisid.com:4747/v1/users?userIDs=1,2' 
 --header 'x-api-key: <string>' 
 --header 'x-client-id: <string>'

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string",
  • "userIDs": [ ]
}

Get User simple list

GET /v1/userlist
iT100


Returns the simple list users for the User IDs passed in query parameter. List of all users is returned when the User ID array is empty.

Rerurns null when there are no users that match the query parameter.

Sample Queries:
`\userlist` for all users
`\userlist?offset=1` start offset 1
`\userlist?limit=1` limit count 1 : `MAX Limit = 1000`
`\pattern=name&field=firstName` : search for name in firstName field.
query Parameters
limit
int

User simple list count limit.
MAX Limit = 1000

offset
int

User simple list count offset.

pattern
string

If only Pattern is present, UserID, FirstName, and LastName will only import those containing the string.
If it is Pattern + Field, it import only if the field has a pattern.

field
string
Enum: "userID" "status" "firstName" "lastName" "role" "department"

If it is Pattern + Field, it import only if the field has a pattern.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/userlist?limit=0&offset=1' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
[
  • {
    }
]

Get User Count

GET /v1/users/count
iT100


Returns the number of users in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/users/count 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "count": 0
}

Delete all Users

DELETE /v1/users/all
iT100


Returns delete all Users in the device.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Responses

Request samples 

curl --location --request DELETE
 'https://it100-simulator.irisid.com:4747/v1/users/all 
 --header 'x-api-key: <string>' 
 --header 'x-client-id: <string>'

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string",
  • "userIDs": [ ]
}

Update users account

PUT /v1/users/account
iT100


Updates users account setting.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
userID
string

You must enter the administrator's ID.

adminPassword
string

Enter an existing password.

newAdminPassword
string

Enter the password you want to change.

adminID
string

Enter an existing login ID.

newAdminID
string

Enter the login ID to change.

Responses

Request samples

Content type
application/json
{
  • "userID": "string",
  • "adminPassword": "string",
  • "newAdminPassword": "string",
  • "adminID": "string",
  • "newAdminID": "string"
}

Response samples

Content type
application/json
{
  • "result": 0
}

User Callback Subscription

POST /v1/users/subscribe
iT100


Subcribes for callbacks that notify changes in user data like user added, modified or deleted in the device. Callback url should be passed in the request body in JSON format as documented below.

Unique identifier for this callback subscription (subscriberID) is returned in response if this API is successful. 'subscriberID' can be used for callback cancellation (Unsubscribe API).
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
url
required
string <uri>
apiKey
string

API Key to be sent in the callbacks (in header with name 'x-api-key')
It is a variable used to strengthen security.
When we call back, we include it in url's header and deliver it.
If unnecessary, you don't have to use it.

Responses

Callbacks

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "subscriberID": "string"
}

Callback payload samples

Callback
Content type
application/json
{
  • "guid": "string",
  • "userID": "string",
  • "active": true,
  • "status": "active",
  • "lIrisCode": "string",
  • "rIrisCode": "string",
  • "faceCode": "string",
  • "title": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "emailAddr": "string",
  • "phoneNum": "string",
  • "cards": [
    ],
  • "role": "string",
  • "department": "string",
  • "adminID": "string",
  • "adminPassword": "string",
  • "recogMode": "Iris",
  • "faceImg": "string",
  • "faceSmallImg": "string",
  • "lIrisImg": "string",
  • "rIrisImg": "string",
  • "enrollTimestamp": 0,
  • "userDefined1": "string",
  • "userDefined2": "string",
  • "userDefined3": "string",
  • "userDefined4": "string",
  • "userDefined5": "string",
  • "userConsent": true,
  • "userConsentCreateTime": 0,
  • "userConsentUpdateTime": 0
}

User Callback Subscription Cancellation

POST /v1/users/unsubscribe
iT100


Cancels user callback subscription. User callbacks will no longer be notified after this API call. A valid 'subscriberID' (returned by Subscribe API) should be passed in the request body.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
subscriberID
string

Responses

Request samples

Content type
application/json
{
  • "subscriberID": "string"
}

config

Configuration Management

Get Configurations

GET /v1/config
iT100 iBAR600E

Returns all configurations.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "language": "string",
  • "time": "string",
  • "timeZone": "Pacific/Majuro",
  • "ntp": "string",
  • "dateformat": 0,
  • "automaticDateTime": true,
  • "displayBrightness": 0,
  • "soundVolume": 0,
  • "dhcp": true,
  • "ipAddress": "string",
  • "subnetMask": "string",
  • "defaultGateway": "string",
  • "dns1": "string",
  • "dns2": "string",
  • "livenessDetectionForFace": true,
  • "livenessDetectionForIris": true,
  • "lensDetection": true,
  • "operationMode": "string",
  • "enableDeviceRecogMode": true,
  • "deviceRecogMode": "Iris",
  • "enableThermalCamera": true,
  • "thermalCameraUnit": "string",
  • "thermalCameraThreshold": 0.1,
  • "thermalCorrectionValue": 0.1,
  • "thermalCorrectionRatio": 0.1,
  • "wiegandFormats": [
    ],
  • "wiegandOut": {
    },
  • "deviceWiegandSetting": {
    },
  • "relayTime": 0,
  • "enableCardReader": true,
  • "cardReaderRS232BaudRate": 0,
  • "cardDeviceType": "string",
  • "cardReaderDataBits": "string",
  • "cardReaderParityBits": "string",
  • "cardReaderStopBits": "string",
  • "cardReaderStartEndChar": "string",
  • "cardReaderRS232ReadTimeout": 0,
  • "subscribedUserServer": [
    ],
  • "subscribedConfigServer": [
    ],
  • "subscribedTxLogServer": [
    ],
  • "heartbeatServer": [
    ],
  • "heartbeatURL": "string",
  • "saveAuditFaceImg": "None",
  • "activationType": "StandAlone",
  • "discoverITMS": "Manual",
  • "itmsIP": "string",
  • "itmsPort": "string",
  • "deviceActivated": true,
  • "siteKeyPassPhrase": "string",
  • "apiKeyPassPhrase": "string",
  • "lastLocalIP": "string",
  • "deviceType": "string",
  • "serialNumber": "string",
  • "deviceName": "string",
  • "softwareVersion": "string",
  • "hardwareVersion": "string",
  • "androidVersion": "string",
  • "kernelVersion": "string",
  • "macAddress": "string",
  • "thermalAccessControl": true,
  • "enableMaskDetection": true,
  • "maskAccessControl": true,
  • "door": "string",
  • "doorInterface": [ ],
  • "gpio0": {
    },
  • "gpio1": {
    },
  • "policy": {
    }
}

Update Configurations

PUT /v1/config
iT100  iBAR600E

Updates all configurations.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
language
string

Display language in the device.

time
string

Current time in the device.

timeZone
string (TimeZone)
Enum: "Pacific/Majuro" "Pacific/Midway" "Pacific/Honolulu" "America/Anchorage" "America/Los_Angeles" "America/Tijuana" "America/Phoenix" "America/Chihuahua" "America/Denver" "America/Costa_Rica" "America/Chicago" "America/Mexico_City" "America/Regina" "America/Bogota" "America/New_York" "America/Caracas" "America/Barbados" "America/Halifax" "America/Manaus" "America/Santiago" "America/St_Johns" "America/Sao_Paulo" "America/Argentina/Buenos_Aires" "America/Godthab" "America/Montevideo" "Atlantic/South_Georgia" "Atlantic/Azores" "Atlantic/Cape_Verde" "Africa/Casablanca" "Europe/London" "Europe/Amsterdam" "Europe/Belgrade" "Europe/Brussels" "Europe/Sarajevo" "Africa/Windhoek" "Africa/Brazzaville" "Asia/Amman" "Europe/Athens" "Asia/Beirut" "Africa/Cairo" "Europe/Helsinki" "Asia/Jerusalem" "Europe/Minsk" "Africa/Harare" "Asia/Baghdad" "Europe/Moscow" "Asia/Kuwait" "Africa/Nairobi" "Asia/Tehran" "Asia/Baku" "Asia/Tbilisi" "Asia/Yerevan" "Asia/Dubai" "Asia/Kabul" "Asia/Karachi" "Asia/Oral" "Asia/Yekaterinburg" "Asia/Calcutta" "Asia/Colombo" "Asia/Katmandu" "Asia/Almaty" "Asia/Rangoon" "Asia/Krasnoyarsk" "Asia/Bangkok" "Asia/Jakarta" "Asia/Shanghai" "Asia/Hong_Kong" "Asia/Irkutsk" "Asia/Kuala_Lumpur" "Australia/Perth" "Asia/Taipei" "Asia/Seoul" "Asia/Tokyo" "Asia/Yakutsk" "Australia/Adelaide" "Australia/Darwin" "Australia/Brisbane" "Australia/Hobart" "Australia/Sydney" "Asia/Vladivostok" "Pacific/Guam" "Asia/Magadan" "Pacific/Auckland" "Pacific/Fiji" "Pacific/Tongatapu"

Current Timezone in the device

ntp
string

NTP server

dateformat
integer

Time format. 12 for 12-hour clock. 24 for 24-hour clock.

automaticDateTime
boolean

Automatic date-time sync with an internet time server (NTP server).

displayBrightness
integer

Display brightness level. Valid range - 2 to 255.

soundVolume
integer

Sound volume. Valid range - 0 to 15.

dhcp
boolean

Enable/Disable DHCP.

ipAddress
string

IP Address.

subnetMask
string

Prefix length is used to define the subnet mask. It is the number of bits set to 1 in the subnet mask. For example, if the subnet mask is 255.255. 255.0, there are 24 bits set to 1 in the binary version of the subnet mask, so the prefix length is 24 bits or /24.

defaultGateway
string

Default gateway configuration.

dns1
string

Primary DNS server

dns2
string

Secondary DNS server

livenessDetectionForFace
boolean

Enable/Disable fake face detection during enrollment and recognition.

livenessDetectionForIris
boolean

Enable/Disable fake eye detection during enrollment and recognition.

lensDetection
boolean

Enable/Disable lens detection during enrollment and recognition. For future use.

operationMode
string

Operation mode: interactive or continuous. In interavtive mode, biometric capture for recognition is initiated manually. It starts automatically in continuous mode when subject comes in front of the device

enableDeviceRecogMode
boolean

Enable or disable device recognition mode.
If enabled, device recognition mode overrides the user recognition mode. All users are recognized in device recognition mode.
If disabled, users are recognized in their respective recognition modes (user recognition mode)

deviceRecogMode
string
Enum: "Iris" "Face" "Fusion" "FaceOrIris" "FaceAndIris" "Card" "FaceOrCard" "IrisOrCard" "FusionOrCard" "FaceAndIrisOrCard" "FaceOrIrisOrCard" "FaceAndCard" "IrisAndCard" "FusionAndCard" "FaceAndIrisAndCard" "FaceOrIrisAndCard"

Device recognition mode

enableThermalCamera
boolean

Enable or disable thermal camera that helps to read user's body temperature during recognition

thermalCameraUnit
string

Body temperature unit. Possible values: Celsius and Fahrenheit.

thermalCameraThreshold
number <float>

Thermal camera threshold

thermalCorrectionValue
number <float>

Thermal correction value

thermalCorrectionRatio
number <float>

Thermal correction ratio

Array of objects (WiegandFormat)
object (WiegandOutSettings)
object (DeviceWiegandConfig)
relayTime
integer

Relay duration.

enableCardReader
boolean

Enable/Disable card reader. For future use.

cardReaderRS232BaudRate
integer

Card reader baud rate. For future use.

cardDeviceType
string

Card device type. For future use.

cardReaderDataBits
string

Card reader data bits. For future use.

cardReaderParityBits
string

Card reader parity bits. For future use.

cardReaderStopBits
string

Card reader stop bits. For future use.

cardReaderStartEndChar
string

Card reader start and end character. For future use.

cardReaderRS232ReadTimeout
integer

RS232 read timeout setting.

Array of objects (CallbackSubscription)

Callback subscription details

Array of objects (CallbackSubscription)

Callback subscription details

Array of objects (CallbackSubscription)

Callback subscription details

Array of objects (CallbackSubscription)

Callback subscription details

heartbeatURL
string

URL for heartbeat check for iTMSfrom the device.

saveAuditFaceImg
string
Enum: "None" "All"

Audit face image configuration that define when to save audit face image in transaction log. This can be any of the following:

  • None - Audit face image is never saved.
  • AllTransactions - Audit face image is saved for all transactions.
  • UnauthorizedTransactions - Audit face image is saved for failure transactions.
activationType
string
Enum: "StandAlone" "ITMS"

Activation type configuration:

  • StandAlone - Stand-alone activation recommended for single door application.
  • ITMS - iTMS activation to configure the device in iTMS application framework.
discoverITMS
string
Enum: "Manual" "Auto"

iTMS discovery type (applicable only for iTMS activation):

  • Manual - Administrator shall enter iTMS information (IP and Port) manually.
  • Auto - the device will discover iTMS information automatically using mDNS.
itmsIP
string

IP address of iTMS server that the device is activated with. This is applicable only for iTMS activation.

itmsPort
string

Port that iTMS server runs on. This is applicable only for iTMS activation.

deviceActivated
boolean

Device activation status.

siteKeyPassPhrase
string

Site key passphrase. This is applicable only for StandAlone activation.

apiKeyPassPhrase
string

API key passphrase. This is applicable only for StandAlone activation.

lastLocalIP
string

Last local Ip address. Checking IP changed

deviceType
string

Device type.

serialNumber
string

Device serial number.

deviceName
string

Device name that is displayed in the device home screen.

softwareVersion
string

Software version.

hardwareVersion
string

Hardware version.

androidVersion
string

Android version.

kernelVersion
string

Kernel version.

macAddress
string

MAC address.

thermalAccessControl
boolean

Enable/Disable Thremal Access Control.

enableMaskDetection
boolean

Enable/Disable MaskDetection.

maskAccessControl
boolean

Enable/Disable Mask Access Control.

door
string

Type of policy attributes

doorInterface
Array of arrays

Select the type of door interface.

  • Relay
  • Wiegand
object (gpioInfo)

gpio settings

object (gpioInfo)

gpio settings

object (policy)

Responses

Request samples

Content type
application/json
{
  • "language": "string",
  • "time": "string",
  • "timeZone": "Pacific/Majuro",
  • "ntp": "string",
  • "dateformat": 0,
  • "automaticDateTime": true,
  • "displayBrightness": 0,
  • "soundVolume": 0,
  • "dhcp": true,
  • "ipAddress": "string",
  • "subnetMask": "string",
  • "defaultGateway": "string",
  • "dns1": "string",
  • "dns2": "string",
  • "livenessDetectionForFace": true,
  • "livenessDetectionForIris": true,
  • "lensDetection": true,
  • "operationMode": "string",
  • "enableDeviceRecogMode": true,
  • "deviceRecogMode": "Iris",
  • "enableThermalCamera": true,
  • "thermalCameraUnit": "string",
  • "thermalCameraThreshold": 0.1,
  • "thermalCorrectionValue": 0.1,
  • "thermalCorrectionRatio": 0.1,
  • "wiegandFormats": [
    ],
  • "wiegandOut": {
    },
  • "deviceWiegandSetting": {
    },
  • "relayTime": 0,
  • "enableCardReader": true,
  • "cardReaderRS232BaudRate": 0,
  • "cardDeviceType": "string",
  • "cardReaderDataBits": "string",
  • "cardReaderParityBits": "string",
  • "cardReaderStopBits": "string",
  • "cardReaderStartEndChar": "string",
  • "cardReaderRS232ReadTimeout": 0,
  • "subscribedUserServer": [
    ],
  • "subscribedConfigServer": [
    ],
  • "subscribedTxLogServer": [
    ],
  • "heartbeatServer": [
    ],
  • "heartbeatURL": "string",
  • "saveAuditFaceImg": "None",
  • "activationType": "StandAlone",
  • "discoverITMS": "Manual",
  • "itmsIP": "string",
  • "itmsPort": "string",
  • "deviceActivated": true,
  • "siteKeyPassPhrase": "string",
  • "apiKeyPassPhrase": "string",
  • "lastLocalIP": "string",
  • "deviceType": "string",
  • "serialNumber": "string",
  • "deviceName": "string",
  • "softwareVersion": "string",
  • "hardwareVersion": "string",
  • "androidVersion": "string",
  • "kernelVersion": "string",
  • "macAddress": "string",
  • "thermalAccessControl": true,
  • "enableMaskDetection": true,
  • "maskAccessControl": true,
  • "door": "string",
  • "doorInterface": [ ],
  • "gpio0": {
    },
  • "gpio1": {
    },
  • "policy": {
    }
}

Get save audit face image setting

GET /v1/config/audit-img
iT100

Returns save audit face image setting in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/audit-img' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "saveAuditFaceImg": "All"
}

Update save audit face image setting

PUT /v1/config/audit-img
iT100


Updates save audit face image setting in the device.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
saveAuditFaceImg
string
Enum: "All" "None" "Success" "Failed" "Unauthorized" "Except for Card-only"

setting saveAuditFaceimge option.

  • All - Audit face image is saved for all transactions.
  • None - Audit face image is never saved.
  • Success - Audit face image is saved for Success transactions.
  • Failed - Audit face image is saved for failure transactions.
  • Unauthorized - Audit face image is saved for unauthorized transactions.
  • Except for Card-only - Audit face image is saved for Except for Card-only transactions.

Responses

Request samples

Content type
application/json
{
  • "saveAuditFaceImg": "All"
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Get Cardreader setting

GET /v1/config/cardreader
iT100

Returns Cardreader in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/cardreader' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "enableCardReader": true,
  • "cardReaderRS232BaudRate": 0,
  • "enableWiegandIn": true,
  • "cardDeviceType": "string",
  • "cardReaderParityBits": "string",
  • "cardReaderStopBits": "string",
  • "cardReaderStartEndChar": "string",
  • "cardReaderRS232ReadTimeout": 0
}

Update Cardreader setting

PUT /v1/config/cardreader
iT100

Updates Cardreader setting in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
enableCardReader
boolean

Enable/Disable card reader. For future use.

cardReaderRS232BaudRate
integer

Card reader baud rate. For future use.

enableWiegandIn
boolean

Enable or Disable the Wiegand Input Port.

cardDeviceType
string

Card device type. For future use.

cardReaderParityBits
string

Card reader parity bits. For future use.

cardReaderStopBits
string

Card reader stop bits. For future use.

cardReaderStartEndChar
string

Card reader start and end character. For future use.

cardReaderRS232ReadTimeout
integer

RS232 read timeout setting.

Responses

Request samples

Content type
application/json
{
  • "enableCardReader": true,
  • "cardReaderRS232BaudRate": 0,
  • "enableWiegandIn": true,
  • "cardDeviceType": "string",
  • "cardReaderParityBits": "string",
  • "cardReaderStopBits": "string",
  • "cardReaderStartEndChar": "string",
  • "cardReaderRS232ReadTimeout": 0
}

Response samples

Content type
application/json
{
  • "result": 0
}

Get Door Setting

GET /v1/config/door
iT100

Returns current Door setting in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/door' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "door": "string",
  • "doorInterface": [ ]
}

Update Door setting

PUT /v1/config/door
iT100

Updates Door setting in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
door
string

Type of policy attributes

doorInterface
Array of arrays

Select the type of door interface.

  • Relay
  • Wiegand

Responses

Request samples

Content type
application/json
{
  • "door": "string",
  • "doorInterface": [ ]
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Get Countermeasure Setting

GET /v1/config/countermeasure
iT100 iBAR600E

Returns current Countermeasure setting in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/countermeasure' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "livenessDetectionForFace": true,
  • "livenessDetectionForIris": true,
  • "lensDetection": true
}

Update Countermeasure setting

PUT /v1/config/countermeasure
iT100 iBAR600E

Updates Countermeasure setting.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
livenessDetectionForFace
boolean

setting livenessDetectionForFace option.

livenessDetectionForIris
boolean

setting livenessDetectionForIris option.

lensDetection
boolean

setting lensDetection option. The value is not working yet.

Responses

Request samples

Content type
application/json
{
  • "livenessDetectionForFace": true,
  • "livenessDetectionForIris": true,
  • "lensDetection": true
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Get MaskDetection Setting

GET /v1/config/mask-detection
iT100

Returns current MaskDetection setting in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/mask-detection' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "enableMaskDetection": true,
  • "maskAccessControl": true
}

Update MaskDetection setting

PUT /v1/config/mask-detection
iT100

Updates MaskDetection setting in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
enableMaskDetection
boolean

Enable/Disable MaskDetection.

maskAccessControl
boolean

Enable/Disable Mask Access Control.

Responses

Request samples

Content type
application/json
{
  • "enableMaskDetection": true,
  • "maskAccessControl": true
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Get operation mode configuration

GET /v1/config/operation-mode
iT100


Returns operation mode configuration.
header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/operation-mode' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "operationMode": "interactive"
}

Update operation mode configuration

PUT /v1/config/operation-mode
iT100


Updates operation mode configuration. Available operation modes: Continuous & Interactive.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
operationMode
string
Enum: "interactive" "continuous"

Operation mode setting: interactive or continuous. In interactive mode, biometric capture for recognition is initiated manually. It starts automatically in continuous mode when subject comes in front of the device

Responses

Request samples

Content type
application/json
{
  • "operationMode": "interactive"
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Get gpio configuration

GET /v1/config/gpio
iT100


Returns gpio configuration.
header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/gpio' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "gpio0": {
    },
  • "gpio1": {
    }
}

Update gpio configuration

PUT /v1/config/gpio
iT100


Updates gpio configuration
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
object (gpioInfo)

gpio settings

object (gpioInfo)

gpio settings

Responses

Request samples

Content type
application/json
{
  • "gpio0": {
    },
  • "gpio1": {
    }
}

Get gpio0in state

GET /v1/config/gpio0in
iT100


Returns gpio0in state.
header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/gpio0in' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "result": 0
}

Get gpio1in state

GET /v1/config/gpio1in
iT100


Returns gpio1in state.
header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/gpio1in' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "result": 0
}

Get relay settings

GET /v1/config/relay
iT100


Returns relay settings.
header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/relay' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "enableRelay": true,
  • "relayTimer": "string",
  • "relayTime": 0
}

Update relay settings

PUT /v1/config/relay
iT100


Updates relay settings.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
enableRelay
boolean

Enable or disable relay activation. If enabled, relay is activated after successful identification

relayTimer
string

Relay activation duration in seconds

relayTime
integer

Relay activation duration in seconds

Responses

Request samples

Content type
application/json
{
  • "enableRelay": true,
  • "relayTimer": "string",
  • "relayTime": 0
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Update Device Name

PUT /v1/config/device-name
iT100 iBAR600E

Updates device name setting.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
deviceName
string

Responses

Request samples

Content type
application/json
{
  • "deviceName": "string"
}

Get Display Settings

GET /v1/config/display
iT100


Returns current display settings in the device.
header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/display' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "displayBrightness": 1
}

Update Display Settings

PUT /v1/config/display
iT100


Updates display settings.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
displayBrightness
required
integer [ 1 .. 255 ]

Display Brightness

Responses

Request samples

Content type
application/json
{
  • "displayBrightness": 1
}

Get Language Settings

GET /v1/config/language
iT100


Returns current language settings in the device.
header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/language' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "language": "en"
}

Update Language Settings

PUT /v1/config/language
iT100


Updates language settings.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
language
required
string
Enum: "en" "ko" "fr" "zh" "ja" "de" "es" "it" "ar" "tr"

en - English ko - Korean fr - French zh - Chinese ja - Japanese de - German es - Spanish it - Italian ar - Arabic tr - Trukish

Responses

Request samples

Content type
application/json
{
  • "language": "en"
}

Get Sound Volume

GET /v1/config/volume
iT100


Returns current sound volume level. Sound valume range: 0 to 15.
header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/volume' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "soundVolume": 15
}

Update Sound Volume

PUT /v1/config/volume
iT100


Updates sound volume lavel. Sound valume range: 0 to 15.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
soundVolume
required
integer [ 0 .. 15 ]

Volume Level

Responses

Request samples

Content type
application/json
{
  • "soundVolume": 15
}

Get Network Settings

GET /v1/config/network
iT100 iBAR600E

Returns current network settings in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/network' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "dhcp": true,
  • "ipAddress": "string",
  • "subnetMask": "string",
  • "defaultGateway": "string",
  • "dns1": "string",
  • "dns2": "string"
}

Update Network Settings

PUT /v1/config/network
iT100 iBAR600E

Update network settings in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
dhcp
boolean
ipAddress
string
subnetMask
string
defaultGateway
string
dns1
string
dns2
string

Responses

Request samples

Content type
application/json
{
  • "dhcp": true,
  • "ipAddress": "string",
  • "subnetMask": "string",
  • "defaultGateway": "string",
  • "dns1": "string",
  • "dns2": "string"
}

Get Date-Time settings

GET /v1/config/date-time
iT100 iBAR600E

Returns current date-time settings in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/date-time' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "automaticDateTime": true,
  • "time": "2019-08-24T14:15:22Z",
  • "timezone": "Pacific/Majuro",
  • "ntp": "string",
  • "dateformat": 12
}

Update Date-Time Settings

PUT /v1/config/date-time
iT100 iBAR600E

Updates date-time settings in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
automaticDateTime
boolean
time
string <date-time>

Date Time

timezone
string (TimeZone)
Enum: "Pacific/Majuro" "Pacific/Midway" "Pacific/Honolulu" "America/Anchorage" "America/Los_Angeles" "America/Tijuana" "America/Phoenix" "America/Chihuahua" "America/Denver" "America/Costa_Rica" "America/Chicago" "America/Mexico_City" "America/Regina" "America/Bogota" "America/New_York" "America/Caracas" "America/Barbados" "America/Halifax" "America/Manaus" "America/Santiago" "America/St_Johns" "America/Sao_Paulo" "America/Argentina/Buenos_Aires" "America/Godthab" "America/Montevideo" "Atlantic/South_Georgia" "Atlantic/Azores" "Atlantic/Cape_Verde" "Africa/Casablanca" "Europe/London" "Europe/Amsterdam" "Europe/Belgrade" "Europe/Brussels" "Europe/Sarajevo" "Africa/Windhoek" "Africa/Brazzaville" "Asia/Amman" "Europe/Athens" "Asia/Beirut" "Africa/Cairo" "Europe/Helsinki" "Asia/Jerusalem" "Europe/Minsk" "Africa/Harare" "Asia/Baghdad" "Europe/Moscow" "Asia/Kuwait" "Africa/Nairobi" "Asia/Tehran" "Asia/Baku" "Asia/Tbilisi" "Asia/Yerevan" "Asia/Dubai" "Asia/Kabul" "Asia/Karachi" "Asia/Oral" "Asia/Yekaterinburg" "Asia/Calcutta" "Asia/Colombo" "Asia/Katmandu" "Asia/Almaty" "Asia/Rangoon" "Asia/Krasnoyarsk" "Asia/Bangkok" "Asia/Jakarta" "Asia/Shanghai" "Asia/Hong_Kong" "Asia/Irkutsk" "Asia/Kuala_Lumpur" "Australia/Perth" "Asia/Taipei" "Asia/Seoul" "Asia/Tokyo" "Asia/Yakutsk" "Australia/Adelaide" "Australia/Darwin" "Australia/Brisbane" "Australia/Hobart" "Australia/Sydney" "Asia/Vladivostok" "Pacific/Guam" "Asia/Magadan" "Pacific/Auckland" "Pacific/Fiji" "Pacific/Tongatapu"

Current Timezone in the device

ntp
string

NTP server

dateformat
integer
Enum: 12 24

Time format. 12 for 12-hour clock. 24 for 24-hour clock.

Responses

Request samples

Content type
application/json
{
  • "automaticDateTime": true,
  • "time": "2019-08-24T14:15:22Z",
  • "timezone": "Pacific/Majuro",
  • "ntp": "string",
  • "dateformat": 12
}

Get Fake Eye Detction Setting

GET /v1/config/fake-eye-detection
iT100


Returns current Fake Eye Detection setting in the device.
header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/fake-eye-detection' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "fakeEyeDetection": true
}

Update Fake Eye Detction setting

PUT /v1/config/fake-eye-detection
iT100


Updates Fake Eye Detection setting in the device.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
fakeEyeDetection
boolean

Responses

Request samples

Content type
application/json
{
  • "fakeEyeDetection": true
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Config Callback Subscription

POST /v1/config/subscribe
iT100 iBAR600E

Subscribes for callbacks that notify changes in certain configurations. Callback url should be passed in the request body in JSON format as documented below.

Unique identifier for this callback subscription (subscriberID) is returned in response if this API is successful. 'subscriberID' can be used for callback cancellation (Unsubscribe API).

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
url
required
string <uri>
apiKey
string

API Key to be sent in the callbacks (in header with name 'x-api-key')
It is a variable used to strengthen security.
When we call back, we include it in url's header and deliver it.
If unnecessary, you don't have to use it.

Responses

Callbacks

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "subscriberID": "string"
}

Callback payload samples

Callback
Content type
application/json
{
  • "ip": "string",
  • "port": "string",
  • "serialNumber": "string"
}

Config Callback Subscription Cancellation

POST /v1/config/unsubscribe
iT100 iBAR600E

Cancels config callback subscription. Changes in configuration will no longer be notified. A valid 'subscriberID' (returned by Subscribe API) should be passed in the request body.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
subscriberID
string

Responses

Request samples

Content type
application/json
{
  • "subscriberID": "string"
}

Get Thermal Camera Settings

GET /v1/config/thermal-camera
iT100


Returns thermal camera settings.
header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/thermal-camera' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "enableThermalCamera": true,
  • "thermalCameraUnit": "Celsius",
  • "thermalCameraThreshold": 0.1,
  • "thermalCorrectionValue": 0.1,
  • "thermalCorrectionRatio": 0.1,
  • "thermalAccessControl": true
}

Update Thermal Camera Settings

PUT /v1/config/thermal-camera
iT100


Updates thermal camera settings in the device.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
enableThermalCamera
boolean

Enable or disable thermal camera

thermalCameraUnit
string
Enum: "Celsius" "Fahrenheit"

Thermal unit: Celsius or Fahrenheit

thermalCameraThreshold
number <float>

Thermal camera threshold

thermalCorrectionValue
number <float>

Thermal correction value

thermalCorrectionRatio
number <float>

Thermal correction ratio

thermalAccessControl
boolean

Enable or disable thermal access control

Responses

Request samples

Content type
application/json
{
  • "enableThermalCamera": true,
  • "thermalCameraUnit": "Celsius",
  • "thermalCameraThreshold": 0.1,
  • "thermalCorrectionValue": 0.1,
  • "thermalCorrectionRatio": 0.1,
  • "thermalAccessControl": true
}

Get Device Recognition Mode Settings

GET /v1/config/device-recog-mode
iT100


Returns current device recognition mode settings.
header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/device-recog-mode' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "enableDeviceRecogMode": true,
  • "deviceRecogMode": "Iris"
}

Update Device Recognition Mode Settings

PUT /v1/config/device-recog-mode
iT100


Updates device recogniton mode settings.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
enableDeviceRecogMode
boolean

Enable or disable device recognition mode.
If enabled, device recognition mode overrides the user recognition mode. All users are recognized in device recognition mode.
If disabled, users are recognized in their respective recognition modes (user recognition mode)

deviceRecogMode
string
Enum: "Iris" "Face" "Fusion" "FaceOrIris" "FaceAndIris" "Card" "FaceOrCard" "IrisOrCard" "FusionOrCard" "FaceAndIrisOrCard" "FaceOrIrisOrCard" "FaceAndCard" "IrisAndCard" "FusionAndCard" "FaceAndIrisAndCard" "FaceOrIrisAndCard"

Device recognition mode

Responses

Request samples

Content type
application/json
{
  • "enableDeviceRecogMode": true,
  • "deviceRecogMode": "Iris"
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Get Device Wiegand Configurations

GET /v1/config/wiegand
iT100


Returns device specific wiegand configurations.
header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/wiegand' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "enableWiegandIn": true,
  • "wiegandInFormatIDs": [
    ],
  • "wiegandInIgnoreFacilityCode": true,
  • "wiegandOutPulseWidthInterval": "100us/1000us"
}

Update Device Wiegand Settings

PUT /v1/config/wiegand
iT100


Updates device specific wiegand settings.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
enableWiegandIn
boolean

Enable or Disable the Wiegand Input Port.

wiegandInFormatIDs
Array of strings

Accepted wiegand formats

wiegandInIgnoreFacilityCode
boolean

When this flag is false, the Wiegand input will check that the Facility Code of the card matches to the number in the Facility Code field.

wiegandOutPulseWidthInterval
string
Enum: "100us/1000us" "40us/2000us"

Wiegand output speed that can be any of the following:

  • "100us/1000us" - Fast.
  • "40us/2000us" - Slow.

Responses

Request samples

Content type
application/json
{
  • "enableWiegandIn": true,
  • "wiegandInFormatIDs": [
    ],
  • "wiegandInIgnoreFacilityCode": true,
  • "wiegandOutPulseWidthInterval": "100us/1000us"
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Get WiegandFormats setting

GET /v1/config/wiegand-formats
iT100


Returns WiegandFormats in the device.
header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/wiegand-formats' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "id": "string",
  • "totalBits": 0,
  • "name": "string",
  • "cardIDStart": 0,
  • "cardIDLen": 0,
  • "cardIDMask": 0,
  • "facilityCodeStart": 0,
  • "facilityCodeLen": 0,
  • "facilityCodeMask": 0,
  • "parityChecks": [
    ]
}

Update WiegandFormats setting

PUT /v1/config/wiegand-formats
iT100


Updates WiegandFormats setting in the device.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
id
string

Id of WiegandFormat

totalBits
integer

TotalBits of WiegandFormat

name
string

Name of WiegandFormat

cardIDStart
integer

CarIDStart of WiegandFormat

cardIDLen
integer

CardIDLen of WiegandFormat

cardIDMask
integer

CardIDMask of WiegandFormat

facilityCodeStart
integer

FacilityCodeStart of WiegandFormat

facilityCodeLen
integer

FacilityCodeLen of WiegandFormat

facilityCodeMask
integer

FacilityCodeMask of WiegandFormat

Array of objects (ParityCheck)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "totalBits": 0,
  • "name": "string",
  • "cardIDStart": 0,
  • "cardIDLen": 0,
  • "cardIDMask": 0,
  • "facilityCodeStart": 0,
  • "facilityCodeLen": 0,
  • "facilityCodeMask": 0,
  • "parityChecks": [
    ]
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Set Logo

PUT /v1/config/logo
iBAR600E

Sets the image on iBar's circular LCD.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Request Body schema: application/json
image
string

The custom logo in base64 encoding. This image is displayed on iBar's circular LCD. Default logo is set when this string is empty.

text
string

A custom text message that will be displayed for 15 seconds to protect the screen from burn-in.

Responses

Request samples

Content type
application/json
{
  • "image": "string",
  • "text": "string"
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

API Key Update

PUT /v1/config/api-key
iBAR600E

Sets the new API key.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Request Body schema: application/json
apiKey
string

New API key to be set.

Responses

Request samples

Content type
application/json
{
  • "apiKey": "string"
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Get Color Camera Settings

GET /v1/config/color-camera
iBAR600E

Returns the current color camera settings.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Responses

Response samples

Content type
application/json
{
  • "whiteBalance": "auto",
  • "brightness": -3,
  • "saturation": 0,
  • "gamma": 0,
  • "tone": "normal",
  • "sharpeness": -2,
  • "iso": "auto",
  • "iHDR": true,
  • "backlightCompensation": 0
}

Update Color Camera Settings

PUT /v1/config/color-camera
iBAR600E

Updates the color camera configurations that will reflect in the live video feed and in the final face picture from iBAR600E.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Request Body schema: application/json
whiteBalance
string
Default: "auto"
Enum: "auto" "HOR" "A" "CWF" "D50" "D65" "D75"

White Balance Setting

brightness
integer
Default: 0
Enum: -3 -2 -1 0 1 2 3 4 5

Brightness Setting

saturation
number <float>
Default: 1
Enum: 0 0.5 1 1.5 2

Saturation Setting

gamma
number <float>
Default: 0
Enum: 0 1.5 2 2.2 2.5

Gamma Setting

tone
string
Default: "normal"
Enum: "normal" "reddish" "bluish" "greenish"

Tone Setting

sharpeness
number <float>
Default: 0
Enum: -2 -1 -0.5 0 0.5 1 2

Sharpeness Setting

iso
string
Default: "auto"
Enum: "auto" "100" "200" "400" "800"

ISO Setting

iHDR
boolean
Default: true

iHDR Setting

backlightCompensation
integer
Default: 2
Enum: 0 1 2 3

Backlight Compensation Setting

Responses

Request samples

Content type
application/json
{
  • "whiteBalance": "auto",
  • "brightness": -3,
  • "saturation": 0,
  • "gamma": 0,
  • "tone": "normal",
  • "sharpeness": -2,
  • "iso": "auto",
  • "iHDR": true,
  • "backlightCompensation": 0
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Get Default Camera Position

GET /v1/config/default-camera-position
iBAR600E

Returns the current 'Default camera position' setting. Camera position is the angle at which camera starts capturing.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Responses

Response samples

Content type
application/json
{
  • "defaultCameraPosition": 0
}

Update Default Camera Position

PUT /v1/config/default-camera-position
iBAR600E

Updates the initial angle at which camera starts capturing. Camera postion can range from -35 to +35.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Request Body schema: application/json
defaultCameraPosition
integer [ -35 .. 35 ]
Default: 0

Camera tilt angle to be set initially

Responses

Request samples

Content type
application/json
{
  • "defaultCameraPosition": 0
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

templates

Biometric Templates

Capture biometric templates

POST /v1/templates
iT100

Initiates capturing of iris and/or face images. This API returns immediately after the initiation of capture procedure. The biometric templates are sent back to the caller via callbacks as decribed below.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
url
string

Callback URL to receive the result of capture procedure.

apiKey
string

API Key to be sent in the callbacks (in header with name 'x-api-key')

userConsent
boolean

Flag to enable/disable user consent prompt

Responses

Callbacks

Request samples

Content type
application/json
{
  • "url": "string",
  • "apiKey": "string",
  • "userConsent": true
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Callback payload samples

Callback
POST: {$request.body#/captureResultCallbackURL}
Content type
application/json
{
  • "result": 0,
  • "faceImg": "string",
  • "faceSmallImg": "string",
  • "lIrisImg": "string",
  • "rIrisImg": "string",
  • "faceCode": "string",
  • "lIrisCode": "string",
  • "rIrisCode": "string",
  • "userID": "string",
  • "matchedEye": "string",
  • "faceScore": "string",
  • "irisScore": "string",
  • "ipd": "string",
  • "faceStatus": "Success",
  • "LeftEyeStatus": "Success",
  • "RightEyeStatus": "Success",
  • "userConsent": true,
  • "userConsentCreateTime": 0,
  • "userConsentUpdateTime": 0
}

Generates face templates for face images

POST /v1/templates/facecode
iT100

Generates face templates for an array of face images. Generated face templates are sent back in a callback on the URL supplied.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client (optional)

Request Body schema: application/json
url
string

Callback URL to receive the face templates generated for the face images.

apiKey
string

API Key to be sent in the callback (in header with name 'x-api-key')

Array of objects (FaceImageInfo)

List of face image information to generate face templates

Responses

Callbacks

Request samples

Content type
application/json
{
  • "url": "string",
  • "apiKey": "string",
  • "imageInfo": [
    ]
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Callback payload samples

Callback
POST: {$request.body#/url}
Content type
application/json
{
  • "result ": "string",
  • "faceCodeInfo": [
    ]
}

transactions

Transaction Logs

Get Transaction Logs - [GET] /v1/transactions

GET /v1/transactions
iT100

Returns the list of transaction logs based on query parameters.

Sample Queries:
`\transactions` for all transactions
`\transactions?startTransactionID=0&endTransactionID=100` to retrieve transactions with Transaction ID 0 to 100.
`\transactions?UserIDs=1111` to retrieve all transactions of the user with the User ID: 1111.
`\transactions?startTimestamp=x&endTimestamp=y` to retrieve transactions from x to y time interval. Date-time stamp shall be in RFC 3339 (ISO 8601) standard.

`MAX limit : 10000`
You can get transaction logs count `\transactions\count`.
If the number of transaction logs is more than 10,000, we have to divide and get the transaction logs.
ex) first `\transactions?startTransactionID=0&endTransactionID=10000`
next `\transactions?startTransactionID=10001&endTransactionID=20000`

query Parameters
userIDs
string

User ID filter, one or more User IDs can be specified. Transactions of users with User IDs will be returned when this filter is applied.

startTimestamp
string

Date-time filter, timestamp shall be in RFC 3339 format. Transactions on or after the timestamp will be returned when this filter is applied.

endTimestamp
string

Date-time filter, timestamp shall be in RFC 3339 format. Transactions on or prior to the timestamp will be returned when this filter is applied.

startTransactionID
integer

Transaction ID filter. Transaction ID is part transaction record. Transactions after the specified transaction ID will be returned when this filter is applied.

endTransactionID
integer

Transaction ID filter. Transaction ID is part transaction record. Transactions occured before the transaction identified by the transaction ID will be returned when this filter is applied.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/transactions'
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
[
  • {
    }
]

Delete Transaction Logs

DELETE /v1/transactions
iT100

Deletes transaction logs based on query parameters.

Sample Queries:
`\transactions` to delete all transactions
`\transactions?startTransactionID=0&endTransactionID=100` to delete transactions with Transaction ID 0 to 100.
`\transactions?UserIDs=1111` to delete all transactions of the user with the User ID: 1111.
`\transactions?startTimestamp=x&endTimestamp=y` to delete transactions from x to y time interval. Date-time stamp shall be in RFC 3339 (ISO 8601) standard.

`MAX limit : 10000`
You can get transaction logs count `\transactions\count`.
If the number of transaction logs is more than 10,000, we have to divide and get the transaction logs.
ex) first `\transactions?startTransactionID=0&endTransactionID=10000`
next `\transactions?startTransactionID=10001&endTransactionID=20000`

query Parameters
userIDs
string

User ID filter, one or more User IDs can be specified. Transactions of users with User IDs will be returned when this filter is applied.

startTimestamp
string

Date-time filter, timestamp shall be in RFC 3339 format. Transactions on or after the timestamp will be returned when this filter is applied.

endTimestamp
string

Date-time filter, timestamp shall be in RFC 3339 format. Transactions on or prior to the timestamp will be returned when this filter is applied.

startTransactionID
integer

Transaction ID filter. Transaction ID is part transaction record. Transactions after the specified transaction ID will be returned when this filter is applied.

endTransactionID
integer

Transaction ID filter. Transaction ID is part transaction record. Transactions occured before the transaction identified by the transaction ID will be returned when this filter is applied.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Responses

Request samples 

curl --location --request DELETE
 'https://it100-simulator.irisid.com:4747/v1/transactions?userIDs=1&startTransactionID=1&endTransactionID=10'
 --header 'x-api-key: <string>'
 --header 'x-client-id: <string>'

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Get transactions Count

GET /v1/transactions/count
iT100

Returns the number of transactions in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/transactions/count 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "count": 0
}

Transaction Log Subscription

POST /v1/transactions/subscribe
iT100

Subscribes for new transaction callbacks in the device. Callback url should be passed in the request body in JSON format as documented below.

Unique identifier for this callback subscription (subscriberID) is returned in response if this API is successful. 'subscriberID' can be used for callback cancellation (Unsubscribe API).

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
url
string <uri>
apiKey
string

API Key to be sent in the callbacks (in header with name 'x-api-key')
It is a variable used to strengthen security.
When we call back, we include it in url's header and deliver it.
If unnecessary, you don't have to use it.

Responses

Callbacks

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "subscriberID": "string"
}

Callback payload samples

Callback
POST: {$request.body#/url}
Content type
application/json
{
  • "transactionID": 0,
  • "deviceName": "string",
  • "deviceSN": "string",
  • "guid": "string",
  • "userID": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "role": "string",
  • "department": "string",
  • "verifiedBy": "Face",
  • "verifiedCard": {
    },
  • "pin": "string",
  • "transactionType": "string",
  • "transactionResult": "Identified",
  • "recogMode": "Iris",
  • "matchedEye": "none",
  • "irisScore": 0.1,
  • "faceScore": 0.1,
  • "fusionScore": 0.1,
  • "auditFaceImg": "string",
  • "ipd": 0.1,
  • "elapsedTime": 0.1,
  • "timestamp": "string",
  • "userDefined1": "string",
  • "userDefined2": "string",
  • "userDefined3": "string",
  • "userDefined4": "string",
  • "userDefined5": "string"
}

Transaction Log Callback Subscription Cancellation

POST /v1/transactions/unsubscribe
iT100

Cancels transaction log callback subscription. New transaction logs will no longer be notified. A valid 'subscriberID' (returned by Subscribe API) should be passed in the request body.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
subscriberID
string

Subscriber ID.
You can find more information in /config.

Responses

Request samples

Content type
application/json
{
  • "subscriberID": "string"
}

heartbeat

Heartbeat

Heartbeat Check

GET /v1/heartbeat
iT100  iBAR600E

Sends heartbeat request. Heartbeat success indicates that the device is online. Heartbeat failure indicates that the device is offline (turned off or network failure).

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/heartbeat' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "remoteAddress": "string",
  • "forwardedFor": "string"
}

Heartbeat Subscription - [POST] /v1/heartbeat/url

POST /v1/heartbeat/url
iT100  iBAR600E

Subscribes for heartbeat by supplying URL for the device to reach back custom application/service for heartbeat check.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
url
required
string <uri>

Responses

Request samples

Content type
application/json
{}

policy

System Level Policies

Get Device Wiegand Configurations

GET /v1/policy/wiegand
iT100


Returns device specific wiegand configurations.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/policy/wiegand' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "wiegandFormats": [
    ],
  • "wiegandOut": {
    }
}

Update Device Wiegand Settings

PUT /v1/policy/wiegand
iT100


Updates device specific wiegand settings.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
Array of objects (WiegandFormat)
object (WiegandOutSettings)

Responses

Request samples

Content type
application/json
{
  • "wiegandFormats": [
    ],
  • "wiegandOut": {
    }
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Delete WiegandFormats

DELETE /v1/policy/wiegand
iT100


Removes existing WiegandFormats from the device. WiegandFormats to be removed is identified by totalBits passed as query parammeter in URL.

Sample Query:
`\wiegand-formats?totalBits=1` to delete WiegandFormats with User totalBits 1
query Parameters
totalBits
required
Array of strings

TotalBits for the WiegandFormats to be deleted

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Responses

Request samples 

curl --location --request DELETE
 'https://it100-simulator.irisid.com:4747/v1/config/wiegand-formats?totalBits=1,2' 
 --header 'x-api-key: <string>' 
 --header 'x-client-id: <string>'

Get policy settings

GET /v1/policy/access-control
iT100


Returns policy settings.
header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/policy/access-control' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "rules": [
    ]
}

Update policy settings

PUT /v1/policy/access-control
iT100


Updates policy settings.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
object (attributes)
Array of objects (rule)

Policy rule

Responses

Request samples

Content type
application/json
{
  • "attributes": {
    },
  • "rules": [
    ]
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

images

Iris and face images

Capture Iris and Face Images

POST /v1/images
iBAR600E

Starts iris and/or face image capture. This API returns immediately after the initiation of capture procedure. The biometric images are sent back to the caller via callback as decribed below.

Capture timeout works as described below:

* Capture operation is timed out in 10 seconds when no person is present (no human face detected) in front of iBar600. Capture timeout result is returned to the client.

* Capture operation is timed out in 20 seconds when person is present in front of iBar600, but not in (and continues to be out of) capture range, may be too near, too far, on the left side, on the right side, too tall or too short. Capture timeout result is returned to the client.

* When subject is in range and capture could not be completed, capture operation is now timed out after 30 seconds. Within this timeout period, capture would be attempted for 5 times and if capture failure occurs in every attempt, capture would fail and the result is retuned to the client accordingly.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Request Body schema: application/json

Inventory item to add

captureIris
required
boolean

Enables iris capture. If true, iris images are captured and included in the callback response.

captureFace
required
boolean

Enables face capture. If true, face pictures are captured and included in the callback response.

url
required
string

REST API end-point to receive the capture result callback.

positionGuideUrl
string

REST API end-point to receive user position guide callbacks.

irisImageFormat
required
string
Enum: "jpg" "bmp" "png"

Image format for the iris images. Jpeg, BMP and PNG are the supported image formats.

faceImageFormat
required
string
Enum: "jpg" "bmp" "png"

Image format for the face pictures. Jpeg, BMP and PNG are the supported image formats.

Responses

Callbacks

Request samples

Content type
application/json
{
  • "captureIris": true,
  • "captureFace": true,
  • "url": "string",
  • "positionGuideUrl": "string",
  • "irisImageFormat": "jpg",
  • "faceImageFormat": "jpg"
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Callback payload samples

Callback
Content type
application/json
{
  • "result": 0,
  • "message": "string",
  • "faceStatus": "success",
  • "faceImage": "string",
  • "faceImageCropped": "string",
  • "leftEyeStatus": "success",
  • "leftIrisImage": "string",
  • "leftEyeQualityMetrics": {
    },
  • "rightEyeStatus": "success",
  • "rightIrisImage": "string",
  • "rightEyeQualityMetrics": {
    },
  • "distance": 0,
  • "captureTime": "string"
}

video

Video streaming

Start Video Streaming

POST /v1/video/start
iBAR600E

Establishes WebRTC session and starts video streaming via WebRTC channel. Caller shall create RTCPeerConnection object, create an SDP offer (using createOffer method) and shall include the session descriptor (webRTCOffer) in request body as described in the request body section.

The API returns the session descriptor (WebRTC answer) for the remote end of the connection. This can be set as remote description (by setting RTCPeerConnection object's 'remoteDescription' property) to get the connection estblished. Video streaming starts as soon as the connection is established.

Please refer Javascript example below: | | | ----------- | let pc = new RTCPeerConnection()
pc.addTransceiver('video', {'direction': 'sendrecv'})
pc.ontrack = function (event) { document.getElementById('remoteVideo').srcObject = event.streams[0]; }

const offer = await pc.createOffer();
await pc.setLocalDescription(offer);

var startVideoParam = {"webRTCOffer": btoa(JSON.stringify(pc.localDescription))}.

await fetch("\startVideo", { method: 'POST', body: JSON.stringify(startVideoParam), headers: { 'Content-Type': 'application/json' }

pc.setRemoteDescription(new RTCSessionDescription(JSON.parse(atob(req.webRTCAnswer)))) | | | ----------- |

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Request Body schema: application/json
webRTCOffer
string

WebRTC offer.

candidates
string

Base64 encoded JSON object that contains an array of 'RTCIceCandidate' objects. These objects are obtained from several 'onicecandidate' event from 'RTCPeerConnection' object.

Responses

Request samples

Content type
application/json
{
  • "webRTCOffer": "string",
  • "candidates": "string"
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string",
  • "webRTCAnswer": "string",
  • "candidates": "string"
}

Stop Video Streaming

POST /v1/video/stop
iBAR600E

Stops video streaming and closes WebRTC communication channel.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Responses

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

logger

Log Configuration

SysLog Configuration

PUT /v1/logger/syslog
iT100 iBAR600E

Updates the syslog configuration.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Request Body schema: application/json
One of
url
string

URL to the syslog server.

level
integer

Log Level

  • 0 : LOG_LEVEL_VERBOSE
  • 1 : LOG_LEVEL_DEBUG
  • 2 : LOG_LEVEL_INFO
  • 3 : LOG_LEVEL_WARNING
  • 4 : LOG_LEVEL_ERROR
  • 5 : LOG_LEVEL_FATAL
  • 6 : LOG_LEVEL_SILENT

Responses

Request samples

Content type
application/json
Example
{
  • "url": "string",
  • "level": 0
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

SysLog Configuration

GET /v1/logger/syslog
iT100 iBAR600E

Returns the syslog configuration.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Responses

Response samples

Content type
application/json
Example
{
  • "url": "string",
  • "level": 0,
  • "status": "string"
}

Enable SysLog

POST /v1/logger/syslog/start
iT100 iBAR600E

Enables sending syslog messages to the server as configured via '/v1/logger/syslog' endpoint.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Responses

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Disable SysLog

POST /v1/logger/syslog/stop
iT100 iBAR600E

Disables sending syslog messages to the server.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Responses

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Update Logger Configuration

PUT /v1/logger
iT100 iBAR600E

Updates the logger configuration.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Request Body schema: application/json
level
integer

Log Level

  • 1 : FATAL - to log only FATAL messages
  • 2 : ERROR - to log ERROR and FATAL messages
  • 3 : WARN - to log WARNING, FATAL and ERROR messages
  • 4 : INFO - to log INFORMATION, FATAL, ERROR and WARNING messages
  • 5 : BEGIN - to log BEGIN, FATAL, ERROR, WARNING and INFORMATION messages
  • 6 : END - to log END, FATAL, ERROR, WARNING, INFORMATION and BEGIN messages
  • 7 : DEBUG - to log DEBUG, FATAL, ERROR, WARNING, INFORMATION, BEGIN and END messages
logcatEnabled
boolean

Enable or disable logcat logs. This configuration is only applicable for iT100 devices.

Responses

Request samples

Content type
application/json
{
  • "level": 0,
  • "logcatEnabled": true
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

device

Device activities & information

Deactivate Device

POST /v1/device/deactivate
iT100 iBAR600E

Deactivates the device so that no further API calls to the device can be made. Once the device is deactivated, it deletes all device configurations and user information stored in the device and restarts the device automatically. In case of the iTMS activation, this operation will remove the device from the iTMS Device Management screen until thethe device checks back in to the iTMS again.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Responses

Request samples 

curl --location --request POST
 'https://it100-simulator.irisid.com:4747/v1/device/deactivate' 
 --header 'x-api-key: <string>' 
 --header 'x-client-id: <string>'

Open device door

POST /v1/device/door-open
iT100


The door connected to the device opens.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
keepState
boolean

true: Keep the door open
false: The door closes automatically over timeout

Responses

Request samples

Content type
application/json
{
  • "keepState": true
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Close device door

POST /v1/device/door-close
iT100


The door connected to the device close.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Responses

Request samples 

curl --location --request POST
 'https://it100-simulator.irisid.com:4747/v1/device/door-close' 
 --header 'x-api-key: <string>' 
 --header 'x-client-id: <string>'

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Device Reboot

POST /v1/device/reboot
iT100 iBAR600E

Initiates device reboot. Device will be rebooted after 5 seconds after the API call.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Responses

Request samples 

curl --location --request POST
 'https://it100-simulator.irisid.com:4747/v1/device/reboot' 
 --header 'x-api-key: <string>' 
 --header 'x-client-id: <string>'

Blink LED and Play Beep

POST /v1/device/locate
iT100


Plays a beep sound & makes LED blink in the device. This API can used to find/locate the device.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Responses

Request samples 

curl --location --request POST
 'https://it100-simulator.irisid.com:4747/v1/device/locate' 
 --header 'x-api-key: <string>' 
 --header 'x-client-id: <string>'

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Get Device Version Information

GET /v1/device/info
iT100 iBAR600E

Returns device & version information

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/device/info' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "deviceType": "string",
  • "serialNumber": "string",
  • "deviceName": "string",
  • "softwareVersion": "string",
  • "kernalVersion": "string",
  • "macAddress": "string",
  • "hardwareVersion": "string",
  • "androidVersion": "string"
}

Device Software Update

POST /v1/device/software
iT100 iBAR600E

Updates software in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: multipart/form-data
updatefile
string <file>

iT100 package file (.ipk).

Responses

Request samples 

curl --location --request POST
 'https://it100-simulator.irisid.com:4747/v1/device/software' 
 --header 'x-api-key: <string>' 
 --header 'x-client-id: <string>' 
 --header 'Content-Type: multipart/form-data' 
 --form 'updatefile="<file>"'

iT100

Everything about your the device

Capture biometric templates

POST /v1/templates
iT100

Initiates capturing of iris and/or face images. This API returns immediately after the initiation of capture procedure. The biometric templates are sent back to the caller via callbacks as decribed below.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
url
string

Callback URL to receive the result of capture procedure.

apiKey
string

API Key to be sent in the callbacks (in header with name 'x-api-key')

userConsent
boolean

Flag to enable/disable user consent prompt

Responses

Callbacks

Request samples

Content type
application/json
{
  • "url": "string",
  • "apiKey": "string",
  • "userConsent": true
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Callback payload samples

Callback
POST: {$request.body#/captureResultCallbackURL}
Content type
application/json
{
  • "result": 0,
  • "faceImg": "string",
  • "faceSmallImg": "string",
  • "lIrisImg": "string",
  • "rIrisImg": "string",
  • "faceCode": "string",
  • "lIrisCode": "string",
  • "rIrisCode": "string",
  • "userID": "string",
  • "matchedEye": "string",
  • "faceScore": "string",
  • "irisScore": "string",
  • "ipd": "string",
  • "faceStatus": "Success",
  • "LeftEyeStatus": "Success",
  • "RightEyeStatus": "Success",
  • "userConsent": true,
  • "userConsentCreateTime": 0,
  • "userConsentUpdateTime": 0
}

Heartbeat Check

GET /v1/heartbeat
iT100  iBAR600E

Sends heartbeat request. Heartbeat success indicates that the device is online. Heartbeat failure indicates that the device is offline (turned off or network failure).

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/heartbeat' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "remoteAddress": "string",
  • "forwardedFor": "string"
}

Heartbeat Subscription - [POST] /v1/heartbeat/url

POST /v1/heartbeat/url
iT100  iBAR600E

Subscribes for heartbeat by supplying URL for the device to reach back custom application/service for heartbeat check.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
url
required
string <uri>

Responses

Request samples

Content type
application/json
{}

Get Transaction Logs - [GET] /v1/transactions

GET /v1/transactions
iT100

Returns the list of transaction logs based on query parameters.

Sample Queries:
`\transactions` for all transactions
`\transactions?startTransactionID=0&endTransactionID=100` to retrieve transactions with Transaction ID 0 to 100.
`\transactions?UserIDs=1111` to retrieve all transactions of the user with the User ID: 1111.
`\transactions?startTimestamp=x&endTimestamp=y` to retrieve transactions from x to y time interval. Date-time stamp shall be in RFC 3339 (ISO 8601) standard.

`MAX limit : 10000`
You can get transaction logs count `\transactions\count`.
If the number of transaction logs is more than 10,000, we have to divide and get the transaction logs.
ex) first `\transactions?startTransactionID=0&endTransactionID=10000`
next `\transactions?startTransactionID=10001&endTransactionID=20000`

query Parameters
userIDs
string

User ID filter, one or more User IDs can be specified. Transactions of users with User IDs will be returned when this filter is applied.

startTimestamp
string

Date-time filter, timestamp shall be in RFC 3339 format. Transactions on or after the timestamp will be returned when this filter is applied.

endTimestamp
string

Date-time filter, timestamp shall be in RFC 3339 format. Transactions on or prior to the timestamp will be returned when this filter is applied.

startTransactionID
integer

Transaction ID filter. Transaction ID is part transaction record. Transactions after the specified transaction ID will be returned when this filter is applied.

endTransactionID
integer

Transaction ID filter. Transaction ID is part transaction record. Transactions occured before the transaction identified by the transaction ID will be returned when this filter is applied.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/transactions'
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
[
  • {
    }
]

Delete Transaction Logs

DELETE /v1/transactions
iT100

Deletes transaction logs based on query parameters.

Sample Queries:
`\transactions` to delete all transactions
`\transactions?startTransactionID=0&endTransactionID=100` to delete transactions with Transaction ID 0 to 100.
`\transactions?UserIDs=1111` to delete all transactions of the user with the User ID: 1111.
`\transactions?startTimestamp=x&endTimestamp=y` to delete transactions from x to y time interval. Date-time stamp shall be in RFC 3339 (ISO 8601) standard.

`MAX limit : 10000`
You can get transaction logs count `\transactions\count`.
If the number of transaction logs is more than 10,000, we have to divide and get the transaction logs.
ex) first `\transactions?startTransactionID=0&endTransactionID=10000`
next `\transactions?startTransactionID=10001&endTransactionID=20000`

query Parameters
userIDs
string

User ID filter, one or more User IDs can be specified. Transactions of users with User IDs will be returned when this filter is applied.

startTimestamp
string

Date-time filter, timestamp shall be in RFC 3339 format. Transactions on or after the timestamp will be returned when this filter is applied.

endTimestamp
string

Date-time filter, timestamp shall be in RFC 3339 format. Transactions on or prior to the timestamp will be returned when this filter is applied.

startTransactionID
integer

Transaction ID filter. Transaction ID is part transaction record. Transactions after the specified transaction ID will be returned when this filter is applied.

endTransactionID
integer

Transaction ID filter. Transaction ID is part transaction record. Transactions occured before the transaction identified by the transaction ID will be returned when this filter is applied.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Responses

Request samples 

curl --location --request DELETE
 'https://it100-simulator.irisid.com:4747/v1/transactions?userIDs=1&startTransactionID=1&endTransactionID=10'
 --header 'x-api-key: <string>'
 --header 'x-client-id: <string>'

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Get transactions Count

GET /v1/transactions/count
iT100

Returns the number of transactions in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/transactions/count 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "count": 0
}

Transaction Log Subscription

POST /v1/transactions/subscribe
iT100

Subscribes for new transaction callbacks in the device. Callback url should be passed in the request body in JSON format as documented below.

Unique identifier for this callback subscription (subscriberID) is returned in response if this API is successful. 'subscriberID' can be used for callback cancellation (Unsubscribe API).

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
url
string <uri>
apiKey
string

API Key to be sent in the callbacks (in header with name 'x-api-key')
It is a variable used to strengthen security.
When we call back, we include it in url's header and deliver it.
If unnecessary, you don't have to use it.

Responses

Callbacks

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "subscriberID": "string"
}

Callback payload samples

Callback
POST: {$request.body#/url}
Content type
application/json
{
  • "transactionID": 0,
  • "deviceName": "string",
  • "deviceSN": "string",
  • "guid": "string",
  • "userID": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "role": "string",
  • "department": "string",
  • "verifiedBy": "Face",
  • "verifiedCard": {
    },
  • "pin": "string",
  • "transactionType": "string",
  • "transactionResult": "Identified",
  • "recogMode": "Iris",
  • "matchedEye": "none",
  • "irisScore": 0.1,
  • "faceScore": 0.1,
  • "fusionScore": 0.1,
  • "auditFaceImg": "string",
  • "ipd": 0.1,
  • "elapsedTime": 0.1,
  • "timestamp": "string",
  • "userDefined1": "string",
  • "userDefined2": "string",
  • "userDefined3": "string",
  • "userDefined4": "string",
  • "userDefined5": "string"
}

Transaction Log Callback Subscription Cancellation

POST /v1/transactions/unsubscribe
iT100

Cancels transaction log callback subscription. New transaction logs will no longer be notified. A valid 'subscriberID' (returned by Subscribe API) should be passed in the request body.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
subscriberID
string

Subscriber ID.
You can find more information in /config.

Responses

Request samples

Content type
application/json
{
  • "subscriberID": "string"
}

Get Configurations

GET /v1/config
iT100 iBAR600E

Returns all configurations.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "language": "string",
  • "time": "string",
  • "timeZone": "Pacific/Majuro",
  • "ntp": "string",
  • "dateformat": 0,
  • "automaticDateTime": true,
  • "displayBrightness": 0,
  • "soundVolume": 0,
  • "dhcp": true,
  • "ipAddress": "string",
  • "subnetMask": "string",
  • "defaultGateway": "string",
  • "dns1": "string",
  • "dns2": "string",
  • "livenessDetectionForFace": true,
  • "livenessDetectionForIris": true,
  • "lensDetection": true,
  • "operationMode": "string",
  • "enableDeviceRecogMode": true,
  • "deviceRecogMode": "Iris",
  • "enableThermalCamera": true,
  • "thermalCameraUnit": "string",
  • "thermalCameraThreshold": 0.1,
  • "thermalCorrectionValue": 0.1,
  • "thermalCorrectionRatio": 0.1,
  • "wiegandFormats": [
    ],
  • "wiegandOut": {
    },
  • "deviceWiegandSetting": {
    },
  • "relayTime": 0,
  • "enableCardReader": true,
  • "cardReaderRS232BaudRate": 0,
  • "cardDeviceType": "string",
  • "cardReaderDataBits": "string",
  • "cardReaderParityBits": "string",
  • "cardReaderStopBits": "string",
  • "cardReaderStartEndChar": "string",
  • "cardReaderRS232ReadTimeout": 0,
  • "subscribedUserServer": [
    ],
  • "subscribedConfigServer": [
    ],
  • "subscribedTxLogServer": [
    ],
  • "heartbeatServer": [
    ],
  • "heartbeatURL": "string",
  • "saveAuditFaceImg": "None",
  • "activationType": "StandAlone",
  • "discoverITMS": "Manual",
  • "itmsIP": "string",
  • "itmsPort": "string",
  • "deviceActivated": true,
  • "siteKeyPassPhrase": "string",
  • "apiKeyPassPhrase": "string",
  • "lastLocalIP": "string",
  • "deviceType": "string",
  • "serialNumber": "string",
  • "deviceName": "string",
  • "softwareVersion": "string",
  • "hardwareVersion": "string",
  • "androidVersion": "string",
  • "kernelVersion": "string",
  • "macAddress": "string",
  • "thermalAccessControl": true,
  • "enableMaskDetection": true,
  • "maskAccessControl": true,
  • "door": "string",
  • "doorInterface": [ ],
  • "gpio0": {
    },
  • "gpio1": {
    },
  • "policy": {
    }
}

Update Configurations

PUT /v1/config
iT100  iBAR600E

Updates all configurations.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
language
string

Display language in the device.

time
string

Current time in the device.

timeZone
string (TimeZone)
Enum: "Pacific/Majuro" "Pacific/Midway" "Pacific/Honolulu" "America/Anchorage" "America/Los_Angeles" "America/Tijuana" "America/Phoenix" "America/Chihuahua" "America/Denver" "America/Costa_Rica" "America/Chicago" "America/Mexico_City" "America/Regina" "America/Bogota" "America/New_York" "America/Caracas" "America/Barbados" "America/Halifax" "America/Manaus" "America/Santiago" "America/St_Johns" "America/Sao_Paulo" "America/Argentina/Buenos_Aires" "America/Godthab" "America/Montevideo" "Atlantic/South_Georgia" "Atlantic/Azores" "Atlantic/Cape_Verde" "Africa/Casablanca" "Europe/London" "Europe/Amsterdam" "Europe/Belgrade" "Europe/Brussels" "Europe/Sarajevo" "Africa/Windhoek" "Africa/Brazzaville" "Asia/Amman" "Europe/Athens" "Asia/Beirut" "Africa/Cairo" "Europe/Helsinki" "Asia/Jerusalem" "Europe/Minsk" "Africa/Harare" "Asia/Baghdad" "Europe/Moscow" "Asia/Kuwait" "Africa/Nairobi" "Asia/Tehran" "Asia/Baku" "Asia/Tbilisi" "Asia/Yerevan" "Asia/Dubai" "Asia/Kabul" "Asia/Karachi" "Asia/Oral" "Asia/Yekaterinburg" "Asia/Calcutta" "Asia/Colombo" "Asia/Katmandu" "Asia/Almaty" "Asia/Rangoon" "Asia/Krasnoyarsk" "Asia/Bangkok" "Asia/Jakarta" "Asia/Shanghai" "Asia/Hong_Kong" "Asia/Irkutsk" "Asia/Kuala_Lumpur" "Australia/Perth" "Asia/Taipei" "Asia/Seoul" "Asia/Tokyo" "Asia/Yakutsk" "Australia/Adelaide" "Australia/Darwin" "Australia/Brisbane" "Australia/Hobart" "Australia/Sydney" "Asia/Vladivostok" "Pacific/Guam" "Asia/Magadan" "Pacific/Auckland" "Pacific/Fiji" "Pacific/Tongatapu"

Current Timezone in the device

ntp
string

NTP server

dateformat
integer

Time format. 12 for 12-hour clock. 24 for 24-hour clock.

automaticDateTime
boolean

Automatic date-time sync with an internet time server (NTP server).

displayBrightness
integer

Display brightness level. Valid range - 2 to 255.

soundVolume
integer

Sound volume. Valid range - 0 to 15.

dhcp
boolean

Enable/Disable DHCP.

ipAddress
string

IP Address.

subnetMask
string

Prefix length is used to define the subnet mask. It is the number of bits set to 1 in the subnet mask. For example, if the subnet mask is 255.255. 255.0, there are 24 bits set to 1 in the binary version of the subnet mask, so the prefix length is 24 bits or /24.

defaultGateway
string

Default gateway configuration.

dns1
string

Primary DNS server

dns2
string

Secondary DNS server

livenessDetectionForFace
boolean

Enable/Disable fake face detection during enrollment and recognition.

livenessDetectionForIris
boolean

Enable/Disable fake eye detection during enrollment and recognition.

lensDetection
boolean

Enable/Disable lens detection during enrollment and recognition. For future use.

operationMode
string

Operation mode: interactive or continuous. In interavtive mode, biometric capture for recognition is initiated manually. It starts automatically in continuous mode when subject comes in front of the device

enableDeviceRecogMode
boolean

Enable or disable device recognition mode.
If enabled, device recognition mode overrides the user recognition mode. All users are recognized in device recognition mode.
If disabled, users are recognized in their respective recognition modes (user recognition mode)

deviceRecogMode
string
Enum: "Iris" "Face" "Fusion" "FaceOrIris" "FaceAndIris" "Card" "FaceOrCard" "IrisOrCard" "FusionOrCard" "FaceAndIrisOrCard" "FaceOrIrisOrCard" "FaceAndCard" "IrisAndCard" "FusionAndCard" "FaceAndIrisAndCard" "FaceOrIrisAndCard"

Device recognition mode

enableThermalCamera
boolean

Enable or disable thermal camera that helps to read user's body temperature during recognition

thermalCameraUnit
string

Body temperature unit. Possible values: Celsius and Fahrenheit.

thermalCameraThreshold
number <float>

Thermal camera threshold

thermalCorrectionValue
number <float>

Thermal correction value

thermalCorrectionRatio
number <float>

Thermal correction ratio

Array of objects (WiegandFormat)
object (WiegandOutSettings)
object (DeviceWiegandConfig)
relayTime
integer

Relay duration.

enableCardReader
boolean

Enable/Disable card reader. For future use.

cardReaderRS232BaudRate
integer

Card reader baud rate. For future use.

cardDeviceType
string

Card device type. For future use.

cardReaderDataBits
string

Card reader data bits. For future use.

cardReaderParityBits
string

Card reader parity bits. For future use.

cardReaderStopBits
string

Card reader stop bits. For future use.

cardReaderStartEndChar
string

Card reader start and end character. For future use.

cardReaderRS232ReadTimeout
integer

RS232 read timeout setting.

Array of objects (CallbackSubscription)

Callback subscription details

Array of objects (CallbackSubscription)

Callback subscription details

Array of objects (CallbackSubscription)

Callback subscription details

Array of objects (CallbackSubscription)

Callback subscription details

heartbeatURL
string

URL for heartbeat check for iTMSfrom the device.

saveAuditFaceImg
string
Enum: "None" "All"

Audit face image configuration that define when to save audit face image in transaction log. This can be any of the following:

  • None - Audit face image is never saved.
  • AllTransactions - Audit face image is saved for all transactions.
  • UnauthorizedTransactions - Audit face image is saved for failure transactions.
activationType
string
Enum: "StandAlone" "ITMS"

Activation type configuration:

  • StandAlone - Stand-alone activation recommended for single door application.
  • ITMS - iTMS activation to configure the device in iTMS application framework.
discoverITMS
string
Enum: "Manual" "Auto"

iTMS discovery type (applicable only for iTMS activation):

  • Manual - Administrator shall enter iTMS information (IP and Port) manually.
  • Auto - the device will discover iTMS information automatically using mDNS.
itmsIP
string

IP address of iTMS server that the device is activated with. This is applicable only for iTMS activation.

itmsPort
string

Port that iTMS server runs on. This is applicable only for iTMS activation.

deviceActivated
boolean

Device activation status.

siteKeyPassPhrase
string

Site key passphrase. This is applicable only for StandAlone activation.

apiKeyPassPhrase
string

API key passphrase. This is applicable only for StandAlone activation.

lastLocalIP
string

Last local Ip address. Checking IP changed

deviceType
string

Device type.

serialNumber
string

Device serial number.

deviceName
string

Device name that is displayed in the device home screen.

softwareVersion
string

Software version.

hardwareVersion
string

Hardware version.

androidVersion
string

Android version.

kernelVersion
string

Kernel version.

macAddress
string

MAC address.

thermalAccessControl
boolean

Enable/Disable Thremal Access Control.

enableMaskDetection
boolean

Enable/Disable MaskDetection.

maskAccessControl
boolean

Enable/Disable Mask Access Control.

door
string

Type of policy attributes

doorInterface
Array of arrays

Select the type of door interface.

  • Relay
  • Wiegand
object (gpioInfo)

gpio settings

object (gpioInfo)

gpio settings

object (policy)

Responses

Request samples

Content type
application/json
{
  • "language": "string",
  • "time": "string",
  • "timeZone": "Pacific/Majuro",
  • "ntp": "string",
  • "dateformat": 0,
  • "automaticDateTime": true,
  • "displayBrightness": 0,
  • "soundVolume": 0,
  • "dhcp": true,
  • "ipAddress": "string",
  • "subnetMask": "string",
  • "defaultGateway": "string",
  • "dns1": "string",
  • "dns2": "string",
  • "livenessDetectionForFace": true,
  • "livenessDetectionForIris": true,
  • "lensDetection": true,
  • "operationMode": "string",
  • "enableDeviceRecogMode": true,
  • "deviceRecogMode": "Iris",
  • "enableThermalCamera": true,
  • "thermalCameraUnit": "string",
  • "thermalCameraThreshold": 0.1,
  • "thermalCorrectionValue": 0.1,
  • "thermalCorrectionRatio": 0.1,
  • "wiegandFormats": [
    ],
  • "wiegandOut": {
    },
  • "deviceWiegandSetting": {
    },
  • "relayTime": 0,
  • "enableCardReader": true,
  • "cardReaderRS232BaudRate": 0,
  • "cardDeviceType": "string",
  • "cardReaderDataBits": "string",
  • "cardReaderParityBits": "string",
  • "cardReaderStopBits": "string",
  • "cardReaderStartEndChar": "string",
  • "cardReaderRS232ReadTimeout": 0,
  • "subscribedUserServer": [
    ],
  • "subscribedConfigServer": [
    ],
  • "subscribedTxLogServer": [
    ],
  • "heartbeatServer": [
    ],
  • "heartbeatURL": "string",
  • "saveAuditFaceImg": "None",
  • "activationType": "StandAlone",
  • "discoverITMS": "Manual",
  • "itmsIP": "string",
  • "itmsPort": "string",
  • "deviceActivated": true,
  • "siteKeyPassPhrase": "string",
  • "apiKeyPassPhrase": "string",
  • "lastLocalIP": "string",
  • "deviceType": "string",
  • "serialNumber": "string",
  • "deviceName": "string",
  • "softwareVersion": "string",
  • "hardwareVersion": "string",
  • "androidVersion": "string",
  • "kernelVersion": "string",
  • "macAddress": "string",
  • "thermalAccessControl": true,
  • "enableMaskDetection": true,
  • "maskAccessControl": true,
  • "door": "string",
  • "doorInterface": [ ],
  • "gpio0": {
    },
  • "gpio1": {
    },
  • "policy": {
    }
}

Get save audit face image setting

GET /v1/config/audit-img
iT100

Returns save audit face image setting in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/audit-img' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "saveAuditFaceImg": "All"
}

Update save audit face image setting

PUT /v1/config/audit-img
iT100


Updates save audit face image setting in the device.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
saveAuditFaceImg
string
Enum: "All" "None" "Success" "Failed" "Unauthorized" "Except for Card-only"

setting saveAuditFaceimge option.

  • All - Audit face image is saved for all transactions.
  • None - Audit face image is never saved.
  • Success - Audit face image is saved for Success transactions.
  • Failed - Audit face image is saved for failure transactions.
  • Unauthorized - Audit face image is saved for unauthorized transactions.
  • Except for Card-only - Audit face image is saved for Except for Card-only transactions.

Responses

Request samples

Content type
application/json
{
  • "saveAuditFaceImg": "All"
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Get Cardreader setting

GET /v1/config/cardreader
iT100

Returns Cardreader in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/cardreader' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "enableCardReader": true,
  • "cardReaderRS232BaudRate": 0,
  • "enableWiegandIn": true,
  • "cardDeviceType": "string",
  • "cardReaderParityBits": "string",
  • "cardReaderStopBits": "string",
  • "cardReaderStartEndChar": "string",
  • "cardReaderRS232ReadTimeout": 0
}

Update Cardreader setting

PUT /v1/config/cardreader
iT100

Updates Cardreader setting in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
enableCardReader
boolean

Enable/Disable card reader. For future use.

cardReaderRS232BaudRate
integer

Card reader baud rate. For future use.

enableWiegandIn
boolean

Enable or Disable the Wiegand Input Port.

cardDeviceType
string

Card device type. For future use.

cardReaderParityBits
string

Card reader parity bits. For future use.

cardReaderStopBits
string

Card reader stop bits. For future use.

cardReaderStartEndChar
string

Card reader start and end character. For future use.

cardReaderRS232ReadTimeout
integer

RS232 read timeout setting.

Responses

Request samples

Content type
application/json
{
  • "enableCardReader": true,
  • "cardReaderRS232BaudRate": 0,
  • "enableWiegandIn": true,
  • "cardDeviceType": "string",
  • "cardReaderParityBits": "string",
  • "cardReaderStopBits": "string",
  • "cardReaderStartEndChar": "string",
  • "cardReaderRS232ReadTimeout": 0
}

Response samples

Content type
application/json
{
  • "result": 0
}

Get Door Setting

GET /v1/config/door
iT100

Returns current Door setting in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/door' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "door": "string",
  • "doorInterface": [ ]
}

Update Door setting

PUT /v1/config/door
iT100

Updates Door setting in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
door
string

Type of policy attributes

doorInterface
Array of arrays

Select the type of door interface.

  • Relay
  • Wiegand

Responses

Request samples

Content type
application/json
{
  • "door": "string",
  • "doorInterface": [ ]
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Get Countermeasure Setting

GET /v1/config/countermeasure
iT100 iBAR600E

Returns current Countermeasure setting in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/countermeasure' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "livenessDetectionForFace": true,
  • "livenessDetectionForIris": true,
  • "lensDetection": true
}

Update Countermeasure setting

PUT /v1/config/countermeasure
iT100 iBAR600E

Updates Countermeasure setting.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
livenessDetectionForFace
boolean

setting livenessDetectionForFace option.

livenessDetectionForIris
boolean

setting livenessDetectionForIris option.

lensDetection
boolean

setting lensDetection option. The value is not working yet.

Responses

Request samples

Content type
application/json
{
  • "livenessDetectionForFace": true,
  • "livenessDetectionForIris": true,
  • "lensDetection": true
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Get MaskDetection Setting

GET /v1/config/mask-detection
iT100

Returns current MaskDetection setting in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/mask-detection' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "enableMaskDetection": true,
  • "maskAccessControl": true
}

Update MaskDetection setting

PUT /v1/config/mask-detection
iT100

Updates MaskDetection setting in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
enableMaskDetection
boolean

Enable/Disable MaskDetection.

maskAccessControl
boolean

Enable/Disable Mask Access Control.

Responses

Request samples

Content type
application/json
{
  • "enableMaskDetection": true,
  • "maskAccessControl": true
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Get operation mode configuration

GET /v1/config/operation-mode
iT100


Returns operation mode configuration.
header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/operation-mode' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "operationMode": "interactive"
}

Update operation mode configuration

PUT /v1/config/operation-mode
iT100


Updates operation mode configuration. Available operation modes: Continuous & Interactive.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
operationMode
string
Enum: "interactive" "continuous"

Operation mode setting: interactive or continuous. In interactive mode, biometric capture for recognition is initiated manually. It starts automatically in continuous mode when subject comes in front of the device

Responses

Request samples

Content type
application/json
{
  • "operationMode": "interactive"
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Get gpio configuration

GET /v1/config/gpio
iT100


Returns gpio configuration.
header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/gpio' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "gpio0": {
    },
  • "gpio1": {
    }
}

Update gpio configuration

PUT /v1/config/gpio
iT100


Updates gpio configuration
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
object (gpioInfo)

gpio settings

object (gpioInfo)

gpio settings

Responses

Request samples

Content type
application/json
{
  • "gpio0": {
    },
  • "gpio1": {
    }
}

Get gpio0in state

GET /v1/config/gpio0in
iT100


Returns gpio0in state.
header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/gpio0in' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "result": 0
}

Get gpio1in state

GET /v1/config/gpio1in
iT100


Returns gpio1in state.
header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/gpio1in' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "result": 0
}

Get relay settings

GET /v1/config/relay
iT100


Returns relay settings.
header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/relay' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "enableRelay": true,
  • "relayTimer": "string",
  • "relayTime": 0
}

Update relay settings

PUT /v1/config/relay
iT100


Updates relay settings.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
enableRelay
boolean

Enable or disable relay activation. If enabled, relay is activated after successful identification

relayTimer
string

Relay activation duration in seconds

relayTime
integer

Relay activation duration in seconds

Responses

Request samples

Content type
application/json
{
  • "enableRelay": true,
  • "relayTimer": "string",
  • "relayTime": 0
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Update Device Name

PUT /v1/config/device-name
iT100 iBAR600E

Updates device name setting.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
deviceName
string

Responses

Request samples

Content type
application/json
{
  • "deviceName": "string"
}

Get Display Settings

GET /v1/config/display
iT100


Returns current display settings in the device.
header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/display' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "displayBrightness": 1
}

Update Display Settings

PUT /v1/config/display
iT100


Updates display settings.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
displayBrightness
required
integer [ 1 .. 255 ]

Display Brightness

Responses

Request samples

Content type
application/json
{
  • "displayBrightness": 1
}

Get Language Settings

GET /v1/config/language
iT100


Returns current language settings in the device.
header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/language' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "language": "en"
}

Update Language Settings

PUT /v1/config/language
iT100


Updates language settings.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
language
required
string
Enum: "en" "ko" "fr" "zh" "ja" "de" "es" "it" "ar" "tr"

en - English ko - Korean fr - French zh - Chinese ja - Japanese de - German es - Spanish it - Italian ar - Arabic tr - Trukish

Responses

Request samples

Content type
application/json
{
  • "language": "en"
}

Get Sound Volume

GET /v1/config/volume
iT100


Returns current sound volume level. Sound valume range: 0 to 15.
header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/volume' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "soundVolume": 15
}

Update Sound Volume

PUT /v1/config/volume
iT100


Updates sound volume lavel. Sound valume range: 0 to 15.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
soundVolume
required
integer [ 0 .. 15 ]

Volume Level

Responses

Request samples

Content type
application/json
{
  • "soundVolume": 15
}

Get Network Settings

GET /v1/config/network
iT100 iBAR600E

Returns current network settings in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/network' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "dhcp": true,
  • "ipAddress": "string",
  • "subnetMask": "string",
  • "defaultGateway": "string",
  • "dns1": "string",
  • "dns2": "string"
}

Update Network Settings

PUT /v1/config/network
iT100 iBAR600E

Update network settings in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
dhcp
boolean
ipAddress
string
subnetMask
string
defaultGateway
string
dns1
string
dns2
string

Responses

Request samples

Content type
application/json
{
  • "dhcp": true,
  • "ipAddress": "string",
  • "subnetMask": "string",
  • "defaultGateway": "string",
  • "dns1": "string",
  • "dns2": "string"
}

Get Date-Time settings

GET /v1/config/date-time
iT100 iBAR600E

Returns current date-time settings in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/date-time' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "automaticDateTime": true,
  • "time": "2019-08-24T14:15:22Z",
  • "timezone": "Pacific/Majuro",
  • "ntp": "string",
  • "dateformat": 12
}

Update Date-Time Settings

PUT /v1/config/date-time
iT100 iBAR600E

Updates date-time settings in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
automaticDateTime
boolean
time
string <date-time>

Date Time

timezone
string (TimeZone)
Enum: "Pacific/Majuro" "Pacific/Midway" "Pacific/Honolulu" "America/Anchorage" "America/Los_Angeles" "America/Tijuana" "America/Phoenix" "America/Chihuahua" "America/Denver" "America/Costa_Rica" "America/Chicago" "America/Mexico_City" "America/Regina" "America/Bogota" "America/New_York" "America/Caracas" "America/Barbados" "America/Halifax" "America/Manaus" "America/Santiago" "America/St_Johns" "America/Sao_Paulo" "America/Argentina/Buenos_Aires" "America/Godthab" "America/Montevideo" "Atlantic/South_Georgia" "Atlantic/Azores" "Atlantic/Cape_Verde" "Africa/Casablanca" "Europe/London" "Europe/Amsterdam" "Europe/Belgrade" "Europe/Brussels" "Europe/Sarajevo" "Africa/Windhoek" "Africa/Brazzaville" "Asia/Amman" "Europe/Athens" "Asia/Beirut" "Africa/Cairo" "Europe/Helsinki" "Asia/Jerusalem" "Europe/Minsk" "Africa/Harare" "Asia/Baghdad" "Europe/Moscow" "Asia/Kuwait" "Africa/Nairobi" "Asia/Tehran" "Asia/Baku" "Asia/Tbilisi" "Asia/Yerevan" "Asia/Dubai" "Asia/Kabul" "Asia/Karachi" "Asia/Oral" "Asia/Yekaterinburg" "Asia/Calcutta" "Asia/Colombo" "Asia/Katmandu" "Asia/Almaty" "Asia/Rangoon" "Asia/Krasnoyarsk" "Asia/Bangkok" "Asia/Jakarta" "Asia/Shanghai" "Asia/Hong_Kong" "Asia/Irkutsk" "Asia/Kuala_Lumpur" "Australia/Perth" "Asia/Taipei" "Asia/Seoul" "Asia/Tokyo" "Asia/Yakutsk" "Australia/Adelaide" "Australia/Darwin" "Australia/Brisbane" "Australia/Hobart" "Australia/Sydney" "Asia/Vladivostok" "Pacific/Guam" "Asia/Magadan" "Pacific/Auckland" "Pacific/Fiji" "Pacific/Tongatapu"

Current Timezone in the device

ntp
string

NTP server

dateformat
integer
Enum: 12 24

Time format. 12 for 12-hour clock. 24 for 24-hour clock.

Responses

Request samples

Content type
application/json
{
  • "automaticDateTime": true,
  • "time": "2019-08-24T14:15:22Z",
  • "timezone": "Pacific/Majuro",
  • "ntp": "string",
  • "dateformat": 12
}

Get Fake Eye Detction Setting

GET /v1/config/fake-eye-detection
iT100


Returns current Fake Eye Detection setting in the device.
header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/fake-eye-detection' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "fakeEyeDetection": true
}

Update Fake Eye Detction setting

PUT /v1/config/fake-eye-detection
iT100


Updates Fake Eye Detection setting in the device.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
fakeEyeDetection
boolean

Responses

Request samples

Content type
application/json
{
  • "fakeEyeDetection": true
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Config Callback Subscription

POST /v1/config/subscribe
iT100 iBAR600E

Subscribes for callbacks that notify changes in certain configurations. Callback url should be passed in the request body in JSON format as documented below.

Unique identifier for this callback subscription (subscriberID) is returned in response if this API is successful. 'subscriberID' can be used for callback cancellation (Unsubscribe API).

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
url
required
string <uri>
apiKey
string

API Key to be sent in the callbacks (in header with name 'x-api-key')
It is a variable used to strengthen security.
When we call back, we include it in url's header and deliver it.
If unnecessary, you don't have to use it.

Responses

Callbacks

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "subscriberID": "string"
}

Callback payload samples

Callback
Content type
application/json
{
  • "ip": "string",
  • "port": "string",
  • "serialNumber": "string"
}

Config Callback Subscription Cancellation

POST /v1/config/unsubscribe
iT100 iBAR600E

Cancels config callback subscription. Changes in configuration will no longer be notified. A valid 'subscriberID' (returned by Subscribe API) should be passed in the request body.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
subscriberID
string

Responses

Request samples

Content type
application/json
{
  • "subscriberID": "string"
}

Get Thermal Camera Settings

GET /v1/config/thermal-camera
iT100


Returns thermal camera settings.
header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/thermal-camera' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "enableThermalCamera": true,
  • "thermalCameraUnit": "Celsius",
  • "thermalCameraThreshold": 0.1,
  • "thermalCorrectionValue": 0.1,
  • "thermalCorrectionRatio": 0.1,
  • "thermalAccessControl": true
}

Update Thermal Camera Settings

PUT /v1/config/thermal-camera
iT100


Updates thermal camera settings in the device.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
enableThermalCamera
boolean

Enable or disable thermal camera

thermalCameraUnit
string
Enum: "Celsius" "Fahrenheit"

Thermal unit: Celsius or Fahrenheit

thermalCameraThreshold
number <float>

Thermal camera threshold

thermalCorrectionValue
number <float>

Thermal correction value

thermalCorrectionRatio
number <float>

Thermal correction ratio

thermalAccessControl
boolean

Enable or disable thermal access control

Responses

Request samples

Content type
application/json
{
  • "enableThermalCamera": true,
  • "thermalCameraUnit": "Celsius",
  • "thermalCameraThreshold": 0.1,
  • "thermalCorrectionValue": 0.1,
  • "thermalCorrectionRatio": 0.1,
  • "thermalAccessControl": true
}

Get Device Recognition Mode Settings

GET /v1/config/device-recog-mode
iT100


Returns current device recognition mode settings.
header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/device-recog-mode' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "enableDeviceRecogMode": true,
  • "deviceRecogMode": "Iris"
}

Update Device Recognition Mode Settings

PUT /v1/config/device-recog-mode
iT100


Updates device recogniton mode settings.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
enableDeviceRecogMode
boolean

Enable or disable device recognition mode.
If enabled, device recognition mode overrides the user recognition mode. All users are recognized in device recognition mode.
If disabled, users are recognized in their respective recognition modes (user recognition mode)

deviceRecogMode
string
Enum: "Iris" "Face" "Fusion" "FaceOrIris" "FaceAndIris" "Card" "FaceOrCard" "IrisOrCard" "FusionOrCard" "FaceAndIrisOrCard" "FaceOrIrisOrCard" "FaceAndCard" "IrisAndCard" "FusionAndCard" "FaceAndIrisAndCard" "FaceOrIrisAndCard"

Device recognition mode

Responses

Request samples

Content type
application/json
{
  • "enableDeviceRecogMode": true,
  • "deviceRecogMode": "Iris"
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Get Device Wiegand Configurations

GET /v1/config/wiegand
iT100


Returns device specific wiegand configurations.
header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/wiegand' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "enableWiegandIn": true,
  • "wiegandInFormatIDs": [
    ],
  • "wiegandInIgnoreFacilityCode": true,
  • "wiegandOutPulseWidthInterval": "100us/1000us"
}

Update Device Wiegand Settings

PUT /v1/config/wiegand
iT100


Updates device specific wiegand settings.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
enableWiegandIn
boolean

Enable or Disable the Wiegand Input Port.

wiegandInFormatIDs
Array of strings

Accepted wiegand formats

wiegandInIgnoreFacilityCode
boolean

When this flag is false, the Wiegand input will check that the Facility Code of the card matches to the number in the Facility Code field.

wiegandOutPulseWidthInterval
string
Enum: "100us/1000us" "40us/2000us"

Wiegand output speed that can be any of the following:

  • "100us/1000us" - Fast.
  • "40us/2000us" - Slow.

Responses

Request samples

Content type
application/json
{
  • "enableWiegandIn": true,
  • "wiegandInFormatIDs": [
    ],
  • "wiegandInIgnoreFacilityCode": true,
  • "wiegandOutPulseWidthInterval": "100us/1000us"
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Get WiegandFormats setting

GET /v1/config/wiegand-formats
iT100


Returns WiegandFormats in the device.
header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/wiegand-formats' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "id": "string",
  • "totalBits": 0,
  • "name": "string",
  • "cardIDStart": 0,
  • "cardIDLen": 0,
  • "cardIDMask": 0,
  • "facilityCodeStart": 0,
  • "facilityCodeLen": 0,
  • "facilityCodeMask": 0,
  • "parityChecks": [
    ]
}

Update WiegandFormats setting

PUT /v1/config/wiegand-formats
iT100


Updates WiegandFormats setting in the device.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
id
string

Id of WiegandFormat

totalBits
integer

TotalBits of WiegandFormat

name
string

Name of WiegandFormat

cardIDStart
integer

CarIDStart of WiegandFormat

cardIDLen
integer

CardIDLen of WiegandFormat

cardIDMask
integer

CardIDMask of WiegandFormat

facilityCodeStart
integer

FacilityCodeStart of WiegandFormat

facilityCodeLen
integer

FacilityCodeLen of WiegandFormat

facilityCodeMask
integer

FacilityCodeMask of WiegandFormat

Array of objects (ParityCheck)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "totalBits": 0,
  • "name": "string",
  • "cardIDStart": 0,
  • "cardIDLen": 0,
  • "cardIDMask": 0,
  • "facilityCodeStart": 0,
  • "facilityCodeLen": 0,
  • "facilityCodeMask": 0,
  • "parityChecks": [
    ]
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Get Device Wiegand Configurations

GET /v1/policy/wiegand
iT100


Returns device specific wiegand configurations.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/policy/wiegand' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "wiegandFormats": [
    ],
  • "wiegandOut": {
    }
}

Update Device Wiegand Settings

PUT /v1/policy/wiegand
iT100


Updates device specific wiegand settings.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
Array of objects (WiegandFormat)
object (WiegandOutSettings)

Responses

Request samples

Content type
application/json
{
  • "wiegandFormats": [
    ],
  • "wiegandOut": {
    }
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Delete WiegandFormats

DELETE /v1/policy/wiegand
iT100


Removes existing WiegandFormats from the device. WiegandFormats to be removed is identified by totalBits passed as query parammeter in URL.

Sample Query:
`\wiegand-formats?totalBits=1` to delete WiegandFormats with User totalBits 1
query Parameters
totalBits
required
Array of strings

TotalBits for the WiegandFormats to be deleted

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Responses

Request samples 

curl --location --request DELETE
 'https://it100-simulator.irisid.com:4747/v1/config/wiegand-formats?totalBits=1,2' 
 --header 'x-api-key: <string>' 
 --header 'x-client-id: <string>'

Get policy settings

GET /v1/policy/access-control
iT100


Returns policy settings.
header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/policy/access-control' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "rules": [
    ]
}

Update policy settings

PUT /v1/policy/access-control
iT100


Updates policy settings.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
object (attributes)
Array of objects (rule)

Policy rule

Responses

Request samples

Content type
application/json
{
  • "attributes": {
    },
  • "rules": [
    ]
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Deactivate Device

POST /v1/device/deactivate
iT100 iBAR600E

Deactivates the device so that no further API calls to the device can be made. Once the device is deactivated, it deletes all device configurations and user information stored in the device and restarts the device automatically. In case of the iTMS activation, this operation will remove the device from the iTMS Device Management screen until thethe device checks back in to the iTMS again.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Responses

Request samples 

curl --location --request POST
 'https://it100-simulator.irisid.com:4747/v1/device/deactivate' 
 --header 'x-api-key: <string>' 
 --header 'x-client-id: <string>'

Open device door

POST /v1/device/door-open
iT100


The door connected to the device opens.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
keepState
boolean

true: Keep the door open
false: The door closes automatically over timeout

Responses

Request samples

Content type
application/json
{
  • "keepState": true
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Close device door

POST /v1/device/door-close
iT100


The door connected to the device close.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Responses

Request samples 

curl --location --request POST
 'https://it100-simulator.irisid.com:4747/v1/device/door-close' 
 --header 'x-api-key: <string>' 
 --header 'x-client-id: <string>'

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Device Reboot

POST /v1/device/reboot
iT100 iBAR600E

Initiates device reboot. Device will be rebooted after 5 seconds after the API call.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Responses

Request samples 

curl --location --request POST
 'https://it100-simulator.irisid.com:4747/v1/device/reboot' 
 --header 'x-api-key: <string>' 
 --header 'x-client-id: <string>'

Blink LED and Play Beep

POST /v1/device/locate
iT100


Plays a beep sound & makes LED blink in the device. This API can used to find/locate the device.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Responses

Request samples 

curl --location --request POST
 'https://it100-simulator.irisid.com:4747/v1/device/locate' 
 --header 'x-api-key: <string>' 
 --header 'x-client-id: <string>'

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Get Device Version Information

GET /v1/device/info
iT100 iBAR600E

Returns device & version information

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/device/info' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "deviceType": "string",
  • "serialNumber": "string",
  • "deviceName": "string",
  • "softwareVersion": "string",
  • "kernalVersion": "string",
  • "macAddress": "string",
  • "hardwareVersion": "string",
  • "androidVersion": "string"
}

Device Software Update

POST /v1/device/software
iT100 iBAR600E

Updates software in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: multipart/form-data
updatefile
string <file>

iT100 package file (.ipk).

Responses

Request samples 

curl --location --request POST
 'https://it100-simulator.irisid.com:4747/v1/device/software' 
 --header 'x-api-key: <string>' 
 --header 'x-client-id: <string>' 
 --header 'Content-Type: multipart/form-data' 
 --form 'updatefile="<file>"'

Get user records with the consent information

GET /v1/users/consent
iT100


Returns the list user records with the consent information.

Rerurns null when there are no users that match the query parameter.

Sample Queries:
`\users` for all users
`\users?userIDs=1` for user with User ID 1
query Parameters
userIDs
Array of strings

Array of User IDs to be queried. Empty array would return the list of all users.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/users/consent?userIDs=1,2' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
[
  • {
    }
]

Get User List

GET /v1/users
iT100


Returns the list users for the User IDs passed in query parameter. List of all users is returned when the User ID array is empty.

Rerurns null when there are no users that match the query parameter.

Sample Queries:
`\users` for all users
`\users?userIDs=1` for user with User ID 1
query Parameters
userIDs
Array of strings

Array of User IDs to be queried. Empty array would return the list of all users.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/users?userIDs=1,2' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
[
  • {
    }
]

Modify User

PUT /v1/users
iT100


Modifies an existing user's demographic and biometric information. User record to be modified is identified by guid in User structure passed in the request body.
`Required all json field`
If you skip json field, that field is default value ( like 0 , null). So we require all field.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
guid
required
string

Globally Unique Identifier for users. System Generated. 20-character string.

userID
required
string

Unique and assigned by the administrator/operators.

active
boolean

true for active user and false for pending user (no biometrics information)

status
required
string
Enum: "active" "pending" "inactive"

user's status

lIrisCode
string

512-byte left iris template (base64 encoded string)

rIrisCode
string

512-byte right iris template (base64 encoded string)

faceCode
string

2121-byte face template (base64 encoded string)

title
string

User's title

firstName
string

User's first name

lastName
string

User's last name

emailAddr
string

User's email address

phoneNum
string

User's phone number

Array of objects (Card)

User's cards serial number

role
string

User type - Administrator or User. It will be augmented in the future.

department
string

User's department

adminID
string

Identifier of the administrator

adminPassword
string

Password of the administrator

recogMode
string
Enum: "Iris" "Face" "Fusion" "FaceOrIris" "FaceAndIris" "Card" "FaceOrCard" "IrisOrCard" "FusionOrCard" "FaceAndIrisOrCard" "FaceOrIrisOrCard" "FaceAndCard" "IrisAndCard" "FusionAndCard" "FaceAndIrisAndCard" "FaceOrIrisAndCard"

User recognition mode

faceImg
string <byte>

Face image - 220 x 294 JPEG

faceSmallImg
string <byte>

Small face image for thumbnail - 60 x 60 JPEG

lIrisImg
string <byte>

Left iris image for thumbnail (not for matching)

rIrisImg
string <byte>

Right iris image for thumbnail (not for matching)

enrollTimestamp
integer

Time and Date of Enrollment

userDefined1
string

User's userDefined1

userDefined2
string

User's userDefined2

userDefined3
string

User's userDefined3

userDefined4
string

User's userDefined4

userDefined5
string

User's userDefined5

userConsent
boolean

User consent. 'True' when user consent is agreed. 'False' when user consent is disagreed.

userConsentCreateTime
number <int64>

Unix timestamp at which user consent is created

userConsentUpdateTime
number <int64>

Unix timestamp at which user consent is updated

Responses

Request samples

Content type
application/json
{
  • "guid": "string",
  • "userID": "string",
  • "active": true,
  • "status": "active",
  • "lIrisCode": "string",
  • "rIrisCode": "string",
  • "faceCode": "string",
  • "title": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "emailAddr": "string",
  • "phoneNum": "string",
  • "cards": [
    ],
  • "role": "string",
  • "department": "string",
  • "adminID": "string",
  • "adminPassword": "string",
  • "recogMode": "Iris",
  • "faceImg": "string",
  • "faceSmallImg": "string",
  • "lIrisImg": "string",
  • "rIrisImg": "string",
  • "enrollTimestamp": 0,
  • "userDefined1": "string",
  • "userDefined2": "string",
  • "userDefined3": "string",
  • "userDefined4": "string",
  • "userDefined5": "string",
  • "userConsent": true,
  • "userConsentCreateTime": 0,
  • "userConsentUpdateTime": 0
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Add User

POST /v1/users
iT100


Enrolls a new user in the device. Demographic and Biomteric information for the user to be added should be passed in the request body in JSON format as documented below.
`Required all json field`
If you skip json field, that field is default value ( like 0 , null). So we require all field.
`Max limit users : 500` (Our device guarantee count)
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
Array
guid
required
string

Globally Unique Identifier for users. System Generated. 20-character string.

userID
required
string

Unique and assigned by the administrator/operators.

active
boolean

true for active user and false for pending user (no biometrics information)

status
required
string
Enum: "active" "pending" "inactive"

user's status

lIrisCode
string

512-byte left iris template (base64 encoded string)

rIrisCode
string

512-byte right iris template (base64 encoded string)

faceCode
string

2121-byte face template (base64 encoded string)

title
string

User's title

firstName
string

User's first name

lastName
string

User's last name

emailAddr
string

User's email address

phoneNum
string

User's phone number

Array of objects (Card)

User's cards serial number

role
string

User type - Administrator or User. It will be augmented in the future.

department
string

User's department

adminID
string

Identifier of the administrator

adminPassword
string

Password of the administrator

recogMode
string
Enum: "Iris" "Face" "Fusion" "FaceOrIris" "FaceAndIris" "Card" "FaceOrCard" "IrisOrCard" "FusionOrCard" "FaceAndIrisOrCard" "FaceOrIrisOrCard" "FaceAndCard" "IrisAndCard" "FusionAndCard" "FaceAndIrisAndCard" "FaceOrIrisAndCard"

User recognition mode

faceImg
string <byte>

Face image - 220 x 294 JPEG

faceSmallImg
string <byte>

Small face image for thumbnail - 60 x 60 JPEG

lIrisImg
string <byte>

Left iris image for thumbnail (not for matching)

rIrisImg
string <byte>

Right iris image for thumbnail (not for matching)

enrollTimestamp
integer

Time and Date of Enrollment

userDefined1
string

User's userDefined1

userDefined2
string

User's userDefined2

userDefined3
string

User's userDefined3

userDefined4
string

User's userDefined4

userDefined5
string

User's userDefined5

userConsent
boolean

User consent. 'True' when user consent is agreed. 'False' when user consent is disagreed.

userConsentCreateTime
number <int64>

Unix timestamp at which user consent is created

userConsentUpdateTime
number <int64>

Unix timestamp at which user consent is updated

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "result": 0,
  • "userIDs": [ ],
  • "resultDetail": [
    ]
}

Delete User

DELETE /v1/users
iT100


Removes an existing user from the device. User to be removed is identified by User ID passed as query parammeter in URL.

Sample Query:
`\users?userIDs=1` to delete user with User ID 1
`Max limit users : 500` (Our device guarantee count)
query Parameters
userIDs
required
Array of strings

Users IDs for the users to be deleted

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Responses

Request samples 

curl --location --request DELETE
 'https://it100-simulator.irisid.com:4747/v1/users?userIDs=1,2' 
 --header 'x-api-key: <string>' 
 --header 'x-client-id: <string>'

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string",
  • "userIDs": [ ]
}

Get User simple list

GET /v1/userlist
iT100


Returns the simple list users for the User IDs passed in query parameter. List of all users is returned when the User ID array is empty.

Rerurns null when there are no users that match the query parameter.

Sample Queries:
`\userlist` for all users
`\userlist?offset=1` start offset 1
`\userlist?limit=1` limit count 1 : `MAX Limit = 1000`
`\pattern=name&field=firstName` : search for name in firstName field.
query Parameters
limit
int

User simple list count limit.
MAX Limit = 1000

offset
int

User simple list count offset.

pattern
string

If only Pattern is present, UserID, FirstName, and LastName will only import those containing the string.
If it is Pattern + Field, it import only if the field has a pattern.

field
string
Enum: "userID" "status" "firstName" "lastName" "role" "department"

If it is Pattern + Field, it import only if the field has a pattern.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/userlist?limit=0&offset=1' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
[
  • {
    }
]

Get User Count

GET /v1/users/count
iT100


Returns the number of users in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/users/count 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "count": 0
}

Delete all Users

DELETE /v1/users/all
iT100


Returns delete all Users in the device.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Responses

Request samples 

curl --location --request DELETE
 'https://it100-simulator.irisid.com:4747/v1/users/all 
 --header 'x-api-key: <string>' 
 --header 'x-client-id: <string>'

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string",
  • "userIDs": [ ]
}

Update users account

PUT /v1/users/account
iT100


Updates users account setting.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
userID
string

You must enter the administrator's ID.

adminPassword
string

Enter an existing password.

newAdminPassword
string

Enter the password you want to change.

adminID
string

Enter an existing login ID.

newAdminID
string

Enter the login ID to change.

Responses

Request samples

Content type
application/json
{
  • "userID": "string",
  • "adminPassword": "string",
  • "newAdminPassword": "string",
  • "adminID": "string",
  • "newAdminID": "string"
}

Response samples

Content type
application/json
{
  • "result": 0
}

User Callback Subscription

POST /v1/users/subscribe
iT100


Subcribes for callbacks that notify changes in user data like user added, modified or deleted in the device. Callback url should be passed in the request body in JSON format as documented below.

Unique identifier for this callback subscription (subscriberID) is returned in response if this API is successful. 'subscriberID' can be used for callback cancellation (Unsubscribe API).
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
url
required
string <uri>
apiKey
string

API Key to be sent in the callbacks (in header with name 'x-api-key')
It is a variable used to strengthen security.
When we call back, we include it in url's header and deliver it.
If unnecessary, you don't have to use it.

Responses

Callbacks

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "subscriberID": "string"
}

Callback payload samples

Callback
Content type
application/json
{
  • "guid": "string",
  • "userID": "string",
  • "active": true,
  • "status": "active",
  • "lIrisCode": "string",
  • "rIrisCode": "string",
  • "faceCode": "string",
  • "title": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "emailAddr": "string",
  • "phoneNum": "string",
  • "cards": [
    ],
  • "role": "string",
  • "department": "string",
  • "adminID": "string",
  • "adminPassword": "string",
  • "recogMode": "Iris",
  • "faceImg": "string",
  • "faceSmallImg": "string",
  • "lIrisImg": "string",
  • "rIrisImg": "string",
  • "enrollTimestamp": 0,
  • "userDefined1": "string",
  • "userDefined2": "string",
  • "userDefined3": "string",
  • "userDefined4": "string",
  • "userDefined5": "string",
  • "userConsent": true,
  • "userConsentCreateTime": 0,
  • "userConsentUpdateTime": 0
}

User Callback Subscription Cancellation

POST /v1/users/unsubscribe
iT100


Cancels user callback subscription. User callbacks will no longer be notified after this API call. A valid 'subscriberID' (returned by Subscribe API) should be passed in the request body.
header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
subscriberID
string

Responses

Request samples

Content type
application/json
{
  • "subscriberID": "string"
}

SysLog Configuration

PUT /v1/logger/syslog
iT100 iBAR600E

Updates the syslog configuration.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Request Body schema: application/json
One of
url
string

URL to the syslog server.

level
integer

Log Level

  • 0 : LOG_LEVEL_VERBOSE
  • 1 : LOG_LEVEL_DEBUG
  • 2 : LOG_LEVEL_INFO
  • 3 : LOG_LEVEL_WARNING
  • 4 : LOG_LEVEL_ERROR
  • 5 : LOG_LEVEL_FATAL
  • 6 : LOG_LEVEL_SILENT

Responses

Request samples

Content type
application/json
Example
{
  • "url": "string",
  • "level": 0
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

SysLog Configuration

GET /v1/logger/syslog
iT100 iBAR600E

Returns the syslog configuration.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Responses

Response samples

Content type
application/json
Example
{
  • "url": "string",
  • "level": 0,
  • "status": "string"
}

Enable SysLog

POST /v1/logger/syslog/start
iT100 iBAR600E

Enables sending syslog messages to the server as configured via '/v1/logger/syslog' endpoint.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Responses

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Disable SysLog

POST /v1/logger/syslog/stop
iT100 iBAR600E

Disables sending syslog messages to the server.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Responses

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Update Logger Configuration

PUT /v1/logger
iT100 iBAR600E

Updates the logger configuration.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Request Body schema: application/json
level
integer

Log Level

  • 1 : FATAL - to log only FATAL messages
  • 2 : ERROR - to log ERROR and FATAL messages
  • 3 : WARN - to log WARNING, FATAL and ERROR messages
  • 4 : INFO - to log INFORMATION, FATAL, ERROR and WARNING messages
  • 5 : BEGIN - to log BEGIN, FATAL, ERROR, WARNING and INFORMATION messages
  • 6 : END - to log END, FATAL, ERROR, WARNING, INFORMATION and BEGIN messages
  • 7 : DEBUG - to log DEBUG, FATAL, ERROR, WARNING, INFORMATION, BEGIN and END messages
logcatEnabled
boolean

Enable or disable logcat logs. This configuration is only applicable for iT100 devices.

Responses

Request samples

Content type
application/json
{
  • "level": 0,
  • "logcatEnabled": true
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Generates face templates for face images

POST /v1/templates/facecode
iT100

Generates face templates for an array of face images. Generated face templates are sent back in a callback on the URL supplied.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client (optional)

Request Body schema: application/json
url
string

Callback URL to receive the face templates generated for the face images.

apiKey
string

API Key to be sent in the callback (in header with name 'x-api-key')

Array of objects (FaceImageInfo)

List of face image information to generate face templates

Responses

Callbacks

Request samples

Content type
application/json
{
  • "url": "string",
  • "apiKey": "string",
  • "imageInfo": [
    ]
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Callback payload samples

Callback
POST: {$request.body#/url}
Content type
application/json
{
  • "result ": "string",
  • "faceCodeInfo": [
    ]
}

iBAR600E

Everything about your IrisBar

Heartbeat Subscription - [POST] /v1/heartbeat/url

POST /v1/heartbeat/url
iT100  iBAR600E

Subscribes for heartbeat by supplying URL for the device to reach back custom application/service for heartbeat check.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
url
required
string <uri>

Responses

Request samples

Content type
application/json
{}

Get Configurations

GET /v1/config
iT100 iBAR600E

Returns all configurations.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "language": "string",
  • "time": "string",
  • "timeZone": "Pacific/Majuro",
  • "ntp": "string",
  • "dateformat": 0,
  • "automaticDateTime": true,
  • "displayBrightness": 0,
  • "soundVolume": 0,
  • "dhcp": true,
  • "ipAddress": "string",
  • "subnetMask": "string",
  • "defaultGateway": "string",
  • "dns1": "string",
  • "dns2": "string",
  • "livenessDetectionForFace": true,
  • "livenessDetectionForIris": true,
  • "lensDetection": true,
  • "operationMode": "string",
  • "enableDeviceRecogMode": true,
  • "deviceRecogMode": "Iris",
  • "enableThermalCamera": true,
  • "thermalCameraUnit": "string",
  • "thermalCameraThreshold": 0.1,
  • "thermalCorrectionValue": 0.1,
  • "thermalCorrectionRatio": 0.1,
  • "wiegandFormats": [
    ],
  • "wiegandOut": {
    },
  • "deviceWiegandSetting": {
    },
  • "relayTime": 0,
  • "enableCardReader": true,
  • "cardReaderRS232BaudRate": 0,
  • "cardDeviceType": "string",
  • "cardReaderDataBits": "string",
  • "cardReaderParityBits": "string",
  • "cardReaderStopBits": "string",
  • "cardReaderStartEndChar": "string",
  • "cardReaderRS232ReadTimeout": 0,
  • "subscribedUserServer": [
    ],
  • "subscribedConfigServer": [
    ],
  • "subscribedTxLogServer": [
    ],
  • "heartbeatServer": [
    ],
  • "heartbeatURL": "string",
  • "saveAuditFaceImg": "None",
  • "activationType": "StandAlone",
  • "discoverITMS": "Manual",
  • "itmsIP": "string",
  • "itmsPort": "string",
  • "deviceActivated": true,
  • "siteKeyPassPhrase": "string",
  • "apiKeyPassPhrase": "string",
  • "lastLocalIP": "string",
  • "deviceType": "string",
  • "serialNumber": "string",
  • "deviceName": "string",
  • "softwareVersion": "string",
  • "hardwareVersion": "string",
  • "androidVersion": "string",
  • "kernelVersion": "string",
  • "macAddress": "string",
  • "thermalAccessControl": true,
  • "enableMaskDetection": true,
  • "maskAccessControl": true,
  • "door": "string",
  • "doorInterface": [ ],
  • "gpio0": {
    },
  • "gpio1": {
    },
  • "policy": {
    }
}

Update Configurations

PUT /v1/config
iT100  iBAR600E

Updates all configurations.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
language
string

Display language in the device.

time
string

Current time in the device.

timeZone
string (TimeZone)
Enum: "Pacific/Majuro" "Pacific/Midway" "Pacific/Honolulu" "America/Anchorage" "America/Los_Angeles" "America/Tijuana" "America/Phoenix" "America/Chihuahua" "America/Denver" "America/Costa_Rica" "America/Chicago" "America/Mexico_City" "America/Regina" "America/Bogota" "America/New_York" "America/Caracas" "America/Barbados" "America/Halifax" "America/Manaus" "America/Santiago" "America/St_Johns" "America/Sao_Paulo" "America/Argentina/Buenos_Aires" "America/Godthab" "America/Montevideo" "Atlantic/South_Georgia" "Atlantic/Azores" "Atlantic/Cape_Verde" "Africa/Casablanca" "Europe/London" "Europe/Amsterdam" "Europe/Belgrade" "Europe/Brussels" "Europe/Sarajevo" "Africa/Windhoek" "Africa/Brazzaville" "Asia/Amman" "Europe/Athens" "Asia/Beirut" "Africa/Cairo" "Europe/Helsinki" "Asia/Jerusalem" "Europe/Minsk" "Africa/Harare" "Asia/Baghdad" "Europe/Moscow" "Asia/Kuwait" "Africa/Nairobi" "Asia/Tehran" "Asia/Baku" "Asia/Tbilisi" "Asia/Yerevan" "Asia/Dubai" "Asia/Kabul" "Asia/Karachi" "Asia/Oral" "Asia/Yekaterinburg" "Asia/Calcutta" "Asia/Colombo" "Asia/Katmandu" "Asia/Almaty" "Asia/Rangoon" "Asia/Krasnoyarsk" "Asia/Bangkok" "Asia/Jakarta" "Asia/Shanghai" "Asia/Hong_Kong" "Asia/Irkutsk" "Asia/Kuala_Lumpur" "Australia/Perth" "Asia/Taipei" "Asia/Seoul" "Asia/Tokyo" "Asia/Yakutsk" "Australia/Adelaide" "Australia/Darwin" "Australia/Brisbane" "Australia/Hobart" "Australia/Sydney" "Asia/Vladivostok" "Pacific/Guam" "Asia/Magadan" "Pacific/Auckland" "Pacific/Fiji" "Pacific/Tongatapu"

Current Timezone in the device

ntp
string

NTP server

dateformat
integer

Time format. 12 for 12-hour clock. 24 for 24-hour clock.

automaticDateTime
boolean

Automatic date-time sync with an internet time server (NTP server).

displayBrightness
integer

Display brightness level. Valid range - 2 to 255.

soundVolume
integer

Sound volume. Valid range - 0 to 15.

dhcp
boolean

Enable/Disable DHCP.

ipAddress
string

IP Address.

subnetMask
string

Prefix length is used to define the subnet mask. It is the number of bits set to 1 in the subnet mask. For example, if the subnet mask is 255.255. 255.0, there are 24 bits set to 1 in the binary version of the subnet mask, so the prefix length is 24 bits or /24.

defaultGateway
string

Default gateway configuration.

dns1
string

Primary DNS server

dns2
string

Secondary DNS server

livenessDetectionForFace
boolean

Enable/Disable fake face detection during enrollment and recognition.

livenessDetectionForIris
boolean

Enable/Disable fake eye detection during enrollment and recognition.

lensDetection
boolean

Enable/Disable lens detection during enrollment and recognition. For future use.

operationMode
string

Operation mode: interactive or continuous. In interavtive mode, biometric capture for recognition is initiated manually. It starts automatically in continuous mode when subject comes in front of the device

enableDeviceRecogMode
boolean

Enable or disable device recognition mode.
If enabled, device recognition mode overrides the user recognition mode. All users are recognized in device recognition mode.
If disabled, users are recognized in their respective recognition modes (user recognition mode)

deviceRecogMode
string
Enum: "Iris" "Face" "Fusion" "FaceOrIris" "FaceAndIris" "Card" "FaceOrCard" "IrisOrCard" "FusionOrCard" "FaceAndIrisOrCard" "FaceOrIrisOrCard" "FaceAndCard" "IrisAndCard" "FusionAndCard" "FaceAndIrisAndCard" "FaceOrIrisAndCard"

Device recognition mode

enableThermalCamera
boolean

Enable or disable thermal camera that helps to read user's body temperature during recognition

thermalCameraUnit
string

Body temperature unit. Possible values: Celsius and Fahrenheit.

thermalCameraThreshold
number <float>

Thermal camera threshold

thermalCorrectionValue
number <float>

Thermal correction value

thermalCorrectionRatio
number <float>

Thermal correction ratio

Array of objects (WiegandFormat)
object (WiegandOutSettings)
object (DeviceWiegandConfig)
relayTime
integer

Relay duration.

enableCardReader
boolean

Enable/Disable card reader. For future use.

cardReaderRS232BaudRate
integer

Card reader baud rate. For future use.

cardDeviceType
string

Card device type. For future use.

cardReaderDataBits
string

Card reader data bits. For future use.

cardReaderParityBits
string

Card reader parity bits. For future use.

cardReaderStopBits
string

Card reader stop bits. For future use.

cardReaderStartEndChar
string

Card reader start and end character. For future use.

cardReaderRS232ReadTimeout
integer

RS232 read timeout setting.

Array of objects (CallbackSubscription)

Callback subscription details

Array of objects (CallbackSubscription)

Callback subscription details

Array of objects (CallbackSubscription)

Callback subscription details

Array of objects (CallbackSubscription)

Callback subscription details

heartbeatURL
string

URL for heartbeat check for iTMSfrom the device.

saveAuditFaceImg
string
Enum: "None" "All"

Audit face image configuration that define when to save audit face image in transaction log. This can be any of the following:

  • None - Audit face image is never saved.
  • AllTransactions - Audit face image is saved for all transactions.
  • UnauthorizedTransactions - Audit face image is saved for failure transactions.
activationType
string
Enum: "StandAlone" "ITMS"

Activation type configuration:

  • StandAlone - Stand-alone activation recommended for single door application.
  • ITMS - iTMS activation to configure the device in iTMS application framework.
discoverITMS
string
Enum: "Manual" "Auto"

iTMS discovery type (applicable only for iTMS activation):

  • Manual - Administrator shall enter iTMS information (IP and Port) manually.
  • Auto - the device will discover iTMS information automatically using mDNS.
itmsIP
string

IP address of iTMS server that the device is activated with. This is applicable only for iTMS activation.

itmsPort
string

Port that iTMS server runs on. This is applicable only for iTMS activation.

deviceActivated
boolean

Device activation status.

siteKeyPassPhrase
string

Site key passphrase. This is applicable only for StandAlone activation.

apiKeyPassPhrase
string

API key passphrase. This is applicable only for StandAlone activation.

lastLocalIP
string

Last local Ip address. Checking IP changed

deviceType
string

Device type.

serialNumber
string

Device serial number.

deviceName
string

Device name that is displayed in the device home screen.

softwareVersion
string

Software version.

hardwareVersion
string

Hardware version.

androidVersion
string

Android version.

kernelVersion
string

Kernel version.

macAddress
string

MAC address.

thermalAccessControl
boolean

Enable/Disable Thremal Access Control.

enableMaskDetection
boolean

Enable/Disable MaskDetection.

maskAccessControl
boolean

Enable/Disable Mask Access Control.

door
string

Type of policy attributes

doorInterface
Array of arrays

Select the type of door interface.

  • Relay
  • Wiegand
object (gpioInfo)

gpio settings

object (gpioInfo)

gpio settings

object (policy)

Responses

Request samples

Content type
application/json
{
  • "language": "string",
  • "time": "string",
  • "timeZone": "Pacific/Majuro",
  • "ntp": "string",
  • "dateformat": 0,
  • "automaticDateTime": true,
  • "displayBrightness": 0,
  • "soundVolume": 0,
  • "dhcp": true,
  • "ipAddress": "string",
  • "subnetMask": "string",
  • "defaultGateway": "string",
  • "dns1": "string",
  • "dns2": "string",
  • "livenessDetectionForFace": true,
  • "livenessDetectionForIris": true,
  • "lensDetection": true,
  • "operationMode": "string",
  • "enableDeviceRecogMode": true,
  • "deviceRecogMode": "Iris",
  • "enableThermalCamera": true,
  • "thermalCameraUnit": "string",
  • "thermalCameraThreshold": 0.1,
  • "thermalCorrectionValue": 0.1,
  • "thermalCorrectionRatio": 0.1,
  • "wiegandFormats": [
    ],
  • "wiegandOut": {
    },
  • "deviceWiegandSetting": {
    },
  • "relayTime": 0,
  • "enableCardReader": true,
  • "cardReaderRS232BaudRate": 0,
  • "cardDeviceType": "string",
  • "cardReaderDataBits": "string",
  • "cardReaderParityBits": "string",
  • "cardReaderStopBits": "string",
  • "cardReaderStartEndChar": "string",
  • "cardReaderRS232ReadTimeout": 0,
  • "subscribedUserServer": [
    ],
  • "subscribedConfigServer": [
    ],
  • "subscribedTxLogServer": [
    ],
  • "heartbeatServer": [
    ],
  • "heartbeatURL": "string",
  • "saveAuditFaceImg": "None",
  • "activationType": "StandAlone",
  • "discoverITMS": "Manual",
  • "itmsIP": "string",
  • "itmsPort": "string",
  • "deviceActivated": true,
  • "siteKeyPassPhrase": "string",
  • "apiKeyPassPhrase": "string",
  • "lastLocalIP": "string",
  • "deviceType": "string",
  • "serialNumber": "string",
  • "deviceName": "string",
  • "softwareVersion": "string",
  • "hardwareVersion": "string",
  • "androidVersion": "string",
  • "kernelVersion": "string",
  • "macAddress": "string",
  • "thermalAccessControl": true,
  • "enableMaskDetection": true,
  • "maskAccessControl": true,
  • "door": "string",
  • "doorInterface": [ ],
  • "gpio0": {
    },
  • "gpio1": {
    },
  • "policy": {
    }
}

Get Countermeasure Setting

GET /v1/config/countermeasure
iT100 iBAR600E

Returns current Countermeasure setting in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/countermeasure' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "livenessDetectionForFace": true,
  • "livenessDetectionForIris": true,
  • "lensDetection": true
}

Update Countermeasure setting

PUT /v1/config/countermeasure
iT100 iBAR600E

Updates Countermeasure setting.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
livenessDetectionForFace
boolean

setting livenessDetectionForFace option.

livenessDetectionForIris
boolean

setting livenessDetectionForIris option.

lensDetection
boolean

setting lensDetection option. The value is not working yet.

Responses

Request samples

Content type
application/json
{
  • "livenessDetectionForFace": true,
  • "livenessDetectionForIris": true,
  • "lensDetection": true
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Update Device Name

PUT /v1/config/device-name
iT100 iBAR600E

Updates device name setting.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
deviceName
string

Responses

Request samples

Content type
application/json
{
  • "deviceName": "string"
}

Get Network Settings

GET /v1/config/network
iT100 iBAR600E

Returns current network settings in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/network' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "dhcp": true,
  • "ipAddress": "string",
  • "subnetMask": "string",
  • "defaultGateway": "string",
  • "dns1": "string",
  • "dns2": "string"
}

Update Network Settings

PUT /v1/config/network
iT100 iBAR600E

Update network settings in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
dhcp
boolean
ipAddress
string
subnetMask
string
defaultGateway
string
dns1
string
dns2
string

Responses

Request samples

Content type
application/json
{
  • "dhcp": true,
  • "ipAddress": "string",
  • "subnetMask": "string",
  • "defaultGateway": "string",
  • "dns1": "string",
  • "dns2": "string"
}

Get Date-Time settings

GET /v1/config/date-time
iT100 iBAR600E

Returns current date-time settings in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/config/date-time' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "automaticDateTime": true,
  • "time": "2019-08-24T14:15:22Z",
  • "timezone": "Pacific/Majuro",
  • "ntp": "string",
  • "dateformat": 12
}

Update Date-Time Settings

PUT /v1/config/date-time
iT100 iBAR600E

Updates date-time settings in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
automaticDateTime
boolean
time
string <date-time>

Date Time

timezone
string (TimeZone)
Enum: "Pacific/Majuro" "Pacific/Midway" "Pacific/Honolulu" "America/Anchorage" "America/Los_Angeles" "America/Tijuana" "America/Phoenix" "America/Chihuahua" "America/Denver" "America/Costa_Rica" "America/Chicago" "America/Mexico_City" "America/Regina" "America/Bogota" "America/New_York" "America/Caracas" "America/Barbados" "America/Halifax" "America/Manaus" "America/Santiago" "America/St_Johns" "America/Sao_Paulo" "America/Argentina/Buenos_Aires" "America/Godthab" "America/Montevideo" "Atlantic/South_Georgia" "Atlantic/Azores" "Atlantic/Cape_Verde" "Africa/Casablanca" "Europe/London" "Europe/Amsterdam" "Europe/Belgrade" "Europe/Brussels" "Europe/Sarajevo" "Africa/Windhoek" "Africa/Brazzaville" "Asia/Amman" "Europe/Athens" "Asia/Beirut" "Africa/Cairo" "Europe/Helsinki" "Asia/Jerusalem" "Europe/Minsk" "Africa/Harare" "Asia/Baghdad" "Europe/Moscow" "Asia/Kuwait" "Africa/Nairobi" "Asia/Tehran" "Asia/Baku" "Asia/Tbilisi" "Asia/Yerevan" "Asia/Dubai" "Asia/Kabul" "Asia/Karachi" "Asia/Oral" "Asia/Yekaterinburg" "Asia/Calcutta" "Asia/Colombo" "Asia/Katmandu" "Asia/Almaty" "Asia/Rangoon" "Asia/Krasnoyarsk" "Asia/Bangkok" "Asia/Jakarta" "Asia/Shanghai" "Asia/Hong_Kong" "Asia/Irkutsk" "Asia/Kuala_Lumpur" "Australia/Perth" "Asia/Taipei" "Asia/Seoul" "Asia/Tokyo" "Asia/Yakutsk" "Australia/Adelaide" "Australia/Darwin" "Australia/Brisbane" "Australia/Hobart" "Australia/Sydney" "Asia/Vladivostok" "Pacific/Guam" "Asia/Magadan" "Pacific/Auckland" "Pacific/Fiji" "Pacific/Tongatapu"

Current Timezone in the device

ntp
string

NTP server

dateformat
integer
Enum: 12 24

Time format. 12 for 12-hour clock. 24 for 24-hour clock.

Responses

Request samples

Content type
application/json
{
  • "automaticDateTime": true,
  • "time": "2019-08-24T14:15:22Z",
  • "timezone": "Pacific/Majuro",
  • "ntp": "string",
  • "dateformat": 12
}

Config Callback Subscription

POST /v1/config/subscribe
iT100 iBAR600E

Subscribes for callbacks that notify changes in certain configurations. Callback url should be passed in the request body in JSON format as documented below.

Unique identifier for this callback subscription (subscriberID) is returned in response if this API is successful. 'subscriberID' can be used for callback cancellation (Unsubscribe API).

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
url
required
string <uri>
apiKey
string

API Key to be sent in the callbacks (in header with name 'x-api-key')
It is a variable used to strengthen security.
When we call back, we include it in url's header and deliver it.
If unnecessary, you don't have to use it.

Responses

Callbacks

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "subscriberID": "string"
}

Callback payload samples

Callback
Content type
application/json
{
  • "ip": "string",
  • "port": "string",
  • "serialNumber": "string"
}

Config Callback Subscription Cancellation

POST /v1/config/unsubscribe
iT100 iBAR600E

Cancels config callback subscription. Changes in configuration will no longer be notified. A valid 'subscriberID' (returned by Subscribe API) should be passed in the request body.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: application/json
subscriberID
string

Responses

Request samples

Content type
application/json
{
  • "subscriberID": "string"
}

Deactivate Device

POST /v1/device/deactivate
iT100 iBAR600E

Deactivates the device so that no further API calls to the device can be made. Once the device is deactivated, it deletes all device configurations and user information stored in the device and restarts the device automatically. In case of the iTMS activation, this operation will remove the device from the iTMS Device Management screen until thethe device checks back in to the iTMS again.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Responses

Request samples 

curl --location --request POST
 'https://it100-simulator.irisid.com:4747/v1/device/deactivate' 
 --header 'x-api-key: <string>' 
 --header 'x-client-id: <string>'

Device Reboot

POST /v1/device/reboot
iT100 iBAR600E

Initiates device reboot. Device will be rebooted after 5 seconds after the API call.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Responses

Request samples 

curl --location --request POST
 'https://it100-simulator.irisid.com:4747/v1/device/reboot' 
 --header 'x-api-key: <string>' 
 --header 'x-client-id: <string>'

Get Device Version Information

GET /v1/device/info
iT100 iBAR600E

Returns device & version information

header Parameters
x-api-key
required
string

API Key for client authentication

Responses

Request samples 

curl --location --request GET
 'https://it100-simulator.irisid.com:4747/v1/device/info' 
 --header 'x-api-key: <string>'

Response samples

Content type
application/json
{
  • "deviceType": "string",
  • "serialNumber": "string",
  • "deviceName": "string",
  • "softwareVersion": "string",
  • "kernalVersion": "string",
  • "macAddress": "string",
  • "hardwareVersion": "string",
  • "androidVersion": "string"
}

Device Software Update

POST /v1/device/software
iT100 iBAR600E

Updates software in the device.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Check the items using whether there is a x-client-id or not.
If you have a x-client-id, it is not a message from itms.
So if you need a callback, add x-client-id, it is delivered to the subscription.

Request Body schema: multipart/form-data
updatefile
string <file>

iT100 package file (.ipk).

Responses

Request samples 

curl --location --request POST
 'https://it100-simulator.irisid.com:4747/v1/device/software' 
 --header 'x-api-key: <string>' 
 --header 'x-client-id: <string>' 
 --header 'Content-Type: multipart/form-data' 
 --form 'updatefile="<file>"'

Set Logo

PUT /v1/config/logo
iBAR600E

Sets the image on iBar's circular LCD.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Request Body schema: application/json
image
string

The custom logo in base64 encoding. This image is displayed on iBar's circular LCD. Default logo is set when this string is empty.

text
string

A custom text message that will be displayed for 15 seconds to protect the screen from burn-in.

Responses

Request samples

Content type
application/json
{
  • "image": "string",
  • "text": "string"
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

API Key Update

PUT /v1/config/api-key
iBAR600E

Sets the new API key.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Request Body schema: application/json
apiKey
string

New API key to be set.

Responses

Request samples

Content type
application/json
{
  • "apiKey": "string"
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

SysLog Configuration

PUT /v1/logger/syslog
iT100 iBAR600E

Updates the syslog configuration.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Request Body schema: application/json
One of
url
string

URL to the syslog server.

level
integer

Log Level

  • 0 : LOG_LEVEL_VERBOSE
  • 1 : LOG_LEVEL_DEBUG
  • 2 : LOG_LEVEL_INFO
  • 3 : LOG_LEVEL_WARNING
  • 4 : LOG_LEVEL_ERROR
  • 5 : LOG_LEVEL_FATAL
  • 6 : LOG_LEVEL_SILENT

Responses

Request samples

Content type
application/json
Example
{
  • "url": "string",
  • "level": 0
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

SysLog Configuration

GET /v1/logger/syslog
iT100 iBAR600E

Returns the syslog configuration.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Responses

Response samples

Content type
application/json
Example
{
  • "url": "string",
  • "level": 0,
  • "status": "string"
}

Enable SysLog

POST /v1/logger/syslog/start
iT100 iBAR600E

Enables sending syslog messages to the server as configured via '/v1/logger/syslog' endpoint.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Responses

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Disable SysLog

POST /v1/logger/syslog/stop
iT100 iBAR600E

Disables sending syslog messages to the server.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Responses

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Abort image capture

POST /v1/images/abort
iBAR600E

Capture operation is aborted. Clinet application is notified via callback on the registred URL (sent with [POST]/v1/images API call).

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Responses

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Capture Iris and Face Images

POST /v1/images
iBAR600E

Starts iris and/or face image capture. This API returns immediately after the initiation of capture procedure. The biometric images are sent back to the caller via callback as decribed below.

Capture timeout works as described below:

* Capture operation is timed out in 10 seconds when no person is present (no human face detected) in front of iBar600. Capture timeout result is returned to the client.

* Capture operation is timed out in 20 seconds when person is present in front of iBar600, but not in (and continues to be out of) capture range, may be too near, too far, on the left side, on the right side, too tall or too short. Capture timeout result is returned to the client.

* When subject is in range and capture could not be completed, capture operation is now timed out after 30 seconds. Within this timeout period, capture would be attempted for 5 times and if capture failure occurs in every attempt, capture would fail and the result is retuned to the client accordingly.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Request Body schema: application/json

Inventory item to add

captureIris
required
boolean

Enables iris capture. If true, iris images are captured and included in the callback response.

captureFace
required
boolean

Enables face capture. If true, face pictures are captured and included in the callback response.

url
required
string

REST API end-point to receive the capture result callback.

positionGuideUrl
string

REST API end-point to receive user position guide callbacks.

irisImageFormat
required
string
Enum: "jpg" "bmp" "png"

Image format for the iris images. Jpeg, BMP and PNG are the supported image formats.

faceImageFormat
required
string
Enum: "jpg" "bmp" "png"

Image format for the face pictures. Jpeg, BMP and PNG are the supported image formats.

Responses

Callbacks

Request samples

Content type
application/json
{
  • "captureIris": true,
  • "captureFace": true,
  • "url": "string",
  • "positionGuideUrl": "string",
  • "irisImageFormat": "jpg",
  • "faceImageFormat": "jpg"
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Callback payload samples

Callback
Content type
application/json
{
  • "result": 0,
  • "message": "string",
  • "faceStatus": "success",
  • "faceImage": "string",
  • "faceImageCropped": "string",
  • "leftEyeStatus": "success",
  • "leftIrisImage": "string",
  • "leftEyeQualityMetrics": {
    },
  • "rightEyeStatus": "success",
  • "rightIrisImage": "string",
  • "rightEyeQualityMetrics": {
    },
  • "distance": 0,
  • "captureTime": "string"
}

Start Video Streaming

POST /v1/video/start
iBAR600E

Establishes WebRTC session and starts video streaming via WebRTC channel. Caller shall create RTCPeerConnection object, create an SDP offer (using createOffer method) and shall include the session descriptor (webRTCOffer) in request body as described in the request body section.

The API returns the session descriptor (WebRTC answer) for the remote end of the connection. This can be set as remote description (by setting RTCPeerConnection object's 'remoteDescription' property) to get the connection estblished. Video streaming starts as soon as the connection is established.

Please refer Javascript example below: | | | ----------- | let pc = new RTCPeerConnection()
pc.addTransceiver('video', {'direction': 'sendrecv'})
pc.ontrack = function (event) { document.getElementById('remoteVideo').srcObject = event.streams[0]; }

const offer = await pc.createOffer();
await pc.setLocalDescription(offer);

var startVideoParam = {"webRTCOffer": btoa(JSON.stringify(pc.localDescription))}.

await fetch("\startVideo", { method: 'POST', body: JSON.stringify(startVideoParam), headers: { 'Content-Type': 'application/json' }

pc.setRemoteDescription(new RTCSessionDescription(JSON.parse(atob(req.webRTCAnswer)))) | | | ----------- |

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Request Body schema: application/json
webRTCOffer
string

WebRTC offer.

candidates
string

Base64 encoded JSON object that contains an array of 'RTCIceCandidate' objects. These objects are obtained from several 'onicecandidate' event from 'RTCPeerConnection' object.

Responses

Request samples

Content type
application/json
{
  • "webRTCOffer": "string",
  • "candidates": "string"
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string",
  • "webRTCAnswer": "string",
  • "candidates": "string"
}

Stop Video Streaming

POST /v1/video/stop
iBAR600E

Stops video streaming and closes WebRTC communication channel.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Responses

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Get Color Camera Settings

GET /v1/config/color-camera
iBAR600E

Returns the current color camera settings.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Responses

Response samples

Content type
application/json
{
  • "whiteBalance": "auto",
  • "brightness": -3,
  • "saturation": 0,
  • "gamma": 0,
  • "tone": "normal",
  • "sharpeness": -2,
  • "iso": "auto",
  • "iHDR": true,
  • "backlightCompensation": 0
}

Update Color Camera Settings

PUT /v1/config/color-camera
iBAR600E

Updates the color camera configurations that will reflect in the live video feed and in the final face picture from iBAR600E.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Request Body schema: application/json
whiteBalance
string
Default: "auto"
Enum: "auto" "HOR" "A" "CWF" "D50" "D65" "D75"

White Balance Setting

brightness
integer
Default: 0
Enum: -3 -2 -1 0 1 2 3 4 5

Brightness Setting

saturation
number <float>
Default: 1
Enum: 0 0.5 1 1.5 2

Saturation Setting

gamma
number <float>
Default: 0
Enum: 0 1.5 2 2.2 2.5

Gamma Setting

tone
string
Default: "normal"
Enum: "normal" "reddish" "bluish" "greenish"

Tone Setting

sharpeness
number <float>
Default: 0
Enum: -2 -1 -0.5 0 0.5 1 2

Sharpeness Setting

iso
string
Default: "auto"
Enum: "auto" "100" "200" "400" "800"

ISO Setting

iHDR
boolean
Default: true

iHDR Setting

backlightCompensation
integer
Default: 2
Enum: 0 1 2 3

Backlight Compensation Setting

Responses

Request samples

Content type
application/json
{
  • "whiteBalance": "auto",
  • "brightness": -3,
  • "saturation": 0,
  • "gamma": 0,
  • "tone": "normal",
  • "sharpeness": -2,
  • "iso": "auto",
  • "iHDR": true,
  • "backlightCompensation": 0
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Get Default Camera Position

GET /v1/config/default-camera-position
iBAR600E

Returns the current 'Default camera position' setting. Camera position is the angle at which camera starts capturing.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Responses

Response samples

Content type
application/json
{
  • "defaultCameraPosition": 0
}

Update Default Camera Position

PUT /v1/config/default-camera-position
iBAR600E

Updates the initial angle at which camera starts capturing. Camera postion can range from -35 to +35.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Request Body schema: application/json
defaultCameraPosition
integer [ -35 .. 35 ]
Default: 0

Camera tilt angle to be set initially

Responses

Request samples

Content type
application/json
{
  • "defaultCameraPosition": 0
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}

Update Logger Configuration

PUT /v1/logger
iT100 iBAR600E

Updates the logger configuration.

header Parameters
x-api-key
required
string

API Key for client authentication

x-client-id
string

Unique ID for each client

Request Body schema: application/json
level
integer

Log Level

  • 1 : FATAL - to log only FATAL messages
  • 2 : ERROR - to log ERROR and FATAL messages
  • 3 : WARN - to log WARNING, FATAL and ERROR messages
  • 4 : INFO - to log INFORMATION, FATAL, ERROR and WARNING messages
  • 5 : BEGIN - to log BEGIN, FATAL, ERROR, WARNING and INFORMATION messages
  • 6 : END - to log END, FATAL, ERROR, WARNING, INFORMATION and BEGIN messages
  • 7 : DEBUG - to log DEBUG, FATAL, ERROR, WARNING, INFORMATION, BEGIN and END messages
logcatEnabled
boolean

Enable or disable logcat logs. This configuration is only applicable for iT100 devices.

Responses

Request samples

Content type
application/json
{
  • "level": 0,
  • "logcatEnabled": true
}

Response samples

Content type
application/json
{
  • "result": 0,
  • "message": "string"
}