> ## Documentation Index
> Fetch the complete documentation index at: https://docs.go.gbgplc.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Digital Identity

Initiate a Digital ID verification session and obtain a launch URL to authenticate a user's identity via a hosted user interface

This page documents the **Digital Identity** module, including its variants, capabilities, and the result values it returns.

## Digital Identity: Digital ID Launch Session

### Capabilities

The module returns the following capabilities.

#### Status

Indicates the current state of the session generation process

| Code       | Label    | Description                                    |
| ---------- | -------- | ---------------------------------------------- |
| `complete` | complete | Session was generated successfully             |
| `error`    | error    | An error occurred during session generation    |
| `pending`  | pending  | Session generation is in progres               |
| `timeout`  | timeout  | Session generation took too long and timed out |

### Default outcomes

The module is pre-configured with the following default outcomes, which can be used in evaluation and routing logic within the journey designer.

| Outcome            | Condition                           | Description                                     |
| ------------------ | ----------------------------------- | ----------------------------------------------- |
| `Session Failed`   | default, when no conditions matched | The session did not complete successfully.      |
| `Session Launched` | Status isAnyOf `complete`           | The session was launched successfully.          |
| `ERROR`            | Default (no conditions matched)     | An unexpected error occurred during processing. |

### Input payload

The following is a sample payload used to submit data to the **Digital ID Launch Session** module for processing.

## Digital Identity: Digital Identity Results

Retrieve the results of the digital identity verification upon completion

### Capabilities

The module returns the following capabilities.

#### Status

Indicates the current state of the digital ID verification process

| Code                   | Label                | Description                                                                                                                       |
| ---------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| `Successful`           | Successful           | Session has been completed successfully                                                                                           |
| `Canceled`             | Canceled             | Session has been canceled                                                                                                         |
| `UserAbandoned`        | UserAbandoned        | User abandoned the session                                                                                                        |
| `UserTimedOut`         | UserTimedOut         | User took too long to complete the verification                                                                                   |
| `Expired`              | Expired              | Session has expired                                                                                                               |
| `InvalidImage`         | InvalidImage         | Image(s) provided for this verification were either too low-quality, not of the correct type, or otherwise unable to be processed |
| `Inauthentic`          | Inauthentic          | Identity data/images provided are suspected to be inauthentic, fraudulent, or forged                                              |
| `UnsupportedDocument`  | UnsupportedDocument  | Document provided is either of an unsupported type, or from an unsupported country                                                |
| `AssuranceLevelNotMet` | AssuranceLevelNotMet | User's identity does not meet the required assurance level for this verification                                                  |
| `Other`                | Other                | Session was not completed successfully                                                                                            |

### Default outcomes

The module is pre-configured with the following default outcomes, which can be used in evaluation and routing logic within the journey designer.

| Outcome        | Condition                                                                                                                            | Description                                            |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------ |
| `Not Verified` | Status isAnyOf `Canceled,UserAbandoned,UserTimedOut,Expired,InvalidImage,Inauthentic,UnsupportedDocument,AssuranceLevelNotMet,Other` | The subject could not be verified.                     |
| `Verified`     | Status isAnyOf `Successful`                                                                                                          | The subject was successfully verified.                 |
| `Error`        | default, when no conditions matched                                                                                                  | An error prevented the module from returning a result. |

### Input payload

The following is a sample payload used to submit data to the **Digital Identity Results** module for processing.