RecurringExpensesResumeRequest500Response
{
"type": "array",
"items": {
"$ref": "#/components/schemas/UnexpectedError"
},
"title": "Unexpected Error",
"description": "This error occurs when we (Belvo) have encountered an internal system error (sorry about that) or due to an unsupported response from the institution.\n \n"
}
RecurringExpensesResumeRequestResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/RecurringExpenses"
}
}
ReportingId
{
"type": "object",
"required": [
"reporting_type",
"reporting_value"
],
"properties": {
"reporting_type": {
"type": "string",
"example": "sectional_address_code",
"description": "The type of reporting ID. For DIAN, this is the sectional address code (*Codigo Dirrecion Seccional*)"
},
"reporting_value": {
"type": "string",
"example": "32",
"description": "The value of the reporting ID."
}
},
"description": "Object containing information about where the tax payer reports their income."
}
RequestTimeoutError
{
"type": "object",
"title": "Request Timeout",
"properties": {
"code": {
"type": "string",
"example": "request_timeout",
"description": "A unique error code (`request_timeout`) that allows you to classify and handle the error programmatically.\n\n\nℹ️ Check our DevPortal for more information on how to handle <a href=\"https://developers.belvo.com/docs/belvo-api-errors#408-request_timeout\" target=\"_blank\">408 request_timeout errors</a>.\n"
},
"message": {
"type": "string",
"example": "The request timed out, you can retry asking for less data by changing your query parameters",
"description": "A short description of the error. \n\n\nFor `request_timeout` errors, the description is:\n \n - `The request timed out, you can retry asking for less data by changing your query parameters`.\n"
},
"request_id": {
"type": "string",
"example": "9e7b283c6efa449c9c028a16b5c249fb",
"pattern": "[a-f0-9]{32}",
"description": "A 32-character unique ID of the request (matching a regex pattern of: `[a-f0-9]{32}`). Provide this ID when contacting the Belvo\nsupport team to accelerate investigations.\n"
}
},
"description": "Belvo has a limit regarding the time it takes to log in, retrieve account data, and log out. A timeout occurs when there is a very high amount of data and everything could not be obtained within the allotted time.\n"
}
RetentionBreakdown
{
"type": "object",
"required": [
"base_amount",
"tax_type",
"retained_amount",
"payment_status"
],
"properties": {
"tax_type": {
"type": "string",
"example": "01",
"nullable": true,
"description": "Optional attribute to indicate the type of tax withheld for the period or year according to the [SAT catalog](https://developers.belvo.com/docs/sat-catalogs#retention-code).\n"
},
"base_amount": {
"type": "number",
"format": "float",
"example": 0.03,
"nullable": true,
"description": "The base amount that was used to calculate the tax retention.\n"
},
"payment_status": {
"$ref": "#/components/schemas/EnumTaxRetentionPaymentStatus"
},
"retained_amount": {
"type": "number",
"format": "float",
"example": 0,
"nullable": true,
"description": "The amount retained.\n"
}
},
"description": "A breakdown of the retained taxes"
}
RiskInsights
{
"type": "object",
"required": [
"id",
"link",
"created_at",
"accounts",
"assets_metrics",
"transactions_metrics",
"balances_metrics",
"cashflow_metrics",
"credit_cards_metrics",
"loans_metrics",
"category_metrics"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "076c66e5-90f5-4e01-99c7-50e32f65ae42",
"description": "Belvo's unique ID for the risk insights request."
},
"link": {
"type": "string",
"format": "uuid",
"example": "30cb4806-6e00-48a4-91c9-ca55968576c8",
"description": "The `link.id` the risk insights analysis belongs to."
},
"accounts": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"example": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
"description": "The Belvo-generated ID for the account."
},
"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"
],
"nullable": true,
"description": "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."
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2022-02-01T20:25:47.307911Z",
"description": "The ISO-8601 timestamp of when the data point was last updated in Belvo's database.\n"
},
"loans_metrics": {
"$ref": "#/components/schemas/RiskInsightsLoansMetrics"
},
"assets_metrics": {
"$ref": "#/components/schemas/RiskInsightsAssetMetrics"
},
"balances_metrics": {
"$ref": "#/components/schemas/RiskInsightsBalanceMetrics"
},
"cashflow_metrics": {
"$ref": "#/components/schemas/RiskInsightsCashflowMetrics"
},
"category_metrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RiskInsightsCategoryMetrics"
},
"description": "An array of aggregate metrics regarding the transaction categories and subcategories that Belvo has identified within the user's transaction history.\n\nIn the array, Belvo only returns categories that have been identified.\n"
},
"credit_cards_metrics": {
"$ref": "#/components/schemas/RiskInsightsCreditCardMetrics"
},
"transactions_metrics": {
"$ref": "#/components/schemas/RiskInsightsTransactionMetrics"
}
}
}
RiskInsightsAssetMetrics
{
"type": "object",
"nullable": true,
"required": [
"institutions",
"num_accounts",
"num_checking_accounts",
"num_savings_accounts",
"checking_accounts_balance",
"savings_accounts_balance"
],
"properties": {
"institutions": {
"type": "array",
"items": {
"type": "string",
"example": "erebor_mx_retail",
"description": "The name of the institution"
},
"example": [
"erebor_mx_retail"
],
"nullable": true,
"description": "An array of institutions from which account information was retrieved for the user. \n\n> **Note**: For most use cases, this array will only return one item.\n"
},
"num_assets_accounts": {
"type": "integer",
"format": "int32",
"example": 1,
"nullable": true,
"description": "The total number of accounts found for the user.\n"
},
"num_savings_accounts": {
"type": "integer",
"format": "int32",
"example": 1,
"nullable": true,
"description": "The total number of savings accounts found for the user.\n"
},
"num_checking_accounts": {
"type": "integer",
"format": "int32",
"example": 1,
"nullable": true,
"description": "The total number of checking accounts found for the user.\n"
},
"savings_accounts_balance": {
"type": "number",
"format": "float",
"example": 300.02,
"nullable": true,
"description": "The total closing balance of all savings accounts.\n"
},
"checking_accounts_balance": {
"type": "number",
"format": "float",
"example": 35901.46,
"nullable": true,
"description": "The total closing balance of all checking accounts.\n"
}
},
"description": "Aggregate details regarding the assets used in the risk insight analysis. For asset metrics, we only consider checking and savings accounts.\n\n\n> 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.\n"
}
RiskInsightsBalanceMetrics
{
"type": "object",
"nullable": true,
"required": [
"closing_balance",
"min_balance_3d",
"min_balance_1w",
"min_balance_1m",
"min_balance_3m",
"min_balance_6m",
"min_balance_12m",
"mean_balance_3d",
"mean_balance_1w",
"mean_balance_1m",
"mean_balance_3m",
"mean_balance_6m",
"mean_balance_12m",
"max_balance_3d",
"max_balance_1w",
"max_balance_1m",
"max_balance_3m",
"max_balance_6m",
"max_balance_12m",
"std_balance_3d",
"std_balance_1w",
"std_balance_1m",
"std_balance_3m",
"std_balance_6m",
"std_balance_12m",
"balance_trend_3d",
"balance_trend_1w",
"balance_trend_1m",
"balance_trend_3m",
"balance_trend_6m",
"balance_trend_12m",
"days_balance_below_0_3d",
"days_balance_below_0_1w",
"days_balance_below_0_1m",
"days_balance_below_0_3m",
"days_balance_below_0_6m",
"days_balance_below_0_12m",
"days_balance_below_mean_3d",
"days_balance_below_mean_1w",
"days_balance_below_mean_1m",
"days_balance_below_mean_3m",
"days_balance_below_mean_6m",
"days_balance_below_mean_12m",
"days_balance_below_x_3d",
"days_balance_below_x_1w",
"days_balance_below_x_1m",
"days_balance_below_x_3m",
"days_balance_below_x_6m",
"days_balance_below_x_12m",
"balance_threshold_x"
],
"properties": {
"max_balance_1m": {
"type": "number",
"format": "float",
"example": 35901.46,
"nullable": true,
"description": "The maximum balance in the last month.\n"
},
"max_balance_1w": {
"type": "number",
"format": "float",
"example": 35901.46,
"nullable": true,
"description": "The maximum balance in the last week.\n"
},
"max_balance_3d": {
"type": "number",
"format": "float",
"example": 35901.46,
"nullable": true,
"description": "The maximum balance in the last three days.\n"
},
"max_balance_3m": {
"type": "number",
"format": "float",
"example": 35901.46,
"nullable": true,
"description": "The maximum balance in the last three months.\n"
},
"max_balance_6m": {
"type": "number",
"format": "float",
"example": 35901.46,
"nullable": true,
"description": "The maximum balance in the last six months.\n"
},
"min_balance_1m": {
"type": "number",
"format": "float",
"example": 33990.59,
"nullable": true,
"description": "The minimum balance in the last month.\n"
},
"min_balance_1w": {
"type": "number",
"format": "float",
"example": 34150.5,
"nullable": true,
"description": "The minimum balance in the last week).\n"
},
"min_balance_3d": {
"type": "number",
"format": "float",
"example": 35417.68,
"nullable": true,
"description": "The minimum balance in the last three days.\n"
},
"min_balance_3m": {
"type": "number",
"format": "float",
"example": 33990.59,
"nullable": true,
"description": "The minimum balance in the last three months.\n"
},
"min_balance_6m": {
"type": "number",
"format": "float",
"example": 33990.59,
"nullable": true,
"description": "The minimum balance in the six last months.\n"
},
"std_balance_1m": {
"type": "number",
"format": "float",
"example": 586.55,
"nullable": true,
"description": "The balance standard deviation in the last month.\n"
},
"std_balance_1w": {
"type": "number",
"format": "float",
"example": 764.03,
"nullable": true,
"description": "The balance standard deviation in the last week.\n"
},
"std_balance_3d": {
"type": "number",
"format": "float",
"example": 279.31,
"nullable": true,
"description": "The balance standard deviation in the last three days.\n"
},
"std_balance_3m": {
"type": "number",
"format": "float",
"example": 586.55,
"nullable": true,
"description": "The balance standard deviation in the last three months.\n"
},
"std_balance_6m": {
"type": "number",
"format": "float",
"example": 586.55,
"nullable": true,
"description": "The balance standard deviation in the last six months.\n"
},
"closing_balance": {
"type": "number",
"format": "float",
"example": 35901.46,
"nullable": true,
"description": "The balance of all the accounts at the `collected_at` time.\n"
},
"max_balance_12m": {
"type": "number",
"format": "float",
"example": 35901.46,
"nullable": true,
"description": "The maximum balance in the last twelve months.\n"
},
"mean_balance_1m": {
"type": "number",
"format": "float",
"example": 34816.08,
"nullable": true,
"description": "The mean balance in the last month.\n"
},
"mean_balance_1w": {
"type": "number",
"format": "float",
"example": 35077.1,
"nullable": true,
"description": "The mean balance in the last week.\n"
},
"mean_balance_3d": {
"type": "number",
"format": "float",
"example": 35659.57,
"nullable": true,
"description": "The mean balance in the last three days.\n"
},
"mean_balance_3m": {
"type": "number",
"format": "float",
"example": 34816.08,
"nullable": true,
"description": "The mean balance in the last three months.\n"
},
"mean_balance_6m": {
"type": "number",
"format": "float",
"example": 34816.08,
"nullable": true,
"description": "The mean balance in the last six months.\n"
},
"min_balance_12m": {
"type": "number",
"format": "float",
"example": 33990.59,
"nullable": true,
"description": "The minimum balance in the last twelve months.\n"
},
"std_balance_12m": {
"type": "number",
"format": "float",
"example": 586.55,
"nullable": true,
"description": "The balance standard deviation in the last twelve months.\n"
},
"balance_trend_1m": {
"type": "number",
"format": "float",
"example": 22.6,
"nullable": true,
"description": "The balance trend of the user in the last month.\n"
},
"balance_trend_1w": {
"type": "number",
"format": "float",
"example": 290.18,
"nullable": true,
"description": "The balance trend of the user in the last week.\n"
},
"balance_trend_3d": {
"type": "number",
"format": "float",
"example": 193.51,
"nullable": true,
"description": "The balance trend of the user in the last three days.\n"
},
"balance_trend_3m": {
"type": "number",
"format": "float",
"example": 22.6,
"nullable": true,
"description": "The balance trend of the user in the last three months.\n"
},
"balance_trend_6m": {
"type": "number",
"format": "float",
"example": 22.6,
"nullable": true,
"description": "The balance trend of the user in the last six months.\n"
},
"mean_balance_12m": {
"type": "number",
"format": "float",
"example": 34816.08,
"nullable": true,
"description": "The mean balance in the last twelve months.\n"
},
"balance_trend_12m": {
"type": "number",
"format": "float",
"example": 22.6,
"nullable": true,
"description": "The balance trend of the user in the last twelve months.\n"
},
"balance_threshold_x": {
"type": "number",
"format": "float",
"example": 1000,
"description": "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).\n"
},
"days_balance_below_0_1m": {
"type": "integer",
"format": "int32",
"example": 0,
"nullable": true,
"description": "The number of days that the total balance of the account is less than or equal to 0 in the last month.\n"
},
"days_balance_below_0_1w": {
"type": "integer",
"format": "int32",
"example": 0,
"nullable": true,
"description": "The number of days that the total balance of the account is less than or equal to 0 in the last week.\n"
},
"days_balance_below_0_3d": {
"type": "integer",
"format": "int32",
"example": 0,
"nullable": true,
"description": "The number of days that the total balance of the account is less than or equal to 0 in the last three days.\n"
},
"days_balance_below_0_3m": {
"type": "integer",
"format": "int32",
"example": 0,
"nullable": true,
"description": "The number of days that the total balance of the account is less than or equal to 0 in the last three months.\n"
},
"days_balance_below_0_6m": {
"type": "integer",
"format": "int32",
"example": 0,
"nullable": true,
"description": "The number of days that the total balance of the account is less than or equal to 0 in the last six months.\n"
},
"days_balance_below_x_1m": {
"type": "integer",
"format": "int32",
"example": 0,
"nullable": true,
"description": "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.\n"
},
"days_balance_below_x_1w": {
"type": "integer",
"format": "int32",
"example": 0,
"nullable": true,
"description": "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.\n"
},
"days_balance_below_x_3d": {
"type": "integer",
"format": "int32",
"example": 0,
"nullable": true,
"description": "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.\n"
},
"days_balance_below_x_3m": {
"type": "integer",
"format": "int32",
"example": 0,
"nullable": true,
"description": "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.\n"
},
"days_balance_below_x_6m": {
"type": "integer",
"format": "int32",
"example": 0,
"nullable": true,
"description": "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.\n"
},
"days_balance_below_0_12m": {
"type": "integer",
"format": "int32",
"example": 0,
"nullable": true,
"description": "The number of days that the total balance of the account is less than or equal to 0 in the last twelve months.\n"
},
"days_balance_below_x_12m": {
"type": "integer",
"format": "int32",
"example": 0,
"nullable": true,
"description": "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.\n"
},
"days_balance_below_mean_1m": {
"type": "integer",
"format": "int32",
"example": 17,
"nullable": true,
"description": "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`.\n"
},
"days_balance_below_mean_1w": {
"type": "integer",
"format": "int32",
"example": 3,
"nullable": true,
"description": "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`.\n"
},
"days_balance_below_mean_3d": {
"type": "integer",
"format": "int32",
"example": 2,
"nullable": true,
"description": "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`.\n"
},
"days_balance_below_mean_3m": {
"type": "integer",
"format": "int32",
"example": 17,
"nullable": true,
"description": "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`.\n"
},
"days_balance_below_mean_6m": {
"type": "integer",
"format": "int32",
"example": 17,
"nullable": true,
"description": "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`.\n"
},
"days_balance_below_mean_12m": {
"type": "integer",
"format": "int32",
"example": 17,
"nullable": true,
"description": "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`.\n"
}
},
"description": "Balance metrics calculated based on the user's balances from checking and savings accounts."
}
RiskInsightsCashflowMetrics
{
"type": "object",
"nullable": true,
"required": [
"max_positive_3d",
"max_positive_1w",
"max_positive_1m",
"max_positive_3m",
"max_positive_6m",
"max_positive_12m",
"max_negative_3d",
"max_negative_1w",
"max_negative_1m",
"max_negative_3m",
"max_negative_6m",
"max_negative_12m",
"mean_positive_3d",
"mean_positive_1w",
"mean_positive_1m",
"mean_positive_3m",
"mean_positive_6m",
"mean_positive_12m",
"mean_negative_3d",
"mean_negative_1w",
"mean_negative_1m",
"mean_negative_3m",
"mean_negative_6m",
"mean_negative_12m",
"sum_positive_3d",
"sum_positive_1w",
"sum_positive_1m",
"sum_positive_3m",
"sum_positive_6m",
"sum_positive_12m",
"sum_positive_trend_3d",
"sum_positive_trend_1w",
"sum_positive_trend_1m",
"sum_positive_trend_3m",
"sum_positive_trend_6m",
"sum_positive_trend_12m",
"sum_negative_3d",
"sum_negative_1w",
"sum_negative_1m",
"sum_negative_3m",
"sum_negative_6m",
"sum_negative_12m",
"sum_negative_trend_3d",
"sum_negative_trend_1w",
"sum_negative_trend_1m",
"sum_negative_trend_3m",
"sum_negative_trend_6m",
"sum_negative_trend_12m",
"positive_to_negative_ratio_3d",
"positive_to_negative_ratio_1w",
"positive_to_negative_ratio_1m",
"positive_to_negative_ratio_3m",
"positive_to_negative_ratio_6m",
"positive_to_negative_ratio_12m",
"net_cashflow_3d",
"net_cashflow_1w",
"net_cashflow_1m",
"net_cashflow_3m",
"net_cashflow_6m",
"net_cashflow_12m",
"net_cashflow_trend_3d",
"net_cashflow_trend_1w",
"net_cashflow_trend_1m",
"net_cashflow_trend_3m",
"net_cashflow_trend_6m",
"net_cashflow_trend_12m"
],
"properties": {
"max_negative_1m": {
"type": "number",
"format": "float",
"example": 5305.92,
"nullable": true,
"description": "The highest value of negative cash flow transactions in the last month.\n"
},
"max_negative_1w": {
"type": "number",
"format": "float",
"example": 3375.43,
"nullable": true,
"description": "The highest value of negative cash flow transactions in the last week.\n"
},
"max_negative_3d": {
"type": "number",
"format": "float",
"example": 3375.43,
"nullable": true,
"description": "The highest value of negative cash flow transactions in the last three days.\n"
},
"max_negative_3m": {
"type": "number",
"format": "float",
"example": 7535.85,
"nullable": true,
"description": "The highest value of negative cash flow transactions in the last three months.\n"
},
"max_negative_6m": {
"type": "number",
"format": "float",
"example": 7535.85,
"nullable": true,
"description": "The highest value of negative cash flow transactions in the last six months.\n"
},
"max_positive_1m": {
"type": "number",
"format": "float",
"example": 4012.61,
"nullable": true,
"description": "The highest value of positive cash flow transactions the last month.\n"
},
"max_positive_1w": {
"type": "number",
"format": "float",
"example": 3808.99,
"nullable": true,
"description": "The highest value of positive cash flow transactions the last week.\n"
},
"max_positive_3d": {
"type": "number",
"format": "float",
"example": 1850.12,
"nullable": true,
"description": "The highest value of positive cash flow transactions in the last three days.\n"
},
"max_positive_3m": {
"type": "number",
"format": "float",
"example": 5001.08,
"nullable": true,
"description": "The highest value of positive cash flow transactions the last three months.\n"
},
"max_positive_6m": {
"type": "number",
"format": "float",
"example": 8500,
"nullable": true,
"description": "The highest value of positive cash flow transactions the last six months.\n"
},
"net_cashflow_1m": {
"type": "number",
"format": "float",
"example": -2250.46,
"nullable": true,
"description": "The net cash flow in the last month.\n"
},
"net_cashflow_1w": {
"type": "number",
"format": "float",
"example": -1536.33,
"nullable": true,
"description": "The net cash flow in the last week.\n"
},
"net_cashflow_3d": {
"type": "number",
"format": "float",
"example": -1104.79,
"nullable": true,
"description": "The net cash flow in the last three days.\n"
},
"net_cashflow_3m": {
"type": "number",
"format": "float",
"example": 5588.51,
"nullable": true,
"description": "The net cash flow in the last three months.\n"
},
"net_cashflow_6m": {
"type": "number",
"format": "float",
"example": 22088.51,
"nullable": true,
"description": "The net cash flow in the last six months.\n"
},
"sum_negative_1m": {
"type": "number",
"format": "float",
"example": 55243.82,
"nullable": true,
"description": "The sum total of all transactions leading to a negative cash flow in the last month.\n"
},
"sum_negative_1w": {
"type": "number",
"format": "float",
"example": 14862.25,
"nullable": true,
"description": "The sum total of all transactions leading to a negative cash flow in the last week.\n"
},
"sum_negative_3d": {
"type": "number",
"format": "float",
"example": 6746.95,
"nullable": true,
"description": "The sum total of all transactions leading to a negative cash flow in the last three days.\n"
},
"sum_negative_3m": {
"type": "number",
"format": "float",
"example": 158108.77,
"nullable": true,
"description": "The sum total of all transactions leading to a negative cash flow in the last three months.\n"
},
"sum_negative_6m": {
"type": "number",
"format": "float",
"example": 167108.77,
"nullable": true,
"description": "The sum total of all transactions leading to a negative cash flow in the last six months.\n"
},
"sum_positive_1m": {
"type": "number",
"format": "float",
"example": 52993.36,
"nullable": true,
"description": "The sum total of all transactions leading to a positive cash flow in the last month.\n"
},
"sum_positive_1w": {
"type": "number",
"format": "float",
"example": 13325.92,
"nullable": true,
"description": "The sum total of all transactions leading to a positive cash flow in the last week.\n"
},
"sum_positive_3d": {
"type": "number",
"format": "float",
"example": 5642.16,
"nullable": true,
"description": "The sum total of all transactions leading to a positive cash flow in the last three days.\n"
},
"sum_positive_3m": {
"type": "number",
"format": "float",
"example": 163697.28,
"nullable": true,
"description": "The sum total of all transactions leading to a positive cash flow in the last three months.\n"
},
"sum_positive_6m": {
"type": "number",
"format": "float",
"example": 189197.28,
"nullable": true,
"description": "The sum total of all transactions leading to a positive cash flow in the last six months.\n"
},
"max_negative_12m": {
"type": "number",
"format": "float",
"example": 7535.85,
"nullable": true,
"description": "The highest value of negative cash flow transactions in the last twelve months.\n"
},
"max_positive_12m": {
"type": "number",
"format": "float",
"example": 8500,
"nullable": true,
"description": "The highest value of positive cash flow transactions the last twelve months.\n"
},
"mean_negative_1m": {
"type": "number",
"format": "float",
"example": 1904.96,
"nullable": true,
"description": "The mean value of the negative cash flow transactions in the last month.\n"
},
"mean_negative_1w": {
"type": "number",
"format": "float",
"example": 2477.04,
"nullable": true,
"description": "The mean value of the negative cash flow transactions in the last week.\n"
},
"mean_negative_3d": {
"type": "number",
"format": "float",
"example": 3373.48,
"nullable": true,
"description": "The mean value of the negative cash flow transactions in the last three days.\n"
},
"mean_negative_3m": {
"type": "number",
"format": "float",
"example": 1838.47,
"nullable": true,
"description": "The mean value of the negative cash flow transactions in the last three months.\n"
},
"mean_negative_6m": {
"type": "number",
"format": "float",
"example": 1877.63,
"nullable": true,
"description": "The mean value of the negative cash flow transactions in the last six months.\n"
},
"mean_positive_1m": {
"type": "number",
"format": "float",
"example": 1827.36,
"nullable": true,
"description": "The mean value of the positive cash flow transactions in the last month.\n"
},
"mean_positive_1w": {
"type": "number",
"format": "float",
"example": 1665.74,
"nullable": true,
"description": "The mean value of the positive cash flow transactions in the last week.\n"
},
"mean_positive_3d": {
"type": "number",
"format": "float",
"example": 1410.54,
"nullable": true,
"description": "The mean value of the positive cash flow transactions in the last three days.\n"
},
"mean_positive_3m": {
"type": "number",
"format": "float",
"example": 1881.58,
"nullable": true,
"description": "The mean value of the positive cash flow transactions in the last three months.\n"
},
"mean_positive_6m": {
"type": "number",
"format": "float",
"example": 2102.19,
"nullable": true,
"description": "The mean value of the positive cash flow transactions in the last six months.\n"
},
"net_cashflow_12m": {
"type": "number",
"format": "float",
"example": 55088.51,
"nullable": true,
"description": "The net cash flow in the last twelve months.\n"
},
"sum_negative_12m": {
"type": "number",
"format": "float",
"example": 185108.77,
"nullable": true,
"description": "The sum total of all transactions leading to a negative cash flow in the last twelve months.\n"
},
"sum_positive_12m": {
"type": "number",
"format": "float",
"example": 240197.28,
"nullable": true,
"description": "The sum total of all transactions leading to a positive cash flow in the last twelve months.\n"
},
"mean_negative_12m": {
"type": "number",
"format": "float",
"example": 1948.51,
"nullable": true,
"description": "The mean value of the negative cash flow transactions in the last twelve months.\n"
},
"mean_positive_12m": {
"type": "number",
"format": "float",
"example": 2502.06,
"nullable": true,
"description": "The mean value of the positive cash flow transactions in the last twelve months.\n"
},
"net_cashflow_trend_1m": {
"type": "number",
"format": "float",
"example": 1.3034,
"nullable": true,
"description": "The net cash flow trend in the last month.\n"
},
"net_cashflow_trend_1w": {
"type": "number",
"format": "float",
"example": 163.8856,
"nullable": true,
"description": "The net cash flow trend in the last week.\n"
},
"net_cashflow_trend_3d": {
"type": "number",
"format": "float",
"example": 1448.683,
"nullable": true,
"description": "The net cash flow trend in the last three days months.\n"
},
"net_cashflow_trend_3m": {
"type": "number",
"format": "float",
"example": -0.472,
"nullable": true,
"description": "The net cash flow trend in the last three months.\n"
},
"net_cashflow_trend_6m": {
"type": "number",
"format": "float",
"example": -15.1286,
"nullable": true,
"description": "The net cash flow trend in the last six months.\n"
},
"sum_negative_trend_1m": {
"type": "number",
"format": "float",
"example": 58.376,
"nullable": true,
"description": "The negative cash flow trend based on the sum of all negative transactions in the last month.\n"
},
"sum_negative_trend_1w": {
"type": "number",
"format": "float",
"example": 254.2517,
"nullable": true,
"description": "The negative cash flow trend based on the sum of all negative transactions in the last week.\n"
},
"sum_negative_trend_3d": {
"type": "number",
"format": "float",
"example": -3.91,
"nullable": true,
"description": "The negative cash flow trend based on the sum of all negative transactions in the last three days.\n"
},
"sum_negative_trend_3m": {
"type": "number",
"format": "float",
"example": 2.5895,
"nullable": true,
"description": "The negative cash flow trend based on the sum of all negative transactions in the last three months.\n"
},
"sum_negative_trend_6m": {
"type": "number",
"format": "float",
"example": -1.4824,
"nullable": true,
"description": "The negative cash flow trend based on the sum of all negative transactions in the last six months.\n"
},
"sum_positive_trend_1m": {
"type": "number",
"format": "float",
"example": 22.7315,
"nullable": true,
"description": "The positive cash flow trend based on the sum of all positive transactions in the last month.\n"
},
"sum_positive_trend_1w": {
"type": "number",
"format": "float",
"example": -84.0393,
"nullable": true,
"description": "The positive cash flow trend based on the sum of all positive transactions in the last week.\n"
},
"sum_positive_trend_3d": {
"type": "number",
"format": "float",
"example": 98.902,
"nullable": true,
"description": "The positive cash flow trend based on the sum of all positive transactions in the last three days.\n"
},
"sum_positive_trend_3m": {
"type": "number",
"format": "float",
"example": 1.8398,
"nullable": true,
"description": "The positive cash flow trend based on the sum of all positive transactions in the last three months.\n"
},
"sum_positive_trend_6m": {
"type": "number",
"format": "float",
"example": -17.1869,
"nullable": true,
"description": "The positive cash flow trend based on the sum of all positive transactions in the last six months.\n"
},
"net_cashflow_trend_12m": {
"type": "number",
"format": "float",
"example": -21.5511,
"nullable": true,
"description": "The net cash flow trend in the last twelve months.\n"
},
"sum_negative_trend_12m": {
"type": "number",
"format": "float",
"example": -4.2394,
"nullable": true,
"description": "The negative cash flow trend based on the sum of all negative transactions in the last twelve months.\n"
},
"sum_positive_trend_12m": {
"type": "number",
"format": "float",
"example": -25.9856,
"nullable": true,
"description": "The positive cash flow trend based on the sum of all positive transactions in the last twelve months.\n"
},
"positive_to_negative_ratio_1m": {
"type": "number",
"format": "float",
"example": 0.96,
"nullable": true,
"description": "The ratio between sum_positive / sum_negative in the last month.\n\nℹ️ 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.\n\n**Note**: In the case that there have been no outgoing transactions, the value will be `null`.\n"
},
"positive_to_negative_ratio_1w": {
"type": "number",
"format": "float",
"example": 0.9,
"nullable": true,
"description": "The ratio between sum_positive / sum_negative in the last week.\n\nℹ️ 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.\n\n**Note**: In the case that there have been no outgoing transactions, the value will be `null`.\n"
},
"positive_to_negative_ratio_3d": {
"type": "number",
"format": "float",
"example": 0.84,
"nullable": true,
"description": "The ratio between sum_positive / sum_negative in the last three days.\n\nℹ️ 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.\n\n**Note**: In the case that there have been no outgoing transactions, the value will be `null`.\n"
},
"positive_to_negative_ratio_3m": {
"type": "number",
"format": "float",
"example": 1.04,
"nullable": true,
"description": "The ratio between sum_positive / sum_negative in the last three months.\n\nℹ️ 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.\n\n**Note**: In the case that there have been no outgoing transactions, the value will be `null`.\n"
},
"positive_to_negative_ratio_6m": {
"type": "number",
"format": "float",
"example": 1.13,
"nullable": true,
"description": "The ratio between sum_positive / sum_negative in the last six months.\n\nℹ️ 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.\n\n**Note**: In the case that there have been no outgoing transactions, the value will be `null`.\n"
},
"positive_to_negative_ratio_12m": {
"type": "number",
"format": "float",
"example": 1.3,
"nullable": true,
"description": "The ratio between sum_positive / sum_negative in the last twelve months.\n\nℹ️ 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.\n\n**Note**: In the case that there have been no outgoing transactions, the value will be `null`.\n"
}
},
"description": "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.\n\n\n> ℹ️ **Note**\n>\n> 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.\n"
}
RiskInsightsCategoryMetrics
{
"type": "object",
"properties": {
"category": {
"$ref": "#/components/schemas/EnumTransactionCategory"
},
"trend_3m": {
"type": "number",
"format": "float",
"example": 0,
"nullable": true,
"description": "The net category transaction trend (incoming - outgoing transactions for the category) for the period."
},
"subcategory": {
"$ref": "#/components/schemas/EnumTransactionSubcategory"
},
"net_amount_3m": {
"type": "number",
"format": "float",
"example": 642.76,
"nullable": true,
"description": "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)."
},
"category_inflow_ratio_3m": {
"type": "number",
"format": "float",
"example": 1,
"nullable": true,
"description": "The ratio of `net_amount_3m` divided by the sum of all incoming categorized transactions (including the current category) for the same period.\n\nNote: If there are no inflow transactions for the period, this value will return `null`.\n"
}
}
}
RiskInsightsCreditCardMetrics
{
"type": "object",
"nullable": true,
"required": [
"num_accounts",
"sum_credit_limit",
"sum_credit_used",
"credit_card_limit_utilization"
],
"properties": {
"num_accounts": {
"type": "integer",
"format": "int32",
"example": 2,
"minimum": 0,
"description": "Number of credit cards accounts associated to the user.\n"
},
"sum_credit_used": {
"type": "number",
"format": "float",
"example": 101020.14,
"nullable": true,
"description": "Sum total of all credit used.\n"
},
"sum_credit_limit": {
"type": "number",
"format": "float",
"example": 106560,
"nullable": true,
"description": "Sum total of all credit cards' limits.\n"
},
"credit_card_limit_utilization": {
"type": "number",
"format": "float",
"example": 0.95,
"nullable": true,
"description": "The percentage of the credit card limit used.\n"
}
},
"description": "Aggregated metrics calculated based on the user's credit card accounts.\n\n> 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.\n"
}
RiskInsightsDeleteSpecificInsight404Response
{
"type": "array",
"items": {
"$ref": "#/components/schemas/NotFoundError"
},
"description": "You made a request where you:\n\n - provided the wrong URL.\n - used an ID (for a link, account, transaction, and so on) that is not associated with your Belvo account.\n \n"
}
RiskInsightsDeleteSpecificInsightResponse
{
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/UnauthorizedError"
},
{
"$ref": "#/components/schemas/401_consent_without_accounts_error"
}
]
}
}
RiskInsightsGetDetails401Response
{
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/UnauthorizedError"
},
{
"$ref": "#/components/schemas/401_consent_without_accounts_error"
}
]
}
}
RiskInsightsGetDetails404Response
{
"type": "array",
"items": {
"$ref": "#/components/schemas/NotFoundError"
},
"description": "You made a request where you:\n\n - provided the wrong URL.\n - used an ID (for a link, account, transaction, and so on) that is not associated with your Belvo account.\n \n"
}
RiskInsightsGetDetailsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/RiskInsights"
}
}
RiskInsightsGetForLink401Response
{
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/UnauthorizedError"
},
{
"$ref": "#/components/schemas/401_consent_without_accounts_error"
}
]
}
}
RiskInsightsGetForLink408Response
{
"type": "array",
"items": {
"$ref": "#/components/schemas/RequestTimeoutError"
},
"title": "Request Timeout",
"description": "Belvo has a limit regarding the time it takes to log in, retrieve account data, and log out. A timeout occurs when there is a very high amount of data and everything could not be obtained within the allotted time.\n \n"
}
RiskInsightsGetForLink428Response
{
"type": "array",
"items": {
"$ref": "#/components/schemas/TokenRequiredResponse"
}
}
RiskInsightsGetForLink500Response
{
"type": "array",
"items": {
"$ref": "#/components/schemas/UnexpectedError"
},
"title": "Unexpected Error",
"description": "This error occurs when we (Belvo) have encountered an internal system error (sorry about that) or due to an unsupported response from the institution.\n \n"
}
RiskInsightsGetForLinkResponse
{
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/TooManySessionsError"
},
{
"$ref": "#/components/schemas/LoginError"
},
{
"$ref": "#/components/schemas/SessionExpiredError"
},
{
"$ref": "#/components/schemas/ValidationError"
},
{
"$ref": "#/components/schemas/InstitutionDownError"
},
{
"$ref": "#/components/schemas/InstitutionUnavailableError"
},
{
"$ref": "#/components/schemas/InstitutionInactiveError"
},
{
"$ref": "#/components/schemas/UnsupportedOperationError"
},
{
"$ref": "#/components/schemas/InvalidLinkError"
},
{
"$ref": "#/components/schemas/UnconfirmedLinkError"
},
{
"$ref": "#/components/schemas/InvalidPeriodError"
}
]
}
}
RiskInsightsListAllRiskInsightsResponse
{
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/UnauthorizedError"
},
{
"$ref": "#/components/schemas/401_consent_without_accounts_error"
}
]
}
}
RiskInsightsLoansMetrics
{
"type": "object",
"nullable": true,
"required": [
"num_accounts",
"sum_loans_principal",
"sum_loans_outstanding_principal",
"sum_loans_monthly_payment",
"loan_limit_utilization",
"overdraft_limit",
"overdraft_limit_utilization"
],
"properties": {
"num_accounts": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "The number of loan accounts associated with the user.\n"
},
"overdraft_limit": {
"type": "number",
"format": "float",
"example": 900,
"nullable": true,
"description": "The total overdraft limit of all checking and savings accounts.\n"
},
"sum_loans_principal": {
"type": "number",
"format": "float",
"example": 5000,
"nullable": true,
"description": "Sum total of the principal for all of the user's loan accounts.\n"
},
"loan_limit_utilization": {
"type": "number",
"format": "float",
"example": 0.3,
"nullable": true,
"description": "The percentage of the loan limit used.\n"
},
"sum_loans_monthly_payment": {
"type": "number",
"format": "float",
"example": 400,
"nullable": true,
"description": "Sum total of the monthly payments for all the user's loan accounts.\n"
},
"overdraft_limit_utilization": {
"type": "number",
"format": "float",
"example": 0.4,
"nullable": true,
"description": "The percentage of the overdraft limit used.\n"
},
"sum_loans_outstanding_principal": {
"type": "number",
"format": "float",
"example": 2000,
"nullable": true,
"description": "Sum total of the outstanding principal for all the user's loan accounts.\n"
}
},
"description": "Aggregated metrics calculated based on the user's loan accounts and checking accounts that have an overdraft.\n\n> 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.\n"
}
RiskInsightsPaginatedResponse
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/common_pagination_properties"
},
{
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RiskInsights"
},
"description": "Array of risk insights objects."
}
}
}
]
}
RiskInsightsResumeInsightsSession201Response
{
"type": "array",
"items": {
"$ref": "#/components/schemas/RiskInsights"
}
}
RiskInsightsResumeInsightsSession400Response
{
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/TooManySessionsError"
},
{
"$ref": "#/components/schemas/LoginError"
},
{
"$ref": "#/components/schemas/SessionExpiredError"
},
{
"$ref": "#/components/schemas/ValidationError"
},
{
"$ref": "#/components/schemas/InstitutionDownError"
},
{
"$ref": "#/components/schemas/InstitutionUnavailableError"
},
{
"$ref": "#/components/schemas/InstitutionInactiveError"
},
{
"$ref": "#/components/schemas/UnsupportedOperationError"
},
{
"$ref": "#/components/schemas/InvalidLinkError"
},
{
"$ref": "#/components/schemas/UnconfirmedLinkError"
}
]
}
}
RiskInsightsResumeInsightsSession401Response
{
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/UnauthorizedError"
},
{
"$ref": "#/components/schemas/401_consent_without_accounts_error"
}
]
}
}
RiskInsightsResumeInsightsSession408Response
{
"type": "array",
"items": {
"$ref": "#/components/schemas/RequestTimeoutError"
},
"title": "Request Timeout",
"description": "Belvo has a limit regarding the time it takes to log in, retrieve account data, and log out. A timeout occurs when there is a very high amount of data and everything could not be obtained within the allotted time.\n \n"
}
RiskInsightsResumeInsightsSession428Response
{
"type": "array",
"items": {
"$ref": "#/components/schemas/TokenRequiredResponse"
}
}
RiskInsightsResumeInsightsSession500Response
{
"type": "array",
"items": {
"$ref": "#/components/schemas/UnexpectedError"
},
"title": "Unexpected Error",
"description": "This error occurs when we (Belvo) have encountered an internal system error (sorry about that) or due to an unsupported response from the institution.\n \n"
}
RiskInsightsResumeInsightsSessionResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/RiskInsights"
}
}
RiskInsightsTransactionMetrics
{
"type": "object",
"nullable": true,
"required": [
"num_transactions_3d",
"num_transactions_1w",
"num_transactions_1m",
"num_transactions_3m",
"num_transactions_6m",
"num_transactions_12m",
"max_num_transactions_3d",
"max_num_transactions_1w",
"max_num_transactions_1m",
"max_num_transactions_3m",
"max_num_transactions_6m",
"max_num_transactions_12m",
"mean_num_transactions_3d",
"mean_num_transactions_1w",
"mean_num_transactions_1m",
"mean_num_transactions_3m",
"mean_num_transactions_6m",
"mean_num_transactions_12m",
"num_incoming_transactions_3d",
"num_incoming_transactions_1w",
"num_incoming_transactions_1m",
"num_incoming_transactions_3m",
"num_incoming_transactions_6m",
"num_incoming_transactions_12m",
"max_num_incoming_transactions_3d",
"max_num_incoming_transactions_1w",
"max_num_incoming_transactions_1m",
"max_num_incoming_transactions_3m",
"max_num_incoming_transactions_6m",
"max_num_incoming_transactions_12m",
"mean_num_incoming_transactions_3d",
"mean_num_incoming_transactions_1w",
"mean_num_incoming_transactions_1m",
"mean_num_incoming_transactions_3m",
"mean_num_incoming_transactions_6m",
"mean_num_incoming_transactions_12m",
"sum_incoming_amount_3d",
"sum_incoming_amount_1w",
"sum_incoming_amount_1m",
"sum_incoming_amount_3m",
"sum_incoming_amount_6m",
"sum_incoming_amount_12m",
"max_incoming_amount_3d",
"max_incoming_amount_1w",
"max_incoming_amount_1m",
"max_incoming_amount_3m",
"max_incoming_amount_6m",
"max_incoming_amount_12m",
"mean_incoming_amount_3d",
"mean_incoming_amount_1w",
"mean_incoming_amount_1m",
"mean_incoming_amount_3m",
"mean_incoming_amount_6m",
"mean_incoming_amount_12m",
"num_outgoing_transactions_3d",
"num_outgoing_transactions_1w",
"num_outgoing_transactions_1m",
"num_outgoing_transactions_3m",
"num_outgoing_transactions_6m",
"num_outgoing_transactions_12m",
"max_num_outgoing_transactions_3d",
"max_num_outgoing_transactions_1w",
"max_num_outgoing_transactions_1m",
"max_num_outgoing_transactions_3m",
"max_num_outgoing_transactions_6m",
"max_num_outgoing_transactions_12m",
"mean_num_outgoing_transactions_3d",
"mean_num_outgoing_transactions_1w",
"mean_num_outgoing_transactions_1m",
"mean_num_outgoing_transactions_3m",
"mean_num_outgoing_transactions_6m",
"mean_num_outgoing_transactions_12m",
"sum_outgoing_amount_3d",
"sum_outgoing_amount_1w",
"sum_outgoing_amount_1m",
"sum_outgoing_amount_3m",
"sum_outgoing_amount_6m",
"sum_outgoing_amount_12m",
"max_outgoing_amount_3d",
"max_outgoing_amount_1w",
"max_outgoing_amount_1m",
"max_outgoing_amount_3m",
"max_outgoing_amount_6m",
"max_outgoing_amount_12m",
"mean_outgoing_amount_3d",
"mean_outgoing_amount_1w",
"mean_outgoing_amount_1m",
"mean_outgoing_amount_3m",
"mean_outgoing_amount_6m",
"mean_outgoing_amount_12m",
"days_without_transactions_3d",
"days_without_transactions_1w",
"days_without_transactions_1m",
"days_without_transactions_3m",
"days_without_transactions_6m",
"days_without_transactions_12m",
"days_since_last_transaction",
"days_since_last_incoming_transaction",
"days_since_last_outgoing_transaction",
"days_history"
],
"properties": {
"days_history": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 365,
"description": "The number of days between when the risk insight request was made and the first transaction.\n"
},
"num_transactions_1m": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 168,
"description": "The total number of transactions analyzed to determine the risk insights for the last month (incoming and outgoing).\n"
},
"num_transactions_1w": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 46,
"description": "The total number of transactions analyzed to determine the risk insights for the last week (incoming and outgoing).\n"
},
"num_transactions_3d": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 26,
"description": "The total number of transactions analyzed to determine the risk insights for the last three days (incoming and outgoing).\n"
},
"num_transactions_3m": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 460,
"description": "The total number of transactions analyzed to determine the risk insights for the last three months (incoming and outgoing).\n"
},
"num_transactions_6m": {
"type": "integer",
"format": "int32",
"default": 670,
"example": 472,
"description": "The total number of transactions analyzed to determine the risk insights for the last six months (incoming and outgoing).\n"
},
"num_transactions_12m": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 496,
"description": "The total number of transactions analyzed to determine the risk insights for the last twelve months (incoming and outgoing).\n"
},
"max_incoming_amount_1m": {
"type": "number",
"format": "float",
"example": 3000,
"nullable": true,
"description": "The highest value inflow transaction in the last month.\n"
},
"max_incoming_amount_1w": {
"type": "number",
"format": "float",
"example": 3000,
"nullable": true,
"description": "The highest value inflow transaction in the last week.\n"
},
"max_incoming_amount_3d": {
"type": "number",
"format": "float",
"example": 3000,
"nullable": true,
"description": "The highest value inflow transaction in the last three days.\n"
},
"max_incoming_amount_3m": {
"type": "number",
"format": "float",
"example": 3000,
"nullable": true,
"description": "The highest value inflow transaction in the last three months.\n"
},
"max_incoming_amount_6m": {
"type": "number",
"format": "float",
"example": 3000,
"nullable": true,
"description": "The highest value inflow transaction in the last six months.\n"
},
"max_outgoing_amount_1m": {
"type": "number",
"format": "float",
"example": 3000,
"nullable": true,
"description": "The highest value outflow transaction in the last month.\n"
},
"max_outgoing_amount_1w": {
"type": "number",
"format": "float",
"example": 3000,
"nullable": true,
"description": "The highest value outflow transaction in the last week.\n"
},
"max_outgoing_amount_3d": {
"type": "number",
"format": "float",
"example": 3000,
"nullable": true,
"description": "The highest value outflow transaction in the last three days.\n"
},
"max_outgoing_amount_3m": {
"type": "number",
"format": "float",
"example": 3000,
"nullable": true,
"description": "The highest value outflow transaction in the last three months.\n"
},
"max_outgoing_amount_6m": {
"type": "number",
"format": "float",
"example": 3000,
"nullable": true,
"description": "The highest value outflow transaction in the last six months.\n"
},
"sum_incoming_amount_1m": {
"type": "number",
"format": "float",
"example": 75993.36,
"nullable": true,
"description": "The total sum of all inflow transactions for the last month.\n"
},
"sum_incoming_amount_1w": {
"type": "number",
"format": "float",
"example": 24825.92,
"nullable": true,
"description": "The total sum of all inflow transactions for the last week.\n"
},
"sum_incoming_amount_3d": {
"type": "number",
"format": "float",
"example": 17142.16,
"nullable": true,
"description": "The total sum of all inflow transactions for the last three days.\n"
},
"sum_incoming_amount_3m": {
"type": "number",
"format": "float",
"example": 198197.28,
"nullable": true,
"description": "The total sum of all inflow transactions for the last three months.\n"
},
"sum_incoming_amount_6m": {
"type": "number",
"format": "float",
"example": 223697.28,
"nullable": true,
"description": "The total sum of all inflow transactions for the last six months.\n"
},
"sum_outgoing_amount_1m": {
"type": "number",
"format": "float",
"example": 78243.82,
"nullable": true,
"description": "The total sum of all outflow transactions for the last month.\n"
},
"sum_outgoing_amount_1w": {
"type": "number",
"format": "float",
"example": 26362.25,
"nullable": true,
"description": "The total sum of all outflow transactions for the last week.\n"
},
"sum_outgoing_amount_3d": {
"type": "number",
"format": "float",
"example": 18246.95,
"nullable": true,
"description": "The total sum of all outflow transactions for the last three days.\n"
},
"sum_outgoing_amount_3m": {
"type": "number",
"format": "float",
"example": 192608.77,
"nullable": true,
"description": "The total sum of all outflow transactions for the last three months.\n"
},
"sum_outgoing_amount_6m": {
"type": "number",
"format": "float",
"example": 201608.77,
"nullable": true,
"description": "The total sum of all outflow transactions for the last six months.\n"
},
"max_incoming_amount_12m": {
"type": "number",
"format": "float",
"example": 3000,
"nullable": true,
"description": "The highest value inflow transaction in the last twelve months.\n"
},
"max_num_transactions_1m": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 18,
"description": "The maximum number of transactions for the last month.\n"
},
"max_num_transactions_1w": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 10,
"description": "The maximum number of transactions for the last week.\n"
},
"max_num_transactions_3d": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 10,
"description": "The maximum number of transactions for the last three days.\n"
},
"max_num_transactions_3m": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 18,
"description": "The maximum number of transactions for the last three months.\n"
},
"max_num_transactions_6m": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 18,
"description": "The maximum number of transactions for the last six months.\n"
},
"max_outgoing_amount_12m": {
"type": "number",
"format": "float",
"example": 3000,
"nullable": true,
"description": "The highest value outflow transaction in the last twelve months.\n"
},
"mean_incoming_amount_1m": {
"type": "number",
"format": "float",
"example": 949.92,
"nullable": true,
"description": "The mean incoming value of all transactions in the last month.\n"
},
"mean_incoming_amount_1w": {
"type": "number",
"format": "float",
"example": 1182.19,
"nullable": true,
"description": "The mean incoming value of all transactions in the last week.\n"
},
"mean_incoming_amount_3d": {
"type": "number",
"format": "float",
"example": 1428.51,
"nullable": true,
"description": "The mean incoming value of all transactions in the last three days.\n"
},
"mean_incoming_amount_3m": {
"type": "number",
"format": "float",
"example": 865.49,
"nullable": true,
"description": "The mean incoming value of all transactions in the last three months.\n"
},
"mean_incoming_amount_6m": {
"type": "number",
"format": "float",
"example": 939.9,
"nullable": true,
"description": "The mean incoming value of all transactions in the last six months.\n"
},
"mean_outgoing_amount_1m": {
"type": "number",
"format": "float",
"example": 889.13,
"nullable": true,
"description": "The mean outgoing value of all transaction in the last month.\n"
},
"mean_outgoing_amount_1w": {
"type": "number",
"format": "float",
"example": 1054.49,
"nullable": true,
"description": "The mean outgoing value of all transaction in the last week.\n"
},
"mean_outgoing_amount_3d": {
"type": "number",
"format": "float",
"example": 1303.35,
"nullable": true,
"description": "The mean outgoing value of all transaction in the last three days.\n"
},
"mean_outgoing_amount_3m": {
"type": "number",
"format": "float",
"example": 833.8,
"nullable": true,
"description": "The mean outgoing value of all transaction in the last three months.\n"
},
"mean_outgoing_amount_6m": {
"type": "number",
"format": "float",
"example": 861.58,
"nullable": true,
"description": "The mean outgoing value of all transaction in the last six months.\n"
},
"sum_incoming_amount_12m": {
"type": "number",
"format": "float",
"example": 274697.28,
"nullable": true,
"description": "The total sum of all inflow transactions for the last twelve months.\n"
},
"sum_outgoing_amount_12m": {
"type": "number",
"format": "float",
"example": 219608.77,
"nullable": true,
"description": "The total sum of all outflow transactions for the last twelve months.\n"
},
"max_num_transactions_12m": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 18,
"description": "The maximum number of transactions for the last twelve months.\n"
},
"mean_incoming_amount_12m": {
"type": "number",
"format": "float",
"example": 1073.04,
"nullable": true,
"description": "The mean incoming value of all transactions in the last twelve months.\n"
},
"mean_num_transactions_1m": {
"type": "number",
"format": "float",
"default": 0,
"example": 5.42,
"description": "The mean number of transactions for the last month.\n"
},
"mean_num_transactions_1w": {
"type": "number",
"format": "float",
"default": 0,
"example": 5.75,
"description": "The mean number of transactions for the last week.\n"
},
"mean_num_transactions_3d": {
"type": "number",
"format": "float",
"default": 0,
"example": 6.5,
"description": "The mean number of transactions for the last three days.\n"
},
"mean_num_transactions_3m": {
"type": "number",
"format": "float",
"default": 0,
"example": 5.05,
"description": "The mean number of transactions for the last three months.\n"
},
"mean_num_transactions_6m": {
"type": "number",
"format": "float",
"default": 0,
"example": 2.61,
"description": "The mean number of transactions for the last six months.\n"
},
"mean_outgoing_amount_12m": {
"type": "number",
"format": "float",
"example": 915.04,
"nullable": true,
"description": "The mean outgoing value of all transaction in the last twelve months.\n"
},
"mean_num_transactions_12m": {
"type": "number",
"format": "float",
"default": 0,
"example": 1.37,
"description": "The mean number of transactions for the last twelve months.\n"
},
"days_since_last_transaction": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"description": "The number of days since the last transaction occurred.\n"
},
"days_without_transactions_1m": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"description": "The number of days that no transactions occurred within the last month.\n"
},
"days_without_transactions_1w": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"description": "The number of days that no transactions occurred within the last week.\n"
},
"days_without_transactions_3d": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"description": "The number of days that no transactions occurred within the last three days.\n"
},
"days_without_transactions_3m": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"description": "The number of days that no transactions occurred within the last three months.\n"
},
"days_without_transactions_6m": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 87,
"description": "The number of days that no transactions occurred within the last six months.\n"
},
"num_incoming_transactions_1m": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 80,
"description": "The total number of inflow transactions for the last month.\n"
},
"num_incoming_transactions_1w": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 21,
"description": "The total number of inflow transactions for the last week.\n"
},
"num_incoming_transactions_3d": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 12,
"description": "The total number of inflow transactions for the last three days.\n"
},
"num_incoming_transactions_3m": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 229,
"description": "The total number of inflow transactions for the last three months.\n"
},
"num_incoming_transactions_6m": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 238,
"description": "The total number of inflow transactions for the last six months.\n"
},
"num_outgoing_transactions_1m": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 88,
"description": "To total number of outflow transactions in the last month.\n"
},
"num_outgoing_transactions_1w": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 25,
"description": "To total number of outflow transactions in the last week.\n"
},
"num_outgoing_transactions_3d": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 14,
"description": "To total number of outflow transactions in the last three days.\n"
},
"num_outgoing_transactions_3m": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 231,
"description": "To total number of outflow transactions in the last three months.\n"
},
"num_outgoing_transactions_6m": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 234,
"description": "To total number of outflow transactions in the last six months.\n"
},
"days_without_transactions_12m": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 261,
"description": "The number of days that no transactions occurred within the last twelve months.\n"
},
"num_incoming_transactions_12m": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 256,
"description": "The total number of inflow transactions for the last twelve months.\n"
},
"num_outgoing_transactions_12m": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 240,
"description": "To total number of outflow transactions in the last twelve months.\n"
},
"max_num_incoming_transactions_1m": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 10,
"description": "The maximum number of inflow transactions for the last month.\n"
},
"max_num_incoming_transactions_1w": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 6,
"description": "The maximum number of inflow transactions for the last week.\n"
},
"max_num_incoming_transactions_3d": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 6,
"description": "The maximum number of inflow transactions for the last three days.\n"
},
"max_num_incoming_transactions_3m": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 10,
"description": "The maximum number of inflow transactions for the last three months.\n"
},
"max_num_incoming_transactions_6m": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 10,
"description": "The maximum number of inflow transactions for the last six months.\n"
},
"max_num_outgoing_transactions_1m": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 8,
"description": "The maximum number of outflow transactions for the last month.\n"
},
"max_num_outgoing_transactions_1w": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 6,
"description": "The maximum number of outflow transactions for the last week.\n"
},
"max_num_outgoing_transactions_3d": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 6,
"description": "The maximum number of outflow transactions for the last three days.\n"
},
"max_num_outgoing_transactions_3m": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 9,
"description": "The maximum number of outflow transactions for the last three months.\n"
},
"max_num_outgoing_transactions_6m": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 9,
"description": "The maximum number of outflow transactions for the last six months.\n"
},
"max_num_incoming_transactions_12m": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 10,
"description": "The maximum number of inflow transactions for the last twelve months.\n"
},
"max_num_outgoing_transactions_12m": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 9,
"description": "The maximum number of outflow transactions for the last twelve months.\n"
},
"mean_num_incoming_transactions_1m": {
"type": "number",
"format": "float",
"default": 0,
"example": 2.58,
"description": "The mean number of inflow transactions for the last month.\n"
},
"mean_num_incoming_transactions_1w": {
"type": "number",
"format": "float",
"default": 0,
"example": 2.62,
"description": "The mean number of inflow transactions for the last week.\n"
},
"mean_num_incoming_transactions_3d": {
"type": "number",
"format": "float",
"default": 0,
"example": 3,
"description": "The mean number of inflow transactions for the last three days.\n"
},
"mean_num_incoming_transactions_3m": {
"type": "number",
"format": "float",
"default": 0,
"example": 2.52,
"description": "The mean number of inflow transactions for the last three months.\n"
},
"mean_num_incoming_transactions_6m": {
"type": "number",
"format": "float",
"default": 0,
"example": 1.31,
"description": "The mean number of inflow transactions for the last six months.\n"
},
"mean_num_outgoing_transactions_1m": {
"type": "number",
"format": "float",
"default": 0,
"example": 2.84,
"description": "The mean number of outflow transactions for the last month.\n"
},
"mean_num_outgoing_transactions_1w": {
"type": "number",
"format": "float",
"default": 0,
"example": 3.12,
"description": "The mean number of outflow transactions for the last week.\n"
},
"mean_num_outgoing_transactions_3d": {
"type": "number",
"format": "float",
"default": 0,
"example": 3.5,
"description": "The mean number of outflow transactions for the last three days.\n"
},
"mean_num_outgoing_transactions_3m": {
"type": "number",
"format": "float",
"default": 0,
"example": 2.54,
"description": "The mean number of outflow transactions for the last three months.\n"
},
"mean_num_outgoing_transactions_6m": {
"type": "number",
"format": "float",
"default": 0,
"example": 1.29,
"description": "The mean number of outflow transactions for the last six months.\n"
},
"mean_num_incoming_transactions_12m": {
"type": "number",
"format": "float",
"default": 0,
"example": 0.71,
"description": "The mean number of inflow transactions for the last twelve months.\n"
},
"mean_num_outgoing_transactions_12m": {
"type": "number",
"format": "float",
"default": 0,
"example": 0.66,
"description": "The mean number of outflow transactions for the last twelve months.\n"
},
"days_since_last_incoming_transaction": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"description": "The number of days since the last inflow transaction occurred.\n"
},
"days_since_last_outgoing_transaction": {
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"description": "The number of days since the last outflow transaction occurred.\n"
}
},
"description": "Aggregated metrics calculated based on the user's transactions from checking, savings, credit card, and loan accounts.\n\n\n> ℹ️ **Note**\n>\n> 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:\n> \n> - `mean_num_transactions_3m` will return `null` as there is no data for months two and three (calculated field).\n> - `num_transactions_3m` will return `0` as there is no data for months two and three ('count-based' field)\n"
}
SessionExpiredError
{
"type": "object",
"title": "Session Expired",
"properties": {
"code": {
"type": "string",
"example": "session_expired",
"description": "A unique error code (`session_expired`) that allows you to classify and handle the error programmatically.\n\n\nℹ️ Check our DevPortal for more information on how to handle <a href=\"https://developers.belvo.com/docs/belvo-api-errors#400-session_expired\" target=\"_blank\">400 session_expired errors</a>.\n"
},
"message": {
"type": "string",
"example": "The session you are trying to resume has expired, please start again from register/retrieve endpoint",
"description": "A short description of the error. \n\n\nFor `session_expired` errors, the description is:\n \n - `The session you are trying to resume has expired, please start again from register/retrieve endpoint`.\n"
},
"request_id": {
"type": "string",
"example": "9e7b283c6efa449c9c028a16b5c249fb",
"pattern": "[a-f0-9]{32}",
"description": "A 32-character unique ID of the request (matching a regex pattern of: `[a-f0-9]{32}`). Provide this ID when contacting the Belvo\nsupport team to accelerate investigations.\n"
}
},
"description": "This error occurs when you try to resume a request session that has already expired. This is usually because the user took too long to provide their authentication token.\n"
}
StandardRequest
{
"type": "object",
"required": [
"link"
],
"properties": {
"link": {
"type": "string",
"format": "uuid",
"example": "2ccd5e15-194a-4a19-a45a-e7223c7e6717",
"description": "The `link.id` that you want to get information for."
},
"token": {
"type": "string",
"example": "1234ab",
"description": "The OTP token generated by the bank."
},
"save_data": {
"type": "boolean",
"default": true,
"description": "Indicates whether or not to persist the data in Belvo. By default, this is set to `true` and we return a 201 Created response.\n\nWhen set to `false`, the data won't be persisted and we return a 200 OK response.\n"
}
}
}
TaxAssessmentBusiness
{
"type": "object",
"required": [
"net_income_taxable",
"fortuitous_profit_tax",
"total_tax_on_taxable_net_income",
"net_income_tax",
"total_tax_due",
"total_withholdings_for_the_taxable_year_to_be_declared",
"total_withheld_tax",
"total_balance_payable",
"total_balance_in_favor",
"total_payment"
],
"properties": {
"total_payment": {
"type": "number",
"format": "float",
"example": 0,
"description": "The total the tax payer is required to pay, taking into account deductions and fiscal credits."
},
"total_tax_due": {
"type": "number",
"format": "float",
"example": 5764000,
"description": "After further deductions, this is the final calculated tax that the taxpayer is required to pay."
},
"net_income_tax": {
"type": "number",
"format": "float",
"example": 5764000,
"description": "After additional deductions that you can apply, this will be the net income tax. If no further deduction are identified, this value will be the same as `total_tax_on_taxable_net_income`."
},
"net_income_taxable": {
"type": "number",
"format": "float",
"example": 18594000,
"description": "The net income on which tax can be applied."
},
"fortuitous_profit_tax": {
"type": "number",
"format": "float",
"example": 0,
"description": "The tax applied on your unexpected income (such as lottery wins or house sales)."
},
"total_balance_payable": {
"type": "number",
"format": "float",
"example": 0,
"description": "How much the tax payer is required to pay."
},
"total_balance_in_favor": {
"type": "number",
"format": "float",
"example": 1889000,
"description": "How much the tax payer is expected to receive."
},
"total_tax_on_taxable_net_income": {
"type": "number",
"format": "float",
"example": 5764000,
"description": "The calculated total tax that can be applied on the tax payer's taxable income (total income - exemptions - deductions)."
},
"total_withholdings_for_the_taxable_year_to_be_declared": {
"type": "number",
"format": "float",
"example": 7361000,
"description": "How much the tax payer has already paid througout the fiscal year."
}
},
"description": "Object containing the calculated tax assessment of the tax payer. This includes the total taxable income, the income tax applied, and taxes already withheld."
}
TaxAssessmentIndividual
{
"type": "object",
"required": [
"fortuitous_profit_tax",
"total_tax_on_taxable_net_income",
"net_income_tax",
"total_tax_due",
"previous_year_balance",
"total_withheld_tax",
"balance_payable",
"balance_refundable",
"total_payment"
],
"properties": {
"total_payment": {
"type": "number",
"format": "float",
"example": 0,
"description": "The total the tax payer is required to pay, taking into account deductions and fiscal credits."
},
"total_tax_due": {
"type": "number",
"format": "float",
"example": 9144000,
"description": "After further deductions, this is the final calculated tax that the taxpayer is required to pay."
},
"net_income_tax": {
"type": "number",
"format": "float",
"example": 9144000,
"description": "After additional deductions that you can apply, this will be the net income tax. If not further deduction are identified, this value will be the same as `total_tax_on_taxable_net_income`."
},
"balance_payable": {
"type": "number",
"format": "float",
"example": 0,
"description": "How much the tax payer is required to pay."
},
"balance_refundable": {
"type": "number",
"format": "float",
"example": 84000,
"description": "How much the tax payer is expected to receive. For DIAN, this will count as credit for the next fiscal year (see `previous_year_balance`)."
},
"total_withheld_tax": {
"type": "number",
"format": "float",
"example": 7714000,
"description": "The total tax already withheld in the current fiscal year."
},
"fortuitous_profit_tax": {
"type": "number",
"format": "float",
"example": 0,
"description": "The tax applied on your unexpected income (such as lottery wins or house sales)."
},
"previous_year_balance": {
"type": "number",
"format": "float",
"example": 1514000,
"description": "Only applicable for DIAN.\n\n\nThe amount the tax payer has as a \"credit\" fromt he previous year (this is equal to the `balance_refundable`) of the previous year.\n"
},
"total_tax_on_taxable_net_income": {
"type": "number",
"format": "float",
"example": 9144000,
"description": "The calculated total tax that can be applied on the tax payer's taxable income (total income - exemptions - deductions)."
}
},
"description": "Object containing the calculated tax assessment of the tax payer. This includes the total taxable income, the income tax applied, and taxes already withheld."
}
TaxComplianceStatus
{
"type": "object",
"required": [
"pdf",
"collected_at"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "91106968-1abd-4d64-85c1-4e73d96fb997",
"description": "Unique identifier created by Belvo used to reference the current Tax\nCompliance Status.\n"
},
"pdf": {
"type": "string",
"format": "binary",
"example": "=PDF-STRING=",
"nullable": true,
"description": "Tax compliance status PDF as a binary."
},
"rfc": {
"type": "string",
"example": "KDFC211118IS0",
"nullable": true,
"description": "The account holder's RFC (Registro Federal de Contribuyentes) number."
},
"outcome": {
"$ref": "#/components/schemas/EnumTaxComplianceStatusOutcome"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2022-02-09T08:45:50.406032Z",
"description": "The ISO-8601 timestamp of when the data point was last updated in Belvo's database.\n"
},
"collected_at": {
"type": "string",
"format": "date-time",
"example": "2022-02-09T08:45:50.406032Z",
"nullable": true,
"description": "The ISO-8601 timestamp when the data point was collected.\n"
},
"internal_identification": {
"type": "string",
"example": "20NE1234567",
"nullable": true,
"description": "The institution’s internal identification number for the document."
}
}
}
TaxComplianceStatusDeleteSpecificTaxComplianceStatus404Response
{
"type": "array",
"items": {
"$ref": "#/components/schemas/NotFoundError"
},
"description": "You made a request where you:\n\n - provided the wrong URL.\n - used an ID (for a link, account, transaction, and so on) that is not associated with your Belvo account.\n \n"
}
TaxComplianceStatusDeleteSpecificTaxComplianceStatusResponse
{
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/UnauthorizedError"
},
{
"$ref": "#/components/schemas/401_consent_without_accounts_error"
}
]
}
}
TaxComplianceStatusGetDetails404Response
{
"type": "array",
"items": {
"$ref": "#/components/schemas/NotFoundError"
},
"description": "You made a request where you:\n\n - provided the wrong URL.\n - used an ID (for a link, account, transaction, and so on) that is not associated with your Belvo account.\n \n"
}
TaxComplianceStatusGetDetailsResponse
{
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/UnauthorizedError"
},
{
"$ref": "#/components/schemas/401_consent_without_accounts_error"
}
]
}
}
TaxComplianceStatusGetFiscalLinkInfo401Response
{
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/UnauthorizedError"
},
{
"$ref": "#/components/schemas/401_consent_without_accounts_error"
}
]
}
}
TaxComplianceStatusGetFiscalLinkInfo408Response
{
"type": "array",
"items": {
"$ref": "#/components/schemas/RequestTimeoutError"
},
"title": "Request Timeout",
"description": "Belvo has a limit regarding the time it takes to log in, retrieve account data, and log out. A timeout occurs when there is a very high amount of data and everything could not be obtained within the allotted time.\n \n"
}
TaxComplianceStatusGetFiscalLinkInfo500Response
{
"type": "array",
"items": {
"$ref": "#/components/schemas/UnexpectedError"
},
"title": "Unexpected Error",
"description": "This error occurs when we (Belvo) have encountered an internal system error (sorry about that) or due to an unsupported response from the institution.\n \n"
}
TaxComplianceStatusGetFiscalLinkInfoResponse
{
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/TooManySessionsError"
},
{
"$ref": "#/components/schemas/LoginError"
},
{
"$ref": "#/components/schemas/SessionExpiredError"
},
{
"$ref": "#/components/schemas/ValidationError"
},
{
"$ref": "#/components/schemas/InstitutionDownError"
},
{
"$ref": "#/components/schemas/InstitutionUnavailableError"
},
{
"$ref": "#/components/schemas/InstitutionInactiveError"
},
{
"$ref": "#/components/schemas/UnsupportedOperationError"
},
{
"$ref": "#/components/schemas/InvalidLinkError"
},
{
"$ref": "#/components/schemas/UnconfirmedLinkError"
}
]
}
}
TaxComplianceStatusListAllResponse
{
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/UnauthorizedError"
},
{
"$ref": "#/components/schemas/401_consent_without_accounts_error"
}
]
}
}
TaxComplianceStatusPaginatedResponse
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/common_pagination_properties"
},
{
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxComplianceStatus"
},
"description": "Array of tax compliance status objects."
}
}
}
]
}
TaxComplianceStatusRequest
{
"type": "object",
"required": [
"link"
],
"properties": {
"link": {
"type": "string",
"format": "uuid",
"example": "d4617561-1c01-4b2f-83b6-a594f7b3bc57",
"description": "The fiscal `link.id` to use."
},
"save_data": {
"type": "boolean",
"default": true,
"example": true,
"description": "Indicates whether or not to persist the data in Belvo. By default, this is set to `true` and we return a 201 Created response.\n\nWhen set to `false`, the data won't be persisted and we return a 200 OK response.\n"
},
"attach_pdf": {
"type": "boolean",
"default": false,
"description": "When set to `true`, you will receive the PDF in binary format in\nthe response.\n"
}
}
}
TaxDeclarationBusiness
{
"type": "object",
"title": "Business Tax Declaration",
"required": [
"id",
"link",
"collected_at",
"created_at",
"document_information",
"tax_payer_information",
"equity_statement",
"annual_income_statement",
"annual_costs_and_deductions_statement",
"tax_assessment",
"date_issued",
"pdf"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "1c83ead8-6665-429c-a17a-ddc76cb3a95e",
"description": "Belvo's unique ID for the current tax declaration."
},
"pdf": {
"type": "string",
"example": "==BINARY-STRING==",
"nullable": true,
"description": "The PDF of the tax declaration, as a binary string."
},
"link": {
"type": "string",
"format": "uuid",
"example": "8a95ca1a-1a7a-4ce0-8599-f8ff1dc792ac",
"description": "Belvo's unique ID of the user that this tax declaration is associated with."
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2020-04-23T21:30:20.336854+00:00",
"description": "The ISO-8601 timestamp of when the data point was last updated in Belvo's database."
},
"date_issued": {
"type": "string",
"format": "date",
"example": "2022-09-02",
"description": "The date the tax declaration was issued by the fiscal institution."
},
"collected_at": {
"type": "string",
"format": "date-time",
"example": "2020-04-23T21:32:55.336854+00:00",
"description": "The ISO-8601 timestamp when the data point was collected."
},
"tax_assessment": {
"$ref": "#/components/schemas/TaxAssessmentBusiness"
},
"equity_statement": {
"$ref": "#/components/schemas/EquityStatementBusiness"
},
"document_information": {
"$ref": "#/components/schemas/DocumentInformationBusiness"
},
"tax_payer_information": {
"$ref": "#/components/schemas/TaxPayerInformationBusiness"
},
"annual_income_statement": {
"$ref": "#/components/schemas/AnnualIncomeStatementBusiness"
},
"annual_costs_and_deductions_statement": {
"$ref": "#/components/schemas/AnnualCostsAndDeductionsStatementBusiness"
}
}
}
TaxDeclarationBusinessPaginated
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/common_pagination_properties"
},
{
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxDeclarationBusiness"
},
"description": "Array of Business Tax Declaration objects."
}
}
}
],
"title": "Tax Declaration Business"
}