Namirial Onboarding API

Namirial Onboarding API Overview

Welcome to the Namirial Onboarding API documentation. Our API is designed to provide a seamless and efficient way to integrate our onboarding solutions into your systems.

We support non-breaking changes. A non-breaking change means that we can modify certain aspects of the API without affecting your existing integration. This ensures that your integration remains stable and functional even as we enhance and expand our API capabilities.

Examples of non-breaking changes include:

• Adding new response fields: New fields may be added to API responses, but existing fields will remain unchanged.

• Adding new response headers: Additional headers can be included in responses without impacting current functionality.

• Adding new endpoints and operations: New API endpoints or operations can be introduced to provide additional functionality.

• Adding new optional parameters in the requests: Optional parameters can be added to requests, allowing for more flexibility without requiring changes to existing requests.

• Changing the order of properties in existing API responses: The order of properties in responses may change, but the structure and content of the responses will remain consistent.

• Changing the length or format of strings and string-based IDs: Adjustments to the length or format of strings and IDs will be made in a way that does not disrupt existing integrations.

By supporting these non-breaking changes, we aim to provide a robust and adaptable API that evolves with product needs while ensuring a smooth and uninterrupted integration experience.

OpenAPI 3 support

We are committed to providing a modern and developer-friendly API experience, which is why we support OpenAPI 3. This specification allows for a standardized and comprehensive description of our API, making it easier for developers to understand and integrate with our services.

To maintain non-breaking changes, we avoid using ENUMs for strings with a limited set of values. Changing an ENUM would be a breaking change, whereas adding new values to a string is not. This approach ensures that our API remains flexible and backward-compatible, even as we introduce new features and enhancements. You can find this disclaimer in the section where we discuss supporting changes in strings.

Environments

Namirial Onboarding provides two distinct environments for API usage: a test environment and a production environment. These environments allow developers to safely test and deploy their integrations.

Test Environment

API URL: https://test.onboarding.namirial.app/api/v2
Dashboard URL: https://test.onboarding.namirial.app/webapp/it/backoffice/

Purpose: For integration, testing, and validation.

This environment is designed for developers to experiment and validate their integrations without affecting real data.
It simulates the production environment’s behavior, enabling comprehensive testing of API functionalities.
This is ideal for integration and to ensure that all API requests and responses work as expected.
Also the third party supplier software integrated in Namirial Onboarding are here available with their test/sandbox environments.

Production Environment

URL: https://eu-ie1-api.namirialonboarding.com/api/v2
Dashboard URL: https://dashboard.namirialonboarding.com/

Purpose: For live operations with real data.

The production environment is used for live operations and handles real user data. Once integrations are thoroughly tested and validated in the test environment, they can be deployed to the production environment for actual use. This environment ensures maximum security and reliability for onboarding operations.

Available APIs

Creation of an Onboarding Request

This set of API calls allows you to initiate a new onboarding request. It involves submitting the necessary customer information and documents required for verification. The API ensures that all data is securely transmitted and processed, adhering to compliance standards.

Please, refer to this page: Create a new request

Creation of Links Associated with a Request

Once an onboarding request is created, this set of API calls enables you to generate links associated with that request. These links can be used to direct customers to specific steps in the onboarding process. This functionality helps streamline the onboarding workflow and provides a seamless experience for the end-user.

Please, refer to this page: Create new links for a request

Retrieval of Onboarding Requests

This API allows you to list and retrieve detailed information about onboarding requests, ensuring secure and compliant data handling. Use it to manage and monitor the onboarding process efficiently.

Please, refer to this page: Retrieve info on requests

Webhook Configuration API Calls

APIs encompass a collection of calls specifically designed to assign webhook configurations to each workflow. These configurations enable you to define the destination URL for the webhook and the authentication method required for making requests to that URL. The supported authentication methods include client-based authentication and several options that use HTTP headers.

Please, refer to this page: Webhook settings

Start integrate fast thanks to a quick integration blueprint available here to enhance understanding and facilitate implementation.

If you have any questions or need further assistance, please refer to the detailed sections of this documentation or contact our support team.