API Reference Introduction

What is Open Data API?

The Khipu Open Data API enables access to our services in a programmatic way, exposing data in a well defined and consistent format. You can consume this API to develop integrations with multiple data sources using the REST pattern, expecting resource-oriented URLs and JSON-encoded responses, with standard HTTP response codes and authentication methods.

You can use either an individual API key, or create an OAuth JWT to access the resources in a secure manner. Both methods are explained in the Authentication section.

All our APIs are built using the OpenAPI specification for the service definitions, so the interaction with the methods is uniform and the interfaces are known in advance.

Use cases

Khipu's APIs provide a set of services that allows developers build innovative solutions using real time data, integrating information from diverse sources using a simple standard. You can create valuable products with this tools, such as:

Access financial data in real time

You can have an immediate view of your finances by accessing your up-to-date daily transactions for all your bank accounts and then create a dashboard showing the evolution of your incomes and expenses.

Enrich existing data

You can enrich data coming from another system with the precise detail of the underlying transaction and always have a correct picture of your movements (such as sales, for instance).

Discover insights from your finances

Being able to access historic financial statements, you can have a deeper view to all of your movements, identifying income sources, expenses and create your own analytical solutions.

Automate workflows

You can schedule your program to fetch data periodically and build a timeline with all the necessary data points.

How this site is organized

This documentation portal is aimed at developers seeking to get familiar with our REST API by making specific requests using Postman calls or our "Try it" functionality, but also is useful to help you enhance existing solutions, providing code snippets in a set of popular programming languages that serve as a starting point.

On the left, you have a sidebar with all the relevant options to navigate this site, like our Quick start guide or the Authentication process, and direct access to the OpenAPI reference. Those definitions are grouped by geographic regions and according to the business logic involved, like Banking.

The center panel is the main container for the section of the site you're visiting, and in the case of OpenAPI definitions you will have a console with the "Try it" panel and the request and response samples. See picture below.

site content

Finally, at the top right there is a search box that allows you to quickly find a specific method or any section of the site.