Skip to main content

API Reference

The API documentation that ships inside the Enrollment SDK package, hosted here so integrators can read it without downloading the SDK.

Current version — v28.2.0​

Open API reference →

Browsable C++ API reference, with the Java and C# connectors. Opens in a new tab.

Download PDF (23 MB) ↓

The same manual and API reference in a single file, for offline reading.

What's covered​

The reference is the authoritative source for the full API:

  • Initialization — Initialize / InitializerConfig, models and license discovery.
  • Applicant and modalities — Applicant, ModalitiesTemplate, and the gallery types.
  • Capture and extraction — face, iris, and fingerprint capture, slap segmentation, and extractors.
  • Matching — verification and identification matchers, similarity score and threshold.
  • Quality — per-modality quality.
  • Serialization — template header and binary parts, writers.

Conceptual notes are also ported to this portal as Overview and Concepts.