Key notions

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

Below, you will find the product namespace.

Request

In the context of Namirial Onboarding, a request is an instance created to initiate and manage the onboarding process for users. It contains all the necessary information and parameters required for the onboarding, such as personal details, identification documents, and other relevant data. Each request is uniquely identified and tracked through its lifecycle, from creation to completion, ensuring that all steps of the onboarding process are properly executed and recorded.

For a comprehensive exploration of the request lifecycle, please refer to the following page: Statuses of a request. This will provide a deep dive into the various stages and statuses involved.

The reference ID is an optional field of the request that maps to an identifier relevant to the integrator’s system. It is not used internally by Namirial Onboarding but helps the integrator track and manage requests within their own systems. Multiple requests can share the same reference ID, providing a way to group related requests together.

The idempotency key is an other optional parameter that ensures the request is processed only once, even if it is sent multiple times. If the endpoint receives a request with the same idempotency key within a specified period (typically 7 days), it will return the same response as the first time, preventing duplicate processing. This is particularly useful for retrying requests without the risk of creating duplicate entries.

Request type

A request type, on the other hand, defines the specific process and requirements for a particular kind of onboarding request. It includes predefined parameters and configurations that dictate how the onboarding should be conducted, such as the types of documents needed, the verification steps, and any specific rules or conditions. Request types ensure that each onboarding request follows a standardised procedure tailored to the specific needs of different onboarding scenarios.

The expiration of each request is determined by the settings of the request type, which are configured in the back office. This ensures that each request has a predefined timeframe within which it must be completed, providing a structured and time-bound process for onboarding.

A request type can support either a single actor or multiple participants. For instance, in some scenarios, multiple users may need to perform actions on the same request, such as providing additional information or completing verification steps. Additionally, an operator might be required to review, approve, or reject the onboarding request. Each participant involved in the process will receive a unique link to access and complete their part of the onboarding, ensuring that all necessary actions are coordinated and tracked efficiently.