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.
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 session you want to resume. You need to use the session value that is provided in the 428 Token Required response that you receive after you make your POST request.
The MFA token generated by the institution which is required to continue a session.
The link.id you want to resume. Must be the same link.id as the one you receive in the 428 Token Required response that contains the session ID.
curl -i -X PATCH \
-u <username>:<password> \
'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/risk-insights/?fields=string&omit=string' \
-H 'Content-Type: application/json' \
-d '{
"session": "6e7b283c6efa449c9c028a16b5c249fa",
"token": "1234ab",
"link": "683005d6-f45c-4adb-b289-f1a12f50f80c",
"save_data": true
}'Ok (when save_data=false)
Belvo's unique identifier for the current item.
The link.id the data belongs to.
The ISO-8601 timestamp of when the data point was created in Belvo's database.
An array of Belvo-generated account numbers (UUIDs) that were used during the risk insights analysis. If no accounts were found, we return an empty array.
Aggregate details regarding the assets used in the risk insight analysis. For asset metrics, we only consider checking and savings accounts.
Asset metrics can provide a snapshot of your user's wealth and liquid assets, indicating how they manage their wealth and their current financial status.
An array of institutions from which account information was retrieved for the user.
Note: For most use cases, this array will only return one item.
The total number of accounts found for the user.
The total number of checking accounts found for the user.
The total number of savings accounts found for the user.
The total closing balance of all checking accounts.
Aggregated metrics calculated based on the user's credit card accounts.
Credit card metrics illustrate a customer's credit card habits, revealing how many credit card accounts a customer has, their total credit limit, how much of that limit they're using, and the rate of their credit card limit utilization.
Number of credit cards accounts associated to the user.
Aggregated metrics calculated based on the user's loan accounts and checking accounts that have an overdraft.
Loan metrics help in understanding a customer's borrowing and repayment behavior, which can help in assessing their ability to take on additional credit and potential default risks.
Sum total of the principal for all of the user's loan accounts.
Sum total of the outstanding principal for all the user's loan accounts.
Sum total of the monthly payments for all the user's loan accounts.
The percentage of the loan limit used.
The total overdraft limit of all checking and savings accounts.
Balance metrics calculated based on the user's balances from checking and savings accounts.
The balance of all the accounts at the collected_at time.
The minimum balance in the last three days.
The minimum balance in the last three months.
The minimum balance in the six last months.
The minimum balance in the last twelve months.
The mean balance in the last three days.
The mean balance in the last three months.
The mean balance in the last six months.
The mean balance in the last twelve months.
The maximum balance in the last three days.
The maximum balance in the last three months.
The maximum balance in the last six months.
The maximum balance in the last twelve months.
The balance standard deviation in the last three days.
The balance standard deviation in the last week.
The balance standard deviation in the last month.
The balance standard deviation in the last three months.
The balance standard deviation in the last six months.
The balance standard deviation in the last twelve months.
The balance trend of the user in the last three days.
The balance trend of the user in the last week.
The balance trend of the user in the last month.
The balance trend of the user in the last three months.
The balance trend of the user in the last six months.
The balance trend of the user in the last twelve months.
The number of days that the total balance of the account is less than or equal to 0 in the last three days.
The number of days that the total balance of the account is less than or equal to 0 in the last week.
The number of days that the total balance of the account is less than or equal to 0 in the last month.
The number of days that the total balance of the account is less than or equal to 0 in the last three months.
The number of days that the total balance of the account is less than or equal to 0 in the last six months.
The number of days that the total balance of the account is less than or equal to 0 in the last twelve months.
The number of days that the mean balance of the account is less than or equal to the amount specified in mean_daily_balance_3d.
The number of days that the mean balance of the account is less than or equal to the amount specified in mean_daily_balance_1w.
The number of days that the mean balance of the account is less than or equal to the amount specified in mean_daily_balance_1m.
The number of days that the mean balance of the account is less than or equal to the amount specified in mean_daily_balance_3m.
The number of days that the mean balance of the account is less than or equal to the amount specified in mean_daily_balance_6m.
The number of days that the mean balance of the account is less than or equal to the amount specified in mean_daily_balance_12m.
The number of days that the total balance of the account is less than or equal to the amount specified in balance_threshold_x in the last three days.
The number of days that the total balance of the account is less than or equal to the amount specified in balance_threshold_x in the last week.
The number of days that the total balance of the account is less than or equal to the amount specified in balance_threshold_x in the last month.
The number of days that the total balance of the account is less than or equal to the amount specified in balance_threshold_x in the last three months.
The number of days that the total balance of the account is less than or equal to the amount specified in balance_threshold_x in the last six months.
The number of days that the total balance of the account is less than or equal to the amount specified in balance_threshold_x in the last twelve months.
Aggregated metrics calculated based on the user's transactions from checking, savings, credit card, and loan accounts.
ℹ️ Note
If there is not enough transactional data for a given period, we return
nullfor calculated fields and0for 'count-based' fields. For example, if the account has only been open for five days (or you have provided data just for five days), we return values for_3d,_1w, and_1m, however:
mean_num_transactions_3mwill returnnullas there is no data for months two and three (calculated field).num_transactions_3mwill return0as there is no data for months two and three ('count-based' field)
The total number of transactions analyzed to determine the risk insights for the last three days (incoming and outgoing).
The total number of transactions analyzed to determine the risk insights for the last week (incoming and outgoing).
The total number of transactions analyzed to determine the risk insights for the last month (incoming and outgoing).
The total number of transactions analyzed to determine the risk insights for the last three months (incoming and outgoing).
The total number of transactions analyzed to determine the risk insights for the last six months (incoming and outgoing).
The total number of transactions analyzed to determine the risk insights for the last twelve months (incoming and outgoing).
The maximum number of transactions for the last three days.
The maximum number of transactions for the last week.
The maximum number of transactions for the last month.
The maximum number of transactions for the last three months.
The maximum number of transactions for the last six months.
The maximum number of transactions for the last twelve months.
The mean number of transactions for the last three days.
The mean number of transactions for the last week.
The mean number of transactions for the last month.
The mean number of transactions for the last three months.
The mean number of transactions for the last six months.
The mean number of transactions for the last twelve months.
The total number of inflow transactions for the last three days.
The total number of inflow transactions for the last week.
The total number of inflow transactions for the last month.
The total number of inflow transactions for the last three months.
The total number of inflow transactions for the last six months.
The total number of inflow transactions for the last twelve months.
The maximum number of inflow transactions for the last three days.
The maximum number of inflow transactions for the last week.
The maximum number of inflow transactions for the last month.
The maximum number of inflow transactions for the last three months.
The maximum number of inflow transactions for the last six months.
The maximum number of inflow transactions for the last twelve months.
The mean number of inflow transactions for the last three days.
The mean number of inflow transactions for the last week.
The mean number of inflow transactions for the last month.
The mean number of inflow transactions for the last three months.
The mean number of inflow transactions for the last six months.
The mean number of inflow transactions for the last twelve months.
The total sum of all inflow transactions for the last three days.
The total sum of all inflow transactions for the last week.
The total sum of all inflow transactions for the last month.
The total sum of all inflow transactions for the last three months.
The total sum of all inflow transactions for the last six months.
The total sum of all inflow transactions for the last twelve months.
The highest value inflow transaction in the last three days.
The highest value inflow transaction in the last week.
The highest value inflow transaction in the last month.
The highest value inflow transaction in the last three months.
The highest value inflow transaction in the last six months.
The highest value inflow transaction in the last twelve months.
The mean incoming value of all transactions in the last three days.
The mean incoming value of all transactions in the last week.
The mean incoming value of all transactions in the last month.
The mean incoming value of all transactions in the last three months.
The mean incoming value of all transactions in the last six months.
The mean incoming value of all transactions in the last twelve months.
To total number of outflow transactions in the last three days.
To total number of outflow transactions in the last week.
To total number of outflow transactions in the last month.
To total number of outflow transactions in the last three months.
To total number of outflow transactions in the last six months.
To total number of outflow transactions in the last twelve months.
The maximum number of outflow transactions for the last three days.
The maximum number of outflow transactions for the last week.
The maximum number of outflow transactions for the last month.
The maximum number of outflow transactions for the last three months.
The maximum number of outflow transactions for the last six months.
The maximum number of outflow transactions for the last twelve months.
The mean number of outflow transactions for the last three days.
The mean number of outflow transactions for the last week.
The mean number of outflow transactions for the last month.
The mean number of outflow transactions for the last three months.
The mean number of outflow transactions for the last six months.
The mean number of outflow transactions for the last twelve months.
The total sum of all outflow transactions for the last three days.
The total sum of all outflow transactions for the last week.
The total sum of all outflow transactions for the last month.
The total sum of all outflow transactions for the last three months.
The total sum of all outflow transactions for the last six months.
The total sum of all outflow transactions for the last twelve months.
The highest value outflow transaction in the last three days.
The highest value outflow transaction in the last week.
The highest value outflow transaction in the last month.
The highest value outflow transaction in the last three months.
The highest value outflow transaction in the last six months.
The highest value outflow transaction in the last twelve months.
The mean outgoing value of all transaction in the last three days.
The mean outgoing value of all transaction in the last week.
The mean outgoing value of all transaction in the last month.
The mean outgoing value of all transaction in the last three months.
The mean outgoing value of all transaction in the last six months.
The mean outgoing value of all transaction in the last twelve months.
The number of days that no transactions occurred within the last three days.
The number of days that no transactions occurred within the last week.
The number of days that no transactions occurred within the last month.
The number of days that no transactions occurred within the last three months.
The number of days that no transactions occurred within the last six months.
The number of days that no transactions occurred within the last twelve months.
The number of days since the last transaction occurred.
The number of days since the last inflow transaction occurred.
The number of days since the last outflow transaction occurred.
Aggregate metrics calculated based on the user's transactions from checking, savings, credit, and loan accounts. However, internal transfers (transfers between accounts belonging to the same link) are not used in the calculation.
ℹ️ Note
If there is not enough transactional data for a given period, we return
null. For example, if the account has only been open for 15 days (or you have only provided data for just 15 days), we return values for_3d,_1w, and_1m, however for_3mwe will returnnullas there is no data for months two and three.
The highest value of positive cash flow transactions in the last three days.
The highest value of positive cash flow transactions the last week.
The highest value of positive cash flow transactions the last month.
The highest value of positive cash flow transactions the last three months.
The highest value of positive cash flow transactions the last six months.
The highest value of positive cash flow transactions the last twelve months.
The highest value of negative cash flow transactions in the last three days.
The highest value of negative cash flow transactions in the last week.
The highest value of negative cash flow transactions in the last month.
The highest value of negative cash flow transactions in the last three months.
The highest value of negative cash flow transactions in the last six months.
The highest value of negative cash flow transactions in the last twelve months.
The mean value of the positive cash flow transactions in the last three days.
The mean value of the positive cash flow transactions in the last week.
The mean value of the positive cash flow transactions in the last month.
The mean value of the positive cash flow transactions in the last three months.
The mean value of the positive cash flow transactions in the last six months.
The mean value of the positive cash flow transactions in the last twelve months.
The mean value of the negative cash flow transactions in the last three days.
The mean value of the negative cash flow transactions in the last week.
The mean value of the negative cash flow transactions in the last month.
The mean value of the negative cash flow transactions in the last three months.
The mean value of the negative cash flow transactions in the last six months.
The mean value of the negative cash flow transactions in the last twelve months.
The sum total of all transactions leading to a positive cash flow in the last three days.
The sum total of all transactions leading to a positive cash flow in the last week.
The sum total of all transactions leading to a positive cash flow in the last month.
The sum total of all transactions leading to a positive cash flow in the last three months.
The sum total of all transactions leading to a positive cash flow in the last six months.
The sum total of all transactions leading to a positive cash flow in the last twelve months.
The positive cash flow trend based on the sum of all positive transactions in the last three days.
The positive cash flow trend based on the sum of all positive transactions in the last week.
The positive cash flow trend based on the sum of all positive transactions in the last month.
The positive cash flow trend based on the sum of all positive transactions in the last three months.
The positive cash flow trend based on the sum of all positive transactions in the last six months.
The positive cash flow trend based on the sum of all positive transactions in the last twelve months.
The sum total of all transactions leading to a negative cash flow in the last three days.
The sum total of all transactions leading to a negative cash flow in the last week.
The sum total of all transactions leading to a negative cash flow in the last month.
The sum total of all transactions leading to a negative cash flow in the last three months.
The sum total of all transactions leading to a negative cash flow in the last six months.
The sum total of all transactions leading to a negative cash flow in the last twelve months.
The negative cash flow trend based on the sum of all negative transactions in the last three days.
The negative cash flow trend based on the sum of all negative transactions in the last week.
The negative cash flow trend based on the sum of all negative transactions in the last month.
The negative cash flow trend based on the sum of all negative transactions in the last three months.
The negative cash flow trend based on the sum of all negative transactions in the last six months.
The negative cash flow trend based on the sum of all negative transactions in the last twelve months.
The ratio between sum_positive / sum_negative in the last three days.
ℹ️ If the ratio is greater than 1, it means that the user has more income than outgoing, indicating that they spend less than they earn.
Note: In the case that there have been no outgoing transactions, the value will be null.
The ratio between sum_positive / sum_negative in the last week.
ℹ️ If the ratio is greater than 1, it means that the user has more income than outgoing, indicating that they spend less than they earn.
Note: In the case that there have been no outgoing transactions, the value will be null.
The ratio between sum_positive / sum_negative in the last month.
ℹ️ If the ratio is greater than 1, it means that the user has more income than outgoing, indicating that they spend less than they earn.
Note: In the case that there have been no outgoing transactions, the value will be null.
The ratio between sum_positive / sum_negative in the last three months.
ℹ️ If the ratio is greater than 1, it means that the user has more income than outgoing, indicating that they spend less than they earn.
Note: In the case that there have been no outgoing transactions, the value will be null.
The ratio between sum_positive / sum_negative in the last six months.
ℹ️ If the ratio is greater than 1, it means that the user has more income than outgoing, indicating that they spend less than they earn.
Note: In the case that there have been no outgoing transactions, the value will be null.
The ratio between sum_positive / sum_negative in the last twelve months.
ℹ️ If the ratio is greater than 1, it means that the user has more income than outgoing, indicating that they spend less than they earn.
Note: In the case that there have been no outgoing transactions, the value will be null.
The net cash flow in the last three days.
The net cash flow in the last three months.
The net cash flow in the last six months.
The net cash flow in the last twelve months.
The net cash flow trend in the last three days months.
The net cash flow trend in the last week.
The net cash flow trend in the last month.
The net cash flow trend in the last three months.
The net cash flow trend in the last six months.
An array of aggregate metrics regarding the transaction categories and subcategories that Belvo has identified within the user's transaction history.
In the array, Belvo only returns categories that have been identified.
The name of the transaction category.
Get transaction categorization With Transaction categorization, we clean and categorize transactions for you, turning raw data into actionable insights. To enable this feature, just reach out to us, and we'll get right to it.
We return one of the following enum values:
Bills & UtilitiesCredits & LoansDepositsFees & ChargesFood & GroceriesHome & LifeIncome & PaymentsInsuranceInvestments & SavingsOnline Platforms & LeisurePersonal ShoppingTaxesTransfersTransport & TravelUnknown*Withdrawal & ATMnull* For clients not using our Transaction Categorization product, we return null instead.
The transaction subcategory.
Get transaction categorization For clients not using our Transaction categorization, we return
nullinstead. To enable this feature, just reach out to us, and we'll get right to it.
We return one of the following enum values:
Electricity & EnergyRentTelecommunicationsWaterAutoCredit CardInstalmentInterest & ChargesMortgagePay AdvancePersonalAdjustmentsBank FeesChargebackRefundBlocked BalancesAlimonyAlcohol & TobaccoBakery & CoffeeBars & NightclubsConvenience StoreDeliveryGroceriesRestaurantsEducationGyms & FitnessHair & BeautyHealthHome Decor & AppliancesLaundry & Dry CleaningPharmaciesProfessional ServicesVeterinary ServicesFreelanceInterestRetirementSalaryGovernmentHome InsuranceAuto InsuranceHealth & Life InsuranceSavingsFixed incomeEquityInvestment FundsDerivativesCryptocurrenciesApps, Software and Cloud ServicesEvents, Parks and MuseumsGamblingGamingLotteryMovie & AudioBooks & NewsClothing & AccessoriesDepartment StoreElectronicsE-commerceGiftsOffice SuppliesPet SuppliesAuto Tax & FeesDonationGovernment FeesIncome TaxReal Estate Tax & FeesTax ReturnAccommodationAuto ExpensesAuto RentalFlightsGasMileage ProgramsParking & TollsPublic TransitTaxis & RidesharesOthernullThe net amount of the transactions for this category in the last three months (calculated as the total incoming - total outgoing transactions for this category).
The ratio of net_amount_3m divided by the sum of all incoming categorized transactions (including the current category) for the same period.
Note: If there are no inflow transactions for the period, this value will return null.
[ { "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "link": "30cb4806-6e00-48a4-91c9-ca55968576c8", "created_at": "2022-02-09T08:45:50.406032Z", "accounts": [ … ], "assets_metrics": { … }, "credit_cards_metrics": { … }, "loans_metrics": { … }, "balances_metrics": { … }, "transactions_metrics": { … }, "cashflow_metrics": { … }, "category_metrics": [ … ] } ]
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/risk-insights/{id}/?fields=string&omit=string'Ok
Belvo's unique identifier for the current item.
The link.id the data belongs to.
The ISO-8601 timestamp of when the data point was created in Belvo's database.
An array of Belvo-generated account numbers (UUIDs) that were used during the risk insights analysis. If no accounts were found, we return an empty array.
Aggregate details regarding the assets used in the risk insight analysis. For asset metrics, we only consider checking and savings accounts.
Asset metrics can provide a snapshot of your user's wealth and liquid assets, indicating how they manage their wealth and their current financial status.
An array of institutions from which account information was retrieved for the user.
Note: For most use cases, this array will only return one item.
The total number of accounts found for the user.
The total number of checking accounts found for the user.
The total number of savings accounts found for the user.
The total closing balance of all checking accounts.
Aggregated metrics calculated based on the user's credit card accounts.
Credit card metrics illustrate a customer's credit card habits, revealing how many credit card accounts a customer has, their total credit limit, how much of that limit they're using, and the rate of their credit card limit utilization.
Number of credit cards accounts associated to the user.
Aggregated metrics calculated based on the user's loan accounts and checking accounts that have an overdraft.
Loan metrics help in understanding a customer's borrowing and repayment behavior, which can help in assessing their ability to take on additional credit and potential default risks.
Sum total of the principal for all of the user's loan accounts.
Sum total of the outstanding principal for all the user's loan accounts.
Sum total of the monthly payments for all the user's loan accounts.
The percentage of the loan limit used.
The total overdraft limit of all checking and savings accounts.
Balance metrics calculated based on the user's balances from checking and savings accounts.
The balance of all the accounts at the collected_at time.
The minimum balance in the last three days.
The minimum balance in the last three months.
The minimum balance in the six last months.
The minimum balance in the last twelve months.
The mean balance in the last three days.
The mean balance in the last three months.
The mean balance in the last six months.
The mean balance in the last twelve months.
The maximum balance in the last three days.
The maximum balance in the last three months.
The maximum balance in the last six months.
The maximum balance in the last twelve months.
The balance standard deviation in the last three days.
The balance standard deviation in the last week.
The balance standard deviation in the last month.
The balance standard deviation in the last three months.
The balance standard deviation in the last six months.
The balance standard deviation in the last twelve months.
The balance trend of the user in the last three days.
The balance trend of the user in the last week.
The balance trend of the user in the last month.
The balance trend of the user in the last three months.
The balance trend of the user in the last six months.
The balance trend of the user in the last twelve months.
The number of days that the total balance of the account is less than or equal to 0 in the last three days.
The number of days that the total balance of the account is less than or equal to 0 in the last week.
The number of days that the total balance of the account is less than or equal to 0 in the last month.
The number of days that the total balance of the account is less than or equal to 0 in the last three months.
The number of days that the total balance of the account is less than or equal to 0 in the last six months.
The number of days that the total balance of the account is less than or equal to 0 in the last twelve months.
The number of days that the mean balance of the account is less than or equal to the amount specified in mean_daily_balance_3d.
The number of days that the mean balance of the account is less than or equal to the amount specified in mean_daily_balance_1w.
The number of days that the mean balance of the account is less than or equal to the amount specified in mean_daily_balance_1m.
The number of days that the mean balance of the account is less than or equal to the amount specified in mean_daily_balance_3m.
The number of days that the mean balance of the account is less than or equal to the amount specified in mean_daily_balance_6m.
The number of days that the mean balance of the account is less than or equal to the amount specified in mean_daily_balance_12m.
The number of days that the total balance of the account is less than or equal to the amount specified in balance_threshold_x in the last three days.
The number of days that the total balance of the account is less than or equal to the amount specified in balance_threshold_x in the last week.
The number of days that the total balance of the account is less than or equal to the amount specified in balance_threshold_x in the last month.
The number of days that the total balance of the account is less than or equal to the amount specified in balance_threshold_x in the last three months.
The number of days that the total balance of the account is less than or equal to the amount specified in balance_threshold_x in the last six months.
The number of days that the total balance of the account is less than or equal to the amount specified in balance_threshold_x in the last twelve months.
Aggregated metrics calculated based on the user's transactions from checking, savings, credit card, and loan accounts.
ℹ️ Note
If there is not enough transactional data for a given period, we return
nullfor calculated fields and0for 'count-based' fields. For example, if the account has only been open for five days (or you have provided data just for five days), we return values for_3d,_1w, and_1m, however:
mean_num_transactions_3mwill returnnullas there is no data for months two and three (calculated field).num_transactions_3mwill return0as there is no data for months two and three ('count-based' field)
The total number of transactions analyzed to determine the risk insights for the last three days (incoming and outgoing).
The total number of transactions analyzed to determine the risk insights for the last week (incoming and outgoing).
The total number of transactions analyzed to determine the risk insights for the last month (incoming and outgoing).
The total number of transactions analyzed to determine the risk insights for the last three months (incoming and outgoing).
The total number of transactions analyzed to determine the risk insights for the last six months (incoming and outgoing).
The total number of transactions analyzed to determine the risk insights for the last twelve months (incoming and outgoing).
The maximum number of transactions for the last three days.
The maximum number of transactions for the last week.
The maximum number of transactions for the last month.
The maximum number of transactions for the last three months.
The maximum number of transactions for the last six months.
The maximum number of transactions for the last twelve months.
The mean number of transactions for the last three days.
The mean number of transactions for the last week.
The mean number of transactions for the last month.
The mean number of transactions for the last three months.
The mean number of transactions for the last six months.
The mean number of transactions for the last twelve months.
The total number of inflow transactions for the last three days.
The total number of inflow transactions for the last week.
The total number of inflow transactions for the last month.
The total number of inflow transactions for the last three months.
The total number of inflow transactions for the last six months.
The total number of inflow transactions for the last twelve months.
The maximum number of inflow transactions for the last three days.
The maximum number of inflow transactions for the last week.
The maximum number of inflow transactions for the last month.
The maximum number of inflow transactions for the last three months.
The maximum number of inflow transactions for the last six months.
The maximum number of inflow transactions for the last twelve months.
The mean number of inflow transactions for the last three days.
The mean number of inflow transactions for the last week.
The mean number of inflow transactions for the last month.
The mean number of inflow transactions for the last three months.
The mean number of inflow transactions for the last six months.
The mean number of inflow transactions for the last twelve months.
The total sum of all inflow transactions for the last three days.
The total sum of all inflow transactions for the last week.
The total sum of all inflow transactions for the last month.
The total sum of all inflow transactions for the last three months.
The total sum of all inflow transactions for the last six months.
The total sum of all inflow transactions for the last twelve months.
The highest value inflow transaction in the last three days.
The highest value inflow transaction in the last week.
The highest value inflow transaction in the last month.
The highest value inflow transaction in the last three months.
The highest value inflow transaction in the last six months.
The highest value inflow transaction in the last twelve months.
The mean incoming value of all transactions in the last three days.
The mean incoming value of all transactions in the last week.
The mean incoming value of all transactions in the last month.
The mean incoming value of all transactions in the last three months.
The mean incoming value of all transactions in the last six months.
The mean incoming value of all transactions in the last twelve months.
To total number of outflow transactions in the last three days.
To total number of outflow transactions in the last week.
To total number of outflow transactions in the last month.
To total number of outflow transactions in the last three months.
To total number of outflow transactions in the last six months.
To total number of outflow transactions in the last twelve months.
The maximum number of outflow transactions for the last three days.
The maximum number of outflow transactions for the last week.
The maximum number of outflow transactions for the last month.
The maximum number of outflow transactions for the last three months.
The maximum number of outflow transactions for the last six months.
The maximum number of outflow transactions for the last twelve months.
The mean number of outflow transactions for the last three days.
The mean number of outflow transactions for the last week.
The mean number of outflow transactions for the last month.
The mean number of outflow transactions for the last three months.
The mean number of outflow transactions for the last six months.
The mean number of outflow transactions for the last twelve months.
The total sum of all outflow transactions for the last three days.
The total sum of all outflow transactions for the last week.
The total sum of all outflow transactions for the last month.
The total sum of all outflow transactions for the last three months.
The total sum of all outflow transactions for the last six months.
The total sum of all outflow transactions for the last twelve months.
The highest value outflow transaction in the last three days.
The highest value outflow transaction in the last week.
The highest value outflow transaction in the last month.
The highest value outflow transaction in the last three months.
The highest value outflow transaction in the last six months.
The highest value outflow transaction in the last twelve months.
The mean outgoing value of all transaction in the last three days.
The mean outgoing value of all transaction in the last week.
The mean outgoing value of all transaction in the last month.
The mean outgoing value of all transaction in the last three months.
The mean outgoing value of all transaction in the last six months.
The mean outgoing value of all transaction in the last twelve months.
The number of days that no transactions occurred within the last three days.
The number of days that no transactions occurred within the last week.
The number of days that no transactions occurred within the last month.
The number of days that no transactions occurred within the last three months.
The number of days that no transactions occurred within the last six months.
The number of days that no transactions occurred within the last twelve months.
The number of days since the last transaction occurred.
The number of days since the last inflow transaction occurred.
The number of days since the last outflow transaction occurred.
Aggregate metrics calculated based on the user's transactions from checking, savings, credit, and loan accounts. However, internal transfers (transfers between accounts belonging to the same link) are not used in the calculation.
ℹ️ Note
If there is not enough transactional data for a given period, we return
null. For example, if the account has only been open for 15 days (or you have only provided data for just 15 days), we return values for_3d,_1w, and_1m, however for_3mwe will returnnullas there is no data for months two and three.
The highest value of positive cash flow transactions in the last three days.
The highest value of positive cash flow transactions the last week.
The highest value of positive cash flow transactions the last month.
The highest value of positive cash flow transactions the last three months.
The highest value of positive cash flow transactions the last six months.
The highest value of positive cash flow transactions the last twelve months.
The highest value of negative cash flow transactions in the last three days.
The highest value of negative cash flow transactions in the last week.
The highest value of negative cash flow transactions in the last month.
The highest value of negative cash flow transactions in the last three months.
The highest value of negative cash flow transactions in the last six months.
The highest value of negative cash flow transactions in the last twelve months.
The mean value of the positive cash flow transactions in the last three days.
The mean value of the positive cash flow transactions in the last week.
The mean value of the positive cash flow transactions in the last month.
The mean value of the positive cash flow transactions in the last three months.
The mean value of the positive cash flow transactions in the last six months.
The mean value of the positive cash flow transactions in the last twelve months.
The mean value of the negative cash flow transactions in the last three days.
The mean value of the negative cash flow transactions in the last week.
The mean value of the negative cash flow transactions in the last month.
The mean value of the negative cash flow transactions in the last three months.
The mean value of the negative cash flow transactions in the last six months.
The mean value of the negative cash flow transactions in the last twelve months.
The sum total of all transactions leading to a positive cash flow in the last three days.
The sum total of all transactions leading to a positive cash flow in the last week.
The sum total of all transactions leading to a positive cash flow in the last month.
The sum total of all transactions leading to a positive cash flow in the last three months.
The sum total of all transactions leading to a positive cash flow in the last six months.
The sum total of all transactions leading to a positive cash flow in the last twelve months.
The positive cash flow trend based on the sum of all positive transactions in the last three days.
The positive cash flow trend based on the sum of all positive transactions in the last week.
The positive cash flow trend based on the sum of all positive transactions in the last month.
The positive cash flow trend based on the sum of all positive transactions in the last three months.
The positive cash flow trend based on the sum of all positive transactions in the last six months.
The positive cash flow trend based on the sum of all positive transactions in the last twelve months.
The sum total of all transactions leading to a negative cash flow in the last three days.
The sum total of all transactions leading to a negative cash flow in the last week.
The sum total of all transactions leading to a negative cash flow in the last month.
The sum total of all transactions leading to a negative cash flow in the last three months.
The sum total of all transactions leading to a negative cash flow in the last six months.
The sum total of all transactions leading to a negative cash flow in the last twelve months.
The negative cash flow trend based on the sum of all negative transactions in the last three days.
The negative cash flow trend based on the sum of all negative transactions in the last week.
The negative cash flow trend based on the sum of all negative transactions in the last month.
The negative cash flow trend based on the sum of all negative transactions in the last three months.
The negative cash flow trend based on the sum of all negative transactions in the last six months.
The negative cash flow trend based on the sum of all negative transactions in the last twelve months.
The ratio between sum_positive / sum_negative in the last three days.
ℹ️ If the ratio is greater than 1, it means that the user has more income than outgoing, indicating that they spend less than they earn.
Note: In the case that there have been no outgoing transactions, the value will be null.
The ratio between sum_positive / sum_negative in the last week.
ℹ️ If the ratio is greater than 1, it means that the user has more income than outgoing, indicating that they spend less than they earn.
Note: In the case that there have been no outgoing transactions, the value will be null.
The ratio between sum_positive / sum_negative in the last month.
ℹ️ If the ratio is greater than 1, it means that the user has more income than outgoing, indicating that they spend less than they earn.
Note: In the case that there have been no outgoing transactions, the value will be null.
The ratio between sum_positive / sum_negative in the last three months.
ℹ️ If the ratio is greater than 1, it means that the user has more income than outgoing, indicating that they spend less than they earn.
Note: In the case that there have been no outgoing transactions, the value will be null.
The ratio between sum_positive / sum_negative in the last six months.
ℹ️ If the ratio is greater than 1, it means that the user has more income than outgoing, indicating that they spend less than they earn.
Note: In the case that there have been no outgoing transactions, the value will be null.
The ratio between sum_positive / sum_negative in the last twelve months.
ℹ️ If the ratio is greater than 1, it means that the user has more income than outgoing, indicating that they spend less than they earn.
Note: In the case that there have been no outgoing transactions, the value will be null.
The net cash flow in the last three days.
The net cash flow in the last three months.
The net cash flow in the last six months.
The net cash flow in the last twelve months.
The net cash flow trend in the last three days months.
The net cash flow trend in the last week.
The net cash flow trend in the last month.
The net cash flow trend in the last three months.
The net cash flow trend in the last six months.
An array of aggregate metrics regarding the transaction categories and subcategories that Belvo has identified within the user's transaction history.
In the array, Belvo only returns categories that have been identified.
The name of the transaction category.
Get transaction categorization With Transaction categorization, we clean and categorize transactions for you, turning raw data into actionable insights. To enable this feature, just reach out to us, and we'll get right to it.
We return one of the following enum values:
Bills & UtilitiesCredits & LoansDepositsFees & ChargesFood & GroceriesHome & LifeIncome & PaymentsInsuranceInvestments & SavingsOnline Platforms & LeisurePersonal ShoppingTaxesTransfersTransport & TravelUnknown*Withdrawal & ATMnull* For clients not using our Transaction Categorization product, we return null instead.
The transaction subcategory.
Get transaction categorization For clients not using our Transaction categorization, we return
nullinstead. To enable this feature, just reach out to us, and we'll get right to it.
We return one of the following enum values:
Electricity & EnergyRentTelecommunicationsWaterAutoCredit CardInstalmentInterest & ChargesMortgagePay AdvancePersonalAdjustmentsBank FeesChargebackRefundBlocked BalancesAlimonyAlcohol & TobaccoBakery & CoffeeBars & NightclubsConvenience StoreDeliveryGroceriesRestaurantsEducationGyms & FitnessHair & BeautyHealthHome Decor & AppliancesLaundry & Dry CleaningPharmaciesProfessional ServicesVeterinary ServicesFreelanceInterestRetirementSalaryGovernmentHome InsuranceAuto InsuranceHealth & Life InsuranceSavingsFixed incomeEquityInvestment FundsDerivativesCryptocurrenciesApps, Software and Cloud ServicesEvents, Parks and MuseumsGamblingGamingLotteryMovie & AudioBooks & NewsClothing & AccessoriesDepartment StoreElectronicsE-commerceGiftsOffice SuppliesPet SuppliesAuto Tax & FeesDonationGovernment FeesIncome TaxReal Estate Tax & FeesTax ReturnAccommodationAuto ExpensesAuto RentalFlightsGasMileage ProgramsParking & TollsPublic TransitTaxis & RidesharesOthernullThe net amount of the transactions for this category in the last three months (calculated as the total incoming - total outgoing transactions for this category).
The ratio of net_amount_3m divided by the sum of all incoming categorized transactions (including the current category) for the same period.
Note: If there are no inflow transactions for the period, this value will return null.
[ { "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "link": "30cb4806-6e00-48a4-91c9-ca55968576c8", "created_at": "2022-02-09T08:45:50.406032Z", "accounts": [ … ], "assets_metrics": { … }, "credit_cards_metrics": { … }, "loans_metrics": { … }, "balances_metrics": { … }, "transactions_metrics": { … }, "cashflow_metrics": { … }, "category_metrics": [ … ] } ]
curl -i -X DELETE \
-u <username>:<password> \
'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/risk-insights/{id}/'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.