{
  "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
  ],
  "type": "string",
  "example": "Income & Payments",
  "nullable": true,
  "description": "The name of the transaction category.\n\n> **Get transaction categorization**\nWith [Transaction categorization](https://developers.belvo.com/docs/banking#categorizing-transactions), we clean and categorize transactions for you, turning raw data into actionable insights. To enable this feature, just [reach out](https://belvo.com/contact/?utm_source=documentation) to us, and we'll get right to it.\n\nWe return one of the following enum values:\n\n  - `Bills & Utilities`\n  - `Credits & Loans`\n  - `Deposits`\n  - `Fees & Charges`\n  - `Food & Groceries`\n  - `Home & Life`\n  - `Income & Payments`\n  - `Insurance`\n  - `Investments & Savings`\n  - `Online Platforms & Leisure`\n  - `Personal Shopping`\n  - `Taxes`\n  - `Transfers`\n  - `Transport & Travel`\n  - `Unknown`*\n  - `Withdrawal & ATM`\n  - `null`\n\n\n  \\* For clients not using our Transaction Categorization product, we return `null` instead.\n"
}

{
  "enum": [
    "INDIVIDUAL",
    "COMPANY",
    null
  ],
  "type": "string",
  "example": "INDIVIDUAL",
  "nullable": true,
  "description": "The transaction counterparty type. We return one of the following values:\n\n  - `INDIVIDUAL`\n  - `COMPANY`\n  - `null`\n"
}

{
  "enum": [
    "REVOLVING_CREDIT",
    "BILL_INSTALLMENT_PAYMENT",
    "LOAN",
    "OTHERS",
    null
  ],
  "type": "string",
  "example": "BILL_INSTALLMENT_PAYMENT",
  "nullable": true,
  "description": "Other types of credit that have been contracted on the card. We return one of the following values:\n\n  - `REVOLVING_CREDIT`\n  - `BILL_INSTALLMENT_PAYMENT`\n  - `LOAN`\n  - `OTHERS`\n  - `null`\n"
}

{
  "enum": [
    "ANNUAL_FEE",
    "NATIONAL_WITHDRAWAL",
    "INTERNATIONAL_WITHDRAWAL",
    "EMERGENCY_CREDIT_EVALUATION_FEE",
    "DUPLICATE_ISSUANCE_FEE",
    "PAYMENT_FEE",
    "SMS_FEE",
    "OTHERS",
    null
  ],
  "type": "string",
  "example": "NATIONAL_WITHDRAWAL",
  "nullable": true,
  "description": "The fee that can be charged for a card transaction. We return one of the following values:\n\n  - `ANNUAL_FEE`\n  - `NATIONAL_WITHDRAWAL`\n  - `INTERNATIONAL_WITHDRAWAL`\n  - `EMERGENCY_CREDIT_EVALUATION_FEE`\n  - `DUPLICATE_ISSUANCE_FEE`\n  - `PAYMENT_FEE`\n  - `SMS_FEE`\n  - `OTHERS`\n  - `null`\n"
}

{
  "enum": [
    "FULL",
    "INSTALLMENT",
    null
  ],
  "type": "string",
  "example": "FULL",
  "nullable": true,
  "description": "The transaction payment type. We return one of the following values:\n\n  - `FULL`\n  - `INSTALLMENT`\n  - `null`\n"
}

{
  "enum": [
    "PENDING",
    "PROCESSED",
    "UNCATEGORIZED",
    null
  ],
  "type": "string",
  "example": "PROCESSED",
  "nullable": true,
  "description": "The status of the transaction. We return one of the following values:\n\n  - `PROCESSED` (The transaction has been processed by the institution.)\n  - `PENDING` (The institution clearly states that the transaction has not yet been processed.)\n  - `UNCATEGORIZED` (deprecated)\n  - `null` (deprecated)\n  \n"
}

{
  "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
  ],
  "type": "string",
  "example": "Freelance",
  "nullable": true,
  "description": "The transaction subcategory.\n\n  > **Get transaction categorization**\n  For clients not using our [Transaction categorization](https://developers.belvo.com/docs/banking#categorizing-transactions), we return `null` instead. To enable this feature, just [reach out](https://belvo.com/contact/?utm_source=documentation) to us, and we'll get right to it.\n\n\nWe return one of the following enum values:\n\n  - `Electricity & Energy`\n  - `Rent`\n  - `Telecommunications`\n  - `Water`\n  - `Auto`\n  - `Credit Card`\n  - `Instalment`\n  - `Interest & Charges`\n  - `Mortgage`\n  - `Pay Advance`\n  - `Personal`\n  - `Adjustments`\n  - `Bank Fees`\n  - `Chargeback`\n  - `Refund`\n  - `Blocked Balances`\n  - `Alimony`\n  - `Alcohol & Tobacco`\n  - `Bakery & Coffee`\n  - `Bars & Nightclubs`\n  - `Convenience Store`\n  - `Delivery`\n  - `Groceries`\n  - `Restaurants`\n  - `Education`\n  - `Gyms & Fitness`\n  - `Hair & Beauty`\n  - `Health`\n  - `Home Decor & Appliances`\n  - `Laundry & Dry Cleaning`\n  - `Pharmacies`\n  - `Professional Services`\n  - `Veterinary Services`\n  - `Freelance`\n  - `Interest`\n  - `Retirement`\n  - `Salary`\n  - `Government`\n  - `Home Insurance`\n  - `Auto Insurance`\n  - `Health & Life Insurance`\n  - `Savings`\n  - `Fixed income`\n  - `Equity`\n  - `Investment Funds`\n  - `Derivatives`\n  - `Cryptocurrencies`\n  - `Apps, Software and Cloud Services`\n  - `Events, Parks and Museums`\n  - `Gambling`\n  - `Gaming`\n  - `Lottery`\n  - `Movie & Audio`\n  - `Books & News`\n  - `Clothing & Accessories`\n  - `Department Store`\n  - `Electronics`\n  - `E-commerce`\n  - `Gifts`\n  - `Office Supplies`\n  - `Pet Supplies`\n  - `Auto Tax & Fees`\n  - `Donation`\n  - `Government Fees`\n  - `Income Tax`\n  - `Real Estate Tax & Fees`\n  - `Tax Return`\n  - `Accommodation`\n  - `Auto Expenses`\n  - `Auto Rental`\n  - `Flights`\n  - `Gas`\n  - `Mileage Programs`\n  - `Parking & Tolls`\n  - `Public Transit`\n  - `Taxis & Rideshares`\n  - `Other`\n  - `null`\n"
}

{
  "enum": [
    "OUTFLOW",
    "INFLOW",
    null
  ],
  "type": "string",
  "example": "INFLOW",
  "nullable": true,
  "description": "The direction of the transaction:\n- `INFLOW` indicates money coming into the account.\n- `OUTFLOW` indicates money going out of the account.\n- `null` when no information was present regarding the direction of the transaction.\n"
}

{
  "type": "object",
  "required": [
    "cash_and_cash_equivalents",
    "investments_and_derivative_financial_instruments",
    "accounts_documents_and_finance_leases_receivable",
    "inventory",
    "property_plant_and_equipment_investment_properties",
    "total_gross_equity",
    "debts",
    "total_net_equity"
  ],
  "properties": {
    "debts": {
      "type": "number",
      "format": "float",
      "example": 207030000,
      "description": "Total debts that the company currently has."
    },
    "inventory": {
      "type": "number",
      "format": "float",
      "example": 0,
      "description": "Total financial value of the company's sellable inventory."
    },
    "total_net_equity": {
      "type": "number",
      "format": "float",
      "example": 13830000,
      "description": "The total net equity of the company (`total_gross_equity` - `debts`)."
    },
    "total_gross_equity": {
      "type": "number",
      "format": "float",
      "example": 220860000,
      "description": "Total gross equity."
    },
    "cash_and_cash_equivalents": {
      "type": "number",
      "format": "float",
      "example": 4648000,
      "description": "Total cash (or cash equivalents) that the business currently holds at the end of the fiscal year."
    },
    "accounts_documents_and_finance_leases_receivable": {
      "type": "number",
      "format": "float",
      "example": 0,
      "description": "Total of all payments the company expects to receive (for example, from partial invoices that have not been paid yet)."
    },
    "investments_and_derivative_financial_instruments": {
      "type": "number",
      "format": "float",
      "example": 77626000,
      "description": "Total value of all investments, stocks, or similar, that the company has."
    },
    "property_plant_and_equipment_investment_properties": {
      "type": "number",
      "format": "float",
      "example": 0,
      "description": "Total value of real estate, plant infrastructure, or equipment that has been purchased."
    }
  },
  "description": "Object containing the general fiscal situation of the taxpayer."
}

{
  "type": "object",
  "required": [
    "total_gross_equity",
    "total_debts",
    "total_net_equity"
  ],
  "properties": {
    "total_debts": {
      "type": "number",
      "format": "float",
      "example": 77626000,
      "description": "The total debts of the tax_payer"
    },
    "total_net_equity": {
      "type": "number",
      "format": "float",
      "example": 0,
      "description": "The total net equity value of the taxpayer."
    },
    "total_gross_equity": {
      "type": "number",
      "format": "float",
      "example": 4648000,
      "description": "The total gross equity of the tax payer."
    }
  },
  "description": "Object containing the general fiscal situation of the taxpayer."
}

{
  "type": "object",
  "required": [
    "id",
    "category",
    "balance",
    "balance_date",
    "currency"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "AGH7890098789087-Checking-Erebor",
      "description": "Your unique ID for the user's account.\n"
    },
    "balance": {
      "type": "number",
      "format": "float",
      "example": 12540.67,
      "description": "The balance of the account."
    },
    "category": {
      "enum": [
        "CHECKING_ACCOUNT",
        "CREDIT_CARD",
        "LOAN_ACCOUNT",
        "SAVINGS_ACCOUNT"
      ],
      "type": "string",
      "example": "CHECKING_ACCOUNT",
      "description": "The category of the bank account. Can be either:\n\n  - `CHECKING_ACCOUNT`\n  - `CREDIT_CARD`\n  - `LOAN_ACCOUNT`\n  - `SAVINGS_ACCOUNT`\n"
    },
    "currency": {
      "type": "string",
      "example": "BRL",
      "description": "The three-letter currency code of the `balance`. For example:\n\n  • 🇧🇷 BRL (Brazilian Real)\n  • 🇨🇴 COP (Colombian Peso)\n  • 🇲🇽 MXN (Mexican Peso)\n\n**Note:** Ensure that the currency of the account and the transactions associated with it are the same. For example, if the currency of the account is `MXN`, then all the transactions associated with that account should also be in `MXN`.\n  \n"
    },
    "balance_date": {
      "type": "string",
      "format": "date",
      "example": "2023-06-01",
      "description": "The date that the `balance` amount was retrieved, in `YYYY-MM-DD` format.\n\n**Note:** For each account you wish to have analyzed, try to provide the same date when the balance was available. \n"
    }
  },
  "description": "EYOD Risk Insight account object.\n"
}

{
  "type": "object",
  "required": [
    "user_id",
    "date_to",
    "language",
    "transactions",
    "accounts"
  ],
  "properties": {
    "date_to": {
      "type": "string",
      "format": "date",
      "example": "2023-06-01",
      "description": "The date from which you want Belvo to start performing the credit score analysis, in `YYYY-MM-DD` format. If you do not specify a `date_to`, we use the current date at the time of your request.\n\n> **Note:**\n>\n> We recommend you use `date_to` if you do not have an account balance for the past few days.\n>\n> For example, if the last account balance date that you have a value for was last week, set the `date_to` parameter to that date. The credit score that you receive will be **relative** to the `date_to` parameter.\n"
    },
    "user_id": {
      "type": "string",
      "example": "AGH7890098789087",
      "description": "Your unique ID for the user.\n"
    },
    "accounts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EyodCreditScoreAccountBody"
      },
      "description": "An array of account objects that the transactions are associated with.\n\n\nEach transaction you provide in the `transactions` array must have an associated account. If you provide transactions without an associated account, we return an error.\n\n**Note:** Each object corresponds to one unique account.\n"
    },
    "language": {
      "type": "string",
      "example": "pt",
      "description": "The two-letter ISO 639-1 code for the language of the transaction. For example:\n  \n  - `pt` for Portugese\n\n  > **Note**: At present, we only support `pt` for Portuguese.\n"
    },
    "transactions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EyodCreditScoreTransactionBody"
      },
      "maxItems": 10000,
      "description": "An array of transaction objects that you want analyzed for the credit score analysis.\n\n\n**Note:** Each object corresponds to one unique transaction and you can send through up to 10,000 transactions per request.\n"
    }
  },
  "description": "EYOD Credit Score request object.\n\n**Note:** You can only send through information for **one** user at a time.\n"
}

{
  "type": "object",
  "required": [
    "transaction_id",
    "account_id",
    "value_date",
    "type",
    "amount",
    "currency",
    "description"
  ],
  "properties": {
    "type": {
      "$ref": "#/components/schemas/EnumRiskInsightTransactionType"
    },
    "amount": {
      "type": "number",
      "format": "float",
      "example": 650.89,
      "maximum": 9999999999.99,
      "minimum": 0,
      "description": "The transaction amount.\n"
    },
    "currency": {
      "type": "string",
      "example": "BRL",
      "description": "The three-letter currency code of the transaction. For example:\n\n  • 🇧🇷 BRL (Brazilian Real)\n  • 🇨🇴 COP (Colombian Peso)\n  • 🇲🇽 MXN (Mexican Peso)\n\n**Note:** Ensure that the currency of the transaction and the account associated with it are the same. For example, if the currency of the account is `MXN`, then all the transactions associated with that account should also be in `MXN`.\n  \n"
    },
    "account_id": {
      "type": "string",
      "example": "AGH7890098789087-Checking-Erebor",
      "description": "Your unique ID for the account where the transaction occurred.\n\n**Note:** You must provide the details of this account in the `accounts` array of the Risk Insights request. Otherwise, we return an error.\n"
    },
    "value_date": {
      "type": "string",
      "format": "date",
      "example": "2023-05-18",
      "description": "The date when the transaction occurred, in `YYYY-MM-DD` format.\n\n**Note:** Transactions that occur after the `reference_date` are not considered in the risk insight analysis.\n"
    },
    "description": {
      "type": "string",
      "example": "Pagamento Netflix Maio 2023",
      "maxLength": 500,
      "description": "The description of the transaction.\n"
    },
    "transaction_id": {
      "type": "string",
      "example": "3CWE4927CF15355",
      "description": "Your unique ID for the transaction."
    }
  },
  "description": "The EYOD Risk Insight transaction object\n"
}

{
  "type": "object",
  "required": [
    "transaction_id",
    "account_holder_type",
    "account_holder_id",
    "account_id",
    "account_category",
    "value_date",
    "description",
    "type",
    "amount",
    "currency",
    "institution"
  ],
  "properties": {
    "type": {
      "$ref": "#/components/schemas/EnumIncomeVerificationType"
    },
    "amount": {
      "type": "number",
      "format": "float",
      "example": 650.89,
      "maximum": 9999999999.99,
      "minimum": 0,
      "description": "The income amount.\n"
    },
    "currency": {
      "type": "string",
      "example": "BRL",
      "description": "The three-letter currency code of the income. For example:\n\n  • 🇧🇷 BRL (Brazilian Real)\n  • 🇨🇴 COP (Colombian Peso)\n  • 🇲🇽 MXN (Mexican Peso)\n  \n"
    },
    "account_id": {
      "type": "string",
      "example": "EBACA-89077589",
      "description": "Your unique ID for the account where the transaction occurred.\n"
    },
    "value_date": {
      "type": "string",
      "format": "date",
      "example": "2022-11-18",
      "description": "The date when the income transaction occurred, in `YYYY-MM-DD` format.\n"
    },
    "description": {
      "type": "string",
      "example": "SALÁRIO MENSAL",
      "description": "The description of the income.\n"
    },
    "institution": {
      "type": "string",
      "example": "Erebor Retail Brasil",
      "description": "The institution where the account is registered.\n\n\n**Note:** This is the name that you use in your system to identify the institution. For example Erebor Retail Brasil Retail.\n"
    },
    "transaction_id": {
      "type": "string",
      "example": "3CWE4927CF15355",
      "description": "Your unique ID for the income."
    },
    "account_category": {
      "$ref": "#/components/schemas/EnumIncomeVerificationAccountCategory"
    },
    "account_holder_id": {
      "type": "string",
      "format": "uuid",
      "example": "a61bc801-9fa5-457b-88ad-850c96eaca30",
      "description": "Your unique ID for the account holder, in UUID format.\n"
    },
    "account_holder_type": {
      "$ref": "#/components/schemas/EnumIncomeVerificationAccountHolderType"
    }
  }
}

{
  "type": "object",
  "required": [
    "language",
    "transactions"
  ],
  "properties": {
    "date_to": {
      "type": "string",
      "example": "2022-12-30",
      "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}",
      "description": "The date you want to stop getting incomes for, in `YYYY-MM-DD` format, within the last 365 days. When you use this parameter, you must also send `date_from`.\n\n\n⚠️ The value of `date_to` cannot be greater than today's date (in other words, no future dates).\n"
    },
    "language": {
      "type": "string",
      "example": "pt",
      "description": "Two-letter ISO 639-1 code for the language of the transaction.\n"
    },
    "date_from": {
      "type": "string",
      "example": "2022-08-01",
      "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}",
      "description": "The date from which you want to start getting incomes for, in `YYYY-MM-DD` format, within the last 365 days. When you use this parameter, you must also send `date_to`.\n\n\n⚠️ The value of `date_from` cannot be greater than `date_to`.\n"
    },
    "transactions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EyodIncomeVerificationBodyRequest"
      },
      "description": "An array of transaction objects that you want enriched.\n\n\n**Note:** Each object corresponds to one, unique transaction and you can send through up to 10,000 transactions per request.\n"
    },
    "allowed_income_types": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EnumInvoiceAllowedIncomeTypesRequest"
      },
      "description": "The categories of the incomes you want to get information for."
    },
    "minimum_confidence_level": {
      "$ref": "#/components/schemas/EnumIncomeMinimumConfidenceLevelRequest"
    }
  }
}

{
  "type": "object",
  "required": [
    "earned_income",
    "fee_based_income",
    "capital_income",
    "non_labor_income"
  ],
  "properties": {
    "earned_income": {
      "type": "number",
      "format": "float",
      "example": 115004000,
      "description": "Income received from employment."
    },
    "capital_income": {
      "type": "number",
      "format": "float",
      "example": 0,
      "description": "Income received from an investment (such as dividends or from renting a property)."
    },
    "fee_based_income": {
      "type": "number",
      "format": "float",
      "example": 0,
      "description": "Income received from emitted invoices (for example, income that independent contractors or freelancers receive)."
    },
    "non_labor_income": {
      "type": "number",
      "format": "float",
      "example": 0,
      "description": "Income that cannot be classified into the other three fields (such as income from cryptocurrencies or regular transfers from parents)."
    }
  },
  "description": "Object containing the declared gross income of the tax payer."
}

{
  "type": "object",
  "required": [
    "id",
    "link",
    "created_at",
    "income_streams",
    "income_source_type",
    "first_transaction_date",
    "last_transaction_date",
    "number_of_income_streams",
    "monthly_average",
    "monthly_average_regular",
    "monthly_average_irregular",
    "monthly_average_low_confidence",
    "monthly_average_medium_confidence",
    "monthly_average_high_confidence",
    "total_income_amount",
    "total_regular_income_amount",
    "total_low_confidence",
    "total_medium_confidence",
    "total_high_confidence"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "example": "076c66e5-90f5-4e01-99c7-50e32f65ae42",
      "description": "Belvo's unique identifier for the current income."
    },
    "link": {
      "type": "string",
      "format": "uuid",
      "example": "f4621548-2f9e-440e-9ebd-ae8decac8c02",
      "description": "The `link.id` the income analysis belongs to."
    },
    "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 created in Belvo's database.\n"
    },
    "income_streams": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/IncomeStreamsBody"
      },
      "description": "An array of enriched income stream objects."
    },
    "monthly_average": {
      "type": "number",
      "format": "float",
      "example": 2500,
      "description": "Average amount of income received per month across all the accounts for the specific user.\n"
    },
    "income_source_type": {
      "$ref": "#/components/schemas/EnumIncomeSourceType"
    },
    "total_income_amount": {
      "type": "number",
      "format": "float",
      "example": 22500,
      "description": "Total amount of all income received for the specific user.\n"
    },
    "total_low_confidence": {
      "type": "number",
      "format": "float",
      "example": 0,
      "description": "Total amount of income for the specific user with `LOW` confidence.\n"
    },
    "last_transaction_date": {
      "type": "string",
      "format": "date",
      "example": "2023-02-09",
      "description": "The date when when the last transaction occurred, in `YYYY-MM-DD` format.\n"
    },
    "total_high_confidence": {
      "type": "number",
      "format": "float",
      "example": 22500,
      "description": "Total amount of income for the specific user with `HIGH` confidence.\n"
    },
    "first_transaction_date": {
      "type": "string",
      "format": "date",
      "example": "2022-06-09",
      "nullable": true,
      "description": "The date when the first transaction occurred, in `YYYY-MM-DD` format.\n"
    },
    "monthly_average_regular": {
      "type": "number",
      "format": "float",
      "example": 2500,
      "description": "Average amount of regular income (with a frequency of `MONTHLY`, `FORTNIGHTLY`, or `WEEKLY`) received per month for the specific user.\n"
    },
    "total_medium_confidence": {
      "type": "number",
      "format": "float",
      "example": 0,
      "description": "Total amount of income for the specific user with `MEDIUM` confidence.\n"
    },
    "number_of_income_streams": {
      "type": "integer",
      "format": "int32",
      "example": 1,
      "description": "Number of total income streams analized.\n"
    },
    "monthly_average_irregular": {
      "type": "number",
      "format": "float",
      "example": 0,
      "description": "Average amount of irregular income (with a frequency of `SINGLE` or `IRREGULAR`) received per month for the specific user.\n"
    },
    "total_regular_income_amount": {
      "type": "number",
      "format": "float",
      "example": 22500,
      "description": "Total amount of regular income (with a frequency of `MONTHLY`, `FORTNIGHTLY`, `WEEKLY`) for the specific user.\n"
    },
    "total_irregular_income_amount": {
      "type": "number",
      "format": "float",
      "example": 0,
      "description": "Total amount of irregular income (with a frequency of `SINGLE` or `IRREGULAR`) for the specific user.\n"
    },
    "monthly_average_low_confidence": {
      "type": "number",
      "format": "float",
      "example": 0,
      "description": "Average amount of income received per month for the specific user with `LOW` confidence.\n"
    },
    "monthly_average_high_confidence": {
      "type": "number",
      "format": "float",
      "example": 2500,
      "description": "Average amount of income received per month for the specific user with `HIGH` confidence.\n"
    },
    "monthly_average_medium_confidence": {
      "type": "number",
      "format": "float",
      "example": 0,
      "description": "Average amount of income received per month for the specific user with `MEDIUM` confidence.\n"
    }
  },
  "description": "Income insights"
}

{
  "type": "object",
  "required": [
    "account_holder_id",
    "income_streams",
    "income_source_type",
    "first_transaction_date",
    "last_transaction_date",
    "number_of_income_streams",
    "monthly_average",
    "monthly_average_regular",
    "monthly_average_irregular",
    "monthly_average_low_confidence",
    "monthly_average_medium_confidence",
    "monthly_average_high_confidence",
    "total_income_amount",
    "total_regular_income_amount",
    "total_low_confidence",
    "total_medium_confidence",
    "total_high_confidence"
  ],
  "properties": {
    "income_streams": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/IncomeStreamsBody"
      },
      "description": "An array of enriched income stream objects."
    },
    "monthly_average": {
      "type": "number",
      "format": "float",
      "example": 2500,
      "description": "Average amount of income received per month across all the accounts for the specific user.\n"
    },
    "account_holder_id": {
      "type": "string",
      "example": "f4621548-2f9e-440e-9ebd-ae8decac8c02",
      "description": "The unique `account_holder_id` the account belongs to, as you provided in the Income Verification request."
    },
    "income_source_type": {
      "$ref": "#/components/schemas/EnumIncomeSourceType"
    },
    "total_income_amount": {
      "type": "number",
      "format": "float",
      "example": 22500,
      "description": "Total amount of all income received for the specific user.\n"
    },
    "total_low_confidence": {
      "type": "number",
      "format": "float",
      "example": 0,
      "description": "Total amount of income for the specific user with `LOW` confidence.\n"
    },
    "last_transaction_date": {
      "type": "string",
      "format": "date",
      "example": "2023-02-09",
      "description": "The date when when the last transaction occurred, in `YYYY-MM-DD` format.\n"
    },
    "total_high_confidence": {
      "type": "number",
      "format": "float",
      "example": 22500,
      "description": "Total amount of income for the specific user with `HIGH` confidence.\n"
    },
    "first_transaction_date": {
      "type": "string",
      "format": "date",
      "example": "2022-06-09",
      "nullable": true,
      "description": "The date when the first transaction occurred, in `YYYY-MM-DD` format.\n"
    },
    "monthly_average_regular": {
      "type": "number",
      "format": "float",
      "example": 2500,
      "description": "Average amount of regular income (with a frequency of `MONTHLY`, `FORTNIGHTLY`, or `WEEKLY`) received per month for the specific user.\n"
    },
    "total_medium_confidence": {
      "type": "number",
      "format": "float",
      "example": 0,
      "description": "Total amount of income for the specific user with `MEDIUM` confidence.\n"
    },
    "number_of_income_streams": {
      "type": "integer",
      "format": "int32",
      "example": 1,
      "description": "Number of total income streams analized.\n"
    },
    "monthly_average_irregular": {
      "type": "number",
      "format": "float",
      "example": 0,
      "description": "Average amount of irregular income (with a frequency of `SINGLE` or `IRREGULAR`) received per month for the specific user.\n"
    },
    "total_regular_income_amount": {
      "type": "number",
      "format": "float",
      "example": 22500,
      "description": "Total amount of regular income (with a frequency of `MONTHLY`, `FORTNIGHTLY`, `WEEKLY`) for the specific user.\n"
    },
    "total_irregular_income_amount": {
      "type": "number",
      "format": "float",
      "example": 0,
      "description": "Total amount of irregular income (with a frequency of `SINGLE` or `IRREGULAR`) for the specific user.\n"
    },
    "monthly_average_low_confidence": {
      "type": "number",
      "format": "float",
      "example": 0,
      "description": "Average amount of income received per month for the specific user with `LOW` confidence.\n"
    },
    "monthly_average_high_confidence": {
      "type": "number",
      "format": "float",
      "example": 2500,
      "description": "Average amount of income received per month for the specific user with `HIGH` confidence.\n"
    },
    "monthly_average_medium_confidence": {
      "type": "number",
      "format": "float",
      "example": 0,
      "description": "Average amount of income received per month for the specific user with `MEDIUM` confidence.\n"
    }
  },
  "description": "Income insights"
}

{
  "type": "object",
  "required": [
    "account_id",
    "income_type",
    "frequency",
    "monthly_average",
    "average_income_amount",
    "last_income_amount",
    "currency",
    "last_income_description",
    "last_income_date",
    "stability",
    "regularity",
    "trend",
    "lookback_periods",
    "full_periods",
    "periods_with_income",
    "number_of_incomes",
    "confidence"
  ],
  "properties": {
    "trend": {
      "type": "number",
      "format": "float",
      "example": 0,
      "nullable": true,
      "description": "The income trend during a period of time calculated between last income and first income received, where:\n  - a negative float means that the income trend is decreasing during the time period.\n  - a positive float means that the income trend is increasing during the time period.\n\n**Note:** For transactions with `frequency`=`SINGLE`, this value returns `null`.\n"
    },
    "currency": {
      "type": "string",
      "example": "BRL",
      "description": "The three-letter currency code of the income. For example:\n\n  • 🇧🇷 BRL (Brazilian Real)\n  • 🇨🇴 COP (Colombian Peso)\n  • 🇲🇽 MXN (Mexican Peso)\n  \n"
    },
    "frequency": {
      "$ref": "#/components/schemas/EnumIncomeStreamFrequency"
    },
    "stability": {
      "type": "number",
      "format": "float",
      "example": 1,
      "nullable": true,
      "description": "The stability of the income based on its amount, with a range from 0 to 1, where 1 represents perfect stability.\n\n**Note:** For transactions with `frequency`=`SINGLE`, this value returns `null`.\n"
    },
    "account_id": {
      "type": "string",
      "example": "EBACA-89077589",
      "description": "Unique ID for the bank account to be verified for income streams."
    },
    "confidence": {
      "$ref": "#/components/schemas/EnumIncomeStreamConfidence"
    },
    "regularity": {
      "type": "number",
      "format": "float",
      "example": 1,
      "nullable": true,
      "description": "The regularity of the income based in its frequency, with a range from 0 to 1, where 1 represents perfect regularity.\n\n**Note:** For transactions with `frequency`=`SINGLE`, this value returns `null`.\n"
    },
    "income_type": {
      "$ref": "#/components/schemas/EnumIncomeStreamType"
    },
    "full_periods": {
      "type": "integer",
      "format": "int32",
      "example": 9,
      "description": "Number of period units (based on *rolling months*) with data to perform calculations.\n\n**Note:** A *rolling month* is a period of 30 days. For example, 2023-01-15 to 2023-02-15.\n"
    },
    "monthly_average": {
      "type": "number",
      "format": "float",
      "example": 2500,
      "description": "The average amount of income received from the source over `lookback_periods`.\n"
    },
    "last_income_date": {
      "type": "string",
      "format": "date",
      "example": "2023-02-09",
      "description": "The date when the most recent income from the stream was received, in `YYYY-MM-DD` format.\n"
    },
    "lookback_periods": {
      "type": "integer",
      "format": "int32",
      "example": 9,
      "description": "Number of period units (based on *rolling months*) used to generate insights and calculations.\n\n**Note:** A *rolling month* is a period of 30 days. For example, 2023-01-15 to 2023-02-15.\n"
    },
    "number_of_incomes": {
      "type": "integer",
      "format": "int32",
      "example": 9,
      "description": "Number of income transactions over the `lookback_periods`.\n"
    },
    "last_income_amount": {
      "type": "number",
      "format": "float",
      "example": 2500,
      "description": "The amount of the most recent income received from the source.\n"
    },
    "periods_with_income": {
      "type": "integer",
      "format": "int32",
      "example": 9,
      "description": "Number of period units (based on *rolling months*) with at least one income available.\n\n**Note:** A *rolling month* is a period of 30 days. For example, 2023-01-15 to 2023-02-15.\n"
    },
    "average_income_amount": {
      "type": "number",
      "format": "float",
      "example": 2500,
      "description": "The average income transaction amount from the source.\n"
    },
    "last_income_description": {
      "type": "string",
      "example": "Salário",
      "description": "The description of the most recent income from the stream. \n"
    }
  },
  "description": "A list of income streams for the account.\n\nFor each income stream, we provide additional insights such as:\n- Frequency, stability, and confidence level of the income transactions.\n- Key metrics about the transaction amounts.\nℹ️ If no income sources are found, we return an empty array.\n"
}

{
  "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"
      }
    ]
  }
}

{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/UnauthorizedError"
      },
      {
        "$ref": "#/components/schemas/401_consent_without_accounts_error"
      }
    ]
  }
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/AccessToResourceDenied"
  },
  "description": "This error occurs when you try to access Belvo's resource without the correct permissions.\n"
}

{
  "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"
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/IncomeEyod"
  }
}

{
  "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"
}

{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/UnauthorizedError"
      },
      {
        "$ref": "#/components/schemas/401_consent_without_accounts_error"
      }
    ]
  }
}

{
  "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"
}

{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/UnauthorizedError"
      },
      {
        "$ref": "#/components/schemas/401_consent_without_accounts_error"
      }
    ]
  }
}

{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/UnauthorizedError"
      },
      {
        "$ref": "#/components/schemas/401_consent_without_accounts_error"
      }
    ]
  }
}

{
  "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"
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/TokenRequiredResponse"
  }
}

{
  "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"
}

{
  "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"
      }
    ]
  }
}

{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/UnauthorizedError"
      },
      {
        "$ref": "#/components/schemas/401_consent_without_accounts_error"
      }
    ]
  }
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/common_pagination_properties"
    },
    {
      "properties": {
        "results": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Income"
          },
          "description": "Array of income objects."
        }
      }
    }
  ]
}

{
  "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."
    },
    "date_to": {
      "type": "string",
      "example": "2020-12-30",
      "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}",
      "description": "The date you want to stop getting incomes for, in `YYYY-MM-DD` format, within the last 365 days. When you use this parameter, you must also send `date_from`.\n\n\n⚠️ You must have at least 90 days between `date_from` and `date_to`.\n\n\n⚠️ The value of `date_to` cannot be greater than today's date (in other words, no future dates).\n"
    },
    "date_from": {
      "type": "string",
      "example": "2020-08-01",
      "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}",
      "description": "The date from which you want to start getting incomes for, in `YYYY-MM-DD` format, within the last 365 days. When you use this parameter, you must also send `date_to`.\n\n\n⚠️ You must have at least 90 days between `date_from` and `date_to`.\n\n\n⚠️ The value of `date_from` cannot be greater than `date_to`.\n"
    },
    "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"
    },
    "allowed_income_types": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EnumInvoiceAllowedIncomeTypesRequest"
      },
      "description": "The categories of the incomes you want to get information for."
    },
    "minimum_confidence_level": {
      "$ref": "#/components/schemas/EnumIncomeMinimumConfidenceLevelRequest"
    }
  }
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Income"
  }
}

{
  "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"
      }
    ]
  }
}

{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/UnauthorizedError"
      },
      {
        "$ref": "#/components/schemas/401_consent_without_accounts_error"
      }
    ]
  }
}

{
  "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"
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/TokenRequiredResponse"
  }
}

{
  "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"
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Income"
  }
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32",
      "example": 1003,
      "description": "The ID of the institution as designated by Belvo."
    },
    "logo": {
      "type": "string",
      "example": "https://belvo-api-media.s3.amazonaws.com/logos/erebor_logo.png",
      "nullable": true,
      "description": "The URL of the institution's logo."
    },
    "name": {
      "type": "string",
      "example": "erebor_mx_retail",
      "description": "The name of the institution, as designated by Belvo.\n\nPlease see our [Institutions](https://developers.belvo.com/docs/institution) DevPortal article for a detailed list of institution names.\n"
    },
    "type": {
      "$ref": "#/components/schemas/EnumInstitutionType"
    },
    "status": {
      "$ref": "#/components/schemas/EnumInstitutionStatus"
    },
    "website": {
      "type": "string",
      "example": "https://www.erebor.com/",
      "nullable": true,
      "description": "The URL of the institution's website."
    },
    "features": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/InstitutionsFeature"
      },
      "description": "The features that the institution supports. If the institution has no special features, then Belvo returns an empty array.\n\nHere is a list of the available features:\n- `token_required` indicates that the institution may require a token during link creation or when making any other requests.\n"
    },
    "icon_logo": {
      "type": "string",
      "example": "https://statics.belvo.io/widget/images/institutions/erebor.svg",
      "nullable": true,
      "description": "The URL of the institution's icon logo."
    },
    "resources": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "ACCOUNTS",
        "description": "A Belvo resource that the institution supports."
      },
      "example": [
        "ACCOUNTS",
        "BALANCES",
        "INCOMES",
        "OWNERS",
        "RECURRING_EXPENSES",
        "RISK_INSIGHTS",
        "TRANSACTIONS"
      ],
      "description": "A list of Belvo resources that you can use with the institution. This list includes one or more of the following resources:\n\n  - `ACCOUNTS`\n  - `BALANCES`\n  - `EMPLOYMENT_RECORDS`\n  - `INCOMES`\n  - `INVOICES`\n  - `OWNERS`\n  - `RECURRING_EXPENSES`\n  - `RISK_INSIGHTS`\n  - `TRANSACTIONS`\n  - `TAX_COMPLIANCE_STATUS`\n  - `TAX_DECLARATIONS`\n  - `TAX_RETENTIONS`\n  - `TAX_RETURNS`\n  - `TAX_STATUS`\n"
    },
    "text_logo": {
      "type": "string",
      "example": "https://statics.belvo.io/widget/images/institutions/erebor.svg",
      "nullable": true,
      "description": "The URL of the institution's text logo."
    },
    "form_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/InstitutionsFormField"
      }
    },
    "display_name": {
      "type": "string",
      "example": "Erebor Mexico",
      "description": "The customer-facing name of the institution."
    },
    "country_codes": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "MX"
      },
      "description": "The country codes where the institution is available, for example:\n- 🇧🇷 BR (Brazil)\n- 🇨🇴 CO (Colombia)\n- 🇲🇽 MX (Mexico)  \n"
    },
    "primary_color": {
      "type": "string",
      "example": "#056dae",
      "description": "The primary color on the institution's website."
    },
    "integration_type": {
      "$ref": "#/components/schemas/EnumInstitutionIntegrationType"
    }
  }
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "example": "erebor_mx_retail",
      "description": "The name of the institution, as designated by Belvo.\n\nPlease see our [Institutions](https://developers.belvo.com/docs/institution) DevPortal article for a detailed list of institution names.\n"
    },
    "type": {
      "$ref": "#/components/schemas/EnumInstitutionType"
    }
  },
  "description": "Details regarding the institution."
}

{
  "type": "object",
  "title": "Institution Down",
  "properties": {
    "code": {
      "type": "string",
      "example": "institution_down",
      "description": "A unique error code (`institution_down`) 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-institution_down\" target=\"_blank\">400 institution_down errors</a>.\n"
    },
    "message": {
      "type": "string",
      "example": "The financial institution is down, try again later",
      "description": "A short description of the error. \n\n\nFor `institution_down` errors, the description is:\n  \n  - `The financial institution is down, try again later`.\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 the institution's website that you're trying to access is down due to maintenance or other issues, which means Belvo is unable to create new links or retrieve new data.\n"
}

{
  "type": "object",
  "title": "Institution Inactive",
  "properties": {
    "code": {
      "type": "string",
      "example": "institution_inactive",
      "description": "A unique error code (`institution_inactive`) 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-institution_inactive\" target=\"_blank\">400 institution_inactive errors</a>.\n"
    },
    "message": {
      "type": "string",
      "example": "The institution has been temporarily deactivated",
      "description": "A short description of the error. \n\n\nFor `institution_inactive` errors, the description is:\n  \n  - `The institution has been temporarily deactivated`.\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 we (Belvo) have deactivated the institution in our API.\n"
}

{
  "type": "object",
  "title": "Institution Unavailable",
  "properties": {
    "code": {
      "type": "string",
      "example": "institution_unavailable",
      "description": "A unique error code (`institution_unavailable`) that allows you to classify and handle the error programmatically.\n\n\nℹ️ Check our DevPortal for more information on how handle <a href=\"https://developers.belvo.com/docs/belvo-api-errors#400-institution_unavailable\" target=\"_blank\">400 institution_unavailable errors</a>.\n"
    },
    "message": {
      "type": "string",
      "example": "The financial institution is unavailable",
      "description": "A short description of the error.\n\n\nFor `institution_unavailable` errors, the description is:\n  \n  - `The financial institution is unavailable`.\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 the institution's website that you're trying to access is down due to maintenance or other issues, which means Belvo is unable to create new links or retrieve new data.\n"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "example": "token_required",
      "description": "The name of the feature."
    },
    "description": {
      "type": "string",
      "example": "The institution may require a token during link creation or login",
      "description": "The description of the feature."
    }
  }
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "example": "username",
      "description": "The username, password, or username type field."
    },
    "type": {
      "type": "string",
      "example": "text",
      "description": "The input type for the form field. For example, string."
    },
    "label": {
      "type": "string",
      "example": "Client number",
      "description": "The label of the form field. For example:\n- Client number\n- Key Bancanet\n- Document\n"
    },
    "values": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/InstitutionsFormFieldValues"
      },
      "description": "If the form field is for documents, the institution may require additional\ninput regarding the document type.\n"
    },
    "validation": {
      "type": "string",
      "example": "^.{1,}$",
      "description": "The type of input validation used for the field."
    },
    "placeholder": {
      "type": "string",
      "example": "ABC333333A33",
      "description": "The placeholder text in the form field."
    },
    "validation_message": {
      "type": "string",
      "example": "Invalid client number",
      "description": "The message displayed when an invalid input is provided in the form field."
    }
  }
}