v1
latestOpenAPI 3.0.22026-08-061464031.4 MBRisk Insights
Retrieve risk insights for a link
Request the risk insights for a given link ID.
If you need to know the currency of the account, just do a GET Details to the accounts endpoint (using the ID you receive from the accounts response).
post/api/risk-insights/
Query parameters
omitstring
Omit certain fields from being returned in the response. For more information, see our <a href="https://developers.belvo.com/docs/searching-and-filtering" target="_blank">Filtering responses</a> DevPortal article.
fieldsstring
Return only the specified fields in the response. For more information, see our <a href="https://developers.belvo.com/docs/searching-and-filtering" target="_blank">Filtering responses</a> DevPortal article.
Request body
Example request
{
"link": "c81a1dea-6dd6-4999-8b9f-541ee8197058",
"token": "1234ab",
"save_data": true
}Response
Ok (when save_data=false)
Example response
{
"id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
"link": "30cb4806-6e00-48a4-91c9-ca55968576c8",
"created_at": "2022-02-09T08:45:50.406032Z",
"accounts": [
"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_metrics": {
"institutions": [
"erebor_mx_retail"
],
"num_assets_accounts": 1,
"num_checking_accounts": 1,
"num_savings_accounts": 1,
"checking_accounts_balance": 35901.46,
"savings_accounts_balance": 300.02
},
"credit_cards_metrics": {
"num_accounts": 2,
"sum_credit_limit": 106560,
"sum_credit_used": 101020.14,
"credit_card_limit_utilization": 0.95
},
"loans_metrics": {
"num_accounts": 1,
"sum_loans_principal": 5000,
"sum_loans_outstanding_principal": 2000,
"sum_loans_monthly_payment": 400,
"loan_limit_utilization": 0.3,
"overdraft_limit": 900,
"overdraft_limit_utilization": 0.4
},
"balances_metrics": {
"closing_balance": 35901.46,
"min_balance_3d": 35417.68,
"min_balance_1w": 34150.5,
"min_balance_1m": 33990.59,
"min_balance_3m": 33990.59,
"min_balance_6m": 33990.59,
"min_balance_12m": 33990.59,
"mean_balance_3d": 35659.57,
"mean_balance_1w": 35077.1,
"mean_balance_1m": 34816.08,
"mean_balance_3m": 34816.08,
"mean_balance_6m": 34816.08,
"mean_balance_12m": 34816.08,
"max_balance_3d": 35901.46,
"max_balance_1w": 35901.46,
"max_balance_1m": 35901.46,
"max_balance_3m": 35901.46,
"max_balance_6m": 35901.46,
"max_balance_12m": 35901.46,
"std_balance_3d": 279.31,
"std_balance_1w": 764.03,
"std_balance_1m": 586.55,
"std_balance_3m": 586.55,
"std_balance_6m": 586.55,
"std_balance_12m": 586.55,
"balance_trend_3d": 193.51,
"balance_trend_1w": 290.18,
"balance_trend_1m": 22.6,
"balance_trend_3m": 22.6,
"balance_trend_6m": 22.6,
"balance_trend_12m": 22.6,
"days_balance_below_mean_3d": 2,
"days_balance_below_mean_1w": 3,
"days_balance_below_mean_1m": 17,
"days_balance_below_mean_3m": 17,
"days_balance_below_mean_6m": 17,
"days_balance_below_mean_12m": 17,
"balance_threshold_x": 1000
},
"transactions_metrics": {
"num_transactions_3d": 26,
"num_transactions_1w": 46,
"num_transactions_1m": 168,
"num_transactions_3m": 460,
"num_transactions_6m": 472,
"num_transactions_12m": 496,
"max_num_transactions_3d": 10,
"max_num_transactions_1w": 10,
"max_num_transactions_1m": 18,
"max_num_transactions_3m": 18,
"max_num_transactions_6m": 18,
"max_num_transactions_12m": 18,
"mean_num_transactions_3d": 6.5,
"mean_num_transactions_1w": 5.75,
"mean_num_transactions_1m": 5.42,
"mean_num_transactions_3m": 5.05,
"mean_num_transactions_6m": 2.61,
"mean_num_transactions_12m": 1.37,
"num_incoming_transactions_3d": 12,
"num_incoming_transactions_1w": 21,
"num_incoming_transactions_1m": 80,
"num_incoming_transactions_3m": 229,
"num_incoming_transactions_6m": 238,
"num_incoming_transactions_12m": 256,
"max_num_incoming_transactions_3d": 6,
"max_num_incoming_transactions_1w": 6,
"max_num_incoming_transactions_1m": 10,
"max_num_incoming_transactions_3m": 10,
"max_num_incoming_transactions_6m": 10,
"max_num_incoming_transactions_12m": 10,
"mean_num_incoming_transactions_3d": 3,
"mean_num_incoming_transactions_1w": 2.62,
"mean_num_incoming_transactions_1m": 2.58,
"mean_num_incoming_transactions_3m": 2.52,
"mean_num_incoming_transactions_6m": 1.31,
"mean_num_incoming_transactions_12m": 0.71,
"sum_incoming_amount_3d": 17142.16,
"sum_incoming_amount_1w": 24825.92,
"sum_incoming_amount_1m": 75993.36,
"sum_incoming_amount_3m": 198197.28,
"sum_incoming_amount_6m": 223697.28,
"sum_incoming_amount_12m": 274697.28,
"max_incoming_amount_3d": 3000,
"max_incoming_amount_1w": 3000,
"max_incoming_amount_1m": 3000,
"max_incoming_amount_3m": 3000,
"max_incoming_amount_6m": 3000,
"max_incoming_amount_12m": 3000,
"mean_incoming_amount_3d": 1428.51,
"mean_incoming_amount_1w": 1182.19,
"mean_incoming_amount_1m": 949.92,
"mean_incoming_amount_3m": 865.49,
"mean_incoming_amount_6m": 939.9,
"mean_incoming_amount_12m": 1073.04,
"num_outgoing_transactions_3d": 14,
"num_outgoing_transactions_1w": 25,
"num_outgoing_transactions_1m": 88,
"num_outgoing_transactions_3m": 231,
"num_outgoing_transactions_6m": 234,
"num_outgoing_transactions_12m": 240,
"max_num_outgoing_transactions_3d": 6,
"max_num_outgoing_transactions_1w": 6,
"max_num_outgoing_transactions_1m": 8,
"max_num_outgoing_transactions_3m": 9,
"max_num_outgoing_transactions_6m": 9,
"max_num_outgoing_transactions_12m": 9,
"mean_num_outgoing_transactions_3d": 3.5,
"mean_num_outgoing_transactions_1w": 3.12,
"mean_num_outgoing_transactions_1m": 2.84,
"mean_num_outgoing_transactions_3m": 2.54,
"mean_num_outgoing_transactions_6m": 1.29,
"mean_num_outgoing_transactions_12m": 0.66,
"sum_outgoing_amount_3d": 18246.95,
"sum_outgoing_amount_1w": 26362.25,
"sum_outgoing_amount_1m": 78243.82,
"sum_outgoing_amount_3m": 192608.77,
"sum_outgoing_amount_6m": 201608.77,
"sum_outgoing_amount_12m": 219608.77,
"max_outgoing_amount_3d": 3000,
"max_outgoing_amount_1w": 3000,
"max_outgoing_amount_1m": 3000,
"max_outgoing_amount_3m": 3000,
"max_outgoing_amount_6m": 3000,
"max_outgoing_amount_12m": 3000,
"mean_outgoing_amount_3d": 1303.35,
"mean_outgoing_amount_1w": 1054.49,
"mean_outgoing_amount_1m": 889.13,
"mean_outgoing_amount_3m": 833.8,
"mean_outgoing_amount_6m": 861.58,
"mean_outgoing_amount_12m": 915.04,
"days_without_transactions_6m": 87,
"days_without_transactions_12m": 261,
"days_history": 365
},
"cashflow_metrics": {
"max_positive_3d": 1850.12,
"max_positive_1w": 3808.99,
"max_positive_1m": 4012.61,
"max_positive_3m": 5001.08,
"max_positive_6m": 8500,
"max_positive_12m": 8500,
"max_negative_3d": 3375.43,
"max_negative_1w": 3375.43,
"max_negative_1m": 5305.92,
"max_negative_3m": 7535.85,
"max_negative_6m": 7535.85,
"max_negative_12m": 7535.85,
"mean_positive_3d": 1410.54,
"mean_positive_1w": 1665.74,
"mean_positive_1m": 1827.36,
"mean_positive_3m": 1881.58,
"mean_positive_6m": 2102.19,
"mean_positive_12m": 2502.06,
"mean_negative_3d": 3373.48,
"mean_negative_1w": 2477.04,
"mean_negative_1m": 1904.96,
"mean_negative_3m": 1838.47,
"mean_negative_6m": 1877.63,
"mean_negative_12m": 1948.51,
"sum_positive_3d": 5642.16,
"sum_positive_1w": 13325.92,
"sum_positive_1m": 52993.36,
"sum_positive_3m": 163697.28,
"sum_positive_6m": 189197.28,
"sum_positive_12m": 240197.28,
"sum_positive_trend_3d": 98.902,
"sum_positive_trend_1w": -84.0393,
"sum_positive_trend_1m": 22.7315,
"sum_positive_trend_3m": 1.8398,
"sum_positive_trend_6m": -17.1869,
"sum_positive_trend_12m": -25.9856,
"sum_negative_3d": 6746.95,
"sum_negative_1w": 14862.25,
"sum_negative_1m": 55243.82,
"sum_negative_3m": 158108.77,
"sum_negative_6m": 167108.77,
"sum_negative_12m": 185108.77,
"sum_negative_trend_3d": -3.91,
"sum_negative_trend_1w": 254.2517,
"sum_negative_trend_1m": 58.376,
"sum_negative_trend_3m": 2.5895,
"sum_negative_trend_6m": -1.4824,
"sum_negative_trend_12m": -4.2394,
"positive_to_negative_ratio_3d": 0.84,
"positive_to_negative_ratio_1w": 0.9,
"positive_to_negative_ratio_1m": 0.96,
"positive_to_negative_ratio_3m": 1.04,
"positive_to_negative_ratio_6m": 1.13,
"positive_to_negative_ratio_12m": 1.3,
"net_cashflow_3d": -1104.79,
"net_cashflow_1w": -1536.33,
"net_cashflow_1m": -2250.46,
"net_cashflow_3m": 5588.51,
"net_cashflow_6m": 22088.51,
"net_cashflow_12m": 55088.51,
"net_cashflow_trend_3d": 1448.683,
"net_cashflow_trend_1w": 163.8856,
"net_cashflow_trend_1m": 1.3034,
"net_cashflow_trend_3m": -0.472,
"net_cashflow_trend_6m": -15.1286,
"net_cashflow_trend_12m": -21.5511
},
"category_metrics": [
{
"category": "Income & Payments",
"subcategory": "Freelance",
"net_amount_3m": 642.76,
"category_inflow_ratio_3m": 1
}
]
}