Concepts

Onboarding Session

In the Incode Omni Platform, a session is a crucial framework that outlines the entirety of an end-user's journey through the identity verification process. This journey commences when the user initiates the onboarding process, guiding them through a series of steps to capture and upload images of their identification documents and their selfie. The session encompasses this entire interaction, from start to finish, ensuring a seamless flow for collecting necessary verification information. The completion of the session signifies that all required steps have been successfully navigated by the user, marking the end of their active engagement in the verification sequence. The session is considered complete once the user reaches the result node in the workflow.

When an onboarding session is initiated on the Incode platform, it is assigned a unique identifier known as the interviewId. This identifier is crucial as it not only links to the specific onboarding session but also serves as a session ID in the Omni Dashboard, where it can be used to search and filter sessions.

Onboarding Session Metadata

Adding metadata to an onboarding session enhances its traceability and integration with external systems. This can be achieved through two primary options:

• External Customer Id: This identifier links the onboarding session to an entity in an external system not part of the Incode Omni Platform. It could represent a prospect Id or a customer Id from the client's database, providing a bridge between the Incode session and the client's internal user management systems.
• Custom Fields: These are key-value pairs that allow for the inclusion of additional metadata within an onboarding session. They offer flexibility in tagging and categorizing sessions with custom data points, which can be later retrieved via API, facilitating advanced data analysis and session management.

How to Create an Onboarding Session

Creating an onboarding session is straightforward and involves utilizing the [/omni/start](https://developer.incode.com/docs/single-onboarding) API endpoint. This action generates the InterviewId, associating it with the new onboarding session. This ID is pivotal for future references to the session, whether for tracking its progress, fetching its results, or integrating session data with external systems.

Workflows

Workflows is a dynamic platform designed to streamline the process of customer verification through a customizable, visual interface. This platform enables admins to easily specify the sequence of verification modules and introduce conditional logic for branching user journeys, facilitating a tailored experience for end-users without the need for coding.

For detailed guidance on creating and testing a workflow, refer to the Workflows chapters of this guide. These sections will provide step-by-step instructions on how to create a workflow, review session results and integrate into your platform.