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:
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:
You can also use our API to make payments in:
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).
Available for:
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.
Available for:
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:
sandbox.belvo.com to api.belvo.com.We use the following HTTP status code in the response depending on the success or failure:
| Status Code | Description |
|---|---|
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. |
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.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.
For a full list of errors and how to troubleshoot them, please see our dedicated Error Handling article.
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).
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.
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.
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.
An institution is an entity that Belvo can access information from. It can be a:
You can see a complete list of institutions by either consulting our Institutions article or making a List request to this endpoint.
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:
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:
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:
At the moment, the employments resource is available for:
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:
At the moment, the employment records resource is available for:
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.
Employment Metrics details
Belvo's unique identifier for the current item.
The link.id the data belongs to.
The ISO-8601 timestamp when the data point was collected.
The ISO-8601 timestamp of when the data point was created in Belvo's database.
The ISO-8601 timestamp of when the employment metrics calculation was last updated.
The reference_date your provided in your request. If you didn't provide one, this field will return null, indicating that the calculations are performed up until the date of the request.
Note: All calculations are relative to this date.
Indicates the employment status of the individual. We return one of the following responses:
EMPLOYEDRETIREDUNEMPLOYEDnullThe number of employers the individual has right now.
The user's latest base salary. If current_status is EMPLOYED, this is the user's current base salary.
The number of weeks the user was employed in their last job. If current_status is EMPLOYED, then this field indicates the number of weeks the user has been employed with his current job.
The number of weeks since their last job. If the value of this field is 0, this indicates that the user is currently employed.
The total number of weeks the user has been employed, according to the institution.
Note:
In the case that the user is employed at two or more places at the same time, we still calculate those weeks as one week. For example, if a user has three concurrent jobs for a month, this is calculated as 4 weeks.
The number of the weeks that the individual has had more than one employer at the same time.
The total number of employers the user has had. Useful to indicate employment stability over the course of their lifetime.
The number of unique employers that the individual has had.
Note:
If the user left one company and returned, for example, six months later to the same company, this is counted as one employer.
Number of employers per year. Useful to indicate employment stability over the course of a year.
Note:
If the user left one company and returned, for example, six months later to the same company, this is counted as one employer.
The total number of weeks the individual was unemployed.
The maximum number of weeks that the individual was unemployed.
The total number of salary increases the user had in their last job. If current_status is EMPLOYED, this refers to the user's current job.
Note:
For all salary increases or decreases, we only take into account those where the change in salary is greater than 2%.
The total number of salary increases the user had in their last job. If current_status is EMPLOYED, this refers to the user's current job.
The total number of salary increases between the individual's penultimate job and the last (or current) job.
The total number of salary decreases between the individual's penultimate job and the last (or current) job.
The total number of salary increases throughout the individual's working career.
The total number of salary decreases throughout the individual's working career.
The total number of salary increases throughout the individual's last year (YTD).
The total number of salary decreases throughout the individual's last year (YTD).
The total number of salary increases throughout the individual's last three years.
Note:
If the individual's working career is less than three years, we return
null.
The total number of salary decreases throughout the individual's last three years.
Note:
If the individual's working career is less than three years, we return
null.
The total number of salary increases throughout the individual's last five years.
Note:
If the individual's working career is less than five years, we return
null.
The total number of salary decreases throughout the individual's last five years.
Note:
If the individual's working career is less than five years, we return
null.
The individual's salary percentage change for the last year (YTD).
The individual's salary percentage change for the last three years.
Note:
If the individual's working career is less than three years, we return
null.
The individual's salary percentage change for the last five years.
Note:
If the individual's working career is less than five years, we return
null.
The individual's minimum monthly salary for the last year.
The individual's minimum monthly salary for the last three years.
The individual's minimum monthly salary for the last five years.
The individual's average monthly salary for the last year.
The individual's average monthly salary for the last three years.
The individual's average monthly salary for the last five years.
The individual's maximum monthly salary for the last year.
The individual's maximum monthly salary for the last three years.
{ "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "link": "30cb4806-6e00-48a4-91c9-ca55968576c8", "collected_at": "2022-02-09T08:45:50.406032Z", "created_at": "2022-02-09T08:45:50.406032Z", "updated_at": "2023-08-30T15:31:35.728607Z", "reference_date": "2023-06-01", "age": 32, "current_status": "EMPLOYED", "current_employer_count": 1, "base_salary_last": 42.17, "weeks_employed_last_job": 327.1429, "weeks_since_last_job": 0, "weeks_employed_total": 148.2, "weeks_with_multiple_employers": 0, "employer_count": 14, "unique_employer_count": 3, "employers_per_year": 0.6326, "weeks_between_jobs": 687.2865, "max_weeks_between_jobs": 249.8571, "increases_last_job": 0, "decreases_last_job": 0, "increases_after_change": 0, "decreases_after_change": 0, "increases_overall": 0, "decreases_overall": 0, "increases_1y": 0, "decreases_1y": 0, "increases_3y": null, "decreases_3y": null, "increases_5y": null, "decreases_5y": null, "yearly_change_1y": 0, "yearly_change_3y": null, "yearly_change_5y": null, "min_monthly_salary_1y": 3402.88, "min_monthly_salary_3y": 3402.88, "min_monthly_salary_5y": 3402.88, "average_monthly_salary_1y": 3402.88, "average_monthly_salary_3y": 3402.88, "average_monthly_salary_5y": 3402.88, "max_monthly_salary_1y": 3402.88, "max_monthly_salary_3y": 3402.88, "max_monthly_salary_5y": 3402.88 }
With the List Employment Metrics method, you can:
link.id (using the link query parameter).employment-metric.id (using the id query parameter).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.
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.
The link.id you want to filter by.
ℹ️ We highly recommend adding the link.id filter in order to improve your performance.
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).
Return results only for these link.ids.
Omit certain fields from being returned in the response. For more information, see our Filtering responses DevPortal article.
Return only the specified fields in the response. For more information, see our Filtering responses DevPortal article.
curl -i -X GET \
-u <username>:<password> \
'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/employment-metrics/?fields=string&link=8848bd0c-9c7e-4f53-a732-ec896b11d4c4&link__in=5722d0ba-69d7-42dc-8ff5-33767b83c5d6&omit=string&page=1&page_size=100'Ok
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).
The URL to the previous page of results. If there is no previous page, the value is null.
{ "count": 130, "next": "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2", "previous": null, "results": [ { … } ] }
Retrieve employment metrics for an individual.
Note: Before requesting employment metrics, make sure to first make a POST Retrieve employment record details request.
Omit certain fields from being returned in the response. For more information, see our Filtering responses DevPortal article.
Return only the specified fields in the response. For more information, see our Filtering responses DevPortal article.
The link.id you want to retrieve information for.
The date until which you want the employment metrics to be calculated, in YYYY-MM-DD format. For example, if you do not want to calculate employment metrics for all of 2023, the add 2022-12-31 as the reference_date.
If you do not provide a reference_date, we perform calcualtions up until the date you make the request.
Note: All calculations will be relative to this date.
curl -i -X POST \
-u <username>:<password> \
'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/employment-metrics/?fields=string&omit=string' \
-H 'Content-Type: application/json' \
-d '{
"link": "c81a1dea-6dd6-4999-8b9f-541ee8197058",
"reference_date": "2023-03-01",
"save_data": true
}'Ok
Belvo's unique identifier for the current item.
The link.id the data belongs to.
The ISO-8601 timestamp when the data point was collected.
The ISO-8601 timestamp of when the data point was created in Belvo's database.
The ISO-8601 timestamp of when the employment metrics calculation was last updated.
The reference_date your provided in your request. If you didn't provide one, this field will return null, indicating that the calculations are performed up until the date of the request.
Note: All calculations are relative to this date.
Indicates the employment status of the individual. We return one of the following responses:
EMPLOYEDRETIREDUNEMPLOYEDnullThe number of employers the individual has right now.
The user's latest base salary. If current_status is EMPLOYED, this is the user's current base salary.
The number of weeks the user was employed in their last job. If current_status is EMPLOYED, then this field indicates the number of weeks the user has been employed with his current job.
The number of weeks since their last job. If the value of this field is 0, this indicates that the user is currently employed.
The total number of weeks the user has been employed, according to the institution.
Note:
In the case that the user is employed at two or more places at the same time, we still calculate those weeks as one week. For example, if a user has three concurrent jobs for a month, this is calculated as 4 weeks.
The number of the weeks that the individual has had more than one employer at the same time.
The total number of employers the user has had. Useful to indicate employment stability over the course of their lifetime.
The number of unique employers that the individual has had.
Note:
If the user left one company and returned, for example, six months later to the same company, this is counted as one employer.
Number of employers per year. Useful to indicate employment stability over the course of a year.
Note:
If the user left one company and returned, for example, six months later to the same company, this is counted as one employer.
The total number of weeks the individual was unemployed.
The maximum number of weeks that the individual was unemployed.
The total number of salary increases the user had in their last job. If current_status is EMPLOYED, this refers to the user's current job.
Note:
For all salary increases or decreases, we only take into account those where the change in salary is greater than 2%.
The total number of salary increases the user had in their last job. If current_status is EMPLOYED, this refers to the user's current job.
The total number of salary increases between the individual's penultimate job and the last (or current) job.
The total number of salary decreases between the individual's penultimate job and the last (or current) job.
The total number of salary increases throughout the individual's working career.
The total number of salary decreases throughout the individual's working career.
The total number of salary increases throughout the individual's last year (YTD).
The total number of salary decreases throughout the individual's last year (YTD).
The total number of salary increases throughout the individual's last three years.
Note:
If the individual's working career is less than three years, we return
null.
The total number of salary decreases throughout the individual's last three years.
Note:
If the individual's working career is less than three years, we return
null.
The total number of salary increases throughout the individual's last five years.
Note:
If the individual's working career is less than five years, we return
null.
The total number of salary decreases throughout the individual's last five years.
Note:
If the individual's working career is less than five years, we return
null.
The individual's salary percentage change for the last year (YTD).
The individual's salary percentage change for the last three years.
Note:
If the individual's working career is less than three years, we return
null.
The individual's salary percentage change for the last five years.
Note:
If the individual's working career is less than five years, we return
null.
The individual's minimum monthly salary for the last year.
The individual's minimum monthly salary for the last three years.
The individual's minimum monthly salary for the last five years.
The individual's average monthly salary for the last year.
The individual's average monthly salary for the last three years.
The individual's average monthly salary for the last five years.
The individual's maximum monthly salary for the last year.
The individual's maximum monthly salary for the last three years.
{ "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "link": "30cb4806-6e00-48a4-91c9-ca55968576c8", "collected_at": "2022-02-09T08:45:50.406032Z", "created_at": "2022-02-09T08:45:50.406032Z", "updated_at": "2023-08-30T15:31:35.728607Z", "reference_date": "2023-06-01", "age": 32, "current_status": "EMPLOYED", "current_employer_count": 1, "base_salary_last": 42.17, "weeks_employed_last_job": 327.1429, "weeks_since_last_job": 0, "weeks_employed_total": 148.2, "weeks_with_multiple_employers": 0, "employer_count": 14, "unique_employer_count": 3, "employers_per_year": 0.6326, "weeks_between_jobs": 687.2865, "max_weeks_between_jobs": 249.8571, "increases_last_job": 0, "decreases_last_job": 0, "increases_after_change": 0, "decreases_after_change": 0, "increases_overall": 0, "decreases_overall": 0, "increases_1y": 0, "decreases_1y": 0, "increases_3y": null, "decreases_3y": null, "increases_5y": null, "decreases_5y": null, "yearly_change_1y": 0, "yearly_change_3y": null, "yearly_change_5y": null, "min_monthly_salary_1y": 3402.88, "min_monthly_salary_3y": 3402.88, "min_monthly_salary_5y": 3402.88, "average_monthly_salary_1y": 3402.88, "average_monthly_salary_3y": 3402.88, "average_monthly_salary_5y": 3402.88, "max_monthly_salary_1y": 3402.88, "max_monthly_salary_3y": 3402.88, "max_monthly_salary_5y": 3402.88 }
To receive inflow payments to your organization's bank account, you must register the bank accounts (individual and business) using Belvo's Payments API.
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_typein theform_fieldsarray, you must send through this value in your PATCH request.