Skip to content
Last updated

To enhance your understanding of the technical documentation, here are some fundamental takeaways regarding Namirial Onboarding.

Below is a comprehensive integration blueprint showing the architecture and flow of the Namirial Onboarding Suite.

Quick Integration Flow

The Namirial Onboarding process follows a structured 6-step journey from start to finish:

START
STEP 1: Setting up a notification channel
STEP 2: Create your first Namirial Onboarding request
STEP 3: Create a new access link
STEP 4: Put yourself in the user's shoes
STEP 5: Reap the rewards of your hard work
STEP 6: Verify almost there!
FINISH

Step 1: Setting up a notification channel

Ensure your server is listening

Begin by setting up webhooks to ensure your server can listen for notifications. This involves configuring your server to handle incoming requests from the Namirial Onboarding service, which will send real-time updates about the onboarding process, including status changes and completion notifications.

Step 2: Create your first Namirial Onboarding request

Create a request with preset data

Now it is possible to create a request in Namirial Onboarding. You have the flexibility to include pre-filled data in your request, which can be retrieved later. For instance, you may want to include a user's email address or phone number, simplifying the process. If you intend to integrate this into your site, you will also require the access link to check it out.

Optional: Create a new access link for the request you just created

Now you can choose whether to use the link that was provided when you created the request or generate a new one. You might be creating a new link and using a shorter expiry time from the original request, or you may want to share it with a different user. Either way, to integrate this into your site, you are going to use this link as a redirect.

Step 4: Put yourself in the user's shoes

Complete the onboarding process yourself

Once the request is created, proceed with the onboarding process and monitor the live notifications during your process through the webhooks you have already set up in the related properties.

Note: Monitor live notifications during onboarding to observe the flow of status updates and webhook callbacks. This will help you manage and anticipate the processes in a production environment.

Step 5: Reap the rewards of your hard work

Retrieve request data

At the end of the onboarding process, retrieve what data you stored and process the information from all the identification steps. The data structure includes capturing more information such as document types, timestamps, verification results, and other enriched data.

Note: The API will allow you to retrieve the details of a specific request as well as the corresponding verification data. Simply request the data after your user completes the onboarding process.

Step 6: Yuo're almost there!

Retrieve the list of identifications

At the end of the onboarding process, retrieve what data you stored and process the information. This includes gathering all relevant data and attachments generated during the process.

Note: Congratulations! Simply request the data returned via webhooks, or request them via API if you need to retrieve them later.