Skip to content

Changelog

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

The format is based on Keep a Changelog.

[Unreleased]

[1.1.1] - 2026-03-30

Changed

  • Upgrade IAD engine to version 2.5.3.

Fixed

  • Docker registry paths corrected from docker-pro-fphi to docker-core-pro-fphi across all documentation and release notes.
  • OpenAPI specification updated with accurate request/response schemas matching actual endpoint behavior.
  • API documentation enhanced with configuration and health check endpoint examples.

[1.1.0] - 2026-03-20

Added

  • Runtime configuration overrides through environment variables.
  • License error translation and normalized license error reporting utilities for clearer operational diagnostics.

Changed

  • Upgrade IAD engine to version 2.5.2.
  • License management improvements to support offline validation scenarios and provide clearer error reporting.
  • Dockerfile streamlined: switched base image, improved package management and runtime dependency handling.

Fixed

  • Docker runtime and base image hardening updates.
  • REST proxy error normalization and consistent error creation/reporting paths.
  • Reduced excessive verbose logs in Docker checks and engine activation flows.

[1.0.0] - 2026-02-03

Added

  • Automatic engine activation from license metadata
  • Docker environment detection and automatic engine initialization
  • ProcessExecutor facade for background process management
  • Filesystem compatibility layer for GCC 7

Changed

  • BREAKING: Standardized all endpoints with /iad prefix (e.g., /api/v1/iad/check-capture)
  • Unified namespace structure across all endpoints
  • Improved engine health check delays and timing
  • Enhanced logging in engine activation process
  • Simplified ProcessExecutor implementation
  • Refactored internal REST proxy logging

Removed

  • BREAKING: Removed /extract_data endpoint (consolidated functionality)

Fixed

  • Filesystem compatibility issues with older GCC versions
  • Engine initialization timing in Docker environments

[0.0.1] - 2026-01-29

Added

  • Initial release of IAD Service REST API
  • Endpoint /api/v1/iad/check-capture for liveness detection and injection attack verification
  • Endpoint /api/v1/iad/extract-image for image extraction from validated captures
  • Management endpoint /api/v1/iad/version for version and license status
  • Management endpoint /api/v1/iad/health for health monitoring
  • Management endpoints /api/v1/iad/config (GET/POST) for configuration management
  • Connection pooling for engine communication
  • Automatic retry mechanism with configurable backoff
  • Dynamic configuration updates without service restart
  • Docker-based deployment with Ubuntu 24.04
  • Support for online and offline license validation
  • Comprehensive logging with configurable levels and rotation
  • OpenAPI 3.0 specification (Swagger documentation)