Onboarding Session Lifecycle
This is an explanation about the Onboarding Execution Life Cycle
The Incode Onboarding Session Lifecycle describes the main steps that are executed during an onboarding process to ensure a successful implementation.
- A New Onboarding Session is Created. A new onboarding session must be created for each onboarding attempt an end-user tries to execute.
- The end user executes Onboarding. The end user goes through the required verification modules on Incode's Webflow App or your web / mobile App powered by Incode's SDK and API.
- Add-on modules are executed (Optional) . Execute Add-on verification modules that may or not require end-user interaction.
- Session is marked as Completed. Once all the verification modules have been executed, the session must be marked as completed (a critical indicator of the conversion and completion metrics).
- Final Results & Onboarding Data fetch. You can get the final results (Scores) to make decisions and fetch the data collected during onboarding. There are two main options to get the results:
- Review and download results on the Omni Dashboard.
- Calling the Omni API from your backend. You can trigger this fetching process by notifying your backend from your Web/Mobile App (App Orchestration), or your backend could wait for the Incode Platform Webhook notification .
Onboarding Session Statuses
All Onboarding Sessions have a completion status. The Incode platform automatically manages this status, and it changes depending on which Incode Verification Modules are being executed during the Onboarding process.
Not all verification modules influence the session status.
The following diagram describes how the onboarding statuses change during the Onboarding lifecycle.
The possible onboarding statuses are the following.
UNKNOWN
: The initial status. Or no data has been collected yet.ID_VALIDATION_FINISHED
: The ID document validation process has finished. At this point, OCR data was extracted from the document, and a score for this module was calculated.POST_PROCESSING_FINISHED
: The ID postprocessing has finished; this status is used on particular implementations where extra data review is required.FACE_VALIDATION_FINISHED
: The face match process between the selfie captured and the photo from the ID document is finished. At this point, a score for this module was calculated.GOVERNMENT_VALIDATION_FINISHED
: The validation with a third-party source of truth has finished. At this point, a score for this module was calculated.ONBOARDING_FINISHED
: The onboarding process is finished, and the session is marked "Completed."MANUAL_REVIEW_APPROVED
: A session that was in a Needs Review state, was manually approved by an executive.MANUAL_REVIEW_REJECTED
: A session that was in Needs Review state, was manually rejected by an executive
ONBOARDING_FINISHED status
This is the status that indicates when an onboarding session is completed. This is an indicator that the scores and the onboarding data is available to fetch.
Getting the onboarding statuses
There are two ways to get the onboarding status of a specific onboarding session:
- Polling the Omni API endpoint
/omni/get/onboarding/status
to get the current status - Using the onboarding webhook notification.
Using one depends on the integration type, application architecture, and internal security policies.
Now that you know the foundations of an onboarding lifecycle, it is time to review the available options and guides toimplement your onboarding integration ↗.
Updated about 2 months ago