全球领先的人工智能和生物识别核心技术

Aratek
Device Management
Assistant
Development Manual

Aratek Biometrics Co.,Ltd.

www.aratek.com.cn | 全球领先的人工智能和生物识别核心技术
 全球领先的人工智能和生物识别核心技术

Version Revision date Editor Operation Note

V1.0 2022/12/27 liujw Modify document V1.0.8.79

www.aratek.com.cn
 全球领先的人工智能和生物识别核心技术

Introduction

Content overview

This document serves as the development and usage instructions for Aratek Device

Management Assistant, and will provide instructions for people who develop based

on this software. This document is mainly divided into two parts, software

description and interface description. The software description includes the

application scope and installation instructions of the software; the interface

description section describes the communication protocol with the software.。

Reader

Developer

Software name and version

Software Name: Aratek Device Management Assistant

Software Version: V1.0.8.79

由于产品的不断更新，本公司不能承诺实际产品与该资料一致， 同时也不承担由于实际技术参
数与本资料不符所导致的任何争议，任何改动恕不提前通知。
 全球领先的人工智能和生物识别核心技术

Contents

Ⅰ.Software Description.................................................................................................................... 1
1.Scope ...................................................................................................................................... 1
2.Directory................................................................................................................................. 1
3.Installation steps .................................................................................................................... 1
4.Instructions for use ................................................................................................................ 5
Ⅱ.Interface Description .................................................................................................................... 6
1.OpenDevice ............................................................................................................................ 6
2.CloseDevice ............................................................................................................................ 7
3.GetDeviceCount ..................................................................................................................... 8
4.GetDeviceDescription ............................................................................................................ 9
5.CaptureFingerData ............................................................................................................... 11
6.StartCapture ......................................................................................................................... 14
7.StopCapture ......................................................................................................................... 16
8.GeneralizeTemplate.............................................................................................................. 17
9.Verify .................................................................................................................................... 18
10.SetOption ........................................................................................................................... 20
11.BmpToRaw ......................................................................................................................... 21
12.BmpToWSQ ........................................................................................................................ 23
13.BmpToISO ........................................................................................................................... 24
14.BmpToANSI......................................................................................................................... 26
15.CID_Init............................................................................................................................... 28
16.CID_Close ........................................................................................................................... 29
17.CID_GetChannelCount ....................................................................................................... 30
18.CID_BeginCapture .............................................................................................................. 32
19.CID_GetFPRawData ............................................................................................................ 33
20.CID_GetFPBmpData ........................................................................................................... 34
21.CID_EndCapture ................................................................................................................. 36
22.CID_GetVersion .................................................................................................................. 37
23.CID_GetDesc....................................................................................................................... 38
24.CID_Alg_GetVersion ........................................................................................................... 39
25.CID_Alg_Begin .................................................................................................................... 40
26.CID_Alg_FeatureExtract ..................................................................................................... 41
27.CID_Alg_FeatureMatch ...................................................................................................... 43
28.CID_Alg_ImageMatch ......................................................................................................... 44
29.CID_Alg_GetQualityScore................................................................................................... 46
30.CID_Alg_End ....................................................................................................................... 47
31.FRO900_OpenDevice ......................................................................................................... 48
32.FRO900_CloseDevice ......................................................................................................... 49
33.FRO900_GetDeviceCount................................................................................................... 50
34.FRO900_CaptureFingerPrintData ....................................................................................... 51
35.FRO900_GeneralizeTemplate ............................................................................................. 56
 全球领先的人工智能和生物识别核心技术

36.FRO900_Verify ................................................................................................................... 57
37.TrustLink_GetDeviceInfo .................................................................................................... 59
38.Iris_InitDevice .................................................................................................................... 60
39.Iris_ReleaseDevice ............................................................................................................. 62
40.Iris_StartCapture ................................................................................................................ 64
41.Iris_StartFastCapture.......................................................................................................... 66
42.Iris_StopCapture ................................................................................................................ 68
43.Iris_SetOptions ................................................................................................................... 69
44.Iris_StartVerify ................................................................................................................... 70
45.Iris_StopVerify .................................................................................................................... 72
46.ARA_ReadIDCard ................................................................................................................ 73
47.ARA_FeaConv ..................................................................................................................... 76
48.ARA_GetCurrentDeviceList ................................................................................................ 78
49.ARA_ChangeFPImgColor .................................................................................................... 80
50.FingerKey_OpenDevice ...................................................................................................... 81
51.FingerKey_CloseDevice ...................................................................................................... 82
52.FingerKey_GetDeviceInformation ...................................................................................... 83
53.FingerKey_CaptureFingerData ........................................................................................... 85
54.FingerKey_ImportFingerPrint ............................................................................................. 87
55.Camera_InitDevice ............................................................................................................. 89
56.Camera_ReleaseDevice ...................................................................................................... 90
57.Camera_StartCapture......................................................................................................... 91
58.Camera_StopCapture ......................................................................................................... 93
59.Camera_SetOption ............................................................................................................. 94
60.Camera_DetectFace ........................................................................................................... 95
61.Camera_Verify .................................................................................................................... 98
Ⅲ.Type identification in the interface ............................................................................................ 99
1.Request/Response data type ............................................................................................... 99
2.Finger position ................................................................................................................... 102
3.Miss Finger position ........................................................................................................... 104
4.Image compression format type ........................................................................................ 104
5.Security level ...................................................................................................................... 105
6.Fingerprint image format type ........................................................................................... 105
7.Fingerprint feature format type ......................................................................................... 105
8.CID series device type ........................................................................................................ 106
9.IR series device type........................................................................................................... 106
10.Camera device type .......................................................................................................... 106
11.IR series device capture mode type ................................................................................. 107
12.ID card type ...................................................................................................................... 107
13.Error code description...................................................................................................... 108
 全球领先的人工智能和生物识别核心技术

Ⅰ.Software Description

1.Scope

Aratek device management assistant(AratekDMA) is applied to the

communication between the web front-end or other applications and Aratek’s

devices, and can realize the functions of biological feature collection, extraction and

verification on the web front-end or other applications. The communication

protocols supported by the software include the WebSocket protocol.

2.Directory

The software compression package directory：

 Demo

Web sample program that realized the functions of image capture, feature

extraction and verification.

 Document

This document’s directory.

 Install

Software installation package location.

3.Installation steps

Step 1：open software installation package

www.aratek.com.cn 1
 全球领先的人工智能和生物识别核心技术

Step 2：select language，and click“OK”button

Step 3：select installation path and click “Next”button

www.aratek.com.cn 2
 全球领先的人工智能和生物识别核心技术

Step 4 ： Check the box if you need to create a desktop shortcut and click

“Next”button

Step 5：Click “Install”button

www.aratek.com.cn 3
 全球领先的人工智能和生物识别核心技术

Step 6：Please check the box if you need to run immediately, and click “Finish”

button

The directory after installation is shown in the figure. The websocket uses port 4397

www.aratek.com.cn 4
 全球领先的人工智能和生物识别核心技术

by default and the socket uses 7934 by default. If you need to set other ports, you

can modify the port number in the “open.bat” script, and then execute the script

to run AratekDMA program. The Drivers folder stores the drivers for the devices

supported by AratekDMA program. Please install the drivers manually after

AratekDMA program is installed.

4.Instructions for use

The effect of AratekDMA program is shown in the figure，

1、The function of Debug is used to view the reception and response of data during

the development process. It should be noted that when this window is opened, all

the transmission data during the opening process will be recorded in the program

installation path. If it is opened for a long time, the data will be accumulated ,

Please pay attention to the usage of disk storage

2、The function of Restart is used to manually restart AratekDMA program

3、The function of About is used to view the current version of AratekDMA program

and other information

4、The function of Exit is used to manually exit AratekDMA program

www.aratek.com.cn 5
 全球领先的人工智能和生物识别核心技术

Ⅱ.Interface Description

1.OpenDevice

Interface description

Function: Open device, Scope: devices supported by TrustFinger

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

{
Request data
“RequestType”: 1,
format
“Index”: 0（0 means the first device）

Request data format description

Field Description Type Required

RequestType Request data type int yes

Index Device index int yes

JSON:

Response data “ResponseType”: 1,

format “ErrorCode”:（Normally returns 0）

，

“ErrorMessage”: (Error message)

www.aratek.com.cn 6
 全球领先的人工智能和生物识别核心技术

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

2.CloseDevice

Interface description

Function: Close device, Scope: devices supported by TrustFinger

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

Request data {

format “RequestType”: 2

Request data format description

Field Description Type Required

RequestType Request data type int yes

JSON:

Response data {

format “ResponseType”: 2,

“ErrorCode”:（Normally returns 0）
，

www.aratek.com.cn 7
 全球领先的人工智能和生物识别核心技术

“ErrorMessage”:（Error message）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

3.GetDeviceCount

Interface description

Function: Get device count, Scope: devices supported by TrustFinger

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

Request data {

format “RequestType”: 3

Request data format description

Field Description Type Required

RequestType Request data type int yes

Response data JSON:

format {

www.aratek.com.cn 8
 全球领先的人工智能和生物识别核心技术

“ResponseType”: 3,

“ErrorCode”:（Normally returns 0）
，

“ErrorMessage”:（Error message）,

“Count”:（Device count）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

Count Device count int no

4.GetDeviceDescription

Interface description

Function: Get device description, Scope: devices supported by TrustFinger

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

{
Request data
“RequestType”: 4,
format
“Index”: 0（0 means the first device）

www.aratek.com.cn 9
 全球领先的人工智能和生物识别核心技术

Request data format description

Field Description Type Required

RequestType Request data type int yes

Index Device index int yes

JSON:

“ResponseType”: 4,

“ErrorCode”:（Normally returns 0）
，

“ErrorMessage”:（Error message）,

“SN”:（Serial number）,

“Manufacturer”:（Manufacturer information）,

Response data “ProductName”:（Product name）,

format “ProductModel”:（Product model）,

“FW_Version”:（Firmware version）,

“HW_Version”:（Hardware version）,

“Image_Width”:（Image width）,

“Image_Height”:（Image height）,

“DPI”:（Image DPI）,

“Device_ID”:（Device ID）

Response data format description

www.aratek.com.cn 10
 全球领先的人工智能和生物识别核心技术

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

SN Serial number string no

Manufacturer Manufacturer information string no

ProductName Product name string no

ProductModel Product model string no

FW_Version Firm version string no

HW_Version Hardware version string no

Image_Width Image width int no

Image_ Height Image height int no

DPI Image DPI int no

Device_ID Device ID int no

5.CaptureFingerData

Interface description

Function: Get a frame of finger image, Scope: devices supported by TrustFinger

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

Request data JSON：

format {

www.aratek.com.cn 11
 全球领先的人工智能和生物识别核心技术

“RequestType”: 5,

“Image_Format”:（Finger image format type）,

“Feature_Format”:（Finger feature format type）,

“TimeOut”:（Overtime time）,

“Finger_Position”:（Finger position type）,

“Compression_Type”:（Image compression format type）,

“Device_ID”:（Device ID）,

“Factor”:（Compression factor, range: 1-15）

Request data format description

Field Description Type Required

RequestType Request data type int yes

Image_Format Finger image format int yes

Feature_Format Finger feature format int yes

TimeOut Overtime int yes

Finger_Position Finger position int yes

Compression_Typ Finger image compression Required when ISO

int
e format or ANSI

Required when ISO

Device_ID Device ID int
or ANSI

Factor Compression factor float Required when JPEG

www.aratek.com.cn 12
 全球领先的人工智能和生物识别核心技术

or JPEG2000

JSON:

“ResponseType”: 5,

“ErrorCode”:（Normally returns 0）
，

“ErrorMessage”:（Error message）,

Response data “Image_Format”:（Finger image format type）,

format “Image_Data”:（Finger image data）,

“Feature_Format”:（Finger feature format type）,

“Feature_Data”:（Finger feature data）,

“Image_Quality”:（Finger image quality）,

“Image_NFIQ”:（Finger image NFIQ value）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

Image_Format Finger image format int no

Image_Data Finger image data string no

Feature_Format Finger feature format int no

www.aratek.com.cn 13
 全球领先的人工智能和生物识别核心技术

Feature_Data Finger feature data string no

Image_Quality Finger image quality int no

Image_NFIQ Finger image NFIQ value int no

6.StartCapture

Interface description

Function: Start real-time capture(image format is bmp), Scope: devices supported

by TrustFinger

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

Request data “RequestType”: 6,

format “Feature_Format”:（Finger feature format type）,

“Finger_Position”:（Finger position）

Request data format description

Field Description Type Required

RequestType Request data type int yes

Feature_Format Finger feature format int yes

Finger_Position Figner position int yes

Response data JSON:

www.aratek.com.cn 14
 全球领先的人工智能和生物识别核心技术

format {

“ResponseType”: 6,

“ErrorCode”:（Normally returns 0）
，

“ErrorMessage”:（Error message）,

“Image_Data”:（Finger image data）,

“Feature_Format”:（Finger feature format type）,

“Feature_Data”:（Finger feature data）,

“Image_Quality”:（Finger image quality）,

“Image_NFIQ”:（Finger image NFIQ value）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

Image_Data Finger image data string no

Feature_Format Finger feature format int no

Feature_Data Finger feature data string no

Image_Quality Finger image quality int no

Image_NFIQ Finger image NFIQ value int no

www.aratek.com.cn 15
 全球领先的人工智能和生物识别核心技术

7.StopCapture

Interface description

Function: Stop real-time capture, Scope: devices supported by TrustFinger

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

Request data {

format “RequestType”: 7

Request data format description

Field Description Type Required

RequestType Request data type int yes

JSON:

Response data “ResponseType”: 7,

format “ErrorCode”:（Normally returns 0），

“ErrorMessage”:（Error message）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

www.aratek.com.cn 16
 全球领先的人工智能和生物识别核心技术

ErrorMessage Error message string yes

8.GeneralizeTemplate

Interface description

Function: Generalize fingerprint template, Scope: devices supported by TrustFinger

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

“RequestType”: 8,
Request data
“Feature_1”:（Finger feature data1）,
format
“Feature_2”:（Finger feature data2）,

“Feature_3”:（Finger feature data3）

Request data format description

Field Description Type Required

RequestType Request data type int yes

Feature_1 Finger feature data1 string yes

Feature_2 Finger feature data2 string yes

Feature_3 Finger feature data3 string yes

Response data JSON:

format {

www.aratek.com.cn 17
 全球领先的人工智能和生物识别核心技术

“ResponseType”: 8,

“ErrorCode”:（Normally returns 0）,

“ErrorMessage”:（Error message）,

“Template_Data”:（Fingerprint template data）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

Template_Data Fingerprint template data string no

9.Verify

Interface description

Function: Fingerprint verification, Scope: devices supported by TrustFinger

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

{
Request data
“RequestType”: 9,
format
“Feature_1”:（Finger feature data1）,

“Feature_2”:（Finger feature data2）,

www.aratek.com.cn 18
 全球领先的人工智能和生物识别核心技术

“Security_Level”:（Security level）

Request data format description

Field Description Type Required

RequestType Request data type int yes

Feature_1 Finger feature data1 string yes

Feature_2 Finger feature data2 string yes

Security_Level Security level int yes

JSON:

“ResponseType”: 9,

Response data “ErrorCode”:（Normally returns 0）,

format “ErrorMessage”:（Error message）,

“Verify_Score”:（Verify score）,

“Verify_Result”:（Verify result）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

www.aratek.com.cn 19
 全球领先的人工智能和生物识别核心技术

Verify_Score Verify score int no

Verify_ Result Verify result int no

10.SetOption

Interface description

Function: Option setting, Scope: devices supported by TrustFinger

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

Request data “RequestType”: 10,

format “LED_Index”:（LED Index）,

“LED_Status”:（LED Status）

Request data format description

Field Description Type Required

RequestType Request data type int yes

LED Index(0 means green，

LED_Index int yes
1 means red)

LED Status(0 means close，

LED_Status int yes
1 means open)

Response data JSON:

www.aratek.com.cn 20
 全球领先的人工智能和生物识别核心技术

format {

“ResponseType”: 10,

“ErrorCode”:（Normally returns 0），

“ErrorMessage”:（Error message）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

11.BmpToRaw

Interface description

Function: Bmp image to raw image, Scope: devices supported by TrustFinger

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

Request data “RequestType”: 11,

format “Bmp_ImageData”:（Bmp image data）,

“Image_Width”:（Image width）,

“Image_Height”:（Image height）

www.aratek.com.cn 21
 全球领先的人工智能和生物识别核心技术

Request data format description

Field Description Type Required

RequestType Request data type int yes

Bmp_ImageData Bmp image data string yes

Image_Width Image width int yes

Image_Height Image height int yes

JSON:

“ResponseType”: 11,
Response data
“ErrorCode”:（Normally returns 0）
，
format
“ErrorMessage”:（Error message）,

“Raw_ImageData”:（Raw image data）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

Raw_ImageData Raw image data string no

www.aratek.com.cn 22
 全球领先的人工智能和生物识别核心技术

12.BmpToWSQ

Interface description

Function: Bmp image to WSQ image, Scope: devices supported by TrustFinger

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

“RequestType”: 12,

“Bmp_ImageData”:（Bmp image data）,

Request data
“Image_Width”:（Image width）,
format
“Image_Height”:（Image height）,

“DPI”:（Image DPI）,

“Bitrate”:（Compression factor）

Request data format description

Field Description Type Required

RequestType Request data type int yes

Bmp_ImageData Bmp image data string yes

Image_Width Image width int yes

Image_Height Image height int yes

DPI Image DPI int yes

Bitrate Compression factor double yes

www.aratek.com.cn 23
 全球领先的人工智能和生物识别核心技术

JSON:

“ResponseType”: 12,
Response data
“ErrorCode”:（Normally returns 0）
，
format
“ErrorMessage”:（Error message）,

“WSQ_ImageData”:（WSQ image data）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

WSQ _ImageData WSQ image data string no

13.BmpToISO

Interface description

Function: Bmp image to ISO image, Scope: devices supported by TrustFinger

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：
Request data
{
format
“RequestType”: 13,

www.aratek.com.cn 24
 全球领先的人工智能和生物识别核心技术

“Bmp_ImageData”:（Bmp image data）,

“Image_Width”:（Image width）,

“Image_Height”:（Image height）,

“Finger_Position”:（Figner position）,

“Compression_Type”:（Image compression format type）,

“Device_ID”:（Device ID）,

“Factor”: （Compression factor）

Request data format description

Field Description Type Required

RequestType Request data type int yes

Bmp_ImageData BMP IMAGE DATA string yes

Image_Width Image width int yes

Image_Height Image height int yes

Finger_Position Figner position int yes

Compression_Type Image compression format int yes

Device_ID Device ID int yes

Required when JPEG

Factor Compression factor float
or JPEG2000

Response data JSON:

format {

www.aratek.com.cn 25
 全球领先的人工智能和生物识别核心技术

“ResponseType”: 13,

“ErrorCode”:（Normally returns 0）
，

“ErrorMessage”:（Error message）,

“ISO_ImageData”:（ISO image data）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

ISO_ImageData ISO image data string no

14.BmpToANSI

Interface description

Function: Bmp image to ANSI image, Scope: devices supported by TrustFinger

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

{
Request data
“RequestType”: 14,
format
“Bmp_ImageData”:（BMP image data）,

“Image_Width”:（Image width）,

www.aratek.com.cn 26
 全球领先的人工智能和生物识别核心技术

“Image_Height”:（Image height）,

“Finger_Position”:（Figner position）,

“Compression_Type”:（Image compression format type）,

“Device_ID”:（Device ID）,

“Factor”:（Compression factor）

Request data format description

Field Description Type Required

RequestType Request data type int yes

Bmp_ImageData BMP IMAGE DATA string yes

Image_Width Image width int yes

Image_Height Image height int yes

Finger_Position Figner position int yes

Compression_Type Image compression format int yes

Device_ID Device ID int yes

Required when JPEG

Factor Compression factor float
or JPEG2000

JSON:

Response data {

format “ResponseType”: 14,

“ErrorCode”:（Normally returns 0）
，

www.aratek.com.cn 27
 全球领先的人工智能和生物识别核心技术

“ErrorMessage”:（Error message）,

“ANSI_ImageData”:（ANSI image data）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

ANSI_ImageData ANSI image data string no

15.CID_Init

Interface description

Function: Init device, Scope: CID series device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

{
Request data
“RequestType”: 15,
format
“DeviceType”:（CID device type）

Request data format description

Field Description Type Required

www.aratek.com.cn 28
 全球领先的人工智能和生物识别核心技术

RequestType Request data type int yes

DeviceType CID device type int yes

JSON:

Response data “ResponseType”: 15,

format “ErrorCode”:（Normally returns 1），

“ErrorMessage”:（Error message）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

16.CID_Close

Interface description

Function: Close device, Scope: CID series device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：
Request data
{
format
“RequestType”: 16

www.aratek.com.cn 29
 全球领先的人工智能和生物识别核心技术

Request data format description

Field Description Type Required

RequestType Request data type int yes

JSON:

Response data “ResponseType”: 16,

format “ErrorCode”:（Normally returns 1），

“ErrorMessage”:（Error message）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

17.CID_GetChannelCount

Interface description

Function: Get device count, Scope: CID series device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

Request data JSON：

www.aratek.com.cn 30
 全球领先的人工智能和生物识别核心技术

format {

“RequestType”: 17

Request data format description

Field Description Type Required

RequestType Request data type int yes

JSON:

“ResponseType”: 17,
Response data
“ErrorCode”:（Normally returns 1），
format
“ErrorMessage”:（Error message）,

“Count”:（Device count）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

Count Device count int yes

www.aratek.com.cn 31
 全球领先的人工智能和生物识别核心技术

18.CID_BeginCapture

Interface description

Function: Need to call before capturing, Scope: CID series device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

{
Request data
“RequestType”: 18,
format
“nChannel”: 0（0 means the first device）

Request data format description

Field Description Type Required

RequestType Request data type int yes

nChannel 设备通道号 int yes

JSON:

Response data “ResponseType”: 18,

format “ErrorCode”:（Normally returns 1），

“ErrorMessage”:（Error message）

Response data format description

Field Description Type Returned

www.aratek.com.cn 32
 全球领先的人工智能和生物识别核心技术

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage 该操作的 Error message string yes

19.CID_GetFPRawData

Interface description

Function: Get a frame of Raw fingerprint image, Scope: CID series device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

{
Request data
“RequestType”: 19,
format
“nChannel”: 0（0 means the first device）

Request data format description

Field Description Type Required

RequestType Request data type int yes

nChannel Device index int yes

JSON:

Response data {

format “ResponseType”: 19,

“ErrorCode”:（Normally returns 1），

www.aratek.com.cn 33
 全球领先的人工智能和生物识别核心技术

“ErrorMessage”:（Error message）,

“RawData”:（Raw image data）,

“ FeaData”: (Bione format feature data, only

CID3000TC or CID7000R support)

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

RawData Raw image data string no

20.CID_GetFPBmpData

Interface description

Function: Get a frame of Bmp fingerprint image, Scope: CID series device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

{
Request data
“RequestType”: 20,
format
“nChannel”: 0（0 means the first device）

www.aratek.com.cn 34
 全球领先的人工智能和生物识别核心技术

Request data format description

Field Description Type Required

RequestType Request data type int yes

nChannel Device index int yes

JSON:

“ResponseType”: 20,

“ErrorCode”:（Normally returns 1），

Response data
“ErrorMessage”:（Error message）,
format
“BmpData”:（Bmp image data）,

“FeaData”: （ Bione format feature data, only

CID3000TC or CID7000R support)

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

BmpData Bmp image data string no

www.aratek.com.cn 35
 全球领先的人工智能和生物识别核心技术

21.CID_EndCapture

Interface description

Function: Need to call after capturing, Scope: CID series device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

{
Request data
“RequestType”: 21,
format
“nChannel”: 0（0 means the first device）

Request data format description

Field Description Type Required

RequestType Request data type int yes

nChannel Device index int yes

JSON:

Response data “ResponseType”: 21,

format “ErrorCode”:（Normally returns 1），

“ErrorMessage”:（Error message）

Response data format description

Field Description Type Returned

www.aratek.com.cn 36
 全球领先的人工智能和生物识别核心技术

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

22.CID_GetVersion

Interface description

Function: Get CID SDK version, Scope: CID series device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

Request data {

format “RequestType”: 22

Request data format description

Field Description Type Required

RequestType Request data type int yes

JSON:

Response data “ResponseType”: 22,

format “ErrorCode”:（Normally returns 1），

“ErrorMessage”:（Error message）,

“Version”:（Version information）

www.aratek.com.cn 37
 全球领先的人工智能和生物识别核心技术

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

Version Version information string no

23.CID_GetDesc

Interface description

Function: Get device descriptiom, Scope: CID series device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

Request data {

format “RequestType”: 23

Request data format description

Field Description Type Required

RequestType Request data type int yes

Response data JSON:

format {

www.aratek.com.cn 38
 全球领先的人工智能和生物识别核心技术

“ResponseType”: 23,

“ErrorCode”:（Normally returns 1），

“ErrorMessage”:（Error message）,

“Description”:（Device description）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

Description Device description string no

24.CID_Alg_GetVersion

Interface description

Function: Get algorithm version, Scope: CID series device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

Request data {

format “RequestType”: 25

Request data format description

www.aratek.com.cn 39
 全球领先的人工智能和生物识别核心技术

Field Description Type Required

RequestType Request data type int yes

JSON:

“ResponseType”: 25,
Response data
“ErrorCode”:（Normally returns 1），
format
“ErrorMessage”:（Error message）,

“Version”:（Version information）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

Version Version information string no

25.CID_Alg_Begin

Interface description

Function: Init algorithm, Scope: CID series device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

Request data JSON：

www.aratek.com.cn 40
 全球领先的人工智能和生物识别核心技术

format {

“RequestType”: 26

Request data format description

Field Description Type Required

RequestType Request data type int yes

JSON:

Response data “ResponseType”: 26,

format “ErrorCode”:（Normally returns 1），

“ErrorMessage”:（Error message）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

26.CID_Alg_FeatureExtract

Interface description

Function: Fingerprint feature extraction Scope: CID series device

www.aratek.com.cn 41
 全球领先的人工智能和生物识别核心技术

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

Request data “RequestType”: 27,

format “FingerPosition”:（Finger position）,

“Image_RawData”:（Raw image data）

Request data format description

Field Description Type Required

RequestType Request data type int yes

FingerPosition Figner position int yes

Image_RawData Raw image data string yes

JSON:

“ResponseType”: 27,
Response data
“ErrorCode”:（Normally returns 1）
，
format
“ErrorMessage”:（Error message）,

“FeatureData”:（Finger feature data）

Response data format description

Field Description Type Returned

www.aratek.com.cn 42
 全球领先的人工智能和生物识别核心技术

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

FeatureData Finger feature data string no

27.CID_Alg_FeatureMatch

Interface description

Function: Match two fingerprints, Scope: CID series device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

Request data “RequestType”: 28,

format “FeatureData1”:（Finger feature data1）,

“FeatureData2”:（Finger feature data2）

Request data format description

Field Description Type Required

RequestType Request data type int yes

FeatureData1 Finger feature data1 string yes

FeatureData2 Finger feature data2 string yes

Response data JSON:

www.aratek.com.cn 43
 全球领先的人工智能和生物识别核心技术

format {

“ResponseType”: 28,

“ErrorCode”:（Normally returns 1），

“ErrorMessage”:（Error message）,

“Similarity”:（Matching similarity）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

Similarity Matching similarity float no

28.CID_Alg_ImageMatch

Interface description

Function: Match fingerprint image and feature, Scope: CID series device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

Request data {

format “RequestType”: 29,

“RawImageData”:（Raw finger image data）,

www.aratek.com.cn 44
 全球领先的人工智能和生物识别核心技术

“FeatureData”:（Finger feature data）

Request data format description

Field Description Type Required

RequestType Request data type int yes

RawImageData Raw finger image data string yes

FeatureData Finger feature data string yes

JSON:

“ResponseType”: 29,
Response data
“ErrorCode”:（Normally returns 1）
，
format
“ErrorMessage”:（Error message）,

“Similarity”:（Matching similarity）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

Similarity Matching similarity float no

www.aratek.com.cn 45
 全球领先的人工智能和生物识别核心技术

29.CID_Alg_GetQualityScore

Interface description

Function: Get fingerprint image quality, Scope: CID series device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

{
Request data
“RequestType”: 32,
format
“RawImageData”:（Raw finger image data）,

Request data format description

Field Description Type Required

RequestType Request data type int yes

RawImageData Raw finger image data string yes

JSON:

“ResponseType”: 32,
Response data
“ErrorCode”:（Normally returns 1）
，
format
“ErrorMessage”:（Error message）,

“Score”:（Fingerprint image quality）

Response data format description

www.aratek.com.cn 46
 全球领先的人工智能和生物识别核心技术

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

Score Fingerprint image quality int no

30.CID_Alg_End

Interface description

Function: Release algorithm, Scope: CID series device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

Request data {

format “RequestType”: 35

Request data format description

Field Description Type Required

RequestType Request data type int yes

JSON:

Response data {

format “ResponseType”: 35,

“ErrorCode”:（Normally returns 1），

www.aratek.com.cn 47
 全球领先的人工智能和生物识别核心技术

“ErrorMessage”:（Error message）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

31.FRO900_OpenDevice

Interface description

Function: Open device, Scope: FRO900

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

{
Request data
“RequestType”: 64,
format
“Index”: 0（0 means the first device）

Request data format description

Field Description Type Required

RequestType Request data type int yes

Index Device index int yes

www.aratek.com.cn 48
 全球领先的人工智能和生物识别核心技术

JSON:

Response data “ResponseType”: 64,

format “ErrorCode”:（Normally returns 0）

，

“ErrorMessage”:（Error message）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

32.FRO900_CloseDevice

Interface description

Function: Close device, Scope: FRO900

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

Request data {

format “RequestType”: 65

Request data format description

www.aratek.com.cn 49
 全球领先的人工智能和生物识别核心技术

Field Description Type Required

RequestType Request data type int yes

JSON:

Response data “ResponseType”: 65,

format “ErrorCode”:（Normally returns 0）

，

“ErrorMessage”:（Error message）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

33.FRO900_GetDeviceCount

Interface description

Function: Get device count, Scope: FRO900

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：
Request data
{
format
“RequestType”: 66

www.aratek.com.cn 50
 全球领先的人工智能和生物识别核心技术

Request data format description

Field Description Type Required

RequestType Request data type int yes

JSON:

“ResponseType”: 66,
Response data
“ErrorCode”:（Normally returns 0）
，
format
“ErrorMessage”:（Error message）,

“Count”:（Device count）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

Count Device count int no

34.FRO900_CaptureFingerPrintData

Interface description

该接口功能为获取指纹信息，适用于 FRO900 设备

www.aratek.com.cn 51
 全球领先的人工智能和生物识别核心技术

Function: Get fingerprint data, Scope: FRO900

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

“RequestType”: 67,

“Image_Format”:（Finger image format type）,

“Feature_Format”:（Finger feature format type）,

“Finger_Position”:（Finger position）,
Request data
“Compression_Type”: （ Fingerprint image compression
format
format type）,

“Factor”:（Compression factor，range: JPEG/JPEG2000 is

1-15，WSQ is 0.75-2.25）
，

“Miss_Finger_Position”：（Select skipped fingers during

multi-finger capture）

Request data format description

Field Description Type Required

RequestType Request data type int yes

Image_Format Finger image format int yes

Feature_Format Finger feature format int yes

Finger_Position Finger position int yes

www.aratek.com.cn 52
 全球领先的人工智能和生物识别核心技术

Compression_Typ Fingerprint image

int yes
e compression format

Required when JPEG

Factor Compression factor float
or JPEG2000

Miss_Finger_Positi Required when

Miss figner position int
on multi-finger capture

JSON:

“ResponseType”: 5,

“ErrorCode”:（Normally returns 0）
，

“ErrorMessage”:（Error message）,

“Image_Format”:（Finger image format type）,

“Image_Data_1”:（Finger image data，Index finger or

Response data
left thumb）,
format
“Image_Data_2”:（Finger image data，Middle finger or

right thumb）,

“Image_Data_3”: （Finger image data，Ring finger）,

“Image_Data_4”: （Finger image data，Little finger）,

“Feature_Format”:（Finger feature format type）,

“Feature_Data_1”:（Finger feature data, Image_Data_1）,

“Feature_Data_2”:（Finger feature data, Image_Data_2）,

www.aratek.com.cn 53
 全球领先的人工智能和生物识别核心技术

“Feature_Data_3”:（Finger feature data, Image_Data_3）,

“Feature_Data_4”:（Finger feature data, Image_Data_4）,

“Image_Quality_1”:(Finger image quality

Image_Data_1),

“Image_Quality_2”:(Finger image quality

Image_Data_2),

“Image_Quality_3”:(Finger image quality

Image_Data_3),

“Image_Quality_4”:(Finger image quality

Image_Data_4),

“Image_NFIQ_1”:(Finger image NFIQ value

Image_Data_1)，

“Image_NFIQ_2”:(Finger image NFIQ value

Image_Data_2)，

“Image_NFIQ_3”:(Finger image NFIQ value

Image_Data_3)，

“Image_NFIQ_4”:(Finger image NFIQ value

Image_Data_4)

Response data format description

Field Description Type Returned

www.aratek.com.cn 54
 全球领先的人工智能和生物识别核心技术

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

Image_Format Fingerprint image format int no

Image_Data_1 Fingerprint image data string no

Image_Data_2 Fingerprint image data string no

Image_Data_3 Fingerprint image data string no

Image_Data_4 Fingerprint image data string no

Feature_Format Fingerprint feature format int no

Feature_Data_1 Fingerprint feature data string no

Feature_Data_2 Fingerprint feature data string no

Feature_Data_3 Fingerprint feature data string no

Feature_Data_4 Fingerprint feature data string no

Image_Quality_1 Fingerprint image quality int no

Image_Quality_2 Fingerprint image quality int no

Image_Quality_3 Fingerprint image quality int no

Image_Quality_4 Fingerprint image quality int no

Fingerprint image NFIQ

Image_NFIQ_1 int no
value

Fingerprint image NFIQ

Image_NFIQ_2 int no
value

www.aratek.com.cn 55
 全球领先的人工智能和生物识别核心技术

Fingerprint image NFIQ

Image_NFIQ_3 int no
value

Fingerprint image NFIQ

Image_NFIQ_4 int no
value

35.FRO900_GeneralizeTemplate

Interface description

Function: Generalize fingerprint template, Scope: FRO900

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

“RequestType”: 68,
Request data
“Feature_1”:（Finger feature data1）,
format
“Feature_2”:（Finger feature data2）,

“Feature_3”:（Finger feature data3）

Request data format description

Field Description Type Required

RequestType Request data type int yes

Feature_1 Finger feature data1 string yes

Feature_2 Finger feature data2 string yes

www.aratek.com.cn 56
 全球领先的人工智能和生物识别核心技术

Feature_3 Finger feature data3 string yes

JSON:

“ResponseType”: 68,
Response data
“ErrorCode”:（Normally returns 0）,
format
“ErrorMessage”:（Error message）,

“Template_Data”:（Fingerprint template data）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

Template_Data Fingerprint template data string no

36.FRO900_Verify

Interface description

Function: Fingerprint verification, Scope: FRO900

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

Request data JSON：

format {

www.aratek.com.cn 57
 全球领先的人工智能和生物识别核心技术

“RequestType”: 69,

“Feature_1”:（Finger feature data1）,

“Feature_2”:（Finger feature data2）,

“Security_Level”:（Security level）

Request data format description

Field Description Type Required

RequestType Request data type int yes

Feature_1 Finger feature data1 string yes

Feature_2 Finger feature data2 string yes

Security_Level Security level int yes

JSON:

“ResponseType”: 69,

Response data “ErrorCode”:（Normally returns 0）,

format “ErrorMessage”:（Error message）,

“Verify_Score”:（Verify score）,

“Verify_Result”:（Verify result）

Response data format description

Field Description Type Returned

www.aratek.com.cn 58
 全球领先的人工智能和生物识别核心技术

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

Verify_Score Verify score int no

Verify_ Result Verify result int no

37.TrustLink_GetDeviceInfo

Interface description

Function:Get local machine’s hostname、MAC address、IP address

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

Request data {

format “RequestType”: 49

Request data format description

Field Description Type Required

RequestType Request data type int yes

JSON:

Response data {

format “ResponseType”: 49,

“ErrorCode”:（Normally returns 0）,

www.aratek.com.cn 59
 全球领先的人工智能和生物识别核心技术

“ErrorMessage”:（Error message）,

“MACAdress”:（MAC address）,

“IPAdress”:（IP address）,

“HostName”：
（Hostname）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

MACAdress MAC address string no

IPAdress IP address string no

HostName Hostname string no

38.Iris_InitDevice

Interface description

Function: Init device, Scope: IR series device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：
Request data
{
format
“RequestType”: 80，

www.aratek.com.cn 60
 全球领先的人工智能和生物识别核心技术

“DeviceType”: （Device type）

，

“EnrollThresh”：
（Enroll thresh）
，

“OcclusionThresh”：
（occlusion value）
，

“MotionThresh”：
（motion value）
，

“FaceFocusThresh”：
（FaceFocus value）
，

“RedLightValue”
：（RedLight value）
，

“WhiteLightValue”：（WhiteLight value）,

“Enroll_Min_Distance”：（Min distance for enroll）

，

“Enroll_Max_Distance”：
（Max distance for enroll），

“Verify_Min_Distance”：
（Min distance for verify）
，

“Verify_Max_Distance”：
（Max distance for verify）

（1、Use profile parameters by default；2、If you need to

switch devices, you need to restart the program）

Request data format description

Field Description Type Required

RequestType Request data type int yes

DeviceType Device type int yes

EnrollThresh Enroll thresh string no

OcclusionThresh occlusion value string no

MotionThresh motion value string no

www.aratek.com.cn 61
 全球领先的人工智能和生物识别核心技术

FaceFocusThresh FaceFocus value string no

RedLightValue RedLight value int no

WhiteLightValue WhiteLight value int no

Enroll_Min_Distance Min distance for enroll int no

Enroll_Max_Distance Max distance for enroll int no

Verify_Min_Distance Min distance for verify int no

Verify_Max_Distance Max distance for verify int no

JSON:

Response data “ResponseType”: 80,

format “ErrorCode”:（Normally returns 0）,

“ErrorMessage”:（Error message）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

39.Iris_ReleaseDevice

Interface description

www.aratek.com.cn 62
 全球领先的人工智能和生物识别核心技术

Function: Release device, Scope: IR series device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

Request data {

format “RequestType”: 81

Request data format description

Field Description Type Required

RequestType Request data type int yes

JSON:

Response data “ResponseType”: 81,

format “ErrorCode”:（Normally returns 0）,

“ErrorMessage”:（Error message）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

www.aratek.com.cn 63
 全球领先的人工智能和生物识别核心技术

40.Iris_StartCapture

Interface description

Function: Start capturing Iris image, Scope: IR series device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

Request data “RequestType”: 82,

format “CaptureMode”：
（Capture model，Capture two eyes by

default）

Request data format description

Field Description Type Required

RequestType Request data type int yes

CaptureMode Capture model int no

JSON1（Return real-time image）:

“ResponseType”: 82,
Response data
“ErrorCode”:（Normally returns 0）,
format
“ErrorMessage”:（Error message）,

“Face_Image”:（JPG face image）,

“Distance”:（Detected distance）

www.aratek.com.cn 64
 全球领先的人工智能和生物识别核心技术

JSON2（Return result）:

“ResponseType”: 83,

“ErrorCode”:（Normally returns 0）,

“ErrorMessage”:（Error message）,

“Left_Eye_Image”:（JPG left eye image）,

“Left_Eye_Data”:（Left eye image encrypted data），

“Right_Eye_Image”:（JPG right eye image）,

“Right_Eye_Data”:（Right eye image encrypted data）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

Face_Image JPG face image string no

Distance Detected distance int no

Left_Eye_Image JPG left eye image string no

Left eye image encrypted

Left_Eye_Data string no
data

www.aratek.com.cn 65
 全球领先的人工智能和生物识别核心技术

Right_Eye_Image JPG right eye image string no

Right eye image encrypted

Right _Eye_Data string no
data

41.Iris_StartFastCapture

Interface description

Function: Start fast capturing Iris image, Scope: IR series device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

Request data “RequestType”: 90,

format “CaptureMode”：
（Capture model，Capture two eyes by

default）

Request data format description

Field Description Type Required

RequestType Request data type int yes

CaptureMode Capture model int no

JSON1（Return real-time image）:

Response data
{
format
“ResponseType”: 90,

www.aratek.com.cn 66
 全球领先的人工智能和生物识别核心技术

“ErrorCode”:（Normally returns 0）,

“ErrorMessage”:（Error message）,

“Face_Image”:（JPG face image）,

“Distance”:（Detected distance）

JSON2（Return result）:

“ResponseType”: 91,

“ErrorCode”:（Normally returns 0）,

“ErrorMessage”:（Error message）,

“Left_Eye_Image”:（JPG left eye image）,

“Left_Eye_Data”:（Left eye image encrypted data），

“Right_Eye_Image”:（JPG right eye image）,

“Right_Eye_Data”:（Right eye image encrypted data）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

Face_Image JPG face image string no

www.aratek.com.cn 67
 全球领先的人工智能和生物识别核心技术

Distance Detected distance int no

Left_Eye_Image JPG left eye image string no

Left eye image encrypted

Left_Eye_Data string no
data

Right_Eye_Image JPG right eye image string no

Right eye image encrypted

Right _Eye_Data string no
data

42.Iris_StopCapture

Interface description

Function: Stop capturing Iris image, Scope: IR series device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

Request data {

format “RequestType”: 84

Request data format description

Field Description Type Required

RequestType Request data type int yes

Response data JSON:

format {

www.aratek.com.cn 68
 全球领先的人工智能和生物识别核心技术

“ResponseType”: 84,

“ErrorCode”:（Normally returns 0）,

“ErrorMessage”:（Error message）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

43.Iris_SetOptions

Interface description

Function: Option setting(not support yet), Scope: IR series device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

{
Request data
“RequestType”: 86，
format
“EnrollThresh”: （Enroll thresh）

Request data format description

Field Description Type Required

www.aratek.com.cn 69
 全球领先的人工智能和生物识别核心技术

RequestType Request data type int yes

EnrollThresh Enroll thresh int yes

JSON:

Response data “ResponseType”: 86,

format “ErrorCode”:（Normally returns 0）,

“ErrorMessage”:（Error message）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

44.Iris_StartVerify

Interface description

Function: Start iris data verification, Scope: IR series device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：
Request data
{
format
“RequestType”: 87,

www.aratek.com.cn 70
 全球领先的人工智能和生物识别核心技术

“Timeout”
：（Overtime time，Use profile parameters by

default）
，

“LeftEye_FeaData”：
（Left eye feature data）
，

“RightEye_FeaData”
：（Right eye feature data）

Request data format description

Field Description Type Required

RequestType Request data type int yes

Timeout Overtime time int no

LeftEye_FeaData Left eye feature data String yes

RightEye_FeaData Right eye feature data String yes

JSON1（Return real-time image）:

“ResponseType”: 87,

“ErrorCode”:（Normally returns 0）,

Response data “ErrorMessage”:（Error message）,

format “Face_Image”:（JPG face image）,

“Distance”:（Detected distance）

JSON2（Verify result 返回）:

www.aratek.com.cn 71
 全球领先的人工智能和生物识别核心技术

“ResponseType”: 88,

“ErrorCode”:（Normally returns 0）,

“ErrorMessage”:（Error message）,

“Verify_Result”:（Verify result）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

Face_Image JPG face image string no

Distance Detected distance int no

Verify_Result Verify result Bool yes

45.Iris_StopVerify

Interface description

Function: Stop iris data verification, Scope: IR series device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：
Request data
{
format
“RequestType”: 89

www.aratek.com.cn 72
 全球领先的人工智能和生物识别核心技术

Request data format description

Field Description Type Required

RequestType Request data type int yes

JSON:

Response data “ResponseType”: 89,

format “ErrorCode”:（Normally returns 0）,

“ErrorMessage”:（Error message）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

46.ARA_ReadIDCard

Interface description

Function: Read ID card information, Scope: ID Card reading machine

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

Request data JSON：

www.aratek.com.cn 73
 全球领先的人工智能和生物识别核心技术

format {

“RequestType”: 50

Request data format description

Field Description Type Required

RequestType Request data type int yes

JSON:

“ResponseType”: 50,

“ErrorCode”:（Normally returns 0）,

“ErrorMessage”:（Error message）,

“CardType”:（ID Card type）,

“CNName”:（Chinese name）,
Response data
“Sex”：
（Sex，1 means male，2 means female）
，
format
“Birth”：（Birthday），

“IDNum”：
（ID number）
，

“ExpDateBegin”：
（Begin of expiry date）

“ExpDateEnd”：
（End expiry date）
，

“Authority”：
（Authority），

“Nation”：（Nation）
，

“Address”：
（Address）
，

www.aratek.com.cn 74
 全球领先的人工智能和生物识别核心技术

“NewAddress”：
（New address），

“PassNum”：（Pass number）
，

“IssueCount”：
（Issue count）
，

“ENName”：
（English name）
，

“Country”：
（Country）
，

“Version”：
（Card version）

“Feature1”：
（Fingerprint feature 1）

“Feature2”：
（Fingerprint feature 2）
，

“PhotoData”：
（Photo data）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

CardType ID Card type int no

CNName Chinese name string no

Sex Sex int no

Birth Birthday string no

IDNum ID number string no

ExpDateBegin Begin of expiry date string no

www.aratek.com.cn 75
 全球领先的人工智能和生物识别核心技术

ExpDateEnd End expiry date string no

Authority Authority string no

Nation Nation string no

Address Address string no

NewAddress New address string no

PassNum Pass number string no

IssueCount Issue count string no

ENName English name string no

Country Country string no

Version Card version string no

Feature1 Fingerprint feature 1 string no

Feature2 Fingerprint feature 2 string no

PhotoData Photo data string no

47.ARA_FeaConv

Interface description

Function: Format conversion of feature data

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：
Request data
{
format
“RequestType”: 51,

www.aratek.com.cn 76
 全球领先的人工智能和生物识别核心技术

“Fea_Src_Data”：
（Feature source data）
，

“Fea_Src_Format”：
（Source data format）
，

“Fea_Dst_Format”：（Destination data format）

Request data format description

Field Description Type Required

RequestType Request data type int yes

Fea_Src_Data Feature source data string yes

Fea_Src_Format Source data format int yes

Fea_Dst_Format Destination data format int yes

JSON:

“ResponseType”: 51,
Response data
“ErrorCode”:（Normally returns 0）,
format
“ErrorMessage”:（Error message）,

“Fea_Dst_Data”
：（Feature destination data）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

www.aratek.com.cn 77
 全球领先的人工智能和生物识别核心技术

ErrorMessage Error message string yes

Fea_Dst_Data Feature destination data string no

48.ARA_GetCurrentDeviceList

Interface description

Function: Get the list of devices connected to the current machine

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

Request data {

format “RequestType”: 53

Request data format description

Field Description Type Required

RequestType Request data type int yes

JSON:

“ResponseType”: 53,
Response data
“ErrorCode”:（Normally returns 0）,
format
“ErrorMessage”:（Error message）,

“List”：
（Device list information）
：[

www.aratek.com.cn 78
 全球领先的人工智能和生物识别核心技术

“ConnectNum”: （ Number of device

connections）
，

“DeviceInfo”:（Device information）
，

“DeviceName”:（Device name）

}, {…},{…}

When it detects that a supported device has been plugged in

or unplugged, it will actively report to all established

connections

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

List Device list information Json no

Number of device
ConnectNum int no
connections

DeviceInfo Device information string no

DeviceName Device name string no

www.aratek.com.cn 79
 全球领先的人工智能和生物识别核心技术

49.ARA_ChangeFPImgColor

Interface description

Function: Change the color of the fingerprint image

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

“RequestType”: 54,

“ 8GrayBmpImgData ”：（ 8-bit Bmp grayscale image

Request data
data），
format
“ImgWidth”
：（Image width）
，

“ImgHeight”：
（Image height），

“Color”：
（color value，example: 0xFF0000 means red）

Request data format description

Field Description Type Required

RequestType Request data type int yes

8GrayBmpImgDat 8-bit Bmp grayscale image

string yes
a data

ImgWidth Image width int yes

ImgHeight Image height int yes

Color Color value int yes

www.aratek.com.cn 80
 全球领先的人工智能和生物识别核心技术

JSON:

“ResponseType”: 54,
Response data
“ErrorCode”:（Normally returns 0）,
format
“ErrorMessage”:（Error message）,

“ColorImgData”：
（Converted image data）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

ColorImgData Converted image data string no

50.FingerKey_OpenDevice

Interface description

Function: Open device, Scope: Finger Key device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：
Request data
{
format
“RequestType”: 96

www.aratek.com.cn 81
 全球领先的人工智能和生物识别核心技术

Request data format description

Field Description Type Required

RequestType Request data type int yes

JSON:

Response data “ResponseType”: 96,

format “ErrorCode”:（Normally returns 0）,

“ErrorMessage”:（Error message）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

51.FingerKey_CloseDevice

Interface description

Function: Close device, Scope: Finger Key device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

Request data JSON：

www.aratek.com.cn 82
 全球领先的人工智能和生物识别核心技术

format {

“RequestType”: 97

Request data format description

Field Description Type Required

RequestType Request data type int yes

JSON:

Response data “ResponseType”: 97,

format “ErrorCode”:（Normally returns 0）,

“ErrorMessage”:（Error message）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

52.FingerKey_GetDeviceInformation

Interface description

Function: Get device information, Scope: Finger Key device

www.aratek.com.cn 83
 全球领先的人工智能和生物识别核心技术

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

Request data {

format “RequestType”: 99

Request data format description

Field Description Type Required

RequestType Request data type int yes

JSON:

“ResponseType”: 99,

“ErrorCode”:（Normally returns 0）,

“ErrorMessage”:（Error message）,

Response data “Manufacture”

：（Manufacturer name）
，

format “Issuer”：
（Issuer）
，

“Label”：
（Label）
，

“SN”
：（Serial number）
，

“HWVer”：
（Hardware version），

“FWVer”：
（Firmware version）

Response data format description

www.aratek.com.cn 84
 全球领先的人工智能和生物识别核心技术

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

Manufacture Manufacturer name string no

Issuer Issuer string no

Label Label string no

SN Serial number string no

HWVer Hardware version string no

FWVer Firmware version string no

53.FingerKey_CaptureFingerData

Interface description

Function: Capture fingerprint data, Scope: Finger Key device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

Request data “RequestType”: 100,

format “Finger_Position”：
（Finger position）
，

“Image_Format”
：（Image data format）
，

“Feature_Format”
：（Feature data format）
，

www.aratek.com.cn 85
 全球领先的人工智能和生物识别核心技术

“TimeOut”：
（Overtime）

Request data format description

Field Description Type Required

RequestType Request data type int yes

Finger_Position Finger position int yes

Image_Format Image data format int yes

Feature _Format Feature data format int yes

TimeOut Overtime（unit：s） int yes

JSON:

“ResponseType”: 100,

“ErrorCode”:（Normally returns 0）,

“ErrorMessage”:（Error message）,
Response data
“Image_Format”
：（Image data format）
，
format
“Image_Data”：
（Image data）
，

“Feature_Format”
：（Feature data format）
，

“Feature_Data”：
（Feature data），

“Image_Quality”：
（Image quality）

Response data format description

www.aratek.com.cn 86
 全球领先的人工智能和生物识别核心技术

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

Image_Format Image data format int no

Image_Data Image data string no

Feature_Format Feature data format int no

Feature_Data Feature data string no

Image_Quality Image quality int no

54.FingerKey_ImportFingerPrint

Interface description

Function: Import fingerprint data to key, Scope: Finger Key device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

“RequestType”: 101,
Request data
“Finger_Position”：
（Finger position）
，
format
“AllFeatureData”
：（Feature data）,

“DataType”:（value is 1，represents the TrustLink data

format）

www.aratek.com.cn 87
 全球领先的人工智能和生物识别核心技术

Multiple fingerprint data in AllFeatureData are separated by

"\r\n" line break

Request data format description

Field Description Type Required

RequestType Request data type int yes

Finger_Position Finger position int yes

AllFeatureData Feature data string yes

DataType Data type int no

JSON:

Response data “ResponseType”: 101,

format “ErrorCode”:（Normally returns 0）,

“ErrorMessage”:（Error message）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

www.aratek.com.cn 88
 全球领先的人工智能和生物识别核心技术

55.Camera_InitDevice

Interface description

Function: Init device, Scope: Camera device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

{
Request data
“RequestType”: 112,
format
“DeviceType”:（Device type）

Request data format description

Field Description Type Required

RequestType Request data type int yes

DeviceType Device type int yes

JSON:

Response data “ResponseType”: 112,

format “ErrorCode”:（Normally returns 0）,

“ErrorMessage”:（Error message）

Response data format description

Field Description Type Returned

www.aratek.com.cn 89
 全球领先的人工智能和生物识别核心技术

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

56.Camera_ReleaseDevice

Interface description

Function: Release device, Scope: Camera device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

Request data {

format “RequestType”: 113

Request data format description

Field Description Type Required

RequestType Request data type int yes

JSON:

Response data “ResponseType”: 113,

format “ErrorCode”:（Normally returns 0）,

“ErrorMessage”:（Error message）

www.aratek.com.cn 90
 全球领先的人工智能和生物识别核心技术

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

57.Camera_StartCapture

Interface description

Function: Start capture face image data, Scope: Camera device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

Request data {

format “RequestType”: 114

Request data format description

Field Description Type Required

RequestType Request data type int yes

JSON:

Response data {

format “ResponseType”: 114,

“ErrorCode”:（Normally returns 0）,

www.aratek.com.cn 91
 全球领先的人工智能和生物识别核心技术

“ErrorMessage”:（Error message）,

“ImageData”:（Image data，JPG format）,

“ InfraredImageData”: （ Infrared image data ， JPG

format）,

“FaceDetect”:（Face detection result，TRUE means a

face is detected）
，

“LiveDetect”
：（Live detection result，1 means living，0

means non-living，-1 means liven detection function is not

turned on）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

ImageData Image data string no

InfraredImageData Infrared image data string no

FaceDetect Face detection result bool no

LiveDetect Live detection result int no

www.aratek.com.cn 92
 全球领先的人工智能和生物识别核心技术

58.Camera_StopCapture

Interface description

Function: Stop capture process, Scope: Camera device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

Request data {

format “RequestType”: 115

Request data format description

Field Description Type Required

RequestType Request data type int yes

JSON:

Response data “ResponseType”: 115,

format “ErrorCode”:（Normally returns 0）,

“ErrorMessage”:（Error message）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

www.aratek.com.cn 93
 全球领先的人工智能和生物识别核心技术

ErrorMessage Error message string yes

59.Camera_SetOption

Interface description

Function: Set camera capture options, Scope: Camera device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

Request data “RequestType”: 116,

format “ LiveDetectSetting”:（ Live detection function switch,

default off (FALSE)）

Request data format description

Field Description Type Required

RequestType Request data type int yes

Live detection function

LiveDetectSetting bool yes
switch

JSON:

Response data {

format “ResponseType”: 116,

“ErrorCode”:（Normally returns 0）,

www.aratek.com.cn 94
 全球领先的人工智能和生物识别核心技术

“ErrorMessage”:（Error message）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

60.Camera_DetectFace

Interface description

Function: Detect face info with inputed image, Scope: Camera device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

“RequestType”: 117，

Request data “ImageData”:（Image data，support jpg、bmp format）

，

format “InfraredImageData”：（Infrared image data，support

jpg、bmp format， the parameter is necessary when use

binocular camera）

Request data format description

www.aratek.com.cn 95
 全球领先的人工智能和生物识别核心技术

Field Description Type Required

RequestType Request data type int yes

ImageData Image data string yes

InfraredImageData Infrared image data string no

JSON:

“ResponseType”: 117,

“ErrorCode”:（Normally returns 0）
，

“ErrorMessage”:（Error message）
，

“FaceDetect”:（Face detection result，TRUE means a

face is detected），

“LiveDetect”
：（Live detection result，1 means living，0
Response data
means non-living，-1 means liven detection function is not
format
turned on）
，

“FaceInfo” ： （ Detected face boxes coordinate

information，take the upper left corner of the image as the

origin of the coordinate axis，array）

[“x1”:（The x coordinate of the upper left corner of

the box）, “y1”:（The y coordinate of the upper left corner of

the box）, “x2”:（The x coordinate of the lower right corner

of the box）, “y2”:（The y coordinate of the lower right corner

www.aratek.com.cn 96
 全球领先的人工智能和生物识别核心技术

of the box）]

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

FaceDetect Face detection result bool no

LiveDetect Live detection result int no

Detected face boxes

FaceInfo array no
coordinate information

The x coordinate of the

FaceInfo.x1 float no
upper left corner of the box

The y coordinate of the

FaceInfo.y1 float no
upper left corner of the box

The x coordinate of the

FaceInfo.x2 lower right corner of the float no

box

The y coordinate of the

FaceInfo.y2 lower right corner of the float no

box

www.aratek.com.cn 97
 全球领先的人工智能和生物识别核心技术

61.Camera_Verify

Interface description

Function: Verify two face images, Scope: Camera device

URL Websocket：127.0.0.1:4397 Socket：127.0.0.1:7934

JSON：

“RequestType”: 118，

Request data “ ImageData1”: （ Image data 1 ， support jpg 、 bmp

format format）
，

“ImageData2”: （ Image data 2 ， support jpg 、 bmp

format）

Request data format description

Field Description Type Required

RequestType Request data type int yes

ImageData1 Image data 1 string yes

ImageData2 Image data 2 string yes

JSON:

Response data {

format “ResponseType”: 118,

“ErrorCode”:（Normally returns 0）
，

www.aratek.com.cn 98
 全球领先的人工智能和生物识别核心技术

“ErrorMessage”:（Error message）,

“Similarity”:（Similarity of face verification，scope 0~1）

Response data format description

Field Description Type Returned

ResponseType Response data type int yes

ErrorCode Error code int yes

ErrorMessage Error message string yes

Similarity of face
Similarity float no
verification

Ⅲ.Type identification in the interface

The enumeration of all type identifiers can be viewed in the Demo\Client.js file.

1.Request/Response data type

Type name Description Value

OpenDevice_Type 1

Request/Response data CloseDevice_Type 2

type GetDeviceCount_Type 3

GetDeviceDescription_Type 4

www.aratek.com.cn 99
 全球领先的人工智能和生物识别核心技术

CaptureFingerData_Type 5

StartCapture_Type 6

StopCapture_Type 7

GeneralizeTemplate_Type 8

Verify_Type 9

SetOption_Type 10

BmpToRaw_Type 11

BmpToWSQ_Type 12

BmpToISO_Type 13

BmpToANSI_Type 14

CID_Init_Type 15

Type name Description Value

CID_Close_Type 16

CID_GetChannelCount_Type 17

CID_BeginCapture_Type 18

Request/Response data CID_GetFPRawData_Type 19

type CID_GetFPBmpData_Type 20

CID_EndCapture_Type 21

CID_GetVersion_Type 22

CID_GetDesc_Type 23

www.aratek.com.cn 100
 全球领先的人工智能和生物识别核心技术

CID_Alg_GetVersion_Type 25

CID_Alg_Begin_Type 26

CID_Alg_FeatureExtract_Type 27

CID_Alg_FeatureMatch_Type 28

CID_Alg_ImageMatch_Type 29

CID_Alg_GetQualityScore_Type 32

CID_Alg_End_Type 35

TrustLink_GetDeviceInfo_Type 49

ARA_ReadIDCard_Type 50

FRO900_OpenDevice_Type 64

FRO900_CloseDevice_Type 65

FRO900_GetDeviceCount_Type 66

FRO900_CaptureFingerPrintData_Type 67

FRO900_GeneralizeTemplate_Type 68

FRO900_Verify_Type 69

Iris_InitDevice_Type 80

Iris_ReleaseDevice_Type 81

Iris_StartCapture_Type 82

Iris_StartCapture2_Type 83

Iris_StopCapture_Type 84

www.aratek.com.cn 101
 全球领先的人工智能和生物识别核心技术

Iris_SetOptions_Type 86

Iris_StartVerify_Type 87

Iris_StartVerify2_Type 88

Iris_StopVerify_Type 89

Iris_StartFastCapture_Type 90

Iris_StartFastCapture2_Type 91

FingerKey_OpenDevice_Type 96

FingerKey_CloseDevice_Type 97

FingerKey_GetDeviceInformation_Type 99

FingerKey_CaptureFingerData_Type 100

FingerKey_ImportFingerPrint_Type 101

Camera_InitDevice_Type 112

Camera_ReleaseDevice_Type 113

Camera_StartCapture_Type 114

Camera_StopCapture_Type 115

Camera_SetOption_Type 116

Camera_DetectFace_Type 117

Camera_Verify_Type 118

2.Finger position

Type name Description Value

www.aratek.com.cn 102
 全球领先的人工智能和生物识别核心技术

UNKNOWN 0

RIGHT_THUMB 1

RIGHT_INDEX 2

RIGHT_MIDDLE 3

RIGHT_RING 4

RIGHT_LITTLE 5
Finger position（range:
LEFT_THUMB 6
device supported by
LEFT_INDEX 7
TrustFinger or FRO900）
LEFT_MIDDLE 8

LEFT_RING 9

LEFT_LITTLE 10

THUMB_TWO（only FRO900） 21

LEFT_FOUR（only FRO900） 22

RIGHT_FOUR（only FRO900） 23

Type name Description Value

UNKNOWN 99

RIGHT_THUMB 11
Finger position（range:
RIGHT_INDEX 12
CID Series device）
RIGHT_MIDDLE 13

RIGHT_RING 14

www.aratek.com.cn 103
 全球领先的人工智能和生物识别核心技术

RIGHT_LITTLE 15

LEFT_THUMB 16

LEFT_INDEX 17

LEFT_MIDDLE 18

LEFT_RING 19

LEFT_LITTLE 20

3.Miss Finger position

Type name Description Value

NO_FINGER_MISS 0

MISS_FINGER_INDEX 1
Finger position（range:
MISS_FINGER_MIDDLE 2
FRO900）
MISS_FINGER_RING 4

MISS_FINGER_LITTLE 8

4.Image compression format type

Type name Description Value

UnCompressed 0

Image compression BitPacked（not support yet） 1

format type WSQ 2

JPEG 3

www.aratek.com.cn 104
 全球领先的人工智能和生物识别核心技术

JPEG2000 4

PNG（not support yet） 5

5.Security level

Type name Description Value

Level_1 1

Level_2 2

Security level Level_3 3

Level_4 4

Level_5 5

6.Fingerprint image format type

Type name Description Value

IRaw 1

Fingerprint image format IBmp 2

type IISO 3

IANSI 4

7.Fingerprint feature format type

Type name Description Value

Fingerprint feature FBione 1

www.aratek.com.cn 105
 全球领先的人工智能和生物识别核心技术

format type FISO 2

FANSI 3

FIDCard 4

FbioMove192 5

8.CID series device type

Type name Description Value

CID3000TC 0

CID4000 1

CID5000 2
CID series device type
CID7000 3

CID3000 4

CID7000R 5

9.IR series device type

Type name Description Value

IR100 1
IR series device type
IR200 2

10.Camera device type

Type name Description Value

www.aratek.com.cn 106
 全球领先的人工智能和生物识别核心技术

FC200V 1

FC200H 2

Camera device type

FC205 3

CID7000 11

11.IR series device capture mode type

Type name Description Value

Two_Eyes 1
IR series device capture
Left_Eye 2
mode type
Right_Eye 3

12.ID card type

Type name Description Value

IDCard_People 1

ID card type IDCard_GAT 2

IDCard_Foreign 3

www.aratek.com.cn 107
 全球领先的人工智能和生物识别核心技术

13.Error code description

Type name Description Value

Success 0

This feature is not authorized 255

The request data format is incorrect 254

Failed to load SDK library 253

Uninitialized device 252

Algorithm initialization failed 251

Device not opened 250

The current request data is not supported 249

Incorrect finger pressing（FRO900） 248

Error code description
Failed to cut fingerprint image（FRO900） 247

The parameter in the request data is not

246
supported

Fingerprint image processing failed

245
（FRO900）

Wrong finger count（FRO900） 244

Template generalize failed（FRO900） 243

Not support multithreading（FRO900） 242

Failed to get hostname（TrustLink） 241

www.aratek.com.cn 108
 全球领先的人工智能和生物识别核心技术

Failed to get MAC or IP address（TrustLink） 240

Iris collection is in progress 239

Iris collection has not started 238

Current device function is occupied 237

Iris verify is in progress 236

Iris verify timed out 235

Failed to open card reader 234

Failed to read card information 233

Failed to find ID card 232

Card reading function is already occupied 231

Failed to enumerate FingerKey 230

Failed to open FingerKey 229

Failed to close FingerKey 228

Failed to get FingerKey information 227

Failed to capture fingerprint (FingerKey) 226

Failed to get image quality (FingerKey) 225

Failed to extract feature (FingerKey) 224

Failed to enumerate application (FingerKey) 223

Failed to open application (FingerKey) 222

Failed to import fingerprint (FingerKey) 221

www.aratek.com.cn 109
 全球领先的人工智能和生物识别核心技术

Iris fast capture timeout 220

No device connected 219

Fingerprint image color conversion failed 218

Camera not detected 217

Failed to open camera 216

Camera is capturing 215

Camera did not start capturing 214

Camera is initialized 213

Iris capture failed 212

Initialize camera failed 211

Detect face failed 210

Extract face feature failed 209

Verify face failed 208

www.aratek.com.cn 110