# Statuses in API

<table><thead><tr><th width="193">Field name / status</th><th>analyse.state</th><th>analyse.resolution_status</th><th>folder.resolution_status</th><th>system_resolution</th></tr></thead><tbody><tr><td>INITIAL</td><td>-</td><td>-</td><td>starting state</td><td>starting state</td></tr><tr><td>PROCESSING</td><td>starting state</td><td>starting state</td><td>analyses in progress</td><td>analyses in progress</td></tr><tr><td>FAILED</td><td>system error</td><td>system error</td><td>system error</td><td>system error</td></tr><tr><td>FINISHED</td><td>finished successfully</td><td>-</td><td>finished successfully</td><td>-</td></tr><tr><td>DECLINED</td><td>-</td><td>check failed</td><td>-</td><td>check failed</td></tr><tr><td>OPERATOR_REQUIRED</td><td>-</td><td>additional check is needed</td><td>-</td><td>additional check is needed</td></tr><tr><td>SUCCESS</td><td>-</td><td>check succeeded</td><td>-</td><td>check succeeded</td></tr></tbody></table>

The details on each status are below.

## Analysis State (analyse.state) <a href="#sostoyanie-analiza-analyse.state" id="sostoyanie-analiza-analyse.state"></a>

This is the state when the analysis is being processed. The values of this state can be:

`PROCESSING` – the analysis is in progress;

`FAILED` – the analysis failed due to some error and couldn't get finished;

`FINISHED` – job's done, the analysis is finished, and you can check the result.

## Analysis Result (analyse.resolution\_status) <a href="#rezultat-analiza-analyse.resolution_status" id="rezultat-analiza-analyse.resolution_status"></a>

Once the analysis is finished, you'll see one of the following results:

`SUCCESS`– everything went fine, the check succeeded (e.g., faces match or liveness confirmed);

`OPERATOR_REQUIRED` (except the Liveness analysis) – the result should be additionally checked by a human operator;

{% hint style="info" %}
The `OPERATOR_REQUIRED status` appears only if it is set up in biometry settings.
{% endhint %}

`DECLINED` – the check failed (e.g., faces don't match or some spoofing attack detected).

If the analysis hasn't been finished yet, the result inherits a value from `analyse.state`: `PROCESSING` (the analysis is in progress) / `FAILED` (the analysis failed due to some error and couldn't get finished).

## Folder Status (folder.resolution\_status) <a href="#sostoyanie-zayavki-folder.resolution_status" id="sostoyanie-zayavki-folder.resolution_status"></a>

A folder is an entity that contains media to analyze. If the analyses have not been finished, the stage of processing media is shown in `resolution_status`:

`INITIAL` – no analyses applied;

`PROCESSING` – analyses are in progress;

`FAILED` – any of the analyses failed due to some error and couldn't get finished;

`FINISHED` – media in this folder are processed, the analyses are finished.

## Folder Result (system\_resolution) <a href="#sostoyanie-zayavki-folder.resolution_status" id="sostoyanie-zayavki-folder.resolution_status"></a>

Folder result is the consolidated result of all analyses applied to media from this folder. Please note: the folder result is the result of the last-finished group of analyses. If all analyses are finished, the result will be:

`SUCCESS`– everything went fine, all analyses completed successfully;

`OPERATOR_REQUIRED` (except the Liveness analysis) – there are no analyses with the `DECLINED` status, but one or more analyses have been completed with the `OPERATOR_REQUIRED` status;

`DECLINED` – one or more analyses have been completed with the `DECLINED` status.

{% hint style="info" %}
&#x20;The analyses you send in a single `POST` request form a group. The group result is the "worst" result of analyses this group contains: `INITIAL` > `PROCESSING` > `FAILED` > `DECLINED` > `OPERATOR_REQUIRED` > `SUCCESS`, where `SUCCESS` means all analyses in the group have been completed successfully without any errors.
{% endhint %}
