2.1.0

Release date: July 20, 2026

General summary

Facephi IAD Service 2.1.0 is a backward-compatible minor version that adds an optional (opt-in) way to return detailed provider information together with the public Liveness result. No existing Endpoint, request field, or default response changes.

What's new

Optional field longDetails and response additionalInfo

• POST /api/v1/iad/liveness/evaluate accepts a new optional multipart text field longDetails with value true or false (case-insensitive, no spaces; by default false).

• When longDetails=true, the correct response includes an additional top-level object, additionalInfo, which contains the provider's Business Intelligence (BI) record for that request.

• The service deterministically correlates each request with the provider: it sends a header correlation-id unique to the IAD Server and retrieves the matching BI record from the Endpoint /bi_records of the engine. Console/stdout logs are not analyzed.

• In the Docker Flow in which the service itself launches the embedded engine, setting logger_long_detail=true or FACEPHI_IAD_LOGGER_LONG_DETAIL=true also causes the engine child 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 enable the BI data path used by longDetails=true.

• A value of longDetails that is invalid is rejected with HTTP 400.

• If the BI record cannot be obtained within the configured latency budget, the response is returned without additionalInfo and a warning is logged.

Configuration

It is resolved from the config.json startup or environment variables FACEPHI_IAD_ENGINE_* (the environment takes precedence over the configuration):

Key	Default	Description
engine_bi_records_enabled	true	Enables obtaining additionalInfo 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	Removes output.request_data of additionalInfo

Activation alternatives for the embedded engine:

• logger_long_detail=true en config.json

• FACEPHI_IAD_LOGGER_LONG_DETAIL=true in the service environment

• IAD_SERVER_BI_LOGS_ENABLED=true directly, and optionally IAD_SERVER_BI_LOGS_PATH=..., in the service environment before startup

Compatibility

• Fully backward-compatible with 2.0.0. When longDetails is absent or is false, the response is byte-for-byte identical to that of 2.0.0.

• Requires facephi-rest-client/1.2.0 (adds support for HTTP headers per request).

Notes

• additionalInfo reflects the schema of the provider's BI record (device/browser/camera metadata, timings, and output). Since it exposes internal provider data, review the privacy requirements before enabling it for end customers; use engine_bi_records_redact_request_data=true to remove output.request_data.

• Retrieval of additionalInfo depends on the Endpoint /bi_records of the provider. For high-volume production use, treat longDetails as a diagnostic feature.