Connect to all finance institutions in Latin America

Welcome to Belvo's API

Belvo is an open banking and fiscal API for Latin America helping innovative companies to access banking and fiscal information in a secure and agile way.

To get up and running right away, follow our quick start guide.


Get started › Create account ›

Get your Belvo API keys

📘

In this section, you will learn how to create a Belvo account and how to get your API keys to start building on sandbox and production environment.

Before you start using Belvo products, you will have to create a Belvo account and generate a secret key.

Environments

Belvo is currently offering two environments:

Environment

Purpose

Registration URL

Sandbox

The sandbox environment is dedicated to test and development phases.
In this environment, you can create links without real credentials and you can pull test data from all endpoints.
⚠️ The sandbox environment is refreshed frequently and your test data can be updated or deleted.

Get your Sandbox API key from Belvo's dashboard.

Production

The production environment is dedicated to live applications with real connections to institutions.
In this environment, you will need real credentials to create links and you will pull real data from the institutions.

Register to production

To make the best use of those environments, we recommend the following steps of development:

  1. Test Belvo: Play with Belvo, discover the endpoints and the data you can access.
    The sandbox environment is perfect for this phase as you will not have to use real credentials to start pulling data.
  2. Build with Belvo: Integrate Belvo in your application and start adding Belvo endpoints in your customer journey.
    You can use a mix of the sandbox and production environments depending on the phase of development and the tests you want to perform.
  3. Release to your customers: Release your Belvo integration to your customers.
    You must use the production environment in this case.

You will have to register to each environment in order to generate your keys.

Step 1: Register to Belvo

Create your account

You can register to Belvo by creating an account in our production environment

Confirm your email

Once you have registered, you will receive an email from us to confirm your email address.
Check your inbox and click in the confirmation link to complete the registration.

Confirm your email

John Doe, you are about to access Belvo.
But before that, we need you to confirm your [email protected] email address.

[I am the owner of this email]

Access the dashboard

After confirming your email address you will automatically be redirected to Belvo's dashboard. Here you will be able to generate your API secret keys, setup Belvo account, contact our support team and see your activity logs.

Step 2: Generate your secret key

Before using Belvo products, you need to create a secret key.
Navigate to the Summary section of the dashboard and expand the Secret key section. If it is the first time it will generate the key for you and show:

  • secretId
  • secretPassword

The secretId and secretPassword are the two values you need to query Belvo products.

❗️

Secret Key

For security reasons we will only show the secretPassword once in the dashboard after the generation. You will also receive an email with both secretId and secretPassword. Make sure you store it securely to be able to retrieve it later.

As soon as the key is generated, you will also receive an email with your new secret key.

Hello from Belvo! Here is your new secret key.

ALIAS:    production
ID:       485bb7e2-c7b1-4971-936c-42fe1ecea0aa
PASSWORD: OR6ngEaMIQ-AxV#[email protected]#N4OXVax1SlAIrnuwa

Thank you for using Belvo!

Step 3: Test your keys

To check that your integration is working correctly, you can make an API request using your API key to list Belvo's supported institutions.

curl -u [Secret Key ID]:[Secret Key PASSWORD] https://api.belvo.co/api/institutions/
curl -u [Secret Key ID]:[Secret Key PASSWORD] https://sandbox.belvo.co/api/institutions/

You should receive a response from Belvo with the list of all supported institutions.

{
    "count": 10,
    "next": null,
    "previous": null,
    "results": [
        ...
        {
            "name": "banamex_mx_retail",
            "type": "bank",
            "website": "https://www.banamex.com/",
            "display_name": "Citibanamex",
            "country_codes": [
                "MX"
            ],
            "primary_color": "#056dae",
            "logo": "https://belvo-api-media-sta.s3.amazonaws.com/logos/citibanamex_logo.png",
            "form_fields": [
                {
                    "name": "username",
                    "type": "text",
                    "label": "Client number"
                },
                {
                    "name": "password",
                    "type": "password",
                    "label": "Key BancaNet"
                }
            ]
        },
        ...
    ]
}

Now you are all set and can start using our API 🎉

Updated 3 days ago



Get your Belvo API keys


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.