Skip to content

Release Notes — Version 2.1.0

Release Date: July 20, 2026

Overview

Facephi IAD Service 2.1.0 is a minor, backward-compatible release that adds an opt-in way to return detailed provider information alongside the public liveness result. No existing endpoint, request field, or default response changes.

What's New

Optional longDetails field and additionalInfo response

  • POST /api/v1/iad/liveness/evaluate accepts a new optional multipart text field longDetails with value true or false (case-insensitive, trimmed; default false).
  • When longDetails=true, the successful response includes an additional top-level additionalInfo object containing the provider Business Intelligence (BI) record for that request.
  • The service correlates each request with the provider deterministically: it sends a unique correlation-id header to the IAD Server and retrieves the matching BI record from the engine /bi_records endpoint. Console/stdout logs are not parsed.
  • In the Docker flow where the service launches the embedded engine itself, setting logger_long_detail=true or FACEPHI_IAD_LOGGER_LONG_DETAIL=true also causes the child engine process to receive IAD_SERVER_BI_LOGS_ENABLED=true and a default BI logs path when those internal variables were not already defined. That is one of the supported ways to activate the BI data path used by longDetails=true.
  • An invalid longDetails value is rejected with HTTP 400.
  • If the BI record cannot be retrieved within the configured latency budget, the response is returned without additionalInfo and a warning is logged.

Configuration

Resolved from startup config.json or FACEPHI_IAD_ENGINE_* environment variables (environment overrides configuration):

Key Default Description
engine_bi_records_enabled true Enable additionalInfo retrieval when longDetails=true
engine_bi_records_max_retries 3 Retries while waiting for the BI record
engine_bi_records_retry_delay_ms 50 Delay between retries (ms)
engine_bi_records_timeout_ms 300 Total latency budget for retrieval (ms)
engine_bi_records_redact_request_data false Strip output.request_data from additionalInfo

Embedded-engine activation alternatives:

  • logger_long_detail=true in config.json
  • FACEPHI_IAD_LOGGER_LONG_DETAIL=true in the service environment
  • Direct IAD_SERVER_BI_LOGS_ENABLED=true and optional IAD_SERVER_BI_LOGS_PATH=... in the service environment before startup

Compatibility

  • Fully backward-compatible with 2.0.0. When longDetails is absent or false, the response is byte-for-byte the same as 2.0.0.
  • Requires facephi-rest-client/1.2.0 (adds per-request HTTP header support).

Notes

  • additionalInfo mirrors the provider BI record schema (device/browser/camera metadata, timings, and output). Because it exposes provider-internal data, review privacy requirements before enabling it for end clients; use engine_bi_records_redact_request_data=true to strip output.request_data.
  • additionalInfo retrieval relies on the provider /bi_records endpoint. For high-volume production usage, treat longDetails as a diagnostic feature.