Explain what is an onboarding

Introduction to Status Codes

Session status codes, also commonly called onboarding statuses, are flags that tell you when certain operations of the flow are complete and the data is ready to be fetched. For example, once you receive the ONBOARDING_FINISHEDstatus, you can safely fetch any data that was collected during the user's onboarding session. Similarly, once you receive theFACE_VALIDATION_FINISHED or any status suffixed with FINISHED you can safely fetch the data associated with those modules. The possible onboarding statuses include:

• ID_VALIDATION_FINISHED: User completed capturing the ID document
• POST_PROCESSING_FINISHED: ID postprocessing completed on the server
• FACE_VALIDATION_FINISHED: User completed the selfie capture
• GOVERNMENT_VALIDATION_FINISHED: User completed government validation
• ONBOARDING_FINISHED: User completed the onboarding process
• 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
• UNKNOWN: Unable to determine the status of the onboarding session
  • This occurs when a user hasn't started the onboarding or the user is still in the process of capturing their ID

Webhooks

Webhooks are the recommended way to receive automatic updates for onboarding status changes as well as status changes for other services (see below). As a user progresses through a flow, a webhook notification will be sent to the server URL specified in the configuration tab of the dashboard. To configure the URL that the webhook payload will be delivered to navigate to the Dashboard then select: Configuration -> Webhooks -> ONBOARDING STATUS WEBHOOK URL. Once your URL is pasted into the text box, click Update webhooks for the changes to take effect. In addition to providing webhooks for onboarding statuses, we also provide webhooks for the following services:

• INE SCRAPING WEBHOOK URL (OPTIONAL): INE (Mexico) government verification
• AUTHENTICATIONS WEBHOOK URL: Face authentication of a successfully onboarded user
• VIDEO SELFIE UPLOADED WEBHOOK URL: Events pertaining to the Video Selfie module
• WATCHLIST UPDATE WEBHOOK URL (OPTIONAL): Events pertaining to the Watchlist module and continuous watchlist updates
• WORK HISTORY CALLBACK URL (OPTIONAL): Events pertaining to the work history verification service
• PAYMENT PROOF CALLBACK URL (OPTIONAL): Events pertaining to the payment proof service

The Webhook Custom Headers are optional, but they are available necessary to receive the webhook payload at your server address. For a technical overview of our webhooks see the next page.

Polling

An alternative to webhooks is to use polling. Polling is only available for fetching an onboarding status. For the other services listed under the webhooks section you will need to utilize our webhooks. Polling isn't recommended since it requires continuous API calls to check the status of an onboarding session, however if it is necessary for your integration you can poll for the onboarding status using this endpoint. If you only want to know when the data is done processing, call this endpoint.