Skip to main content

IDKit

IDKit is the Innovatrics fingerprint recognition SDK for on-device 1:1 verification and 1:N identification. The core is a C++ shared library (libidkit) with Java and .NET connectors. It implements the Identification (1:N) and Verification (1:1) flows for the fingerprint modality.

IDKit is a fingerprint recognition SDK.

This page reflects the Linux 64-bit package, v9.2.3.

Getting the SDK​

Distributed through the Innovatrics Customer Portal and available on request via sales@innovatrics.com.

Package​

  • Root directory contains the changelog, EULA, readme, and the installation script.
  • doc/ — API documentation of the library (PDF + CHM), javadoc for the Java connector, and the Innovatrics Logo Program.
  • samples/cpp/ — C++ samples with complete CMake (sample_register, sample_identify, sample_register_match).
  • samples/java/ — Java samples with run scripts.
  • samples/NET/ — .NET samples.
  • bin/ — License Manager application for installing the license, and scripts for using a USB-token license.
  • lib/ — C++ shared libraries, Java connector, and .NET connector.
  • include/ — the C++ header (idkit.h).

Installation (Linux)​

Run the bin/install.sh script. It copies the C++ shared libraries to /usr/lib and registers them using ldconfig. Root privileges are required.

Licensing​

You will need a valid license file to use this library. The license file must be named iengine.lic.

Guided flow:

  1. Run bin/license_manager_cli -g and open the given URL in your browser.
  2. Log into the Customer Portal using your credentials, generate a license file for your HW ID, and download it.
  3. Run bin/license_manager_cli -d and specify the path to the downloaded license file.
  4. Run bin/license_manager_cli -l to check that the license is valid.

Manual flow:

  1. Run bin/license_manager_cli -p to obtain the device hardware ID.
  2. Connect to Customer Portal using your credentials and generate a license file for that hardware ID.
  3. Copy the license file to one of the following locations: ~/.innovatrics, /etc/innovatrics, or the working directory.
  4. Run bin/license_manager_cli -l to check that the license is valid.

For how the SDK searches for a license at runtime (including the in-memory license option), see License in Concepts.

Samples​

C++ — pre-compiled samples are ready to run in samples/cpp/<sample>/bin. To build from source:

cd samples/cpp/<sample>/
mkdir _build && cd _build
cmake ..
make install

The executable lands in samples/cpp/<sample>/_build/_install.

Java — compile and run with the run.sh script in samples/java/<sample>.

Support​

Contact sdk_support@innovatrics.com for issues or licensing details.