Skip to main content

API Reference

Full per-function and per-struct C API reference for the SFE Toolkit. This is the Doxygen-generated documentation that ships inside the SDK package, hosted here so integrators can browse it from the portal without downloading the SDK.

Current version — v4.2.1​

Open API reference (HTML) →

Doxygen-generated site with search, navtree, and cross-referenced types. Opens in a new tab.

Download PDF (6 MB) ↓

Single-file manual + reference for offline reading or printing.

Previous versions​

For integrators on older SDK releases, the corresponding Doxygen documentation is hosted here as well. Manual content (Features, Solvers, etc.) for previous versions lives inside its own Doxygen site rather than as separate portal pages.

v3.2.2​

Open v3.2.2 documentation (HTML) →
Download v3.2.2 PDF (5 MB) ↓

If you are still on v3.x and planning to move to v4.x, see the Upgrade Guide 3.x → 4.0.

What's covered (current version)​

The HTML reference is the authoritative source for:

  • C API per header — sfe_core.h, sfe_face.h, sfe_iris.h, sfe_palm.h, sfe_object.h, sfe_person.h, sfe_tattoo.h, sfe_document.h.
  • All public functions with parameter lists, return types, error semantics, and bindings (Python / Kotlin / Swift / .NET) for each.
  • All public structs and enums with member-level documentation.
  • Example sources (example_face_identify.cpp, example_face_track.cpp, example_face_liveness.cpp, …) cross-linked into the API.