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

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

Complete a risk insights request

Request

Used to resume an Risk insights retrieve session that was paused because an MFA token was required by the institution.

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.

Bodyapplication/jsonrequired
sessionstring[a-f0-9]{32}required

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.

Example: "6e7b283c6efa449c9c028a16b5c249fa"
tokenstring

The MFA token generated by the institution which is required to continue a session.

Example: "1234ab"
linkstring(uuid)required

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.

Example: "683005d6-f45c-4adb-b289-f1a12f50f80c"
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 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
  }'

Responses

Ok (when save_data=false)

Bodyapplication/jsonArray [
idstring(uuid)required

Belvo's unique identifier for the current item.

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

The link.id the data belongs to.

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

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

Example: "2022-02-09T08:45:50.406032Z"
accountsArray of strings or null(uuid)required

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.

Example: ["0d3ffb69-f83b-456e-ad8e-208d0998d71d","00293c8e-1152-440b-9892-3c071fb88672","cf638fba-ef45-4c10-bc6f-adecc4b2bf4e","3861a5da-ae9b-4f20-a632-a9294489d5ac","1f60315b-236d-498e-be7a-92bc613d329b","a2c8da63-ed51-41e6-891a-4ae7e784463a"]
assets_metricsobject or nullrequired

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.

institutionsArray of strings or nullrequired

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.

Example: ["erebor_mx_retail"]
num_assets_accountsinteger or null(int32)

The total number of accounts found for the user.

Example: 1
num_checking_accountsinteger or null(int32)required

The total number of checking accounts found for the user.

Example: 1
num_savings_accountsinteger or null(int32)required

The total number of savings accounts found for the user.

Example: 1
checking_accounts_balancenumber or null(float)required

The total closing balance of all checking accounts.

Example: 35901.46
savings_accounts_balancenumber or null(float)required

The total closing balance of all savings accounts.

Example: 300.02
credit_cards_metricsobject or nullrequired

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.

num_accountsinteger(int32)>= 0required

Number of credit cards accounts associated to the user.

Example: 2
sum_credit_limitnumber or null(float)required

Sum total of all credit cards' limits.

Example: 106560
sum_credit_usednumber or null(float)required

Sum total of all credit used.

Example: 101020.14
credit_card_limit_utilizationnumber or null(float)required

The percentage of the credit card limit used.

Example: 0.95
loans_metricsobject or nullrequired

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.

num_accountsinteger(int32)required

The number of loan accounts associated with the user.

Example: 1
sum_loans_principalnumber or null(float)required

Sum total of the principal for all of the user's loan accounts.

Example: 5000
sum_loans_outstanding_principalnumber or null(float)required

Sum total of the outstanding principal for all the user's loan accounts.

Example: 2000
sum_loans_monthly_paymentnumber or null(float)required

Sum total of the monthly payments for all the user's loan accounts.

Example: 400
loan_limit_utilizationnumber or null(float)required

The percentage of the loan limit used.

Example: 0.3
overdraft_limitnumber or null(float)required

The total overdraft limit of all checking and savings accounts.

Example: 900
overdraft_limit_utilizationnumber or null(float)required

The percentage of the overdraft limit used.

Example: 0.4
balances_metricsobject or nullrequired

Balance metrics calculated based on the user's balances from checking and savings accounts.

closing_balancenumber or null(float)required

The balance of all the accounts at the collected_at time.

Example: 35901.46
min_balance_3dnumber or null(float)required

The minimum balance in the last three days.

Example: 35417.68
min_balance_1wnumber or null(float)required

The minimum balance in the last week).

Example: 34150.5
min_balance_1mnumber or null(float)required

The minimum balance in the last month.

Example: 33990.59
min_balance_3mnumber or null(float)required

The minimum balance in the last three months.

Example: 33990.59
min_balance_6mnumber or null(float)required

The minimum balance in the six last months.

Example: 33990.59
min_balance_12mnumber or null(float)required

The minimum balance in the last twelve months.

Example: 33990.59
mean_balance_3dnumber or null(float)required

The mean balance in the last three days.

Example: 35659.57
mean_balance_1wnumber or null(float)required

The mean balance in the last week.

Example: 35077.1
mean_balance_1mnumber or null(float)required

The mean balance in the last month.

Example: 34816.08
mean_balance_3mnumber or null(float)required

The mean balance in the last three months.

Example: 34816.08
mean_balance_6mnumber or null(float)required

The mean balance in the last six months.

Example: 34816.08
mean_balance_12mnumber or null(float)required

The mean balance in the last twelve months.

Example: 34816.08
max_balance_3dnumber or null(float)required

The maximum balance in the last three days.

Example: 35901.46
max_balance_1wnumber or null(float)required

The maximum balance in the last week.

Example: 35901.46
max_balance_1mnumber or null(float)required

The maximum balance in the last month.

Example: 35901.46
max_balance_3mnumber or null(float)required

The maximum balance in the last three months.

Example: 35901.46
max_balance_6mnumber or null(float)required

The maximum balance in the last six months.

Example: 35901.46
max_balance_12mnumber or null(float)required

The maximum balance in the last twelve months.

Example: 35901.46
std_balance_3dnumber or null(float)required

The balance standard deviation in the last three days.

Example: 279.31
std_balance_1wnumber or null(float)required

The balance standard deviation in the last week.

Example: 764.03
std_balance_1mnumber or null(float)required

The balance standard deviation in the last month.

Example: 586.55
std_balance_3mnumber or null(float)required

The balance standard deviation in the last three months.

Example: 586.55
std_balance_6mnumber or null(float)required

The balance standard deviation in the last six months.

Example: 586.55
std_balance_12mnumber or null(float)required

The balance standard deviation in the last twelve months.

Example: 586.55
balance_trend_3dnumber or null(float)required

The balance trend of the user in the last three days.

Example: 193.51
balance_trend_1wnumber or null(float)required

The balance trend of the user in the last week.

Example: 290.18
balance_trend_1mnumber or null(float)required

The balance trend of the user in the last month.

Example: 22.6
balance_trend_3mnumber or null(float)required

The balance trend of the user in the last three months.

Example: 22.6
balance_trend_6mnumber or null(float)required

The balance trend of the user in the last six months.

Example: 22.6
balance_trend_12mnumber or null(float)required

The balance trend of the user in the last twelve months.

Example: 22.6
days_balance_below_0_3dinteger or null(int32)required

The number of days that the total balance of the account is less than or equal to 0 in the last three days.

Example: 0
days_balance_below_0_1winteger or null(int32)required

The number of days that the total balance of the account is less than or equal to 0 in the last week.

Example: 0
days_balance_below_0_1minteger or null(int32)required

The number of days that the total balance of the account is less than or equal to 0 in the last month.

Example: 0
days_balance_below_0_3minteger or null(int32)required

The number of days that the total balance of the account is less than or equal to 0 in the last three months.

Example: 0
days_balance_below_0_6minteger or null(int32)required

The number of days that the total balance of the account is less than or equal to 0 in the last six months.

Example: 0
days_balance_below_0_12minteger or null(int32)required

The number of days that the total balance of the account is less than or equal to 0 in the last twelve months.

Example: 0
days_balance_below_mean_3dinteger or null(int32)required

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.

Example: 2
days_balance_below_mean_1winteger or null(int32)required

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.

Example: 3
days_balance_below_mean_1minteger or null(int32)required

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.

Example: 17
days_balance_below_mean_3minteger or null(int32)required

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.

Example: 17
days_balance_below_mean_6minteger or null(int32)required

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.

Example: 17
days_balance_below_mean_12minteger or null(int32)required

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.

Example: 17
days_balance_below_x_3dinteger or null(int32)required

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.

Example: 0
days_balance_below_x_1winteger or null(int32)required

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.

Example: 0
days_balance_below_x_1minteger or null(int32)required

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.

Example: 0
days_balance_below_x_3minteger or null(int32)required

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.

Example: 0
days_balance_below_x_6minteger or null(int32)required

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.

Example: 0
days_balance_below_x_12minteger or null(int32)required

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.

Example: 0
balance_threshold_xnumber(float)required

The threshold used to compute days_balance_below_x_period. Please note, this is value is country specific (both in terms of the amount and the currency).

Example: 1000
transactions_metricsobject or nullrequired

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 null for calculated fields and 0 for '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_3m will return null as there is no data for months two and three (calculated field).
  • num_transactions_3m will return 0 as there is no data for months two and three ('count-based' field)
num_transactions_3dinteger(int32)required

The total number of transactions analyzed to determine the risk insights for the last three days (incoming and outgoing).

Default 0
Example: 26
num_transactions_1winteger(int32)required

The total number of transactions analyzed to determine the risk insights for the last week (incoming and outgoing).

Default 0
Example: 46
num_transactions_1minteger(int32)required

The total number of transactions analyzed to determine the risk insights for the last month (incoming and outgoing).

Default 0
Example: 168
num_transactions_3minteger(int32)required

The total number of transactions analyzed to determine the risk insights for the last three months (incoming and outgoing).

Default 0
Example: 460
num_transactions_6minteger(int32)required

The total number of transactions analyzed to determine the risk insights for the last six months (incoming and outgoing).

Default 670
Example: 472
num_transactions_12minteger(int32)required

The total number of transactions analyzed to determine the risk insights for the last twelve months (incoming and outgoing).

Default 0
Example: 496
max_num_transactions_3dinteger(int32)required

The maximum number of transactions for the last three days.

Default 0
Example: 10
max_num_transactions_1winteger(int32)required

The maximum number of transactions for the last week.

Default 0
Example: 10
max_num_transactions_1minteger(int32)required

The maximum number of transactions for the last month.

Default 0
Example: 18
max_num_transactions_3minteger(int32)required

The maximum number of transactions for the last three months.

Default 0
Example: 18
max_num_transactions_6minteger(int32)required

The maximum number of transactions for the last six months.

Default 0
Example: 18
max_num_transactions_12minteger(int32)required

The maximum number of transactions for the last twelve months.

Default 0
Example: 18
mean_num_transactions_3dnumber(float)required

The mean number of transactions for the last three days.

Default 0
Example: 6.5
mean_num_transactions_1wnumber(float)required

The mean number of transactions for the last week.

Default 0
Example: 5.75
mean_num_transactions_1mnumber(float)required

The mean number of transactions for the last month.

Default 0
Example: 5.42
mean_num_transactions_3mnumber(float)required

The mean number of transactions for the last three months.

Default 0
Example: 5.05
mean_num_transactions_6mnumber(float)required

The mean number of transactions for the last six months.

Default 0
Example: 2.61
mean_num_transactions_12mnumber(float)required

The mean number of transactions for the last twelve months.

Default 0
Example: 1.37
num_incoming_transactions_3dinteger(int32)required

The total number of inflow transactions for the last three days.

Default 0
Example: 12
num_incoming_transactions_1winteger(int32)required

The total number of inflow transactions for the last week.

Default 0
Example: 21
num_incoming_transactions_1minteger(int32)required

The total number of inflow transactions for the last month.

Default 0
Example: 80
num_incoming_transactions_3minteger(int32)required

The total number of inflow transactions for the last three months.

Default 0
Example: 229
num_incoming_transactions_6minteger(int32)required

The total number of inflow transactions for the last six months.

Default 0
Example: 238
num_incoming_transactions_12minteger(int32)required

The total number of inflow transactions for the last twelve months.

Default 0
Example: 256
max_num_incoming_transactions_3dinteger(int32)required

The maximum number of inflow transactions for the last three days.

Default 0
Example: 6
max_num_incoming_transactions_1winteger(int32)required

The maximum number of inflow transactions for the last week.

Default 0
Example: 6
max_num_incoming_transactions_1minteger(int32)required

The maximum number of inflow transactions for the last month.

Default 0
Example: 10
max_num_incoming_transactions_3minteger(int32)required

The maximum number of inflow transactions for the last three months.

Default 0
Example: 10
max_num_incoming_transactions_6minteger(int32)required

The maximum number of inflow transactions for the last six months.

Default 0
Example: 10
max_num_incoming_transactions_12minteger(int32)required

The maximum number of inflow transactions for the last twelve months.

Default 0
Example: 10
mean_num_incoming_transactions_3dnumber(float)required

The mean number of inflow transactions for the last three days.

Default 0
Example: 3
mean_num_incoming_transactions_1wnumber(float)required

The mean number of inflow transactions for the last week.

Default 0
Example: 2.62
mean_num_incoming_transactions_1mnumber(float)required

The mean number of inflow transactions for the last month.

Default 0
Example: 2.58
mean_num_incoming_transactions_3mnumber(float)required

The mean number of inflow transactions for the last three months.

Default 0
Example: 2.52
mean_num_incoming_transactions_6mnumber(float)required

The mean number of inflow transactions for the last six months.

Default 0
Example: 1.31
mean_num_incoming_transactions_12mnumber(float)required

The mean number of inflow transactions for the last twelve months.

Default 0
Example: 0.71
sum_incoming_amount_3dnumber or null(float)required

The total sum of all inflow transactions for the last three days.

Example: 17142.16
sum_incoming_amount_1wnumber or null(float)required

The total sum of all inflow transactions for the last week.

Example: 24825.92
sum_incoming_amount_1mnumber or null(float)required

The total sum of all inflow transactions for the last month.

Example: 75993.36
sum_incoming_amount_3mnumber or null(float)required

The total sum of all inflow transactions for the last three months.

Example: 198197.28
sum_incoming_amount_6mnumber or null(float)required

The total sum of all inflow transactions for the last six months.

Example: 223697.28
sum_incoming_amount_12mnumber or null(float)required

The total sum of all inflow transactions for the last twelve months.

Example: 274697.28
max_incoming_amount_3dnumber or null(float)required

The highest value inflow transaction in the last three days.

Example: 3000
max_incoming_amount_1wnumber or null(float)required

The highest value inflow transaction in the last week.

Example: 3000
max_incoming_amount_1mnumber or null(float)required

The highest value inflow transaction in the last month.

Example: 3000
max_incoming_amount_3mnumber or null(float)required

The highest value inflow transaction in the last three months.

Example: 3000
max_incoming_amount_6mnumber or null(float)required

The highest value inflow transaction in the last six months.

Example: 3000
max_incoming_amount_12mnumber or null(float)required

The highest value inflow transaction in the last twelve months.

Example: 3000
mean_incoming_amount_3dnumber or null(float)required

The mean incoming value of all transactions in the last three days.

Example: 1428.51
mean_incoming_amount_1wnumber or null(float)required

The mean incoming value of all transactions in the last week.

Example: 1182.19
mean_incoming_amount_1mnumber or null(float)required

The mean incoming value of all transactions in the last month.

Example: 949.92
mean_incoming_amount_3mnumber or null(float)required

The mean incoming value of all transactions in the last three months.

Example: 865.49
mean_incoming_amount_6mnumber or null(float)required

The mean incoming value of all transactions in the last six months.

Example: 939.9
mean_incoming_amount_12mnumber or null(float)required

The mean incoming value of all transactions in the last twelve months.

Example: 1073.04
num_outgoing_transactions_3dinteger(int32)required

To total number of outflow transactions in the last three days.

Default 0
Example: 14
num_outgoing_transactions_1winteger(int32)required

To total number of outflow transactions in the last week.

Default 0
Example: 25
num_outgoing_transactions_1minteger(int32)required

To total number of outflow transactions in the last month.

Default 0
Example: 88
num_outgoing_transactions_3minteger(int32)required

To total number of outflow transactions in the last three months.

Default 0
Example: 231
num_outgoing_transactions_6minteger(int32)required

To total number of outflow transactions in the last six months.

Default 0
Example: 234
num_outgoing_transactions_12minteger(int32)required

To total number of outflow transactions in the last twelve months.

Default 0
Example: 240
max_num_outgoing_transactions_3dinteger(int32)required

The maximum number of outflow transactions for the last three days.

Default 0
Example: 6
max_num_outgoing_transactions_1winteger(int32)required

The maximum number of outflow transactions for the last week.

Default 0
Example: 6
max_num_outgoing_transactions_1minteger(int32)required

The maximum number of outflow transactions for the last month.

Default 0
Example: 8
max_num_outgoing_transactions_3minteger(int32)required

The maximum number of outflow transactions for the last three months.

Default 0
Example: 9
max_num_outgoing_transactions_6minteger(int32)required

The maximum number of outflow transactions for the last six months.

Default 0
Example: 9
max_num_outgoing_transactions_12minteger(int32)required

The maximum number of outflow transactions for the last twelve months.

Default 0
Example: 9
mean_num_outgoing_transactions_3dnumber(float)required

The mean number of outflow transactions for the last three days.

Default 0
Example: 3.5
mean_num_outgoing_transactions_1wnumber(float)required

The mean number of outflow transactions for the last week.

Default 0
Example: 3.12
mean_num_outgoing_transactions_1mnumber(float)required

The mean number of outflow transactions for the last month.

Default 0
Example: 2.84
mean_num_outgoing_transactions_3mnumber(float)required

The mean number of outflow transactions for the last three months.

Default 0
Example: 2.54
mean_num_outgoing_transactions_6mnumber(float)required

The mean number of outflow transactions for the last six months.

Default 0
Example: 1.29
mean_num_outgoing_transactions_12mnumber(float)required

The mean number of outflow transactions for the last twelve months.

Default 0
Example: 0.66
sum_outgoing_amount_3dnumber or null(float)required

The total sum of all outflow transactions for the last three days.

Example: 18246.95
sum_outgoing_amount_1wnumber or null(float)required

The total sum of all outflow transactions for the last week.

Example: 26362.25
sum_outgoing_amount_1mnumber or null(float)required

The total sum of all outflow transactions for the last month.

Example: 78243.82
sum_outgoing_amount_3mnumber or null(float)required

The total sum of all outflow transactions for the last three months.

Example: 192608.77
sum_outgoing_amount_6mnumber or null(float)required

The total sum of all outflow transactions for the last six months.

Example: 201608.77
sum_outgoing_amount_12mnumber or null(float)required

The total sum of all outflow transactions for the last twelve months.

Example: 219608.77
max_outgoing_amount_3dnumber or null(float)required

The highest value outflow transaction in the last three days.

Example: 3000
max_outgoing_amount_1wnumber or null(float)required

The highest value outflow transaction in the last week.

Example: 3000
max_outgoing_amount_1mnumber or null(float)required

The highest value outflow transaction in the last month.

Example: 3000
max_outgoing_amount_3mnumber or null(float)required

The highest value outflow transaction in the last three months.

Example: 3000
max_outgoing_amount_6mnumber or null(float)required

The highest value outflow transaction in the last six months.

Example: 3000
max_outgoing_amount_12mnumber or null(float)required

The highest value outflow transaction in the last twelve months.

Example: 3000
mean_outgoing_amount_3dnumber or null(float)required

The mean outgoing value of all transaction in the last three days.

Example: 1303.35
mean_outgoing_amount_1wnumber or null(float)required

The mean outgoing value of all transaction in the last week.

Example: 1054.49
mean_outgoing_amount_1mnumber or null(float)required

The mean outgoing value of all transaction in the last month.

Example: 889.13
mean_outgoing_amount_3mnumber or null(float)required

The mean outgoing value of all transaction in the last three months.

Example: 833.8
mean_outgoing_amount_6mnumber or null(float)required

The mean outgoing value of all transaction in the last six months.

Example: 861.58
mean_outgoing_amount_12mnumber or null(float)required

The mean outgoing value of all transaction in the last twelve months.

Example: 915.04
days_without_transactions_3dinteger(int32)required

The number of days that no transactions occurred within the last three days.

Default 0
Example: 0
days_without_transactions_1winteger(int32)required

The number of days that no transactions occurred within the last week.

Default 0
Example: 0
days_without_transactions_1minteger(int32)required

The number of days that no transactions occurred within the last month.

Default 0
Example: 0
days_without_transactions_3minteger(int32)required

The number of days that no transactions occurred within the last three months.

Default 0
Example: 0
days_without_transactions_6minteger(int32)required

The number of days that no transactions occurred within the last six months.

Default 0
Example: 87
days_without_transactions_12minteger(int32)required

The number of days that no transactions occurred within the last twelve months.

Default 0
Example: 261
days_since_last_transactioninteger(int32)required

The number of days since the last transaction occurred.

Default 0
Example: 0
days_since_last_incoming_transactioninteger(int32)required

The number of days since the last inflow transaction occurred.

Default 0
Example: 0
days_since_last_outgoing_transactioninteger(int32)required

The number of days since the last outflow transaction occurred.

Default 0
Example: 0
days_historyinteger(int32)required

The number of days between when the risk insight request was made and the first transaction.

Default 0
Example: 365
cashflow_metricsobject or nullrequired

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.

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 _3m we will return null as there is no data for months two and three.

max_positive_3dnumber or null(float)required

The highest value of positive cash flow transactions in the last three days.

Example: 1850.12
max_positive_1wnumber or null(float)required

The highest value of positive cash flow transactions the last week.

Example: 3808.99
max_positive_1mnumber or null(float)required

The highest value of positive cash flow transactions the last month.

Example: 4012.61
max_positive_3mnumber or null(float)required

The highest value of positive cash flow transactions the last three months.

Example: 5001.08
max_positive_6mnumber or null(float)required

The highest value of positive cash flow transactions the last six months.

Example: 8500
max_positive_12mnumber or null(float)required

The highest value of positive cash flow transactions the last twelve months.

Example: 8500
max_negative_3dnumber or null(float)required

The highest value of negative cash flow transactions in the last three days.

Example: 3375.43
max_negative_1wnumber or null(float)required

The highest value of negative cash flow transactions in the last week.

Example: 3375.43
max_negative_1mnumber or null(float)required

The highest value of negative cash flow transactions in the last month.

Example: 5305.92
max_negative_3mnumber or null(float)required

The highest value of negative cash flow transactions in the last three months.

Example: 7535.85
max_negative_6mnumber or null(float)required

The highest value of negative cash flow transactions in the last six months.

Example: 7535.85
max_negative_12mnumber or null(float)required

The highest value of negative cash flow transactions in the last twelve months.

Example: 7535.85
mean_positive_3dnumber or null(float)required

The mean value of the positive cash flow transactions in the last three days.

Example: 1410.54
mean_positive_1wnumber or null(float)required

The mean value of the positive cash flow transactions in the last week.

Example: 1665.74
mean_positive_1mnumber or null(float)required

The mean value of the positive cash flow transactions in the last month.

Example: 1827.36
mean_positive_3mnumber or null(float)required

The mean value of the positive cash flow transactions in the last three months.

Example: 1881.58
mean_positive_6mnumber or null(float)required

The mean value of the positive cash flow transactions in the last six months.

Example: 2102.19
mean_positive_12mnumber or null(float)required

The mean value of the positive cash flow transactions in the last twelve months.

Example: 2502.06
mean_negative_3dnumber or null(float)required

The mean value of the negative cash flow transactions in the last three days.

Example: 3373.48
mean_negative_1wnumber or null(float)required

The mean value of the negative cash flow transactions in the last week.

Example: 2477.04
mean_negative_1mnumber or null(float)required

The mean value of the negative cash flow transactions in the last month.

Example: 1904.96
mean_negative_3mnumber or null(float)required

The mean value of the negative cash flow transactions in the last three months.

Example: 1838.47
mean_negative_6mnumber or null(float)required

The mean value of the negative cash flow transactions in the last six months.

Example: 1877.63
mean_negative_12mnumber or null(float)required

The mean value of the negative cash flow transactions in the last twelve months.

Example: 1948.51
sum_positive_3dnumber or null(float)required

The sum total of all transactions leading to a positive cash flow in the last three days.

Example: 5642.16
sum_positive_1wnumber or null(float)required

The sum total of all transactions leading to a positive cash flow in the last week.

Example: 13325.92
sum_positive_1mnumber or null(float)required

The sum total of all transactions leading to a positive cash flow in the last month.

Example: 52993.36
sum_positive_3mnumber or null(float)required

The sum total of all transactions leading to a positive cash flow in the last three months.

Example: 163697.28
sum_positive_6mnumber or null(float)required

The sum total of all transactions leading to a positive cash flow in the last six months.

Example: 189197.28
sum_positive_12mnumber or null(float)required

The sum total of all transactions leading to a positive cash flow in the last twelve months.

Example: 240197.28
sum_positive_trend_3dnumber or null(float)required

The positive cash flow trend based on the sum of all positive transactions in the last three days.

Example: 98.902
sum_positive_trend_1wnumber or null(float)required

The positive cash flow trend based on the sum of all positive transactions in the last week.

Example: -84.0393
sum_positive_trend_1mnumber or null(float)required

The positive cash flow trend based on the sum of all positive transactions in the last month.

Example: 22.7315
sum_positive_trend_3mnumber or null(float)required

The positive cash flow trend based on the sum of all positive transactions in the last three months.

Example: 1.8398
sum_positive_trend_6mnumber or null(float)required

The positive cash flow trend based on the sum of all positive transactions in the last six months.

Example: -17.1869
sum_positive_trend_12mnumber or null(float)required

The positive cash flow trend based on the sum of all positive transactions in the last twelve months.

Example: -25.9856
sum_negative_3dnumber or null(float)required

The sum total of all transactions leading to a negative cash flow in the last three days.

Example: 6746.95
sum_negative_1wnumber or null(float)required

The sum total of all transactions leading to a negative cash flow in the last week.

Example: 14862.25
sum_negative_1mnumber or null(float)required

The sum total of all transactions leading to a negative cash flow in the last month.

Example: 55243.82
sum_negative_3mnumber or null(float)required

The sum total of all transactions leading to a negative cash flow in the last three months.

Example: 158108.77
sum_negative_6mnumber or null(float)required

The sum total of all transactions leading to a negative cash flow in the last six months.

Example: 167108.77
sum_negative_12mnumber or null(float)required

The sum total of all transactions leading to a negative cash flow in the last twelve months.

Example: 185108.77
sum_negative_trend_3dnumber or null(float)required

The negative cash flow trend based on the sum of all negative transactions in the last three days.

Example: -3.91
sum_negative_trend_1wnumber or null(float)required

The negative cash flow trend based on the sum of all negative transactions in the last week.

Example: 254.2517
sum_negative_trend_1mnumber or null(float)required

The negative cash flow trend based on the sum of all negative transactions in the last month.

Example: 58.376
sum_negative_trend_3mnumber or null(float)required

The negative cash flow trend based on the sum of all negative transactions in the last three months.

Example: 2.5895
sum_negative_trend_6mnumber or null(float)required

The negative cash flow trend based on the sum of all negative transactions in the last six months.

Example: -1.4824
sum_negative_trend_12mnumber or null(float)required

The negative cash flow trend based on the sum of all negative transactions in the last twelve months.

Example: -4.2394
positive_to_negative_ratio_3dnumber or null(float)required

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.

Example: 0.84
positive_to_negative_ratio_1wnumber or null(float)required

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.

Example: 0.9
positive_to_negative_ratio_1mnumber or null(float)required

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.

Example: 0.96
positive_to_negative_ratio_3mnumber or null(float)required

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.

Example: 1.04
positive_to_negative_ratio_6mnumber or null(float)required

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.

Example: 1.13
positive_to_negative_ratio_12mnumber or null(float)required

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.

Example: 1.3
net_cashflow_3dnumber or null(float)required

The net cash flow in the last three days.

Example: -1104.79
net_cashflow_1wnumber or null(float)required

The net cash flow in the last week.

Example: -1536.33
net_cashflow_1mnumber or null(float)required

The net cash flow in the last month.

Example: -2250.46
net_cashflow_3mnumber or null(float)required

The net cash flow in the last three months.

Example: 5588.51
net_cashflow_6mnumber or null(float)required

The net cash flow in the last six months.

Example: 22088.51
net_cashflow_12mnumber or null(float)required

The net cash flow in the last twelve months.

Example: 55088.51
net_cashflow_trend_3dnumber or null(float)required

The net cash flow trend in the last three days months.

Example: 1448.683
net_cashflow_trend_1wnumber or null(float)required

The net cash flow trend in the last week.

Example: 163.8856
net_cashflow_trend_1mnumber or null(float)required

The net cash flow trend in the last month.

Example: 1.3034
net_cashflow_trend_3mnumber or null(float)required

The net cash flow trend in the last three months.

Example: -0.472
net_cashflow_trend_6mnumber or null(float)required

The net cash flow trend in the last six months.

Example: -15.1286
net_cashflow_trend_12mnumber or null(float)required

The net cash flow trend in the last twelve months.

Example: -21.5511
category_metricsArray of objectsrequired

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.

categorystring or null

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 & Utilities
  • Credits & Loans
  • Deposits
  • Fees & Charges
  • Food & Groceries
  • Home & Life
  • Income & Payments
  • Insurance
  • Investments & Savings
  • Online Platforms & Leisure
  • Personal Shopping
  • Taxes
  • Transfers
  • Transport & Travel
  • Unknown*
  • Withdrawal & ATM
  • null

* For clients not using our Transaction Categorization product, we return null instead.

Enum"Bills & Utilities""Credits & Loans""Deposits""Fees & Charges""Food & Groceries""Home & Life""Income & Payments""Insurance""Investments & Savings""Online Platforms & Leisure"
Example: "Income & Payments"
subcategorystring or null

The transaction subcategory.

Get transaction categorization For clients not using our Transaction categorization, we return null instead. 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 & Energy
  • Rent
  • Telecommunications
  • Water
  • Auto
  • Credit Card
  • Instalment
  • Interest & Charges
  • Mortgage
  • Pay Advance
  • Personal
  • Adjustments
  • Bank Fees
  • Chargeback
  • Refund
  • Blocked Balances
  • Alimony
  • Alcohol & Tobacco
  • Bakery & Coffee
  • Bars & Nightclubs
  • Convenience Store
  • Delivery
  • Groceries
  • Restaurants
  • Education
  • Gyms & Fitness
  • Hair & Beauty
  • Health
  • Home Decor & Appliances
  • Laundry & Dry Cleaning
  • Pharmacies
  • Professional Services
  • Veterinary Services
  • Freelance
  • Interest
  • Retirement
  • Salary
  • Government
  • Home Insurance
  • Auto Insurance
  • Health & Life Insurance
  • Savings
  • Fixed income
  • Equity
  • Investment Funds
  • Derivatives
  • Cryptocurrencies
  • Apps, Software and Cloud Services
  • Events, Parks and Museums
  • Gambling
  • Gaming
  • Lottery
  • Movie & Audio
  • Books & News
  • Clothing & Accessories
  • Department Store
  • Electronics
  • E-commerce
  • Gifts
  • Office Supplies
  • Pet Supplies
  • Auto Tax & Fees
  • Donation
  • Government Fees
  • Income Tax
  • Real Estate Tax & Fees
  • Tax Return
  • Accommodation
  • Auto Expenses
  • Auto Rental
  • Flights
  • Gas
  • Mileage Programs
  • Parking & Tolls
  • Public Transit
  • Taxis & Rideshares
  • Other
  • null
Enum"Electricity & Energy""Rent""Telecommunications""Water""Auto""Credit Card""Instalment""Interest & Charges""Mortgage""Pay Advance"
Example: "Freelance"
net_amount_3mnumber or null(float)

The net amount of the transactions for this category in the last three months (calculated as the total incoming - total outgoing transactions for this category).

Example: 642.76
category_inflow_ratio_3mnumber or null(float)

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.

Example: 1
trend_3mnumber or null(float)

The net category transaction trend (incoming - outgoing transactions for the category) for the period.

Example: 0
]
Response
application/json
[
  {
    "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": [ … ]
  }
]

Get a risk insight's details

Request

Get the details of a specific risk insight.

Path
idstring(uuid)required

The risk-insights.id you want to get detailed information about.

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.

curl -i -X GET \
  -u <username>:<password> \
  'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/risk-insights/{id}/?fields=string&omit=string'

Responses

Ok

Bodyapplication/jsonArray [
idstring(uuid)required

Belvo's unique identifier for the current item.

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

The link.id the data belongs to.

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

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

Example: "2022-02-09T08:45:50.406032Z"
accountsArray of strings or null(uuid)required

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.

Example: ["0d3ffb69-f83b-456e-ad8e-208d0998d71d","00293c8e-1152-440b-9892-3c071fb88672","cf638fba-ef45-4c10-bc6f-adecc4b2bf4e","3861a5da-ae9b-4f20-a632-a9294489d5ac","1f60315b-236d-498e-be7a-92bc613d329b","a2c8da63-ed51-41e6-891a-4ae7e784463a"]
assets_metricsobject or nullrequired

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.

institutionsArray of strings or nullrequired

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.

Example: ["erebor_mx_retail"]
num_assets_accountsinteger or null(int32)

The total number of accounts found for the user.

Example: 1
num_checking_accountsinteger or null(int32)required

The total number of checking accounts found for the user.

Example: 1
num_savings_accountsinteger or null(int32)required

The total number of savings accounts found for the user.

Example: 1
checking_accounts_balancenumber or null(float)required

The total closing balance of all checking accounts.

Example: 35901.46
savings_accounts_balancenumber or null(float)required

The total closing balance of all savings accounts.

Example: 300.02
credit_cards_metricsobject or nullrequired

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.

num_accountsinteger(int32)>= 0required

Number of credit cards accounts associated to the user.

Example: 2
sum_credit_limitnumber or null(float)required

Sum total of all credit cards' limits.

Example: 106560
sum_credit_usednumber or null(float)required

Sum total of all credit used.

Example: 101020.14
credit_card_limit_utilizationnumber or null(float)required

The percentage of the credit card limit used.

Example: 0.95
loans_metricsobject or nullrequired

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.

num_accountsinteger(int32)required

The number of loan accounts associated with the user.

Example: 1
sum_loans_principalnumber or null(float)required

Sum total of the principal for all of the user's loan accounts.

Example: 5000
sum_loans_outstanding_principalnumber or null(float)required

Sum total of the outstanding principal for all the user's loan accounts.

Example: 2000
sum_loans_monthly_paymentnumber or null(float)required

Sum total of the monthly payments for all the user's loan accounts.

Example: 400
loan_limit_utilizationnumber or null(float)required

The percentage of the loan limit used.

Example: 0.3
overdraft_limitnumber or null(float)required

The total overdraft limit of all checking and savings accounts.

Example: 900
overdraft_limit_utilizationnumber or null(float)required

The percentage of the overdraft limit used.

Example: 0.4
balances_metricsobject or nullrequired

Balance metrics calculated based on the user's balances from checking and savings accounts.

closing_balancenumber or null(float)required

The balance of all the accounts at the collected_at time.

Example: 35901.46
min_balance_3dnumber or null(float)required

The minimum balance in the last three days.

Example: 35417.68
min_balance_1wnumber or null(float)required

The minimum balance in the last week).

Example: 34150.5
min_balance_1mnumber or null(float)required

The minimum balance in the last month.

Example: 33990.59
min_balance_3mnumber or null(float)required

The minimum balance in the last three months.

Example: 33990.59
min_balance_6mnumber or null(float)required

The minimum balance in the six last months.

Example: 33990.59
min_balance_12mnumber or null(float)required

The minimum balance in the last twelve months.

Example: 33990.59
mean_balance_3dnumber or null(float)required

The mean balance in the last three days.

Example: 35659.57
mean_balance_1wnumber or null(float)required

The mean balance in the last week.

Example: 35077.1
mean_balance_1mnumber or null(float)required

The mean balance in the last month.

Example: 34816.08
mean_balance_3mnumber or null(float)required

The mean balance in the last three months.

Example: 34816.08
mean_balance_6mnumber or null(float)required

The mean balance in the last six months.

Example: 34816.08
mean_balance_12mnumber or null(float)required

The mean balance in the last twelve months.

Example: 34816.08
max_balance_3dnumber or null(float)required

The maximum balance in the last three days.

Example: 35901.46
max_balance_1wnumber or null(float)required

The maximum balance in the last week.

Example: 35901.46
max_balance_1mnumber or null(float)required

The maximum balance in the last month.

Example: 35901.46
max_balance_3mnumber or null(float)required

The maximum balance in the last three months.

Example: 35901.46
max_balance_6mnumber or null(float)required

The maximum balance in the last six months.

Example: 35901.46
max_balance_12mnumber or null(float)required

The maximum balance in the last twelve months.

Example: 35901.46
std_balance_3dnumber or null(float)required

The balance standard deviation in the last three days.

Example: 279.31
std_balance_1wnumber or null(float)required

The balance standard deviation in the last week.

Example: 764.03
std_balance_1mnumber or null(float)required

The balance standard deviation in the last month.

Example: 586.55
std_balance_3mnumber or null(float)required

The balance standard deviation in the last three months.

Example: 586.55
std_balance_6mnumber or null(float)required

The balance standard deviation in the last six months.

Example: 586.55
std_balance_12mnumber or null(float)required

The balance standard deviation in the last twelve months.

Example: 586.55
balance_trend_3dnumber or null(float)required

The balance trend of the user in the last three days.

Example: 193.51
balance_trend_1wnumber or null(float)required

The balance trend of the user in the last week.

Example: 290.18
balance_trend_1mnumber or null(float)required

The balance trend of the user in the last month.

Example: 22.6
balance_trend_3mnumber or null(float)required

The balance trend of the user in the last three months.

Example: 22.6
balance_trend_6mnumber or null(float)required

The balance trend of the user in the last six months.

Example: 22.6
balance_trend_12mnumber or null(float)required

The balance trend of the user in the last twelve months.

Example: 22.6
days_balance_below_0_3dinteger or null(int32)required

The number of days that the total balance of the account is less than or equal to 0 in the last three days.

Example: 0
days_balance_below_0_1winteger or null(int32)required

The number of days that the total balance of the account is less than or equal to 0 in the last week.

Example: 0
days_balance_below_0_1minteger or null(int32)required

The number of days that the total balance of the account is less than or equal to 0 in the last month.

Example: 0
days_balance_below_0_3minteger or null(int32)required

The number of days that the total balance of the account is less than or equal to 0 in the last three months.

Example: 0
days_balance_below_0_6minteger or null(int32)required

The number of days that the total balance of the account is less than or equal to 0 in the last six months.

Example: 0
days_balance_below_0_12minteger or null(int32)required

The number of days that the total balance of the account is less than or equal to 0 in the last twelve months.

Example: 0
days_balance_below_mean_3dinteger or null(int32)required

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.

Example: 2
days_balance_below_mean_1winteger or null(int32)required

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.

Example: 3
days_balance_below_mean_1minteger or null(int32)required

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.

Example: 17
days_balance_below_mean_3minteger or null(int32)required

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.

Example: 17
days_balance_below_mean_6minteger or null(int32)required

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.

Example: 17
days_balance_below_mean_12minteger or null(int32)required

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.

Example: 17
days_balance_below_x_3dinteger or null(int32)required

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.

Example: 0
days_balance_below_x_1winteger or null(int32)required

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.

Example: 0
days_balance_below_x_1minteger or null(int32)required

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.

Example: 0
days_balance_below_x_3minteger or null(int32)required

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.

Example: 0
days_balance_below_x_6minteger or null(int32)required

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.

Example: 0
days_balance_below_x_12minteger or null(int32)required

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.

Example: 0
balance_threshold_xnumber(float)required

The threshold used to compute days_balance_below_x_period. Please note, this is value is country specific (both in terms of the amount and the currency).

Example: 1000
transactions_metricsobject or nullrequired

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 null for calculated fields and 0 for '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_3m will return null as there is no data for months two and three (calculated field).
  • num_transactions_3m will return 0 as there is no data for months two and three ('count-based' field)
num_transactions_3dinteger(int32)required

The total number of transactions analyzed to determine the risk insights for the last three days (incoming and outgoing).

Default 0
Example: 26
num_transactions_1winteger(int32)required

The total number of transactions analyzed to determine the risk insights for the last week (incoming and outgoing).

Default 0
Example: 46
num_transactions_1minteger(int32)required

The total number of transactions analyzed to determine the risk insights for the last month (incoming and outgoing).

Default 0
Example: 168
num_transactions_3minteger(int32)required

The total number of transactions analyzed to determine the risk insights for the last three months (incoming and outgoing).

Default 0
Example: 460
num_transactions_6minteger(int32)required

The total number of transactions analyzed to determine the risk insights for the last six months (incoming and outgoing).

Default 670
Example: 472
num_transactions_12minteger(int32)required

The total number of transactions analyzed to determine the risk insights for the last twelve months (incoming and outgoing).

Default 0
Example: 496
max_num_transactions_3dinteger(int32)required

The maximum number of transactions for the last three days.

Default 0
Example: 10
max_num_transactions_1winteger(int32)required

The maximum number of transactions for the last week.

Default 0
Example: 10
max_num_transactions_1minteger(int32)required

The maximum number of transactions for the last month.

Default 0
Example: 18
max_num_transactions_3minteger(int32)required

The maximum number of transactions for the last three months.

Default 0
Example: 18
max_num_transactions_6minteger(int32)required

The maximum number of transactions for the last six months.

Default 0
Example: 18
max_num_transactions_12minteger(int32)required

The maximum number of transactions for the last twelve months.

Default 0
Example: 18
mean_num_transactions_3dnumber(float)required

The mean number of transactions for the last three days.

Default 0
Example: 6.5
mean_num_transactions_1wnumber(float)required

The mean number of transactions for the last week.

Default 0
Example: 5.75
mean_num_transactions_1mnumber(float)required

The mean number of transactions for the last month.

Default 0
Example: 5.42
mean_num_transactions_3mnumber(float)required

The mean number of transactions for the last three months.

Default 0
Example: 5.05
mean_num_transactions_6mnumber(float)required

The mean number of transactions for the last six months.

Default 0
Example: 2.61
mean_num_transactions_12mnumber(float)required

The mean number of transactions for the last twelve months.

Default 0
Example: 1.37
num_incoming_transactions_3dinteger(int32)required

The total number of inflow transactions for the last three days.

Default 0
Example: 12
num_incoming_transactions_1winteger(int32)required

The total number of inflow transactions for the last week.

Default 0
Example: 21
num_incoming_transactions_1minteger(int32)required

The total number of inflow transactions for the last month.

Default 0
Example: 80
num_incoming_transactions_3minteger(int32)required

The total number of inflow transactions for the last three months.

Default 0
Example: 229
num_incoming_transactions_6minteger(int32)required

The total number of inflow transactions for the last six months.

Default 0
Example: 238
num_incoming_transactions_12minteger(int32)required

The total number of inflow transactions for the last twelve months.

Default 0
Example: 256
max_num_incoming_transactions_3dinteger(int32)required

The maximum number of inflow transactions for the last three days.

Default 0
Example: 6
max_num_incoming_transactions_1winteger(int32)required

The maximum number of inflow transactions for the last week.

Default 0
Example: 6
max_num_incoming_transactions_1minteger(int32)required

The maximum number of inflow transactions for the last month.

Default 0
Example: 10
max_num_incoming_transactions_3minteger(int32)required

The maximum number of inflow transactions for the last three months.

Default 0
Example: 10
max_num_incoming_transactions_6minteger(int32)required

The maximum number of inflow transactions for the last six months.

Default 0
Example: 10
max_num_incoming_transactions_12minteger(int32)required

The maximum number of inflow transactions for the last twelve months.

Default 0
Example: 10
mean_num_incoming_transactions_3dnumber(float)required

The mean number of inflow transactions for the last three days.

Default 0
Example: 3
mean_num_incoming_transactions_1wnumber(float)required

The mean number of inflow transactions for the last week.

Default 0
Example: 2.62
mean_num_incoming_transactions_1mnumber(float)required

The mean number of inflow transactions for the last month.

Default 0
Example: 2.58
mean_num_incoming_transactions_3mnumber(float)required

The mean number of inflow transactions for the last three months.

Default 0
Example: 2.52
mean_num_incoming_transactions_6mnumber(float)required

The mean number of inflow transactions for the last six months.

Default 0
Example: 1.31
mean_num_incoming_transactions_12mnumber(float)required

The mean number of inflow transactions for the last twelve months.

Default 0
Example: 0.71
sum_incoming_amount_3dnumber or null(float)required

The total sum of all inflow transactions for the last three days.

Example: 17142.16
sum_incoming_amount_1wnumber or null(float)required

The total sum of all inflow transactions for the last week.

Example: 24825.92
sum_incoming_amount_1mnumber or null(float)required

The total sum of all inflow transactions for the last month.

Example: 75993.36
sum_incoming_amount_3mnumber or null(float)required

The total sum of all inflow transactions for the last three months.

Example: 198197.28
sum_incoming_amount_6mnumber or null(float)required

The total sum of all inflow transactions for the last six months.

Example: 223697.28
sum_incoming_amount_12mnumber or null(float)required

The total sum of all inflow transactions for the last twelve months.

Example: 274697.28
max_incoming_amount_3dnumber or null(float)required

The highest value inflow transaction in the last three days.

Example: 3000
max_incoming_amount_1wnumber or null(float)required

The highest value inflow transaction in the last week.

Example: 3000
max_incoming_amount_1mnumber or null(float)required

The highest value inflow transaction in the last month.

Example: 3000
max_incoming_amount_3mnumber or null(float)required

The highest value inflow transaction in the last three months.

Example: 3000
max_incoming_amount_6mnumber or null(float)required

The highest value inflow transaction in the last six months.

Example: 3000
max_incoming_amount_12mnumber or null(float)required

The highest value inflow transaction in the last twelve months.

Example: 3000
mean_incoming_amount_3dnumber or null(float)required

The mean incoming value of all transactions in the last three days.

Example: 1428.51
mean_incoming_amount_1wnumber or null(float)required

The mean incoming value of all transactions in the last week.

Example: 1182.19
mean_incoming_amount_1mnumber or null(float)required

The mean incoming value of all transactions in the last month.

Example: 949.92
mean_incoming_amount_3mnumber or null(float)required

The mean incoming value of all transactions in the last three months.

Example: 865.49
mean_incoming_amount_6mnumber or null(float)required

The mean incoming value of all transactions in the last six months.

Example: 939.9
mean_incoming_amount_12mnumber or null(float)required

The mean incoming value of all transactions in the last twelve months.

Example: 1073.04
num_outgoing_transactions_3dinteger(int32)required

To total number of outflow transactions in the last three days.

Default 0
Example: 14
num_outgoing_transactions_1winteger(int32)required

To total number of outflow transactions in the last week.

Default 0
Example: 25
num_outgoing_transactions_1minteger(int32)required

To total number of outflow transactions in the last month.

Default 0
Example: 88
num_outgoing_transactions_3minteger(int32)required

To total number of outflow transactions in the last three months.

Default 0
Example: 231
num_outgoing_transactions_6minteger(int32)required

To total number of outflow transactions in the last six months.

Default 0
Example: 234
num_outgoing_transactions_12minteger(int32)required

To total number of outflow transactions in the last twelve months.

Default 0
Example: 240
max_num_outgoing_transactions_3dinteger(int32)required

The maximum number of outflow transactions for the last three days.

Default 0
Example: 6
max_num_outgoing_transactions_1winteger(int32)required

The maximum number of outflow transactions for the last week.

Default 0
Example: 6
max_num_outgoing_transactions_1minteger(int32)required

The maximum number of outflow transactions for the last month.

Default 0
Example: 8
max_num_outgoing_transactions_3minteger(int32)required

The maximum number of outflow transactions for the last three months.

Default 0
Example: 9
max_num_outgoing_transactions_6minteger(int32)required

The maximum number of outflow transactions for the last six months.

Default 0
Example: 9
max_num_outgoing_transactions_12minteger(int32)required

The maximum number of outflow transactions for the last twelve months.

Default 0
Example: 9
mean_num_outgoing_transactions_3dnumber(float)required

The mean number of outflow transactions for the last three days.

Default 0
Example: 3.5
mean_num_outgoing_transactions_1wnumber(float)required

The mean number of outflow transactions for the last week.

Default 0
Example: 3.12
mean_num_outgoing_transactions_1mnumber(float)required

The mean number of outflow transactions for the last month.

Default 0
Example: 2.84
mean_num_outgoing_transactions_3mnumber(float)required

The mean number of outflow transactions for the last three months.

Default 0
Example: 2.54
mean_num_outgoing_transactions_6mnumber(float)required

The mean number of outflow transactions for the last six months.

Default 0
Example: 1.29
mean_num_outgoing_transactions_12mnumber(float)required

The mean number of outflow transactions for the last twelve months.

Default 0
Example: 0.66
sum_outgoing_amount_3dnumber or null(float)required

The total sum of all outflow transactions for the last three days.

Example: 18246.95
sum_outgoing_amount_1wnumber or null(float)required

The total sum of all outflow transactions for the last week.

Example: 26362.25
sum_outgoing_amount_1mnumber or null(float)required

The total sum of all outflow transactions for the last month.

Example: 78243.82
sum_outgoing_amount_3mnumber or null(float)required

The total sum of all outflow transactions for the last three months.

Example: 192608.77
sum_outgoing_amount_6mnumber or null(float)required

The total sum of all outflow transactions for the last six months.

Example: 201608.77
sum_outgoing_amount_12mnumber or null(float)required

The total sum of all outflow transactions for the last twelve months.

Example: 219608.77
max_outgoing_amount_3dnumber or null(float)required

The highest value outflow transaction in the last three days.

Example: 3000
max_outgoing_amount_1wnumber or null(float)required

The highest value outflow transaction in the last week.

Example: 3000
max_outgoing_amount_1mnumber or null(float)required

The highest value outflow transaction in the last month.

Example: 3000
max_outgoing_amount_3mnumber or null(float)required

The highest value outflow transaction in the last three months.

Example: 3000
max_outgoing_amount_6mnumber or null(float)required

The highest value outflow transaction in the last six months.

Example: 3000
max_outgoing_amount_12mnumber or null(float)required

The highest value outflow transaction in the last twelve months.

Example: 3000
mean_outgoing_amount_3dnumber or null(float)required

The mean outgoing value of all transaction in the last three days.

Example: 1303.35
mean_outgoing_amount_1wnumber or null(float)required

The mean outgoing value of all transaction in the last week.

Example: 1054.49
mean_outgoing_amount_1mnumber or null(float)required

The mean outgoing value of all transaction in the last month.

Example: 889.13
mean_outgoing_amount_3mnumber or null(float)required

The mean outgoing value of all transaction in the last three months.

Example: 833.8
mean_outgoing_amount_6mnumber or null(float)required

The mean outgoing value of all transaction in the last six months.

Example: 861.58
mean_outgoing_amount_12mnumber or null(float)required

The mean outgoing value of all transaction in the last twelve months.

Example: 915.04
days_without_transactions_3dinteger(int32)required

The number of days that no transactions occurred within the last three days.

Default 0
Example: 0
days_without_transactions_1winteger(int32)required

The number of days that no transactions occurred within the last week.

Default 0
Example: 0
days_without_transactions_1minteger(int32)required

The number of days that no transactions occurred within the last month.

Default 0
Example: 0
days_without_transactions_3minteger(int32)required

The number of days that no transactions occurred within the last three months.

Default 0
Example: 0
days_without_transactions_6minteger(int32)required

The number of days that no transactions occurred within the last six months.

Default 0
Example: 87
days_without_transactions_12minteger(int32)required

The number of days that no transactions occurred within the last twelve months.

Default 0
Example: 261
days_since_last_transactioninteger(int32)required

The number of days since the last transaction occurred.

Default 0
Example: 0
days_since_last_incoming_transactioninteger(int32)required

The number of days since the last inflow transaction occurred.

Default 0
Example: 0
days_since_last_outgoing_transactioninteger(int32)required

The number of days since the last outflow transaction occurred.

Default 0
Example: 0
days_historyinteger(int32)required

The number of days between when the risk insight request was made and the first transaction.

Default 0
Example: 365
cashflow_metricsobject or nullrequired

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.

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 _3m we will return null as there is no data for months two and three.

max_positive_3dnumber or null(float)required

The highest value of positive cash flow transactions in the last three days.

Example: 1850.12
max_positive_1wnumber or null(float)required

The highest value of positive cash flow transactions the last week.

Example: 3808.99
max_positive_1mnumber or null(float)required

The highest value of positive cash flow transactions the last month.

Example: 4012.61
max_positive_3mnumber or null(float)required

The highest value of positive cash flow transactions the last three months.

Example: 5001.08
max_positive_6mnumber or null(float)required

The highest value of positive cash flow transactions the last six months.

Example: 8500
max_positive_12mnumber or null(float)required

The highest value of positive cash flow transactions the last twelve months.

Example: 8500
max_negative_3dnumber or null(float)required

The highest value of negative cash flow transactions in the last three days.

Example: 3375.43
max_negative_1wnumber or null(float)required

The highest value of negative cash flow transactions in the last week.

Example: 3375.43
max_negative_1mnumber or null(float)required

The highest value of negative cash flow transactions in the last month.

Example: 5305.92
max_negative_3mnumber or null(float)required

The highest value of negative cash flow transactions in the last three months.

Example: 7535.85
max_negative_6mnumber or null(float)required

The highest value of negative cash flow transactions in the last six months.

Example: 7535.85
max_negative_12mnumber or null(float)required

The highest value of negative cash flow transactions in the last twelve months.

Example: 7535.85
mean_positive_3dnumber or null(float)required

The mean value of the positive cash flow transactions in the last three days.

Example: 1410.54
mean_positive_1wnumber or null(float)required

The mean value of the positive cash flow transactions in the last week.

Example: 1665.74
mean_positive_1mnumber or null(float)required

The mean value of the positive cash flow transactions in the last month.

Example: 1827.36
mean_positive_3mnumber or null(float)required

The mean value of the positive cash flow transactions in the last three months.

Example: 1881.58
mean_positive_6mnumber or null(float)required

The mean value of the positive cash flow transactions in the last six months.

Example: 2102.19
mean_positive_12mnumber or null(float)required

The mean value of the positive cash flow transactions in the last twelve months.

Example: 2502.06
mean_negative_3dnumber or null(float)required

The mean value of the negative cash flow transactions in the last three days.

Example: 3373.48
mean_negative_1wnumber or null(float)required

The mean value of the negative cash flow transactions in the last week.

Example: 2477.04
mean_negative_1mnumber or null(float)required

The mean value of the negative cash flow transactions in the last month.

Example: 1904.96
mean_negative_3mnumber or null(float)required

The mean value of the negative cash flow transactions in the last three months.

Example: 1838.47
mean_negative_6mnumber or null(float)required

The mean value of the negative cash flow transactions in the last six months.

Example: 1877.63
mean_negative_12mnumber or null(float)required

The mean value of the negative cash flow transactions in the last twelve months.

Example: 1948.51
sum_positive_3dnumber or null(float)required

The sum total of all transactions leading to a positive cash flow in the last three days.

Example: 5642.16
sum_positive_1wnumber or null(float)required

The sum total of all transactions leading to a positive cash flow in the last week.

Example: 13325.92
sum_positive_1mnumber or null(float)required

The sum total of all transactions leading to a positive cash flow in the last month.

Example: 52993.36
sum_positive_3mnumber or null(float)required

The sum total of all transactions leading to a positive cash flow in the last three months.

Example: 163697.28
sum_positive_6mnumber or null(float)required

The sum total of all transactions leading to a positive cash flow in the last six months.

Example: 189197.28
sum_positive_12mnumber or null(float)required

The sum total of all transactions leading to a positive cash flow in the last twelve months.

Example: 240197.28
sum_positive_trend_3dnumber or null(float)required

The positive cash flow trend based on the sum of all positive transactions in the last three days.

Example: 98.902
sum_positive_trend_1wnumber or null(float)required

The positive cash flow trend based on the sum of all positive transactions in the last week.

Example: -84.0393
sum_positive_trend_1mnumber or null(float)required

The positive cash flow trend based on the sum of all positive transactions in the last month.

Example: 22.7315
sum_positive_trend_3mnumber or null(float)required

The positive cash flow trend based on the sum of all positive transactions in the last three months.

Example: 1.8398
sum_positive_trend_6mnumber or null(float)required

The positive cash flow trend based on the sum of all positive transactions in the last six months.

Example: -17.1869
sum_positive_trend_12mnumber or null(float)required

The positive cash flow trend based on the sum of all positive transactions in the last twelve months.

Example: -25.9856
sum_negative_3dnumber or null(float)required

The sum total of all transactions leading to a negative cash flow in the last three days.

Example: 6746.95
sum_negative_1wnumber or null(float)required

The sum total of all transactions leading to a negative cash flow in the last week.

Example: 14862.25
sum_negative_1mnumber or null(float)required

The sum total of all transactions leading to a negative cash flow in the last month.

Example: 55243.82
sum_negative_3mnumber or null(float)required

The sum total of all transactions leading to a negative cash flow in the last three months.

Example: 158108.77
sum_negative_6mnumber or null(float)required

The sum total of all transactions leading to a negative cash flow in the last six months.

Example: 167108.77
sum_negative_12mnumber or null(float)required

The sum total of all transactions leading to a negative cash flow in the last twelve months.

Example: 185108.77
sum_negative_trend_3dnumber or null(float)required

The negative cash flow trend based on the sum of all negative transactions in the last three days.

Example: -3.91
sum_negative_trend_1wnumber or null(float)required

The negative cash flow trend based on the sum of all negative transactions in the last week.

Example: 254.2517
sum_negative_trend_1mnumber or null(float)required

The negative cash flow trend based on the sum of all negative transactions in the last month.

Example: 58.376
sum_negative_trend_3mnumber or null(float)required

The negative cash flow trend based on the sum of all negative transactions in the last three months.

Example: 2.5895
sum_negative_trend_6mnumber or null(float)required

The negative cash flow trend based on the sum of all negative transactions in the last six months.

Example: -1.4824
sum_negative_trend_12mnumber or null(float)required

The negative cash flow trend based on the sum of all negative transactions in the last twelve months.

Example: -4.2394
positive_to_negative_ratio_3dnumber or null(float)required

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.

Example: 0.84
positive_to_negative_ratio_1wnumber or null(float)required

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.

Example: 0.9
positive_to_negative_ratio_1mnumber or null(float)required

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.

Example: 0.96
positive_to_negative_ratio_3mnumber or null(float)required

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.

Example: 1.04
positive_to_negative_ratio_6mnumber or null(float)required

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.

Example: 1.13
positive_to_negative_ratio_12mnumber or null(float)required

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.

Example: 1.3
net_cashflow_3dnumber or null(float)required

The net cash flow in the last three days.

Example: -1104.79
net_cashflow_1wnumber or null(float)required

The net cash flow in the last week.

Example: -1536.33
net_cashflow_1mnumber or null(float)required

The net cash flow in the last month.

Example: -2250.46
net_cashflow_3mnumber or null(float)required

The net cash flow in the last three months.

Example: 5588.51
net_cashflow_6mnumber or null(float)required

The net cash flow in the last six months.

Example: 22088.51
net_cashflow_12mnumber or null(float)required

The net cash flow in the last twelve months.

Example: 55088.51
net_cashflow_trend_3dnumber or null(float)required

The net cash flow trend in the last three days months.

Example: 1448.683
net_cashflow_trend_1wnumber or null(float)required

The net cash flow trend in the last week.

Example: 163.8856
net_cashflow_trend_1mnumber or null(float)required

The net cash flow trend in the last month.

Example: 1.3034
net_cashflow_trend_3mnumber or null(float)required

The net cash flow trend in the last three months.

Example: -0.472
net_cashflow_trend_6mnumber or null(float)required

The net cash flow trend in the last six months.

Example: -15.1286
net_cashflow_trend_12mnumber or null(float)required

The net cash flow trend in the last twelve months.

Example: -21.5511
category_metricsArray of objectsrequired

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.

categorystring or null

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 & Utilities
  • Credits & Loans
  • Deposits
  • Fees & Charges
  • Food & Groceries
  • Home & Life
  • Income & Payments
  • Insurance
  • Investments & Savings
  • Online Platforms & Leisure
  • Personal Shopping
  • Taxes
  • Transfers
  • Transport & Travel
  • Unknown*
  • Withdrawal & ATM
  • null

* For clients not using our Transaction Categorization product, we return null instead.

Enum"Bills & Utilities""Credits & Loans""Deposits""Fees & Charges""Food & Groceries""Home & Life""Income & Payments""Insurance""Investments & Savings""Online Platforms & Leisure"
Example: "Income & Payments"
subcategorystring or null

The transaction subcategory.

Get transaction categorization For clients not using our Transaction categorization, we return null instead. 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 & Energy
  • Rent
  • Telecommunications
  • Water
  • Auto
  • Credit Card
  • Instalment
  • Interest & Charges
  • Mortgage
  • Pay Advance
  • Personal
  • Adjustments
  • Bank Fees
  • Chargeback
  • Refund
  • Blocked Balances
  • Alimony
  • Alcohol & Tobacco
  • Bakery & Coffee
  • Bars & Nightclubs
  • Convenience Store
  • Delivery
  • Groceries
  • Restaurants
  • Education
  • Gyms & Fitness
  • Hair & Beauty
  • Health
  • Home Decor & Appliances
  • Laundry & Dry Cleaning
  • Pharmacies
  • Professional Services
  • Veterinary Services
  • Freelance
  • Interest
  • Retirement
  • Salary
  • Government
  • Home Insurance
  • Auto Insurance
  • Health & Life Insurance
  • Savings
  • Fixed income
  • Equity
  • Investment Funds
  • Derivatives
  • Cryptocurrencies
  • Apps, Software and Cloud Services
  • Events, Parks and Museums
  • Gambling
  • Gaming
  • Lottery
  • Movie & Audio
  • Books & News
  • Clothing & Accessories
  • Department Store
  • Electronics
  • E-commerce
  • Gifts
  • Office Supplies
  • Pet Supplies
  • Auto Tax & Fees
  • Donation
  • Government Fees
  • Income Tax
  • Real Estate Tax & Fees
  • Tax Return
  • Accommodation
  • Auto Expenses
  • Auto Rental
  • Flights
  • Gas
  • Mileage Programs
  • Parking & Tolls
  • Public Transit
  • Taxis & Rideshares
  • Other
  • null
Enum"Electricity & Energy""Rent""Telecommunications""Water""Auto""Credit Card""Instalment""Interest & Charges""Mortgage""Pay Advance"
Example: "Freelance"
net_amount_3mnumber or null(float)

The net amount of the transactions for this category in the last three months (calculated as the total incoming - total outgoing transactions for this category).

Example: 642.76
category_inflow_ratio_3mnumber or null(float)

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.

Example: 1
trend_3mnumber or null(float)

The net category transaction trend (incoming - outgoing transactions for the category) for the period.

Example: 0
]
Response
application/json
[
  {
    "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": [ … ]
  }
]

Delete a risk insight

Request

Delete a specific risk insight from your Belvo account.

Path
idstring(uuid)required

The risk-insights.id that you want to delete

curl -i -X DELETE \
  -u <username>:<password> \
  'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/risk-insights/{id}/'

Responses

No content

Response
No content

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