About us
Open side menu

Integrating with Narvi's Backend API

Welcome to Narvi's Backend API integration guide! Here, you'll find all the information you need to seamlessly integrate with our backend using our REST API and our dedicated Node.js integration library.

Table of Contents
  1. Introduction

  2. REST API Documentation

  3. Node.js and Python Integration Libraries

  4. Getting Started

  5. Authentication and API key generation

  6. API Endpoints

  7. How to limit access to your accounts

  8. Support

Useful Links

REST API Documentation

Node.js Integration Library

Python Integration Library

API Settings in Narvi's Banking App

Integrating with Narvi's Backend API

1. Introduction

Narvi provides a powerful backend API that allows you to access and manipulate your data within our platform. Whether you're building a web application, mobile app, or integrating with other systems, our API makes it easy to leverage Narvi's capabilities in your projects.

2. REST API Documentation

Our REST API documentation serves as a comprehensive resource for developers. You can access it here. The documentation provides detailed information on available endpoints, request parameters, response formats, and usage examples.

3. Node.js and Python Integration Libraries

For Node.js and Python developers, we offer a dedicated integration libraries. Those libraries streamlines the integration process, making it even more straightforward to interact with Narvi's backend. You can find the libraries here.

4. Getting Started

To get started with Narvi's API integration, follow these simple steps:

  1. Sign up for Narvi: If you haven't already, sign up for an account at Narvi.

  2. Review Documentation: Familiarize yourself with our API by exploring our REST API documentation.

  3. Install the Node.js Library: If you're using Node.js, install our integration library from npm using the command "npm install narvi"

  4. Authentication: Ensure you have the necessary API credentials for authentication.

5. Authentication and API key generation

Authentication is a crucial step in interacting with Narvi's Backend API. To ensure the security of your data and API access, we use API keys and private keys that are generated within your Narvi account.

Here's how the authentication process works:

  1. Sign in to your Narvi account: Log in to your Narvi account at my.narvi.com.

  2. Generate API key: To generate API keys in the app, click the company name in the top right corner, then select "Settings" and go to the "API" tab. You can can also use this link. These keys will be used for authentication in your application.

    Important: API key grants the exact access and permissions that your user profile possesses within our web application. This means it grants access to all your entities and iban accounts.

  3. Securely store your keys: Once generated, ensure that you securely store your API keys and private keys. These keys are sensitive and should not be shared publicly.

  4. Use your API key for integration: Read the docs listed above to see how to use your API key and private key to integrate your application, either directly connecting to our REST API, or by using provided node.js Narvi library.

By following this authentication process, you'll have secure access to Narvi's Backend API, allowing you to interact with our platform and access your data seamlessly.

If you encounter any issues with authentication or need assistance in generating and managing your API keys and private keys, please don't hesitate to reach out to our support team at support@narvi.com.

Your security and data protection are our top priorities, and we're here to help you maintain the integrity of your Narvi integration.

6. API Endpoints

Narvi's API offers a wide range of endpoints for different functionalities, including account management, data retrieval, transaction creation, and more. Refer to our documentation for a complete list of endpoints and their use cases.


7. How to limit access to your accounts

If you want to grant access to a specific business entity or limit access levels, follow these steps:

  1. Invite your developer as a Team Member: Detailed instructions can be found in our multi-user guide.

  2. Assign Access Levels: Viewers and Preparers can generate API keys for read-only access, while Admins can create API keys with write access.

  3. Developer's API Keys: Your developer can then generate their API keys by following the instructions in point 5 of this documentation.

8. Support

We're here to help you every step of the way. If you have any questions, encounter issues, or need assistance with your integration, don't hesitate to reach out to our support team at support@narvi.com.

Thank you for choosing Narvi for your backend integration needs.

We look forward to seeing the amazing applications you'll create using our API and Node.js integration library. Happy coding!