Belvo API Docs (1.218.0)

Introduction

Reach new audiences and convert more users by easily and safely connecting to their financial data, understanding their behavior and enabling instant payments with open finance. Through our API, you can access:

Available Information and Payment Methods

Belvo is an open banking API for Latin America that allows companies to access banking and fiscal information in a secure as well as agile way.

Through our API, you can access:

  • Banking Information in Brazil
  • Employment Information in Brazil
  • Employment Information in Mexico
  • Fiscal Information in Mexico
  • Fiscal Information in Chile

You can also use our API to make payments in:

  • Brazil
  • Mexico

Data Dictionaries

If you woud like the response documentation in Excel or CSV form, please download them from our public GitHub Reposiitory: Belvo Open Finance Data Dictionaries.

Our EXCEL and CSV files are additionally localized into Spanish and Portuguese (Brazil).

Environments

We currently offer two environments: sandbox and production.

Sandbox

Available for:

  • 🟢 Aggregation and Enrichment
  • ⚪️ Payment Initiation

Use our Sandbox environment to build your integration. We offer dummy data that mimics that of real-world use cases, which means you can test out all the endpoints, use the widget, and implement webhooks - just as you would with real-world data!

All you need to get started with the Sandbox environment is to get your API keys. We really recommend that you start creating your integration in this environment.

Production

Available for:

  • 🟢 Aggregation and Enrichment
  • 🟢 Payment Initiation

After you have tested your integration in the Sandbox environment and are ready to go live, you'll need to request access to our Production environment. After you request access, our Sales Team will get in contact with you to schedule a meeting just to ensure your needs are met, and then you'll just need to go through a certification process with one of our engineers to make sure that your integration is running optimally. To prepare for the certification meeting, just follow our Integration checklist.

Once your integration is certified, all you'll need to do is:

  • Request Production API keys (and change your Sandbox API keys in the code to these new ones).
  • Change the base URL that you make requests to from sandbox.belvo.com to api.belvo.com.
  • If you're using webhooks, make sure to set a Production URL for your webhooks.

Response codes

We use the following HTTP status code in the response depending on the success or failure:

Status CodeDescription
200✅ Success - The content is available in the response body.
201✅ Success - The content was created successfully on Belvo.
204✅ Success - No content to return.
400❌ Bad Request Error - Request returned an error, detail in the content.
401❌ Unauthorized - The Belvo credentials provided are not valid.
404❌ Not Found - The resource you try to access cannot be found.
405❌ Method Not Allowed - The HTTP method you are using is not accepted for this resource.
408❌ Request Timeout - The request timed out and was terminated by the server.
428❌ MFA Token Required - MFA token was required by the institution to connect.
500❌ Internal Server Error - The detail of the error is available in the response body.

Error handling

Belvo API errors are returned in JSON format. For example, an error might look like this:

[
    {
      "request_id": "a6e1c493d7a29d91aed4338e6fcf077d",
      "message": "This field is required.",
      "code": "required",
      "field": "link"
    }
]

Typically, an error response will have the following parameters:

  • request_id: a unique ID for the request, you should share it with the Belvo support team for investigations.
  • message: human-readable description of the error.
  • code: a unique code for the error. Check the table below to see how to handle each error code.
  • field (optional): The specific field in the request body that has an issue.

Request identifier

When you need help with a specific error, include the request identifier (request_id) in your message to the Belvo support team. This will speed up investigations and get you back up and running in no time at all.

Error codes and troubleshooting

For a full list of errors and how to troubleshoot them, please see our dedicated Error Handling article.

Retry policy

50x errors

Implement an automated exponential backoff of up to five retries. We recommend using a base interval of three seconds with a factor of two. For example, the first retry should be after three seconds, the second retry after six seconds (2 * 3), the third retry after 12 seconds (2 * 6), the fourth retry after 24 seconds (2 * 12), and the fifth retry after 48 seconds (2 * 24).

40x errors

You should not retry making requests if you receive a 40x response, as this is a client error.

The only exception is the “Too Many Sessions” error, as it means that your end-user is accessing the account from another browser at the same time. In this case, please implement the same retry policy as with 50x errors.

Deprecated fields

In our schema, you may see that a field has been marked as deprecated. This means that this field is no longer maintained by the Belvo team. You may still receive data for this field depending on the institution, however, you should not rely on this field.

OpenAPI: required and nullable fields

In our API specification, you'll see that some response parameters will have a required annotation. According to the OpenAPI specification, when a response parameter is marked as required, this means that the response key must be returned. However, the value of that response parameter can be null.

📘 Info

In short, any response parameter marked as required will be returned by our API, but the value can be set to null.

Download OpenAPI description
BelvoOpenApiSpec.json
BelvoOpenApiSpec.yaml
Overview
URL

https://developers.belvo.com

Need help?

support@belvo.com

Languages
Servers
Mock server

https://developers.belvo.com/_mock/apis/belvoopenapispec/

Sandbox

https://sandbox.belvo.com/

Institutions

An institution is an entity that Belvo can access information from. It can be a:

  • bank institution, such as Nubank Brazil.
  • fiscal institution, such as the Servicio de Administración Tributaria (SAT) in Mexico.
  • employment institutions, such as Instituto Mexicano del Seguro Social (IMSS) in Mexico or Instituto Nacional do Seguro Social (INSS) in Brazil.
Operations

Links

A Link is a set of credentials associated to an end-user's access to an institution. You will need to register a Link before accessing information from that specific end-user, such as account or transaction details.

We recommend using the Belvo Hosted Widget to manage the connection process.

Operations

Widget Access Token

Operations

Consents

A consent is a permission given by the end user to access their financial data in the Open Finance Network in Brazil.

Operations

Owners

An owner represents the person who has access to a Link and is the owner of all the accounts inside the Link.

You can use this endpoint in order to get useful information about your client, such as:

  • their full name
  • key contact information
  • information about the ID document they used when opening the account
Operations

Accounts

An account is the representation of a bank account inside a financial institution. A user can have one or more accounts in an institution.

For example, one user (or link) can have a checking account, several credit cards, and a loan account.

Querying for a user's account information is useful as you can get information regarding:

  • what types of accounts the user has.
  • the balance for each account (savings, checking, credit card, loan, and so on).
  • detailed information regarding their credit card spending.
  • the current situation of any loans they may have.
Operations

Balances

A balance is the amount of money available in a given bank account (checking or savings) at a given time.

Operations

Transactions

A transaction contains the detailed information of each movement inside an account. For example, a purchase at a store or a restaurant.

Operations

Bills

A bill refers to the credit card bill a user receives for a given account.

Operations

Investments Brazil

Operations

Investment Transactions Brazil

Operations

Employments Brazil

Our employments resource for Brazil lets you get a comprehensive view of your user's current employment history and salary information.

For each user, we return the:

  • work history (including occupations and employer data)
  • historical and current salary information (per employer)

At the moment, the employments resource is available for:

  • 🇧🇷 Brazil (INSS)
Operations

Employment Records Mexico

Our employment records resource for Mexico lets you get a comprehensive view of your user’s current social security contributions and employment history.

With Belvo's employment records resource for Mexico, you can access information about your user's current social security contributions and employment history. For the each user, we return the:

  • personal data
  • work history
  • historical and current daily base salary
  • and more!

At the moment, the employment records resource is available for:

  • 🇲🇽 Mexico (IMSS)
  • 🇲🇽 Mexico (ISSSTE)
Operations

Employment Record Object (Mexico)

Employment record response payload

idstring(uuid)

Belvo's unique identifier for the current item.

Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"
linkstring or null(uuid)

The link.id the data belongs to.

Example: "30cb4806-6e00-48a4-91c9-ca55968576c8"
created_atstring(date-time)

The ISO-8601 timestamp of when the data point was created in Belvo's database.

Example: "2022-02-09T08:45:50.406032Z"
collected_atstring(date-time)

The ISO-8601 timestamp when the data point was collected.

Example: "2022-02-09T08:45:50.406032Z"
report_datestring(date)

The date when the employment record report was generated, in YYYY-MM-DD format.

Example: "2023-01-19"
internal_identificationstring

Unique ID for user according to the institution. For IMSS and ISSSTE Mexico, this is the CURP.

Example: "BLPM951331IONVGR54"
personal_dataobject

Details regarding the personal information of the individual.

social_security_summaryobject or null

Details regarding the individual's social security contributions, according to the IMSS.

Note: For ISSSTE Mexico, this value will return null.

employment_recordsArray of objects

Details regarding the individual's employment history.

employment_scoresArray of objects or null

An array of employment_record scores. Each score provides an insight into employability and income generation potential in a given period.

Note 1: This field is only available for links created with Mexico's IMSS. For other institutions, this field will return null.

Note 2: This field will return null for employment records retrieved before 16-04-2024. For employment records generated before 16-04-2024, you'll need to make a new POST request to retrieve employment records to calculate the scores.

Example: [{"score":722,"period":3,"version":"1.0.0"},{"score":612,"period":6,"version":"1.0.0"},{"score":570,"period":12,"version":"1.0.0"}]
filesArray of objects or null

Additional PDF binary files relating to the individual's employment.

{
  "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
  "link": "30cb4806-6e00-48a4-91c9-ca55968576c8",
  "created_at": "2022-02-09T08:45:50.406032Z",
  "collected_at": "2022-02-09T08:45:50.406032Z",
  "report_date": "2023-01-19",
  "internal_identification": "BLPM951331IONVGR54",
  "personal_data": {
    "official_name": "Bruce Banner del Torro",
    "first_name": "Bruce",
    "last_name": "Banner del Torro",
    "birth_date": "2022-02-09",
    "entitlements": { … },
    "document_ids": [ … ],
    "email": "bruce.banner@avengers.com"
  },
  "social_security_summary": {
    "weeks_redeemed": 0,
    "weeks_reinstated": 0,
    "weeks_contributed": 188
  },
  "employment_records": [
    { … }
  ],
  "employment_scores": [
    { … },
    { … },
    { … }
  ],
  "files": [
    { … }
  ]
}

List employment records

Request

▶️ Usage

With the List Employment Records method, you can:

  1. List employment records related to a specific link.id (using the link query parameter).
  2. Get the details of a specific employment-record.id (using the id query parameter).
  3. [Not Recommended] List all employment records related to your Belvo account (without using any query parameters).

📖 Pagination

This method returns a paginated response (default: 100 items per page). You can use the page_size query parameter to increase the number of items returned to a maximum of 1000 items. You can use the page query parameter to navigate through the results. For more details on how to navigate Belvo's paginated responses, see our Pagination Tips article.

🔦 Filtering Responses

Please see the query list below for a list of fields that you can filter your responses by. For more information on how to use filters, see our Filtering responses article.

Query
linkstring(uuid)

The link.id you want to filter by.

ℹ️ We highly recommend adding the link.id filter in order to improve your performance.

Example: link=8848bd0c-9c7e-4f53-a732-ec896b11d4c4
page_sizeinteger(int32)[ 1 .. 1000 ]

Indicates how many results to return per page. By default we return 100 results per page.

ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000).

Default 100
Example: page_size=100
pageinteger(int32)>= 1

A page number within the paginated result set.

Example: page=1
omitstring

Omit certain fields from being returned in the response. For more information, see our Filtering responses DevPortal article.

fieldsstring

Return only the specified fields in the response. For more information, see our Filtering responses DevPortal article.

idstring(uuid)

Return information only for this resource id.

Example: id=24ccab1d-3a86-4136-a6eb-e04bf52b356f
id__inArray of strings(uuid)

Return information for these resource ids.

Example: id__in=6b3dea0f-be29-49d1-aabe-1a6d588642e6
link__inArray of strings(uuid)

Return results only for these link.ids.

Example: link__in=5722d0ba-69d7-42dc-8ff5-33767b83c5d6
internal_identificationstring

The internal_identification you want to filter by.

Example: internal_identification=BLPM951331IONVGR54
internal_identification__inArray of strings

One or more internal_identifications you want to filter by.

Example: internal_identification__in=BLPM951331IONVGR54
collected_atstring(date)

Return items that were retrieved from the institution on this date (YYYY-MM-DD or full ISO-8601 timestamp).

Example: collected_at=2022-05-01
collected_at__gtstring(date)

Return items that were retrieved from the institution after this date (YYYY-MM-DD or full ISO-8601 timestamp).

Example: collected_at__gt=2022-05-05
collected_at__gtestring(date)

Return items that were retrieved from the institution after or on this date (YYYY-MM-DD or full ISO-8601 timestamp).

Example: collected_at__gte=2022-05-04
collected_at__ltstring(date)

Return items that were retrieved from the institution before this date (YYYY-MM-DD or full ISO-8601 timestamp).

Example: collected_at__lt=2022-04-01
collected_at__ltestring(date)

Return items that were retrieved from the institution before or on this date (YYYY-MM-DD or full ISO-8601 timestamp).

Example: collected_at__lte=2022-03-30
collected_at__rangeArray of strings(date)<= 2 items

Return items that were retrieved from the institution between two dates (YYYY-MM-DD or full ISO-8601 timestamp).

Example: collected_at__range=2022-05-04
created_atstring(date)

Return items that were last updated in Belvo's database on this date (in YYYY-MM-DD format).

Example: created_at=2022-05-05
created_at__gtstring(date)

Return items that were last updated in Belvo's database after this date (in YYYY-MM-DD format).

Example: created_at__gt=2022-05-05
created_at__gtestring(date)

Return items that were last updated in Belvo's database after or on this date (in YYYY-MM-DD format).

Example: created_at__gte=2022-05-04
created_at__ltstring(date)

Return items that were last updated in Belvo's database before this date (in YYYY-MM-DD format).

Example: created_at__lt=2022-04-01
created_at__ltestring(date)

Return items that were last updated in Belvo's database before or on this date (in YYYY-MM-DD format).

Example: created_at__lte=2022-03-30
created_at__rangeArray of strings(date)<= 2 items

Return accounts that were last updated in Belvo's database between two dates (in YYYY-MM-DD format).

Example: created_at__range=2022-03-03
curl -i -X GET \
  -u <username>:<password> \
  'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/employment-records/?collected_at=2022-05-01&collected_at__gt=2022-05-05&collected_at__gte=2022-05-04&collected_at__lt=2022-04-01&collected_at__lte=2022-03-30&collected_at__range=2022-05-04&created_at=2022-05-05&created_at__gt=2022-05-05&created_at__gte=2022-05-04&created_at__lt=2022-04-01&created_at__lte=2022-03-30&created_at__range=2022-03-03&fields=string&id=24ccab1d-3a86-4136-a6eb-e04bf52b356f&id__in=6b3dea0f-be29-49d1-aabe-1a6d588642e6&internal_identification=BLPM951331IONVGR54&internal_identification__in=BLPM951331IONVGR54&link=8848bd0c-9c7e-4f53-a732-ec896b11d4c4&link__in=5722d0ba-69d7-42dc-8ff5-33767b83c5d6&omit=string&page=1&page_size=100'

Responses

Ok

Bodyapplication/json
countinteger(int32)

The total number of results in your Belvo account.

Example: 130
nextstring or null(uri)

The URL to next page of results. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is null.

In our documentation example, we use {endpoint} as a placeholder value. In production, this value will be replaced by the actual endpoint you are currently using (for example, accounts or owners).

Example: "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2"
previousstring or null(uri)

The URL to the previous page of results. If there is no previous page, the value is null.

Example: null
resultsArray of objects

Array of employment record objects.

Response
application/json

Example of a paginated IMSS response.

{
  "count": 20,
  "next": "https://sandbox.belvo.com/api/employment-records/?page=2",
  "previous": null,
  "results": [
    { … }
  ]
}

Retrieve employment record details

Request

Retrieve employment record details for an individual.

Query
omitstring

Omit certain fields from being returned in the response. For more information, see our Filtering responses DevPortal article.

fieldsstring

Return only the specified fields in the response. For more information, see our Filtering responses DevPortal article.

Headers
X-Belvo-Request-Modestring

Recommended header parameter to make your POST request asynchronous (thus preventing timeouts and improving your data flow).

When you make an asynchronous request, Belvo responds with a 202 - Accepted payload, including the request_id. Once we have retrieved the requested information, you will receive a webhook with the link and request IDs.

Value"async"
Example: async
Bodyapplication/jsonrequired
linkstring(uuid)required

The link.id you want to retrieve information for.

Example: "c81a1dea-6dd6-4999-8b9f-541ee8197058"
attach_pdfboolean

When set to true, you will receive the PDF in binary format in the response.

Default false
Example: true
save_databoolean

Indicates whether or not to persist the data in Belvo. By default, this is set to true and we return a 201 Created response.

When set to false, the data won't be persisted and we return a 200 OK response.

Default true
Example: true
curl -i -X POST \
  -u <username>:<password> \
  'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/employment-records/?fields=string&omit=string' \
  -H 'Content-Type: application/json' \
  -H 'X-Belvo-Request-Mode: async' \
  -d '{
    "link": "c81a1dea-6dd6-4999-8b9f-541ee8197058",
    "attach_pdf": true,
    "save_data": true
  }'

Responses

Ok

Bodyapplication/jsonArray [
idstring(uuid)

Belvo's unique identifier for the current item.

Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"
linkstring or null(uuid)

The link.id the data belongs to.

Example: "30cb4806-6e00-48a4-91c9-ca55968576c8"
created_atstring(date-time)

The ISO-8601 timestamp of when the data point was created in Belvo's database.

Example: "2022-02-09T08:45:50.406032Z"
collected_atstring(date-time)

The ISO-8601 timestamp when the data point was collected.

Example: "2022-02-09T08:45:50.406032Z"
report_datestring(date)

The date when the employment record report was generated, in YYYY-MM-DD format.

Example: "2023-01-19"
internal_identificationstring

Unique ID for user according to the institution. For IMSS and ISSSTE Mexico, this is the CURP.

Example: "BLPM951331IONVGR54"
personal_dataobject

Details regarding the personal information of the individual.

social_security_summaryobject or null

Details regarding the individual's social security contributions, according to the IMSS.

Note: For ISSSTE Mexico, this value will return null.

employment_recordsArray of objects

Details regarding the individual's employment history.

employment_scoresArray of objects or null

An array of employment_record scores. Each score provides an insight into employability and income generation potential in a given period.

Note 1: This field is only available for links created with Mexico's IMSS. For other institutions, this field will return null.

Note 2: This field will return null for employment records retrieved before 16-04-2024. For employment records generated before 16-04-2024, you'll need to make a new POST request to retrieve employment records to calculate the scores.

Example: [{"score":722,"period":3,"version":"1.0.0"},{"score":612,"period":6,"version":"1.0.0"},{"score":570,"period":12,"version":"1.0.0"}]
filesArray of objects or null

Additional PDF binary files relating to the individual's employment.

]
Response
application/json

Example of an IMSS response.

[
  {
    "id": "fef05fc8-7357-4a4a-9d29-55038ea31a04",
    "link": "27c1d5cf-e8fb-433a-a2f7-d246de199c01",
    "created_at": "2022-02-09T08:45:50.406032Z",
    "collected_at": "2022-02-09T08:45:50.406032Z",
    "report_date": "2023-01-19",
    "internal_identification": "BLPM951331IONVGR54",
    "personal_data": { … },
    "social_security_summary": { … },
    "employment_records": [ … ],
    "employment_scores": [ … ],
    "files": [ … ]
  }
]

Invoices

Operations

Tax compliance status

Operations

Tax returns

Operations

Tax retentions

Operations

Tax status

Operations

Financial Statements

Operations

Invoices Chile

Operations

Tax Status Chile

Operations

Debt Reports Chile

Operations

Incomes

Use the Incomes endpoint to gather insights on an account's income sources for the past 365 days. The endpoint is particularly useful when you want to verify a person's income.

📘 Info

The incomes resource is only available for Checking and Savings accounts associated with banking links.

Operations

Recurring Expenses

Belvo's Recurring Expenses API allows you to identify a user's regular payments for subscription services, such as Netflix or gym memberships, as well as utility payments, such as electricity or phone bills. We return information for up to 365 days.

📘 Info

The recurring expenses resource is only available for Checking, Savings and Credit Card accounts associated with banking links.

Operations

Risk Insights

Operations

Employment Metrics

Operations

Payment Institutions (Brazil)

A payment institution is an entity that Belvo can access information from. You can see a complete list of institutions available for payments by making a List request to this endpoint.

Operations

Customers (Brazil)

A customer is the payer that's going to push funds into your bank account. You need to create a customer in order to receive inflow payments to your organization's bank account.

Operations

Bank Accounts (Brazil)

To receive inflow payments to your organization's bank account, you must register the bank accounts (individual and business) using Belvo's Payments API.

  • Individual bank accounts must be created for each payer (your customer).
  • Business bank accounts need to be created for the beneficiary of the payment (your organization).
Operations

Payment Links (Brazil)

This is a Payment link.

Operations

Payment Intents (Brazil)

A payment intent is a single point of access to create payments using any payment method offered by Belvo.

A payment intent captures all payment information (such as the amount to be charged, the description of the payment, the provider, and so on) and guides your customers through the payment flow.

Note: For institutions that require the username_type in the form_fields array, you must send through this value in your PATCH request.

Operations

Biometric Pix Widget Access Token (Brazil)

Use the Biometric Pix Widget Token requests to create a access token for Biometric Payments.

Operations

Payment Transactions (Brazil)

Each time you receive an inflow payment from your customer, a transaction is created in the Belvo database.

You can use the Payment Transactions resource in order to get useful information about a transaction as well as the specific charge associated with it.

Operations
Copyright © 2020-2025 Belvo. All rights reserved