Skip to content

Changelog

All notable changes to Facephi Finger Service will be documented in this file.

The format is based on Keep a Changelog.

[2.1.0] - 2026-06-11

Added

  • New management endpoint GET /api/v1/finger/metrics returning usageCountersEnabled, extractCount, authenticateCount, and totalCount.
  • License-gated usage counting for successful POST /api/v1/finger/extract and POST /api/v1/finger/authenticate operations via metadata key ActivateUsageCounters.

Changed

  • Usage counter synchronization behavior improved to reduce lag between service-side metrics and license dashboard values.
  • Integration coverage updated to validate metrics behavior without brittle timing assumptions.

Documentation

  • Updated README.md, OpenAPI, release notes, and technical documentation to include the /metrics contract and usage-counter configuration.
  • Documented supported image formats for image-based inputs in extract and authenticate: wsq, bmp, png, jpg, jp2.

[2.0.0] - 2026-06-08

Breaking Changes

  • Removed the legacy public routes POST /api/v1/finger/create-template and POST /api/v1/finger/verify.
  • Introduced the 2.0.0 public contract for POST /api/v1/finger/extract and POST /api/v1/finger/authenticate.
  • Request and response payloads for fingerprint operations changed and are not backward compatible with 1.x.x clients.

Added

  • Public API mapping layer (FingerContractMapper) translating the Facephi public contract to the processing backend contract.
  • Input validation (Base64 encoding, required fields, position names, scanType) returning error400.
  • Unit tests for contract mapping and validation (FingerContractMapperTest).
  • Integration test assertions verifying public contract fields, absence of implementation-specific fields, and 404 responses on removed legacy routes.

Changed

  • Response fields renamed to: fingerTemplate, quality, qualityDetails, authStatus, similarity, sdkDuration, queueDuration.
  • authThreshold validation for authenticate requests is strict integer-only (0..100), matching the documented public contract.
  • Public error400 payload messages for extract/authenticate/health were normalized to product-facing wording.

Documentation

  • Refreshed installation, technical, and overview guides for the public 2.0.0 release.

Testing

  • Unit tests: FingerContractMapperTest covering mapping, validation, and absence of internal fields in all responses.
  • Integration tests: Newman collection updated for public contract 2.0.0 with stub-inspection assertions and explicit checks for removed legacy routes.

[1.0.0] - 2026-04-20

Added

  • Initial public documentation package under doc/.
  • OpenAPI 3.0 specification for all public endpoints.
  • Installation and technical specification guides.
  • Release notes for the initial public service release.

Service Scope

  • Fingerprint template creation endpoint.
  • 1:1 fingerprint verification endpoint.
  • Management endpoints for version, health, and runtime configuration.
  • Runtime configuration precedence with environment variable overrides.
  • Master/worker deployment role model for clustered operation.