SenseCrypt eID Docs

Release Notes

Release Notes for SenseCrypt Releases

SenseCrypt 4.0.0

General

Integration of SensePrint V4 — More Robust Biometric Matching

  • SensePrint V4 introduces a new matching algorithm (Post Quantum Safe Cryptography) that is significantly more robust to variations in face images — better
    lighting, angle, and camera differences — while maintaining the same strong privacy
    guarantees.
  • All new SensePrints are created as V4 by default. Existing V1/V2/V3
    SensePrints continue to work.

New: Refresh SensePrint

  • A new POST /refresh-senseprint-face endpoint lets you upgrade an existing SensePrint
    (any version) to V4 without requiring the user to re-enroll. Simply present the old
    SensePrint and the user's face, and the server reissues a fresh V4 SensePrint. This is
    the recommended migration path for upgrading your existing user base to V4.

Post-Quantum Safe Cryptography for Face PKI

  • Face Certificates, face signing, and face encryption now support post-quantum safe algorithms alongside the existing Secp256k1.
  • ML-DSA (NIST FIPS 204) — post-quantum digital signatures, for face signing and Face Certificates used in verification.
  • ML-KEM (NIST FIPS 203) — post-quantum key encapsulation, for Face Certificates used in encryption/decryption.
  • All Face PKI endpoints now accept a key_type field to choose the algorithm. Supported values: Secp256k1, MlDsa44, MlDsa65, MlDsa87, MlKem512, MlKem768, MlKem1024.

New Server Configuration: PKI_PRIVATE_KEY

  • A new pki_private_key server configuration key controls Face PKI (root certificate, face certificate issuance, and verification). It supports Secp256k1, ML-DSA-44, ML-DSA-65, and ML-DSA-87. Set it in secrets.json or the PKI_PRIVATE_KEY environment variable.
  • The existing issuers_private_key (used to sign SensePrints) is unchanged and continues to work. It now also supports ML-DSA key types in addition to Secp256k1.

New: Verify Signature Without a Certificate

  • A new POST /verify-face-signature-with-public-key endpoint verifies a face-based
    signature using a raw public key directly, without needing a Face Certificate or
    certificate chain. Useful for lightweight verification by parties who only hold the
    public key.

SensePrint Attributes: extra_binary_data Field

  • SensePrint generation now accepts an optional extra_binary_data field, allowing you to attach arbitrary binary data to a SensePrint at creation time.

Liveness Improvements

  • Passive liveness checking is now available inside PassiveFaceCaptureSession with per-session billing.
  • Head pose detection improvements for more accurate liveness assessment.
  • Updated liveness SDK (idrnd v1.51.0).

Performance Improvements

  • Mobile SDK initialisation is now parallelised — biometric model, liveness model, and polar projection matrix all load concurrently, reducing startup time.
  • Face featuriser model replaced with a smaller model for faster inference while retaining same accuracy.

SenseCrypt 3.1.6

General

Integration of SensePrint V2

  • SensePrint V2 uses a more powerful cryptographic algorithm to perform more accurate encryption and decryption during senseprint generation and verification respectively. The size of a generated senseprint is also smaller.

  • Two additional levels of tolerance, REGULAR_HARD and REGULAR_SOFT are added to provide higher flexibility in deciding the security level of the generated senseprints.

  • Senseprints generated with older SDKs are still verifiable using the current release. However, there will be no option to generate senseprints using the legacy algorithm. Upgrade of Liveness SDK

  • The embedded liveness sdk has been upgraded to the latest version for better performance. Along with this upgrade, the internal libraries used to host model inferences have been upgraded as well.

:mobile_phone: Mobile SDK

Added MultiSensePrintSession

  • This session allows user to set a image (which can be a group photo or an individual's photo) and run group verification similar to the verify_group endpoint. See more details in the server sdk session.

:desktop: Server SDK

Added more information in senseprint_raw endpoint

  • The face crop detected from the input image and used to generate the senseprint is returned as base64 string together with the senseprint.

Added verify_group endpoint

  • This endpoint allows the user to verify a list of senseprints (together with their corresponding passwords and verifiers auth keys) against a group image. When the input image is flagged as a group image, it will detect all faces in the group and attempt to decrypt each senseprint with each face. On the other hand, when the input image is not flagged as a group image, the best detection from the image will be used to decrypt all provided senseprints. The response will contain a list of decrypted senseprint data and face crops that are detected but unmatched.

SenseCrypt 3.1.5

General


Auto-update of Expired License

  • For licenses generated after this release, expiry extensions can now be done without updating the license file in the source code.

:mobile_phone: Mobile SDK

  • Model Size Reduction & Inference Performance Improvement
    • We have reduced the machine learning model size by 50%, optimising runtime performance for slower devices.

  • Android(.aar file update)

    • There will be only two AAR files from this update: Online and Offline.
    • The SenseCryptSdkOfflineLiteCore AAR file has been removed.
  • Added Download Session
  • Online-Offline Mode Switch
    • The SDK now supports an online-to-offline mode switch. When switching to offline mode, the required models are downloaded.
  • New Carousel View
    • A carousel view has been added for first-time app installations. It provides an overview of SenseCrypt SDK features along with short descriptions on how they can be utilized.
  • New Dialog for SDK Mode Selection & Download Progress
    • A model selection dialog has been added, prompting users to choose between offline and online modes when the app is first installed.
    • If offline mode is selected, a download progress bar dialog appears, displaying the status of model downloads.
  • New Settings Page for SDK Mode Selection
    • A settings page has been added, allowing users to switch between offline and online modes at any time.
  • Liveness Detection Integration
    • The IDRND Liveness detection for offline mode is now handled within the SenseCrypt SDK framework.
    • The function is called CheckLiveness.
    • CheckLiveness takes image bytes as input and determines whether the presented face is live or not.

:desktop: Server SDK

SenseCrypt 3.1.3

:mobile_phone: Mobile SDK

  • Added ImageSession
    • This new session type complements the existing session types - ActiveCapture & PassiveCapture. Instead of using the device camera, ImageSession offers a simple way to generate & verify SensePrints from existing images.
  • Added Face Signing
    • While Face Signing was already introduced in SenseCrypt 3.1.1 for the Server API. This release enables Face Signing using the mobile SDK for both offline & online builds.
  • Removed Lightweight Liveness
    • Issues under different lighting conditions convinced us to deprecate the optional Lightweight Liveness feature.
    • This change includes changes in the AppConfig, settings and parameters of the GenerateSensePrintRequest of the SDK.
  • Changed Sequence of Screens for SensePrint Generation
    • To improve the consistency between Offline & Online Liveness Check, the SensePrint Generation Form now comes before a Face Capture screen, such that the sequence of screens is:
      • SensePrint Generation Form
      • Face Capture
      • Result -> Error Message or Success
  • Added the loading of App Constants from JSON config
    • This allows to change the endpoint server without needing to change the app's source code.

:desktop: Server SDK

  • Solved network failure issue with slow connectivity
    • Slow network connectivity could lead to repeated network failure exceptions on mobile devices.

SenseCrypt 3.1.2

:mobile_phone: Mobile SDK

  • Lightweight Liveness
    • Optionally during Active- & Passive-FaceCapture a lightweight Liveness model can be utilized to spot spoofing early on, without the need to hit the backend server.
  • New Settings Page
    • The new Settings Page allows
      • to switch between Active- & Passive-FaceCapture
      • to switch between Front- & Back-Camera
      • to activate or deactivate Lightweight Liveness
  • New SDK Mode OfflineLite
    • To reduce the app size for store publishing, SDK Mode OfflineLite allows packaging the apps without the model files. During initialization, a path can be specified from which the models can be loaded.
  • Bugfix ActiveFaceCapture
    • Fixed bug, where ActiveFaceCapture always started with "User Should Look Up"
  • Improved Frame Selection in ActiveFaceCapture
    • The frame selection algorithm for face comparison during ActiveFaceCapture has been improved. This reduces False Negatives during Face Matching.

:desktop: Server SDK

  • New Environment variable to define mobile requests timeout
    • REQUEST_TIMEOUT defines in seconds until a mobile request is considered as timeout. The default is 10 seconds.

:book: General

  • Added SenseCrypt Walk-through
    • A GitHub Repository containing a series of Juypter Notebooks for hands on walk-through of the SenseCrypt eID and SenseCrypt Face PKI APIs.
  • Improved Documentation

For further details see the documentation of SenseCrypt 3.1.2

SenseCrypt 3.1.1

See the documentation of SenseCrypt 3.1.1

Foundational vs Functional eID

How Face PKI enables functional eID

On this page

SenseCrypt 4.0.0GeneralSenseCrypt 3.1.6General:mobile_phone: Mobile SDK:desktop: Server SDKSenseCrypt 3.1.5General:mobile_phone: Mobile SDKAndroid(.aar file update)A new session has been introduced to allow downloading machine learning models from a remote source.:desktop: Server SDKSenseCrypt 3.1.3:mobile_phone: Mobile SDK:desktop: Server SDKSenseCrypt 3.1.2:mobile_phone: Mobile SDK:desktop: Server SDK:book: GeneralSenseCrypt 3.1.1