# Statuses of a request

## Overview

In the Namirial Onboarding process, identification requests can transition through various statuses, each representing a specific stage in the request lifecycle.

There are three **types** of statuses: `STATUS_UPDATE`, `STATUS_UPDATE_STEP` and `STATUS_UPDATE_ACTOR`.

To manage webhooks, all the necessary details are available on this page.

Below is a list of the `STATUS_UPDATE` type statuses:

- [**CREATED**](#created)
- [**RUNNING**](#running)
- [**COMPLETED**](#completed)
- [**EXPIRED**](#expired)
- [**FAILED**](#failed)
- [**CANCELLED**](#cancelled)


### STATUS_UPDATE

The `STATUS_UPDATE` statuses are related to the status of the request. Below is an example:


```json
{
  "id": "dd11fc7d-c48b-407c-867c-121407d9e304",
  "type": "STATUS_UPDATE",
  "createdAt": "2024-12-02T21:17:44.276957577Z",
  "request": {
    "requestId": "48502a4e-3256-41a8-b119-fb5fa2d25514",
    "requestTypeId": "69efb67a-cf6d-42a7-8f9b-eb707887dee8",
    "status": "RUNNING"
  }
}
```

### STATUS_UPDATE_ACTOR

The `STATUS_UPDATE_ACTOR` is a status type useful for the multi-actor workflows and is triggered by Namirial Onboarding when a specific `actor` starts its workflow. Below is an example.


```json
{
  "id": "ead25182-793a-47bd-9fa9-db93e36b6a35",
  "type": "STATUS_UPDATE_ACTOR",
  "createdAt": "2024-12-02T21:17:50.152882204Z",
  "request": {
    "requestId": "48502a4e-3256-41a8-b119-fb5fa2d25514",
    "requestTypeId": "69efb67a-cf6d-42a7-8f9b-eb707887dee8",
    "status": "RUNNING",
    "actor": "userToIdentify"
  }
}
```

### STATUS_UPDATE_STEP

The `STATUS_UPDATE_STEP` is related to a specific action done by an actor inside a step of a request, as shown below.


```json
{
  "id": "7ec43889-53d8-45c0-9fc9-8c606d0cb393",
  "type": "STATUS_UPDATE_STEP",
  "createdAt": "2024-12-02T21:17:50.163164068Z",
  "request": {
    "requestId": "48502a4e-3256-41a8-b119-fb5fa2d25514",
    "requestTypeId": "69efb67a-cf6d-42a7-8f9b-eb707887dee8",
    "status": "RUNNING",
    "actor": "userToIdentify",
    "stepName": "termsAndConditions",
    "stepId": "/termsAndConditions",
    "stepStatus": "ACTIVE"
  }
}
```

The `STATUS_UPDATE_STEP` event above reports that the `"actor": "userToIdentify"` is now `"ACTIVE"` in the step of the process `"termsAndConditions"`.

Possible `stepStatus` values: `ACTIVE`, `DONE`.

## Status Details

### CREATED

This status indicates that the identification request has been successfully created and initialised. At this stage, the request has been registered in the system, but no further actions have been taken yet. It serves as the starting point for the onboarding process, where all necessary information and initial parameters are set up.

### RUNNING

When a request is in the RUNNING status, it means that the identification process is actively underway.

This includes various activities such as document verification, biometric checks, and any other required steps to confirm the user's identity.

During this stage, actions are expected from both the user and the system. The user may need to upload documents, provide biometric data, or complete other verification steps, while the system processes and validates the provided information. The RUNNING status signifies that the system is currently processing the request and performing the necessary validations.

> **Note:** Based on the specific workflows, the running status can also include waiting due to, for example, human validations or manual verifications.


When validation actions are expected from the user, we include the `"operatorPending": true` in the request. We can see this icon near the request in the back office.

### COMPLETED

A request reaches the COMPLETED status when all required identification steps have been successfully completed.

This means that the user's identity has been verified, and all necessary checks have been passed.

The COMPLETED status indicates that the onboarding process has been successfully completed.

### EXPIRED

The EXPIRED status is assigned to requests that have not been completed within a predefined timeframe. This could occur if the user fails to provide the necessary information or complete the required steps within the specified timeframe. An expired request is no longer active; the user must initiate a new request to proceed with the onboarding process.

### FAILED

A request is marked as FAILED when the identification process cannot be completed due to technical errors.

### CANCELLED

The CANCELLED status occurs in different situations:

- when the user decides to cancel the identification request > This could happen for various reasons, such as the user no longer wishing to proceed with the onboarding process. In this case, the request is terminated at the user’s discretion.
- when an operator or system administrator cancels the identification request. This could be due to administrative reasons, such as detecting fraudulent activity, or operational decisions made by the onboarding team. The operator halts the request, and no further actions are taken.


These statuses provide a comprehensive view of the various stages an identification request can undergo in the Namirial Onboarding process.
By monitoring these statuses, businesses can effectively manage the onboarding workflow, address any issues promptly, and ensure a smooth and secure identification process for their users.