# List risk insights ## ▶️ Usage With the List Risk Insights method, you can: 1. List risk insights related to a specific (using the query parameter). 2. Get the details of a specific (using the query parameter). 3. List all risk insights related to your Belvo account (without using any query parameters). ## 📖 Pagination This method returns a paginated response (default: 100 items per page). You can use the query parameter to increase the number of items returned to a maximum of 1000 items. You can use the query parameter to navigate through the results. For more details on how to navigate Belvo's paginated responses, see our Pagination Tips article. ## 🔦 Filtering Responses Please see the query list below for a list of fields that you can filter your responses by. For more information on how to use filters, see our Filtering responses article. Endpoint: GET /api/risk-insights/ Version: 1.222.0 Security: basicAuth ## Query parameters: - `link` (string) The you want to filter by. ℹ️ We highly recommend adding the filter in order to improve your performance. Example: "8848bd0c-9c7e-4f53-a732-ec896b11d4c4" - `page_size` (integer) Indicates how many results to return per page. By default we return 100 results per page. ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000). Example: 100 - `page` (integer) A page number within the paginated result set. Example: 1 - `omit` (string) Omit certain fields from being returned in the response. For more information, see our Filtering responses DevPortal article. - `fields` (string) Return only the specified fields in the response. For more information, see our Filtering responses DevPortal article. - `link__in` (array) Return results only for these s. Example: ["5722d0ba-69d7-42dc-8ff5-33767b83c5d6"] - `account` (string) The you want to filter by. ℹ️ We highly recommend adding either the or the filters in order to improve your performance. Example: "8848bd0c-9c7e-4f53-a732-ec896b11d4c4" - `account__in` (array) Return results only for these s. Example: ["85b77707-90ef-46fd-9059-5a757f24247a"] - `id` (string) Return information only for this resource . Example: "24ccab1d-3a86-4136-a6eb-e04bf52b356f" - `id__in` (array) Return information for these resource s. Example: ["6b3dea0f-be29-49d1-aabe-1a6d588642e6"] ## Response 200 fields (application/json): - `count` (integer) The total number of results in your Belvo account. Example: 130 - `next` (string,null) The URL to next page of results. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is . In our documentation example, we use as a placeholder value. In production, this value will be replaced by the actual endpoint you are currently using (for example, or ). Example: "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2" - `previous` (string,null) The URL to the previous page of results. If there is no previous page, the value is . - `results` (array) Array of risk insights objects. - `results.id` (string, required) Belvo's unique identifier for the current item. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `results.link` (string,null, required) The the data belongs to. Example: "30cb4806-6e00-48a4-91c9-ca55968576c8" - `results.created_at` (string, required) The ISO-8601 timestamp of when the data point was created in Belvo's database. Example: "2022-02-09T08:45:50.406032Z" - `results.accounts` (array,null, 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"] - `results.assets_metrics` (object,null, required) 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. - `results.assets_metrics.institutions` (array,null, required) An array of institutions from which account information was retrieved for the user. > : For most use cases, this array will only return one item. Example: ["erebor_mx_retail"] - `results.assets_metrics.num_assets_accounts` (integer,null) The total number of accounts found for the user. Example: 1 - `results.assets_metrics.num_checking_accounts` (integer,null, required) The total number of checking accounts found for the user. Example: 1 - `results.assets_metrics.num_savings_accounts` (integer,null, required) The total number of savings accounts found for the user. Example: 1 - `results.assets_metrics.checking_accounts_balance` (number,null, required) The total closing balance of all checking accounts. Example: 35901.46 - `results.assets_metrics.savings_accounts_balance` (number,null, required) The total closing balance of all savings accounts. Example: 300.02 - `results.credit_cards_metrics` (object,null, required) 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. - `results.credit_cards_metrics.num_accounts` (integer, required) Number of credit cards accounts associated to the user. Example: 2 - `results.credit_cards_metrics.sum_credit_limit` (number,null, required) Sum total of all credit cards' limits. Example: 106560 - `results.credit_cards_metrics.sum_credit_used` (number,null, required) Sum total of all credit used. Example: 101020.14 - `results.credit_cards_metrics.credit_card_limit_utilization` (number,null, required) The percentage of the credit card limit used. Example: 0.95 - `results.loans_metrics` (object,null, required) 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. - `results.loans_metrics.num_accounts` (integer, required) The number of loan accounts associated with the user. Example: 1 - `results.loans_metrics.sum_loans_principal` (number,null, required) Sum total of the principal for all of the user's loan accounts. Example: 5000 - `results.loans_metrics.sum_loans_outstanding_principal` (number,null, required) Sum total of the outstanding principal for all the user's loan accounts. Example: 2000 - `results.loans_metrics.sum_loans_monthly_payment` (number,null, required) Sum total of the monthly payments for all the user's loan accounts. Example: 400 - `results.loans_metrics.loan_limit_utilization` (number,null, required) The percentage of the loan limit used. Example: 0.3 - `results.loans_metrics.overdraft_limit` (number,null, required) The total overdraft limit of all checking and savings accounts. Example: 900 - `results.loans_metrics.overdraft_limit_utilization` (number,null, required) The percentage of the overdraft limit used. Example: 0.4 - `results.balances_metrics` (object,null, required) Balance metrics calculated based on the user's balances from checking and savings accounts. - `results.balances_metrics.closing_balance` (number,null, required) The balance of all the accounts at the time. Example: 35901.46 - `results.balances_metrics.min_balance_3d` (number,null, required) The minimum balance in the last three days. Example: 35417.68 - `results.balances_metrics.min_balance_1w` (number,null, required) The minimum balance in the last week). Example: 34150.5 - `results.balances_metrics.min_balance_1m` (number,null, required) The minimum balance in the last month. Example: 33990.59 - `results.balances_metrics.min_balance_3m` (number,null, required) The minimum balance in the last three months. Example: 33990.59 - `results.balances_metrics.min_balance_6m` (number,null, required) The minimum balance in the six last months. Example: 33990.59 - `results.balances_metrics.min_balance_12m` (number,null, required) The minimum balance in the last twelve months. Example: 33990.59 - `results.balances_metrics.mean_balance_3d` (number,null, required) The mean balance in the last three days. Example: 35659.57 - `results.balances_metrics.mean_balance_1w` (number,null, required) The mean balance in the last week. Example: 35077.1 - `results.balances_metrics.mean_balance_1m` (number,null, required) The mean balance in the last month. Example: 34816.08 - `results.balances_metrics.mean_balance_3m` (number,null, required) The mean balance in the last three months. Example: 34816.08 - `results.balances_metrics.mean_balance_6m` (number,null, required) The mean balance in the last six months. Example: 34816.08 - `results.balances_metrics.mean_balance_12m` (number,null, required) The mean balance in the last twelve months. Example: 34816.08 - `results.balances_metrics.max_balance_3d` (number,null, required) The maximum balance in the last three days. Example: 35901.46 - `results.balances_metrics.max_balance_1w` (number,null, required) The maximum balance in the last week. Example: 35901.46 - `results.balances_metrics.max_balance_1m` (number,null, required) The maximum balance in the last month. Example: 35901.46 - `results.balances_metrics.max_balance_3m` (number,null, required) The maximum balance in the last three months. Example: 35901.46 - `results.balances_metrics.max_balance_6m` (number,null, required) The maximum balance in the last six months. Example: 35901.46 - `results.balances_metrics.max_balance_12m` (number,null, required) The maximum balance in the last twelve months. Example: 35901.46 - `results.balances_metrics.std_balance_3d` (number,null, required) The balance standard deviation in the last three days. Example: 279.31 - `results.balances_metrics.std_balance_1w` (number,null, required) The balance standard deviation in the last week. Example: 764.03 - `results.balances_metrics.std_balance_1m` (number,null, required) The balance standard deviation in the last month. Example: 586.55 - `results.balances_metrics.std_balance_3m` (number,null, required) The balance standard deviation in the last three months. Example: 586.55 - `results.balances_metrics.std_balance_6m` (number,null, required) The balance standard deviation in the last six months. Example: 586.55 - `results.balances_metrics.std_balance_12m` (number,null, required) The balance standard deviation in the last twelve months. Example: 586.55 - `results.balances_metrics.balance_trend_3d` (number,null, required) The balance trend of the user in the last three days. Example: 193.51 - `results.balances_metrics.balance_trend_1w` (number,null, required) The balance trend of the user in the last week. Example: 290.18 - `results.balances_metrics.balance_trend_1m` (number,null, required) The balance trend of the user in the last month. Example: 22.6 - `results.balances_metrics.balance_trend_3m` (number,null, required) The balance trend of the user in the last three months. Example: 22.6 - `results.balances_metrics.balance_trend_6m` (number,null, required) The balance trend of the user in the last six months. Example: 22.6 - `results.balances_metrics.balance_trend_12m` (number,null, required) The balance trend of the user in the last twelve months. Example: 22.6 - `results.balances_metrics.days_balance_below_0_3d` (integer,null, required) The number of days that the total balance of the account is less than or equal to 0 in the last three days. - `results.balances_metrics.days_balance_below_0_1w` (integer,null, required) The number of days that the total balance of the account is less than or equal to 0 in the last week. - `results.balances_metrics.days_balance_below_0_1m` (integer,null, required) The number of days that the total balance of the account is less than or equal to 0 in the last month. - `results.balances_metrics.days_balance_below_0_3m` (integer,null, required) The number of days that the total balance of the account is less than or equal to 0 in the last three months. - `results.balances_metrics.days_balance_below_0_6m` (integer,null, required) The number of days that the total balance of the account is less than or equal to 0 in the last six months. - `results.balances_metrics.days_balance_below_0_12m` (integer,null, required) The number of days that the total balance of the account is less than or equal to 0 in the last twelve months. - `results.balances_metrics.days_balance_below_mean_3d` (integer,null, required) The number of days that the mean balance of the account is less than or equal to the amount specified in . Example: 2 - `results.balances_metrics.days_balance_below_mean_1w` (integer,null, required) The number of days that the mean balance of the account is less than or equal to the amount specified in . Example: 3 - `results.balances_metrics.days_balance_below_mean_1m` (integer,null, required) The number of days that the mean balance of the account is less than or equal to the amount specified in . Example: 17 - `results.balances_metrics.days_balance_below_mean_3m` (integer,null, required) The number of days that the mean balance of the account is less than or equal to the amount specified in . Example: 17 - `results.balances_metrics.days_balance_below_mean_6m` (integer,null, required) The number of days that the mean balance of the account is less than or equal to the amount specified in . Example: 17 - `results.balances_metrics.days_balance_below_mean_12m` (integer,null, required) The number of days that the mean balance of the account is less than or equal to the amount specified in . Example: 17 - `results.balances_metrics.days_balance_below_x_3d` (integer,null, required) The number of days that the total balance of the account is less than or equal to the amount specified in in the last three days. - `results.balances_metrics.days_balance_below_x_1w` (integer,null, required) The number of days that the total balance of the account is less than or equal to the amount specified in in the last week. - `results.balances_metrics.days_balance_below_x_1m` (integer,null, required) The number of days that the total balance of the account is less than or equal to the amount specified in in the last month. - `results.balances_metrics.days_balance_below_x_3m` (integer,null, required) The number of days that the total balance of the account is less than or equal to the amount specified in in the last three months. - `results.balances_metrics.days_balance_below_x_6m` (integer,null, required) The number of days that the total balance of the account is less than or equal to the amount specified in in the last six months. - `results.balances_metrics.days_balance_below_x_12m` (integer,null, required) The number of days that the total balance of the account is less than or equal to the amount specified in in the last twelve months. - `results.balances_metrics.balance_threshold_x` (number, required) The threshold used to compute . Please note, this is value is country specific (both in terms of the amount and the currency). Example: 1000 - `results.transactions_metrics` (object,null, required) Aggregated metrics calculated based on the user's transactions from checking, savings, credit card, and loan accounts. > ℹ️ > > If there is not enough transactional data for a given period, we return for calculated fields and 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 , , and , however: > > - will return as there is no data for months two and three (calculated field). > - will return as there is no data for months two and three ('count-based' field) - `results.transactions_metrics.num_transactions_3d` (integer, required) The total number of transactions analyzed to determine the risk insights for the last three days (incoming and outgoing). Example: 26 - `results.transactions_metrics.num_transactions_1w` (integer, required) The total number of transactions analyzed to determine the risk insights for the last week (incoming and outgoing). Example: 46 - `results.transactions_metrics.num_transactions_1m` (integer, required) The total number of transactions analyzed to determine the risk insights for the last month (incoming and outgoing). Example: 168 - `results.transactions_metrics.num_transactions_3m` (integer, required) The total number of transactions analyzed to determine the risk insights for the last three months (incoming and outgoing). Example: 460 - `results.transactions_metrics.num_transactions_6m` (integer, required) The total number of transactions analyzed to determine the risk insights for the last six months (incoming and outgoing). Example: 472 - `results.transactions_metrics.num_transactions_12m` (integer, required) The total number of transactions analyzed to determine the risk insights for the last twelve months (incoming and outgoing). Example: 496 - `results.transactions_metrics.max_num_transactions_3d` (integer, required) The maximum number of transactions for the last three days. Example: 10 - `results.transactions_metrics.max_num_transactions_1w` (integer, required) The maximum number of transactions for the last week. Example: 10 - `results.transactions_metrics.max_num_transactions_1m` (integer, required) The maximum number of transactions for the last month. Example: 18 - `results.transactions_metrics.max_num_transactions_3m` (integer, required) The maximum number of transactions for the last three months. Example: 18 - `results.transactions_metrics.max_num_transactions_6m` (integer, required) The maximum number of transactions for the last six months. Example: 18 - `results.transactions_metrics.max_num_transactions_12m` (integer, required) The maximum number of transactions for the last twelve months. Example: 18 - `results.transactions_metrics.mean_num_transactions_3d` (number, required) The mean number of transactions for the last three days. Example: 6.5 - `results.transactions_metrics.mean_num_transactions_1w` (number, required) The mean number of transactions for the last week. Example: 5.75 - `results.transactions_metrics.mean_num_transactions_1m` (number, required) The mean number of transactions for the last month. Example: 5.42 - `results.transactions_metrics.mean_num_transactions_3m` (number, required) The mean number of transactions for the last three months. Example: 5.05 - `results.transactions_metrics.mean_num_transactions_6m` (number, required) The mean number of transactions for the last six months. Example: 2.61 - `results.transactions_metrics.mean_num_transactions_12m` (number, required) The mean number of transactions for the last twelve months. Example: 1.37 - `results.transactions_metrics.num_incoming_transactions_3d` (integer, required) The total number of inflow transactions for the last three days. Example: 12 - `results.transactions_metrics.num_incoming_transactions_1w` (integer, required) The total number of inflow transactions for the last week. Example: 21 - `results.transactions_metrics.num_incoming_transactions_1m` (integer, required) The total number of inflow transactions for the last month. Example: 80 - `results.transactions_metrics.num_incoming_transactions_3m` (integer, required) The total number of inflow transactions for the last three months. Example: 229 - `results.transactions_metrics.num_incoming_transactions_6m` (integer, required) The total number of inflow transactions for the last six months. Example: 238 - `results.transactions_metrics.num_incoming_transactions_12m` (integer, required) The total number of inflow transactions for the last twelve months. Example: 256 - `results.transactions_metrics.max_num_incoming_transactions_3d` (integer, required) The maximum number of inflow transactions for the last three days. Example: 6 - `results.transactions_metrics.max_num_incoming_transactions_1w` (integer, required) The maximum number of inflow transactions for the last week. Example: 6 - `results.transactions_metrics.max_num_incoming_transactions_1m` (integer, required) The maximum number of inflow transactions for the last month. Example: 10 - `results.transactions_metrics.max_num_incoming_transactions_3m` (integer, required) The maximum number of inflow transactions for the last three months. Example: 10 - `results.transactions_metrics.max_num_incoming_transactions_6m` (integer, required) The maximum number of inflow transactions for the last six months. Example: 10 - `results.transactions_metrics.max_num_incoming_transactions_12m` (integer, required) The maximum number of inflow transactions for the last twelve months. Example: 10 - `results.transactions_metrics.mean_num_incoming_transactions_3d` (number, required) The mean number of inflow transactions for the last three days. Example: 3 - `results.transactions_metrics.mean_num_incoming_transactions_1w` (number, required) The mean number of inflow transactions for the last week. Example: 2.62 - `results.transactions_metrics.mean_num_incoming_transactions_1m` (number, required) The mean number of inflow transactions for the last month. Example: 2.58 - `results.transactions_metrics.mean_num_incoming_transactions_3m` (number, required) The mean number of inflow transactions for the last three months. Example: 2.52 - `results.transactions_metrics.mean_num_incoming_transactions_6m` (number, required) The mean number of inflow transactions for the last six months. Example: 1.31 - `results.transactions_metrics.mean_num_incoming_transactions_12m` (number, required) The mean number of inflow transactions for the last twelve months. Example: 0.71 - `results.transactions_metrics.sum_incoming_amount_3d` (number,null, required) The total sum of all inflow transactions for the last three days. Example: 17142.16 - `results.transactions_metrics.sum_incoming_amount_1w` (number,null, required) The total sum of all inflow transactions for the last week. Example: 24825.92 - `results.transactions_metrics.sum_incoming_amount_1m` (number,null, required) The total sum of all inflow transactions for the last month. Example: 75993.36 - `results.transactions_metrics.sum_incoming_amount_3m` (number,null, required) The total sum of all inflow transactions for the last three months. Example: 198197.28 - `results.transactions_metrics.sum_incoming_amount_6m` (number,null, required) The total sum of all inflow transactions for the last six months. Example: 223697.28 - `results.transactions_metrics.sum_incoming_amount_12m` (number,null, required) The total sum of all inflow transactions for the last twelve months. Example: 274697.28 - `results.transactions_metrics.max_incoming_amount_3d` (number,null, required) The highest value inflow transaction in the last three days. Example: 3000 - `results.transactions_metrics.max_incoming_amount_1w` (number,null, required) The highest value inflow transaction in the last week. Example: 3000 - `results.transactions_metrics.max_incoming_amount_1m` (number,null, required) The highest value inflow transaction in the last month. Example: 3000 - `results.transactions_metrics.max_incoming_amount_3m` (number,null, required) The highest value inflow transaction in the last three months. Example: 3000 - `results.transactions_metrics.max_incoming_amount_6m` (number,null, required) The highest value inflow transaction in the last six months. Example: 3000 - `results.transactions_metrics.max_incoming_amount_12m` (number,null, required) The highest value inflow transaction in the last twelve months. Example: 3000 - `results.transactions_metrics.mean_incoming_amount_3d` (number,null, required) The mean incoming value of all transactions in the last three days. Example: 1428.51 - `results.transactions_metrics.mean_incoming_amount_1w` (number,null, required) The mean incoming value of all transactions in the last week. Example: 1182.19 - `results.transactions_metrics.mean_incoming_amount_1m` (number,null, required) The mean incoming value of all transactions in the last month. Example: 949.92 - `results.transactions_metrics.mean_incoming_amount_3m` (number,null, required) The mean incoming value of all transactions in the last three months. Example: 865.49 - `results.transactions_metrics.mean_incoming_amount_6m` (number,null, required) The mean incoming value of all transactions in the last six months. Example: 939.9 - `results.transactions_metrics.mean_incoming_amount_12m` (number,null, required) The mean incoming value of all transactions in the last twelve months. Example: 1073.04 - `results.transactions_metrics.num_outgoing_transactions_3d` (integer, required) To total number of outflow transactions in the last three days. Example: 14 - `results.transactions_metrics.num_outgoing_transactions_1w` (integer, required) To total number of outflow transactions in the last week. Example: 25 - `results.transactions_metrics.num_outgoing_transactions_1m` (integer, required) To total number of outflow transactions in the last month. Example: 88 - `results.transactions_metrics.num_outgoing_transactions_3m` (integer, required) To total number of outflow transactions in the last three months. Example: 231 - `results.transactions_metrics.num_outgoing_transactions_6m` (integer, required) To total number of outflow transactions in the last six months. Example: 234 - `results.transactions_metrics.num_outgoing_transactions_12m` (integer, required) To total number of outflow transactions in the last twelve months. Example: 240 - `results.transactions_metrics.max_num_outgoing_transactions_3d` (integer, required) The maximum number of outflow transactions for the last three days. Example: 6 - `results.transactions_metrics.max_num_outgoing_transactions_1w` (integer, required) The maximum number of outflow transactions for the last week. Example: 6 - `results.transactions_metrics.max_num_outgoing_transactions_1m` (integer, required) The maximum number of outflow transactions for the last month. Example: 8 - `results.transactions_metrics.max_num_outgoing_transactions_3m` (integer, required) The maximum number of outflow transactions for the last three months. Example: 9 - `results.transactions_metrics.max_num_outgoing_transactions_6m` (integer, required) The maximum number of outflow transactions for the last six months. Example: 9 - `results.transactions_metrics.max_num_outgoing_transactions_12m` (integer, required) The maximum number of outflow transactions for the last twelve months. Example: 9 - `results.transactions_metrics.mean_num_outgoing_transactions_3d` (number, required) The mean number of outflow transactions for the last three days. Example: 3.5 - `results.transactions_metrics.mean_num_outgoing_transactions_1w` (number, required) The mean number of outflow transactions for the last week. Example: 3.12 - `results.transactions_metrics.mean_num_outgoing_transactions_1m` (number, required) The mean number of outflow transactions for the last month. Example: 2.84 - `results.transactions_metrics.mean_num_outgoing_transactions_3m` (number, required) The mean number of outflow transactions for the last three months. Example: 2.54 - `results.transactions_metrics.mean_num_outgoing_transactions_6m` (number, required) The mean number of outflow transactions for the last six months. Example: 1.29 - `results.transactions_metrics.mean_num_outgoing_transactions_12m` (number, required) The mean number of outflow transactions for the last twelve months. Example: 0.66 - `results.transactions_metrics.sum_outgoing_amount_3d` (number,null, required) The total sum of all outflow transactions for the last three days. Example: 18246.95 - `results.transactions_metrics.sum_outgoing_amount_1w` (number,null, required) The total sum of all outflow transactions for the last week. Example: 26362.25 - `results.transactions_metrics.sum_outgoing_amount_1m` (number,null, required) The total sum of all outflow transactions for the last month. Example: 78243.82 - `results.transactions_metrics.sum_outgoing_amount_3m` (number,null, required) The total sum of all outflow transactions for the last three months. Example: 192608.77 - `results.transactions_metrics.sum_outgoing_amount_6m` (number,null, required) The total sum of all outflow transactions for the last six months. Example: 201608.77 - `results.transactions_metrics.sum_outgoing_amount_12m` (number,null, required) The total sum of all outflow transactions for the last twelve months. Example: 219608.77 - `results.transactions_metrics.max_outgoing_amount_3d` (number,null, required) The highest value outflow transaction in the last three days. Example: 3000 - `results.transactions_metrics.max_outgoing_amount_1w` (number,null, required) The highest value outflow transaction in the last week. Example: 3000 - `results.transactions_metrics.max_outgoing_amount_1m` (number,null, required) The highest value outflow transaction in the last month. Example: 3000 - `results.transactions_metrics.max_outgoing_amount_3m` (number,null, required) The highest value outflow transaction in the last three months. Example: 3000 - `results.transactions_metrics.max_outgoing_amount_6m` (number,null, required) The highest value outflow transaction in the last six months. Example: 3000 - `results.transactions_metrics.max_outgoing_amount_12m` (number,null, required) The highest value outflow transaction in the last twelve months. Example: 3000 - `results.transactions_metrics.mean_outgoing_amount_3d` (number,null, required) The mean outgoing value of all transaction in the last three days. Example: 1303.35 - `results.transactions_metrics.mean_outgoing_amount_1w` (number,null, required) The mean outgoing value of all transaction in the last week. Example: 1054.49 - `results.transactions_metrics.mean_outgoing_amount_1m` (number,null, required) The mean outgoing value of all transaction in the last month. Example: 889.13 - `results.transactions_metrics.mean_outgoing_amount_3m` (number,null, required) The mean outgoing value of all transaction in the last three months. Example: 833.8 - `results.transactions_metrics.mean_outgoing_amount_6m` (number,null, required) The mean outgoing value of all transaction in the last six months. Example: 861.58 - `results.transactions_metrics.mean_outgoing_amount_12m` (number,null, required) The mean outgoing value of all transaction in the last twelve months. Example: 915.04 - `results.transactions_metrics.days_without_transactions_3d` (integer, required) The number of days that no transactions occurred within the last three days. - `results.transactions_metrics.days_without_transactions_1w` (integer, required) The number of days that no transactions occurred within the last week. - `results.transactions_metrics.days_without_transactions_1m` (integer, required) The number of days that no transactions occurred within the last month. - `results.transactions_metrics.days_without_transactions_3m` (integer, required) The number of days that no transactions occurred within the last three months. - `results.transactions_metrics.days_without_transactions_6m` (integer, required) The number of days that no transactions occurred within the last six months. Example: 87 - `results.transactions_metrics.days_without_transactions_12m` (integer, required) The number of days that no transactions occurred within the last twelve months. Example: 261 - `results.transactions_metrics.days_since_last_transaction` (integer, required) The number of days since the last transaction occurred. - `results.transactions_metrics.days_since_last_incoming_transaction` (integer, required) The number of days since the last inflow transaction occurred. - `results.transactions_metrics.days_since_last_outgoing_transaction` (integer, required) The number of days since the last outflow transaction occurred. - `results.transactions_metrics.days_history` (integer, required) The number of days between when the risk insight request was made and the first transaction. Example: 365 - `results.cashflow_metrics` (object,null, required) 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. {% admonition type="info" %} If there is not enough transactional data for a given period, we return . 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 , , and , however for we will return as there is no data for months two and three. {% /admonition %} - `results.cashflow_metrics.max_positive_3d` (number,null, required) The highest value of positive cash flow transactions in the last three days. Example: 1850.12 - `results.cashflow_metrics.max_positive_1w` (number,null, required) The highest value of positive cash flow transactions the last week. Example: 3808.99 - `results.cashflow_metrics.max_positive_1m` (number,null, required) The highest value of positive cash flow transactions the last month. Example: 4012.61 - `results.cashflow_metrics.max_positive_3m` (number,null, required) The highest value of positive cash flow transactions the last three months. Example: 5001.08 - `results.cashflow_metrics.max_positive_6m` (number,null, required) The highest value of positive cash flow transactions the last six months. Example: 8500 - `results.cashflow_metrics.max_positive_12m` (number,null, required) The highest value of positive cash flow transactions the last twelve months. Example: 8500 - `results.cashflow_metrics.max_negative_3d` (number,null, required) The highest value of negative cash flow transactions in the last three days. Example: 3375.43 - `results.cashflow_metrics.max_negative_1w` (number,null, required) The highest value of negative cash flow transactions in the last week. Example: 3375.43 - `results.cashflow_metrics.max_negative_1m` (number,null, required) The highest value of negative cash flow transactions in the last month. Example: 5305.92 - `results.cashflow_metrics.max_negative_3m` (number,null, required) The highest value of negative cash flow transactions in the last three months. Example: 7535.85 - `results.cashflow_metrics.max_negative_6m` (number,null, required) The highest value of negative cash flow transactions in the last six months. Example: 7535.85 - `results.cashflow_metrics.max_negative_12m` (number,null, required) The highest value of negative cash flow transactions in the last twelve months. Example: 7535.85 - `results.cashflow_metrics.mean_positive_3d` (number,null, required) The mean value of the positive cash flow transactions in the last three days. Example: 1410.54 - `results.cashflow_metrics.mean_positive_1w` (number,null, required) The mean value of the positive cash flow transactions in the last week. Example: 1665.74 - `results.cashflow_metrics.mean_positive_1m` (number,null, required) The mean value of the positive cash flow transactions in the last month. Example: 1827.36 - `results.cashflow_metrics.mean_positive_3m` (number,null, required) The mean value of the positive cash flow transactions in the last three months. Example: 1881.58 - `results.cashflow_metrics.mean_positive_6m` (number,null, required) The mean value of the positive cash flow transactions in the last six months. Example: 2102.19 - `results.cashflow_metrics.mean_positive_12m` (number,null, required) The mean value of the positive cash flow transactions in the last twelve months. Example: 2502.06 - `results.cashflow_metrics.mean_negative_3d` (number,null, required) The mean value of the negative cash flow transactions in the last three days. Example: 3373.48 - `results.cashflow_metrics.mean_negative_1w` (number,null, required) The mean value of the negative cash flow transactions in the last week. Example: 2477.04 - `results.cashflow_metrics.mean_negative_1m` (number,null, required) The mean value of the negative cash flow transactions in the last month. Example: 1904.96 - `results.cashflow_metrics.mean_negative_3m` (number,null, required) The mean value of the negative cash flow transactions in the last three months. Example: 1838.47 - `results.cashflow_metrics.mean_negative_6m` (number,null, required) The mean value of the negative cash flow transactions in the last six months. Example: 1877.63 - `results.cashflow_metrics.mean_negative_12m` (number,null, required) The mean value of the negative cash flow transactions in the last twelve months. Example: 1948.51 - `results.cashflow_metrics.sum_positive_3d` (number,null, required) The sum total of all transactions leading to a positive cash flow in the last three days. Example: 5642.16 - `results.cashflow_metrics.sum_positive_1w` (number,null, required) The sum total of all transactions leading to a positive cash flow in the last week. Example: 13325.92 - `results.cashflow_metrics.sum_positive_1m` (number,null, required) The sum total of all transactions leading to a positive cash flow in the last month. Example: 52993.36 - `results.cashflow_metrics.sum_positive_3m` (number,null, required) The sum total of all transactions leading to a positive cash flow in the last three months. Example: 163697.28 - `results.cashflow_metrics.sum_positive_6m` (number,null, required) The sum total of all transactions leading to a positive cash flow in the last six months. Example: 189197.28 - `results.cashflow_metrics.sum_positive_12m` (number,null, required) The sum total of all transactions leading to a positive cash flow in the last twelve months. Example: 240197.28 - `results.cashflow_metrics.sum_positive_trend_3d` (number,null, required) The positive cash flow trend based on the sum of all positive transactions in the last three days. Example: 98.902 - `results.cashflow_metrics.sum_positive_trend_1w` (number,null, required) The positive cash flow trend based on the sum of all positive transactions in the last week. Example: -84.0393 - `results.cashflow_metrics.sum_positive_trend_1m` (number,null, required) The positive cash flow trend based on the sum of all positive transactions in the last month. Example: 22.7315 - `results.cashflow_metrics.sum_positive_trend_3m` (number,null, required) The positive cash flow trend based on the sum of all positive transactions in the last three months. Example: 1.8398 - `results.cashflow_metrics.sum_positive_trend_6m` (number,null, required) The positive cash flow trend based on the sum of all positive transactions in the last six months. Example: -17.1869 - `results.cashflow_metrics.sum_positive_trend_12m` (number,null, required) The positive cash flow trend based on the sum of all positive transactions in the last twelve months. Example: -25.9856 - `results.cashflow_metrics.sum_negative_3d` (number,null, required) The sum total of all transactions leading to a negative cash flow in the last three days. Example: 6746.95 - `results.cashflow_metrics.sum_negative_1w` (number,null, required) The sum total of all transactions leading to a negative cash flow in the last week. Example: 14862.25 - `results.cashflow_metrics.sum_negative_1m` (number,null, required) The sum total of all transactions leading to a negative cash flow in the last month. Example: 55243.82 - `results.cashflow_metrics.sum_negative_3m` (number,null, required) The sum total of all transactions leading to a negative cash flow in the last three months. Example: 158108.77 - `results.cashflow_metrics.sum_negative_6m` (number,null, required) The sum total of all transactions leading to a negative cash flow in the last six months. Example: 167108.77 - `results.cashflow_metrics.sum_negative_12m` (number,null, required) The sum total of all transactions leading to a negative cash flow in the last twelve months. Example: 185108.77 - `results.cashflow_metrics.sum_negative_trend_3d` (number,null, required) The negative cash flow trend based on the sum of all negative transactions in the last three days. Example: -3.91 - `results.cashflow_metrics.sum_negative_trend_1w` (number,null, required) The negative cash flow trend based on the sum of all negative transactions in the last week. Example: 254.2517 - `results.cashflow_metrics.sum_negative_trend_1m` (number,null, required) The negative cash flow trend based on the sum of all negative transactions in the last month. Example: 58.376 - `results.cashflow_metrics.sum_negative_trend_3m` (number,null, required) The negative cash flow trend based on the sum of all negative transactions in the last three months. Example: 2.5895 - `results.cashflow_metrics.sum_negative_trend_6m` (number,null, required) The negative cash flow trend based on the sum of all negative transactions in the last six months. Example: -1.4824 - `results.cashflow_metrics.sum_negative_trend_12m` (number,null, required) The negative cash flow trend based on the sum of all negative transactions in the last twelve months. Example: -4.2394 - `results.cashflow_metrics.positive_to_negative_ratio_3d` (number,null, required) The ratio between sum_positive / sum_negative in the last three days. ℹ️ If the ratio is greater than , it means that the user has more income than outgoing, indicating that they spend less than they earn. : In the case that there have been no outgoing transactions, the value will be . Example: 0.84 - `results.cashflow_metrics.positive_to_negative_ratio_1w` (number,null, required) The ratio between sum_positive / sum_negative in the last week. ℹ️ If the ratio is greater than , it means that the user has more income than outgoing, indicating that they spend less than they earn. : In the case that there have been no outgoing transactions, the value will be . Example: 0.9 - `results.cashflow_metrics.positive_to_negative_ratio_1m` (number,null, required) The ratio between sum_positive / sum_negative in the last month. ℹ️ If the ratio is greater than , it means that the user has more income than outgoing, indicating that they spend less than they earn. : In the case that there have been no outgoing transactions, the value will be . Example: 0.96 - `results.cashflow_metrics.positive_to_negative_ratio_3m` (number,null, required) The ratio between sum_positive / sum_negative in the last three months. ℹ️ If the ratio is greater than , it means that the user has more income than outgoing, indicating that they spend less than they earn. : In the case that there have been no outgoing transactions, the value will be . Example: 1.04 - `results.cashflow_metrics.positive_to_negative_ratio_6m` (number,null, required) The ratio between sum_positive / sum_negative in the last six months. ℹ️ If the ratio is greater than , it means that the user has more income than outgoing, indicating that they spend less than they earn. : In the case that there have been no outgoing transactions, the value will be . Example: 1.13 - `results.cashflow_metrics.positive_to_negative_ratio_12m` (number,null, required) The ratio between sum_positive / sum_negative in the last twelve months. ℹ️ If the ratio is greater than , it means that the user has more income than outgoing, indicating that they spend less than they earn. : In the case that there have been no outgoing transactions, the value will be . Example: 1.3 - `results.cashflow_metrics.net_cashflow_3d` (number,null, required) The net cash flow in the last three days. Example: -1104.79 - `results.cashflow_metrics.net_cashflow_1w` (number,null, required) The net cash flow in the last week. Example: -1536.33 - `results.cashflow_metrics.net_cashflow_1m` (number,null, required) The net cash flow in the last month. Example: -2250.46 - `results.cashflow_metrics.net_cashflow_3m` (number,null, required) The net cash flow in the last three months. Example: 5588.51 - `results.cashflow_metrics.net_cashflow_6m` (number,null, required) The net cash flow in the last six months. Example: 22088.51 - `results.cashflow_metrics.net_cashflow_12m` (number,null, required) The net cash flow in the last twelve months. Example: 55088.51 - `results.cashflow_metrics.net_cashflow_trend_3d` (number,null, required) The net cash flow trend in the last three days months. Example: 1448.683 - `results.cashflow_metrics.net_cashflow_trend_1w` (number,null, required) The net cash flow trend in the last week. Example: 163.8856 - `results.cashflow_metrics.net_cashflow_trend_1m` (number,null, required) The net cash flow trend in the last month. Example: 1.3034 - `results.cashflow_metrics.net_cashflow_trend_3m` (number,null, required) The net cash flow trend in the last three months. Example: -0.472 - `results.cashflow_metrics.net_cashflow_trend_6m` (number,null, required) The net cash flow trend in the last six months. Example: -15.1286 - `results.cashflow_metrics.net_cashflow_trend_12m` (number,null, required) The net cash flow trend in the last twelve months. Example: -21.5511 - `results.category_metrics` (array, required) 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. - `results.category_metrics.category` (string,null) The name of the transaction category. > 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: - - - - - - - - - - - - - - - * - - \* For clients not using our Transaction Categorization product, we return instead. Enum: "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 - `results.category_metrics.subcategory` (string,null) The transaction subcategory. > For clients not using our Transaction categorization, we return 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: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Enum: "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 - `results.category_metrics.net_amount_3m` (number,null) 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 - `results.category_metrics.category_inflow_ratio_3m` (number,null) The ratio of 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 . Example: 1 - `results.category_metrics.trend_3m` (number,null) The net category transaction trend (incoming - outgoing transactions for the category) for the period. ## Response 403 fields (application/json): - `code` (string) A unique error code () that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 403 access_to_resource_denied. Example: "access_to_resource_denied" - `message` (string) A short description of the error. For errors, the description is: - . Example: "You don't have access to this resource." - `request_id` (string) A 32-character unique ID of the request (matching a regex pattern of: ). Provide this ID when contacting the Belvo support team to accelerate investigations. Example: "9e7b283c6efa449c9c028a16b5c249fb" ## Response 404 fields (application/json): - `code` (string) A unique error code () that allows you to classify and handle the error programmatically. Example: "not_found" - `message` (string) A short description of the error. For errors, the description is: - Example: "Not found" - `request_id` (string) A 32-character unique ID of the request (matching a regex pattern of: ). Provide this ID when contacting the Belvo support team to accelerate investigations. Example: "9e7b283c6efa449c9c028a16b5c249fb" ## Response 408 fields (application/json): - `code` (string) A unique error code () that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 408 request_timeout errors. Example: "request_timeout" - `message` (string) A short description of the error. For errors, the description is: - . Example: "The request timed out, you can retry asking for less data by changing your query parameters" - `request_id` (string) A 32-character unique ID of the request (matching a regex pattern of: ). Provide this ID when contacting the Belvo support team to accelerate investigations. Example: "9e7b283c6efa449c9c028a16b5c249fb" ## Response 428 fields (application/json): - `code` (string) A unique error code () that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 428 token_required errors. Example: "token_required" - `message` (string) A short description of the error. For errors, the description is: - . Example: "A MFA token is required by the institution to login" - `request_id` (string) A 32-character unique ID of the request (matching a regex pattern of: ). Provide this ID when contacting the Belvo support team to accelerate investigations. Example: "9e7b283c6efa449c9c028a16b5c249fb" - `session` (string) A 32-character unique ID of the login session (matching a regex pattern of: ). Example: "2675b703b9d4451f8d4861a3eee54449" - `expiry` (integer) Session duration time in seconds. Example: 9600 - `link` (string) Unique identifier created by Belvo, used to reference the current Link. Example: "30cb4806-6e00-48a4-91c9-ca55968576c8" - `token_generation_data` (object) Details on how to generate the token. - `token_generation_data.instructions` (string) Instructions for token generation. Example: "Use this code to generate the token" - `token_generation_data.type` (string) Type of the data to generate the token (QR code, numeric challenge). Example: "numeric" - `token_generation_data.value` (string) Value to use to generate the token. Example: "12345" - `token_generation_data.expects_user_input` (boolean) Indicates whether the user needs to provide input in order to complete the authentication. When set to , your user may need to: - confirm the login on another device - scan a QR code You will still need to make a PATCH call to complete the request. Example: true ## Response 500 fields (application/json): - `code` (string) A unique error code () that allows you to classify and handle the error programmatically. ℹ️ Check our DevPortal for more information on how to handle 500 unexpected_error errors. Example: "unexpected_error" - `message` (string) A short description of the error. For errors, the description is: - . Example: "Belvo is unable to process the request due to an internal system issue or to an unsupported response from an institution" - `request_id` (string) A 32-character unique ID of the request (matching a regex pattern of: ). Provide this ID when contacting the Belvo support team to accelerate investigations. Example: "9e7b283c6efa449c9c028a16b5c249fb"