Namirial Onboarding - Documentation

How to Use the Namirial Onboarding Documentation

The Namirial Onboarding documentation is designed to provide a comprehensive guide for developers to effectively integrate and utilize the onboarding APIs. It begins with a Technical Overview, which introduces key concepts and the various statuses a request can have during its lifecycle. This foundational knowledge is crucial for understanding the overall onboarding process and how different components interact.

The core of the documentation is the Namirial Onboarding API section, which details the API endpoints and their usage. This section covers everything from creating new onboarding requests, both with and without preset data, to generating new links for requests. It also explains how to retrieve information on requests, including listing all requests and obtaining detailed information about specific ones. Additionally, it provides guidance on configuring webhooks for request types, including creating, retrieving, and deleting webhook settings.

Finally, the documentation includes a Workflows section, which outlines various onboarding scenarios supported by Namirial Onboarding. Each workflow is described in detail, providing step-by-step instructions to ensure a smooth and efficient onboarding process. By following this structured documentation, developers can easily find the information they need, ensuring that all API interactions are secure, compliant, and effective.