> ## 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 Retrieve available identity providers. List mode (default): with no inputs supplied, returns the full list of providers licensed for this account. The 'licensed' configuration filter applies to this mode only. Recommend mode: when any of the optional inputs (country, state, phone) is supplied, returns a ranked recommendation instead — recommended providers first, then the remainder, with per-tier counts in result.note.providerTiers (\{recommended, remainder}). Results are scoped by the verification profile rather than the 'licensed' filter. The end user's session IP, when available, enriches the recommendation but never triggers it. Inputs are read from the subject context (API payload or upstream modules) — the variant renders no end-user input form. The phone signal must be E.164 format (leading +); national-format numbers are ignored. Credentials: the Verification Profile Id field is enforced at runtime only in recommend mode (when country/state/phone inputs are present) — update stored credentials before enabling recommendation inputs. The credential form's required marking is a Designer-time aid; journeys created via the API rely on the runtime guard. Output: the provider list is written to result.note.providers; downstream modules read it via context.process.flow\.DigitalId\_ProviderSelector.result.note.providers. This page documents the **Digital Identity** module, including its variants, capabilities, and the result values it returns. ## 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. 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. ## Capabilities ### Status Indicates the current state of the session generation process | Value | Description | | ---------- | ---------------------------------------------- | | `complete` | Session was generated successfully | | `error` | An error occurred during session generation | | `pending` | Session generation is in progres | | `timeout` | Session generation took too long and timed out | ## Capabilities ### Status Indicates the current state of the digital ID verification process | Value | Description | | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | | `Successful` | Session has been completed successfully | | `Canceled` | Session has been canceled | | `UserAbandoned` | User abandoned the session | | `UserTimedOut` | User took too long to complete the verification | | `Expired` | Session has expired | | `InvalidImage` | Image(s) provided for this verification were either too low-quality, not of the correct type, or otherwise unable to be processed | | `Inauthentic` | Identity data/images provided are suspected to be inauthentic, fraudulent, or forged | | `UnsupportedDocument` | Document provided is either of an unsupported type, or from an unsupported country | | `AssuranceLevelNotMet` | User's identity does not meet the required assurance level for this verification | | `Other` | Session was not completed successfully | | `PollingExhausted` | Results were still pending when the polling attempt limit was reached; the user did not complete the verification within the polling window | | `TimedOut` | Results were still pending when the step's configured timeout (iSO8602TimeoutDuration) elapsed, before the polling attempt limit was reached | ## Capabilities ### Status Indicates whether the provider list was successfully retrieved from Trinsic | Value | Description | | --------- | ----------------------------------------------------------- | | `SUCCESS` | Provider list retrieved successfully | | `ERROR` | API call failed or an unexpected error occurred | | `TIMEOUT` | Request to Trinsic timed out before a response was received | ## Input payload The following is a sample payload used to submit data to the **Digital ID Provider Selector** module for processing. ```json JSON theme={null} { "context": { "config": { "iSO8602TimeoutDuration": "PT30S", "licensed": true }, "subject": {} } } ``` ## Sample response The following is a sample response returned by the module. ```json JSON theme={null} { "response": { "advice": { "status": "SUCCESS" }, "outcome": "Providers Retrieved" } } ```