Incode Onboarding
The Onboarding process is in the Incode Platform Context and its main components
About the process
The Incode Onboarding is a modular and fully configurable way to run an identity verification session in three well-defined moments:
- Setup and integrate Incode. Here, you can select one of the Incode integration types: No-code, Low-code, or Full SDK/API integration. In each integration type, you will configure your identity verification flow step by step, the behavior of each verification module and how the data will be processed.
- Create and execute Onboarding Sessions. Depending on the integration type, this is where end-users use your application to collect and validate data to calculate an identity verification score.
- Fetch data and validation results. Once the user finishes the identity verification, you can fetch all the collected data, images, and scores to make decisions or continue your onboarding process.
Core concepts
Onboarding Session.
An Incode Onboarding Session is the core entity of the Onboarding Process. It will be linked to all user data, images, scores, and events by a unique identifier called Session ID or interviewId
.
Session ID or interviewId
interviewId
The interviewId
or Session ID is an alphanumeric string that will be the unique Onboarding Session identifier.
This identifier will link all collected data, images, documents, scores, events, and metadata from the Onboarding Session and represents one person's identity verification process.
You may find "interviewId
" as a programming term, for example, used as a parameter for an endpoint request of the Incode Omni API. And "Session ID" is more often used in the context of the Incode Omni Dashboard. However, both terms refer to the same identifier.
Onboarding Attempt
An Incode Onboarding Session is created each time a user goes through a new process, regardless of whether the user completed or abandoned the onboarding. This means a new interviewId
must be created for each process.
Each onboarding opportunity is called an Onboarding Attempt. These are some considerations about attempts:
- Users can make multiple attempts using the same or different Incode Flow / Workflow.
- Each attempt has its score. This means the same person may have a different result for each attempt.
- Different Onboarding attempts may be "linked" to one person by an
externalCustomerId
.
Onboarding Session Metadata
It is possible to add metadata to an onboarding session; it could be done with the following options.
- External Customer Id.. A string value to store a unique identifier from an external system. For example, a user ID from your system.
- Custom Fields. A set of key-value pairs to associate metadata (strings, numbers, and boolean values) to an onboarding session.
How to create an Onboarding session
Depending on the type of integration, onboarding sessions can be created:
- Using Incode Flows and Workflows by providing the user a URL for an out-of-the-box web application.
- Using the Incode Omni API.
Verification Modules.
An Incode Verification Module is a specific step within the onboarding process. Each module may have different features and verifications, and depending on the module, this may generate a Score or Influence the total Onboarding Score.
Learn more about the Incode Verification Modules ↗.
Flows and Workflows.
The visual representation of the business logic for each verification step. Here, you select and configure the modules executed during the Onboarding. Learn more about Incode Workflows..
OCR Data.
All the data extracted by OCR from the documents provided by the user during the onboarding process. The resulting data depends on the provided document, for example, a two-sided ID card such as a driver's license, a residence ID, or a one-side passport.
Images.
These documents and face images are uploaded and linked to the Onboarding Session. There are three main types of images:
- Images from the front and back sides (if applicable) of an ID document.
- Face or "selfie" images.
- Documents images, such as Proof of Address documents.
An Onboarding session may have more than one image of the same type.
Scores.
These are the resulting values, the final validation status calculated for each verification module and for the Onboarding Session. The scoring system will determine whether the user's data is approved, rejected, or subject to manual review. Learn more about the scoring system.
Onboarding Session Lifecycle
The Incode Onboarding Session Lifecycle describes how the Session changes from creation to completion and all the statuses involved. Learn more about the Onboarding Session Lifecycle and how to use it in your integrations.
Updated 28 days ago