Session Data

Introduction

During the verification process, data is accumulated from the end user and stored as Process Instance variables or Session Data. This data is created after the execution of a Process. The data will be stored at the end of the Process.

The general structure of the data is as follows:

• _faces
• _idDocs
• _checks
• _additionalDocs
• _customFormData
• _initVars

Faces

During the face capture process, data is collected depending on the number of actions that are performed during the Identity Verification process. This data is collected in the top level Face object.

Face data is stored under a key so that the data related to a face can be referenced elsewhere. For example, in decision gateways, webhooks or cloud functions. See Capture Face Image for more information.

For full description of the data available, see Face Session Data Tables.

ID Document

Front and back ID document data is captured during the ID&V process. This data is collected in the top-level idDocs object.

The Document data structure contains many levels of data due to the complexity of supporting multiple capture attempts as well as capturing multi-page documents.

Document data is stored under a key so that the data related to a face can be referenced elsewhere. For example, in decision gateways, webhooks or cloud functions. See Capture Document Image - Front and Capture Document Image - Back for more information.

For full description of the data available, see Document Session Data Tables.

Checks

As part of a typical flow a number of checks are performed. For example, typically as as part of and ID&V flow, face liveness is performed at the time of capture. The checks data structure is used to expose the outcome of these checks.

Checks are recorded in the _checks variable within the session data. Each check will contain an outcome - values include: PASS | FAIL | N/A | INDETERMINATE.

The Outcome of a check is useful for making decisions and updating the current flow. For example, after a liveness check is performed, the process can be directed depending on this Outcome value:

For full description of the data available, see Check Session Data Tables.

Additional Documents

Additional Documents allow users to define and collect non-identity and non-government documents from the end customer. The data captured from these documents can be accessed via the _keyedAdditionalDocs variable.

For a full description of the data available, see the _keyedAdditionalDocs Table.

Custom Form Data

Custom Forms allow users to create a form with custom fields that can be introduced to the ID&V flow using the Process Designer. Data captured from the form can be accessed in the _customFormDatavariable.

For a full description of the data available, see the Custom Form Data tables.

Initial Variables

Initial Variables can be included as part of the Process Token creation as Additional Parameters (see Generate a Token). The captured parameters will be recorded in the _initVars variable. This is a key:value pair where each represents the additional parameters defined as part of the Process Token.

For a full description of the available data, see Initial Variables Data Table.