ID Card Recognition SDK - Server
This stands for ID card scanner, ID document reader, ID card reader, ID document recognition, passport scanner, ID scanner, MRZ parser, barcode reader, barcode scan, MRZ scan on Linux and Windows
Features
License
We offer lifetime license(perpetual license)
based on machine ID
for server(Windows, Linux). The license is available for one-time payment
. In other words, once you purchase license from me, you can use our SDK permanently.
To request a license, please contact us:
Email: [email protected]
Telegram: @kbyai
WhatsApp: +19092802609
System Requirements
1. Windows
CPU: 2 cores or more (Recommended: 2 cores)
RAM: 4 GB or more (Recommended: 8 GB)
HDD: 4 GB or more (Recommended: 8 GB)
OS: Windows 7 or later
Architecture: x64
2. Linux
CPU: 2 cores or more (Recommended: 2 cores)
RAM: 4 GB or more (Recommended: 8 GB)
HDD: 4 GB or more (Recommended: 8 GB)
OS: Ubuntu 20.04 or later
Architecture: x64
Import SDK
Python
from idsdk import getMachineCode
from idsdk import setActivation
from idsdk import initSDK
from idsdk import idcardRecognition
C++
#include "idsdk.h"
# CMake for Windows
target_link_libraries(your_app_name
/path/to/library/idsdk.lib
)
# CMake for Linux
target_link_libraries(your_app_name
/path/to/library/libidsdk.so
)
Initializing SDK
Step one
First, obtain the machine code for activation and request a license based on the
machine code
.
# Python code example
machineCode = getMachineCode()
print("machineCode: ", machineCode.decode('utf-8'))
// C++ code example
printf("machine code: %s\n", getMachineCode());
Step Two
Next, activate the SDK using the received license.
# Python code example
setActivation(license.encode('utf-8'))
// C++ code example
int ret = setActivation("...");
If activation is successful, the return value will be
SDK_SUCCESS
. Otherwise, an error value will be returned.
Step Three
After activation, call the initialization function of the SDK.
# Python code example
initSDK()
// C++ code example
ret = initSDK();
The 'data' model directory should be located in the same path as the library. For example: |--data | |--model1.bin | |--model2.bin | |--model3.bin |--libidsdk.so ...
The first parameter is the path to the model.
If initialization is successful, the return value will be
SDK_SUCCESS
. Otherwise, an error value will be returned.
APIs
1. getMachineCode
First, obtain the machine code for activation and request a license based on the machine code
.
# Python code example
machineCode = getMachineCode()
print("machineCode: ", machineCode.decode('utf-8'))
// C++ code example
printf("machine code: %s\n", getMachineCode());
2. setActivation
Next, activate the SDK using the received license.
# Python code example
setActivation(license.encode('utf-8'))
// C++ code example
int ret = setActivation("...");
If activation is successful, the return value will be SDK_SUCCESS
. Otherwise, an error value will be returned.
3. initSDK
After activation, call the initialization function of the SDK.
# Python code example
initSDK()
// C++ code example
ret = initSDK();
The first parameter is the path to the model.
If initialization is successful, the return value will be SDK_SUCCESS
. Otherwise, an error value will be returned.
4. idcardRecognition
The SDK provides a single API
for ID card recognition
.
The function can be used as follows:
# Python code example
jsonResult = idcardRecognition(base64_image.encode('utf-8'))
// C++ code example
char* jsonResult = idcardRecognition(base64_image);
The function accepts only one parameter, which should be the base64-encoded
format of the image (e.g., JPG
, PNG
, etc.).
If the recognition is successful, the function will return a JSON-formatted
string containing the recognized information. In case of failure, the return value will be NULL
.
Last updated