API Reference
The API documentation that ships inside the IDKit SDK package, hosted here so integrators can read it without downloading the SDK.
Current version — v9.2.3
Download PDF (2 MB) ↓
Complete C++ API reference and integration manual in a single file.
Open Java connector reference (javadoc) →
Browsable javadoc for the com.innovatrics.idkit Java connector. Opens in a new tab.
Documentation in the package
| Document | Format | Location in the package |
|---|---|---|
| C++ API reference + manual | PDF (hosted above) and CHM | doc/IDKit.pdf, doc/IDKit.chm |
| Java connector reference | javadoc (hosted above) | doc/javadoc/ |
| .NET connector reference | CHM | doc/NET/Innovatrics.IDKit.NET.chm |
CHM files (Windows compiled help) cannot be hosted on the portal — open them locally from the downloaded package.
What's covered
The PDF is the authoritative source for:
- The full C++ API — initialization, connections, user records (fingerprint add, properties,
biometry, import/export, tags), collections, database operations, identification, verification,
images, parameters, and error codes — all exposed through the single header
idkit.h. - Conceptual notes — also ported to this portal as Overview and Concepts.
The javadoc covers the same API surface through the Java connector classes (IDKit, User, and
related types).