Liveness pipelines
Configuration¶
The IDLIVEDOC_SERVER_AVAILABLE_PIPELINES environment variable defines which liveness checking pipelines will be available for invocation. The server initializes all the listed pipelines, and then they can be used in /check_liveness requests. If no pipelines are specified in the IDLIVEDOC_SERVER_AVAILABLE_PIPELINES variable or if the variable is missing, then no pipeline will be initialized and the container will exit.
Usage example: -e IDLIVEDOC_SERVER_AVAILABLE_PIPELINES=ibis-sr,robin-pc
Note
Be careful, each additional pipeline proportionally increases the server's memory consumption.
Available pipeline names¶
| Name | Attack vector | Description |
|---|---|---|
| toucan-sr | Screen Replay | This pipeline is our latest release and the recommended algorithm for detecting Screen Replay attacks. |
| ibis-sr | Screen Replay | This pipeline is a previous version of the Screen Replay algorithm, now deprecated. |
| ibis-sr-soft | Screen Replay | This pipeline modifies the results of ibis-sr by significantly reducing false rejections at the cost of slightly higher false approvals. |
| robin-pc | Printed Copy | This pipeline is our latest release and the recommended algorithm for detecting Printed Copy attacks. "REGULAR" and "SOFT" calibrations are supported. Note: images of document backs are not supported at this time. |
| penguin-pc | Printed Copy | This pipeline is a previous version of the Printed Copy algorithm, now deprecated. |
| umbrellabird-ps | Portrait Substitution | This pipeline is our latest release and the recommended algorithm for detecting Portrait Substitution attacks. "REGULAR" and "HARD" calibrations are supported. |
| stork-ps | Portrait Substitution | This pipeline is a previous version of the Portrait Substitution algorithm, now deprecated. |
| hawk-sd | Digital Manipulation (EXPERIMENTAL) | This pipeline is designed to detect screengrabs from mobile devices which are submitted by direct image upload. For example, an image with a bar showing battery life or other mobile screen artifacts in addition to the document. |
Pipeline aliases ¶
In addition to specifying pipeline names explicitly, pipeline aliases are also available and do not change from release to release. While the actual underlying pipelines might change, these aliases can simplify continuous migration by always invoking the most recent liveness pipeline for a given attack vector.
Here is the list of available pipeline aliases and their current mappings:
default-sr->toucan-srdefault-pc->robin-pcdefault-ps->umbrellabird-ps
The aliases can be used in any context where a regular pipeline name is accepted, e.g. in configuration variables such as IDLIVEDOC_SERVER_AVAILABLE_PIPELINES or in REST API calls.
Liveness check calibrations¶
The IDLD API provides a way to specify a threshold calibration for the liveness check for minimizing either APCER or BPCER. If the specified calibration is not supported by the pipeline in question, the result will return a judgment based on the REGULAR calibration.
The table below describes which calibration is supported for each liveness pipeline present:
| Pipeline | SOFT | REGULAR | HARD |
|---|---|---|---|
| toucan-sr | - | + | + |
| ibis-sr | - | + | - |
| ibis-sr-soft | - | + | - |
| robin-pc | - | + | + |
| penguin-pc | - | + | + |
| umbrellabird-ps | - | + | + |
| stork-ps | - | + | + |
| hawk-sd | - | + | - |