Workflow Sessions

Represents a single instance of a workflow run by a client.

A Workflow Session represents a single execution of a predefined Workflow Template. It encapsulates the full verification process for a given client, including all the checks performed, data captured, and rules applied.

They serve as the primary resource for tracking status, outcomes, and results of a workflow run.

Each session is uniquely tied to a workflow run and contains:

• The list of executed checks

• All input and captured data (e.g., data, images)

The workflow sessions API allows you to run and retrieve workflow sessions. You can retrieve a specific workflow sessions as well as a list of all your client's workflow sessions.

The Workflow Session object

Attribute	Type	Description
id	string	The unique identifier for a workflow session.
clientId	string	The ID of the client associated with the workflow session.
entityName	string	The full name of the client. This will be auto-generated.
status	string	Indicates the current status of the workflow session. The session's status evolves as the client progresses through the session. Values can be: started - the session has been started by the client. processing - the client has completed the flow and the verification checks are currently being processed. complete - the session has completed. abandoned - the session was initiated but left incomplete and inactive for an extended period. cancelled - the session was cancelled before completion.
workflowTemplateId	string	The ID of the workflow template used by the workflow session.
workflowTemplateName	string	The name of the workflow template.
workflowTemplateDescription	string	The description of the workflow template.
workflowId	string	The ID of the workflow version used by the workflow session.
workflowVersion	number	The workflow version.
workflowDescription	string	The description of the workflow version.
compliancePolicies	array[object]	The list of compliance policies enabled for the workflow session.
outcome	string	The overall outcome of all the checks run within the workflow session. This will only have a value when all the checks are complete. Values can be: clear: Indicates every check returned a successful result. attention: Indicates one or more of the checks require attention. rejected: Indicates one or more checks were rejected.
allRelatedChecks	array[object]	The list of checks or verifications executed as part of this workflow session. Also, see the allRelatedCheck object below.
policyAssurance	array[object]	The detailed outcome of all compliance policies as evaluated against the data and checks within the workflow session.
tasks	array[object]	The tasks that define the structure and execution flow of the workflow session.
lastCompletedTaskId	string	The ID of the most recently completed task within the workflow session.
createdAt	string	The date and time when the workflow session was created.
completedAt	string	The date and time when the workflow session was completed.
updatedAt	string	The date and time when the workflow session was last updated.

The allRelatedCheck object

Attribute	Type	Description
checkId	string	The ID of the check created as part of this workflow session.
type	string	The type of check created as part of this workflow session.
taskId	string	The ID of the task within the workflow session that initiated the creation of the check.