object AnnualIncomeStatementBusiness

{
  "type": "object",
  "required": [
    "gross_income_from_ordinary_activities",
    "dividends",
    "other_income",
    "total_gross_income",
    "returns_rebates_and_discounts_on_sales",
    "total_net_income"
  ],
  "properties": {
    "dividends": {
      "type": "number",
      "format": "float",
      "example": 0,
      "description": "Total income that the company generated from dividends."
    },
    "other_income": {
      "type": "number",
      "format": "float",
      "example": 0,
      "description": "Total income that the company generated from activities not associated with their main economic activity."
    },
    "total_net_income": {
      "type": "number",
      "format": "float",
      "example": 210043000,
      "description": "Total net income of the company, taking into account `returns_rebates_and_discounts_on_sales`."
    },
    "total_gross_income": {
      "type": "number",
      "format": "float",
      "example": 210043000,
      "description": "Total gross income the company generated."
    },
    "gross_income_from_ordinary_activities": {
      "type": "number",
      "format": "float",
      "example": 210043000,
      "description": "Total gross income that the company generated from their main economic activity."
    },
    "returns_rebates_and_discounts_on_sales": {
      "type": "number",
      "format": "float",
      "example": 0,
      "description": "Total value of cancelled orders, corrected invoices, or similar, that can be discounted from the `total_gross_income`."
    }
  },
  "description": "Object containing the reported annual incomes, deductions, and final balances of the tax payer."
}

object AnnualIncomeStatementIndividual

{
  "type": "object",
  "required": [
    "gross_income",
    "non_taxable_income",
    "net_income",
    "annual_totals"
  ],
  "properties": {
    "net_income": {
      "$ref": "#/components/schemas/NetIncomeIndividual"
    },
    "gross_income": {
      "$ref": "#/components/schemas/GrossIncomeIndividual"
    },
    "annual_totals": {
      "$ref": "#/components/schemas/AnnualTotalsIndividual"
    },
    "non_taxable_income": {
      "$ref": "#/components/schemas/NonTaxableIncomeIndividual"
    }
  },
  "description": "Object containing the reported annual incomes, deductions, and final balances of the tax payer."
}

object AnnualTotalsIndividual

{
  "type": "object",
  "required": [
    "total_exempt_income",
    "total_applicable_deductions",
    "total_exemptions_and_deductions",
    "total_ordinary_net_income"
  ],
  "properties": {
    "total_exempt_income": {
      "type": "number",
      "format": "float",
      "example": 115004000,
      "description": "Total income that is not taxable, according to the institution."
    },
    "total_ordinary_net_income": {
      "type": "number",
      "format": "float",
      "example": 0,
      "description": "Sum total of the taxpayer's income (gross income - exemptions - deductions)."
    },
    "total_applicable_deductions": {
      "type": "number",
      "format": "float",
      "example": 0,
      "description": "Total deductions that the taxpayer can apply to their income, according to the institution."
    },
    "total_exemptions_and_deductions": {
      "type": "number",
      "format": "float",
      "example": 0,
      "description": "Sum total of all exempt and deductions that can be applied to the taxpayer's income."
    }
  },
  "description": "Object containing the tax payers total exempt, deducted, and ordinary net incomes."
}

object AsynchronousAccepted202

{
  "type": "object",
  "properties": {
    "request_id": {
      "type": "string",
      "example": "b5d0106ac9cc43d5b36199fe831f6bbe",
      "description": "The unique ID for this request. We recommend you store this value to later identify which webhook event relates to an asynchronous request."
    }
  }
}

object Balance

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "example": "076c66e5-90f5-4e01-99c7-50e32f65ae42",
      "description": "Belvo's unique ID for the balance request."
    },
    "account": {
      "$ref": "#/components/schemas/Account"
    },
    "balance": {
      "type": "number",
      "format": "float",
      "example": 50000,
      "description": "The funds available in the account by the end of the `value_date`."
    },
    "statement": {
      "type": "string",
      "example": null,
      "nullable": true,
      "deprecated": true,
      "description": "*This field has been deprecated. For more information regarding Belvo and deprecation, see our [Deprecated fields](https://developers.belvo.com/reference/using-the-api-reference#%EF%B8%8F-deprecated-fields) explanation.*\n\n*The ID of the banking statement used to extract the `balance`.*\n"
    },
    "value_date": {
      "type": "string",
      "format": "date",
      "example": "2019-10-23",
      "description": "The date when the `balance` was available, in `YYYY-MM-DD` format."
    },
    "collected_at": {
      "type": "string",
      "format": "date-time",
      "example": null,
      "nullable": true,
      "deprecated": true,
      "description": "*This field has been deprecated. For more information regarding Belvo and deprecation, see our [Deprecated fields](https://developers.belvo.com/reference/using-the-api-reference#%EF%B8%8F-deprecated-fields) explanation.*\n\n*The ISO-8601 timestamp when the data point was collected.*\n"
    },
    "current_balance": {
      "type": "number",
      "example": null,
      "nullable": true,
      "deprecated": true,
      "description": "*This field has been deprecated. For more information regarding Belvo and deprecation, see our [Deprecated fields](https://developers.belvo.com/reference/using-the-api-reference#%EF%B8%8F-deprecated-fields) explanation.*\n\nPlease use the `balance` field instead.\n"
    }
  }
}

array BalancesDeleteBalance404Response

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

array BalancesDeleteBalanceResponse

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

array BalancesGetAllResponse

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

array BalancesGetDetails404Response

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

array BalancesGetDetailsResponse

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

array BalancesGetLinkBalances201Response

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

array BalancesGetLinkBalances400Response

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

array BalancesGetLinkBalances401Response

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

array BalancesGetLinkBalances408Response

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

array BalancesGetLinkBalances428Response

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

array BalancesGetLinkBalances500Response

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

array BalancesGetLinkBalancesResponse

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

object BalancesPaginatedResponse

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

object BalancesRequest

{
  "type": "object",
  "required": [
    "link",
    "date_from",
    "date_to"
  ],
  "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."
    },
    "account": {
      "type": "string",
      "format": "uuid",
      "example": "d4617561-1c01-4b2f-83b6-a594f7b3bc57",
      "description": "If provided, only balances matching this `account.id` are\nreturned.\n"
    },
    "date_to": {
      "type": "string",
      "example": "2021-02-15",
      "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}",
      "description": "Date that you want to stop receiving balances, in `YYYY-MM-DD` format.\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": "2021-01-18",
      "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}",
      "description": "Date from which you want to start receiving balances, in `YYYY-MM-DD` format.\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"
    }
  }
}

array BalancesResumeSession201Response

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

array BalancesResumeSession400Response

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

array BalancesResumeSession401Response

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

array BalancesResumeSession408Response

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

array BalancesResumeSession428Response

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

array BalancesResumeSession500Response

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

array BalancesResumeSessionResponse

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

object Categorization

{
  "type": "object",
  "properties": {
    "transactions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CategorizationBody"
      },
      "description": "An array of enriched transaction objects."
    }
  }
}

object CategorizationBody

{
  "type": "object",
  "required": [
    "transaction_id",
    "account_holder_type",
    "account_holder_id",
    "account_id",
    "account_category",
    "value_date",
    "description",
    "type",
    "amount",
    "currency",
    "institution",
    "category",
    "merchant"
  ],
  "properties": {
    "mcc": {
      "type": "integer",
      "format": "int32",
      "example": 2345,
      "nullable": true,
      "description": "The four-digit ISO 18245 Merchant Category Code (MCC).\n"
    },
    "type": {
      "$ref": "#/components/schemas/EnumCategorizationTransactionType"
    },
    "amount": {
      "type": "number",
      "format": "float",
      "example": 650.89,
      "maximum": 9999999999.99,
      "minimum": 0,
      "description": "The transaction amount.\n"
    },
    "category": {
      "$ref": "#/components/schemas/EnumCategorizationTransactionCategory"
    },
    "currency": {
      "type": "string",
      "example": "BRL",
      "description": "The currency of the account, in ISO-4217 format. For example:\n- 🇧🇷 BRL (Brazilian Real)\n- 🇨🇴 COP (Colombian Peso)\n- 🇲🇽 MXN (Mexican Peso)"
    },
    "merchant": {
      "$ref": "#/components/schemas/CategorizationMerchantData"
    },
    "account_id": {
      "type": "string",
      "example": "EREB-89077589",
      "description": "The unique ID for the account where the transaction occurred in your system.\n"
    },
    "value_date": {
      "type": "string",
      "format": "date",
      "example": "2022-11-18",
      "description": "The date when the transaction occurred, in `YYYY-MM-DD` format.\n"
    },
    "description": {
      "type": "string",
      "example": "APPL3STORE",
      "description": "The description of the transaction.\n"
    },
    "institution": {
      "type": "string",
      "example": "Erebor Brazil",
      "description": "The institution where the account is registered.\n\n\n>**Note:** This is the name that you use in your system to identify an institution.\n \n"
    },
    "subcategory": {
      "$ref": "#/components/schemas/EnumCategorizationTransactionSubcategory"
    },
    "transaction_id": {
      "type": "string",
      "example": "3CWE4927CF15355",
      "description": "The unique ID for the transaction in your system."
    },
    "account_category": {
      "$ref": "#/components/schemas/EnumCategorizationAccountCategory"
    },
    "account_holder_id": {
      "type": "string",
      "example": "7890098789087",
      "description": "The unique ID for the account holder in your system.\n"
    },
    "account_holder_type": {
      "$ref": "#/components/schemas/EnumCategorizationAccountHolderType"
    }
  }
}

object CategorizationBodyRequest

{
  "type": "object",
  "required": [
    "transaction_id",
    "account_holder_type",
    "account_holder_id",
    "account_id",
    "account_category",
    "value_date",
    "description",
    "type",
    "amount",
    "currency",
    "institution"
  ],
  "properties": {
    "mcc": {
      "type": "integer",
      "format": "int32",
      "example": 2345,
      "nullable": true,
      "description": "The four-digit ISO 18245 Merchant Category Code (MCC).\n"
    },
    "type": {
      "$ref": "#/components/schemas/EnumCategorizationTransactionType"
    },
    "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 currency of the account, in ISO-4217 format. For example:\n- 🇧🇷 BRL (Brazilian Real)\n- 🇨🇴 COP (Colombian Peso)\n- 🇲🇽 MXN (Mexican Peso)\n"
    },
    "account_id": {
      "type": "string",
      "example": "EREB-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 transaction occurred, in `YYYY-MM-DD` format.\n"
    },
    "description": {
      "type": "string",
      "example": "APPL3STORE",
      "description": "The description of the transaction.\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 an institution.\n"
    },
    "transaction_id": {
      "type": "string",
      "example": "3CWE4927CF15355",
      "description": "Your unique ID for the transaction."
    },
    "account_category": {
      "$ref": "#/components/schemas/EnumCategorizationAccountCategory"
    },
    "account_holder_id": {
      "type": "string",
      "example": "7890098789087",
      "description": "Your unique ID for the account holder.\n"
    },
    "account_holder_type": {
      "$ref": "#/components/schemas/EnumCategorizationAccountHolderType"
    }
  }
}

array CategorizationCategorizeTransactions401Response

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

array CategorizationCategorizeTransactions403Response

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

array CategorizationCategorizeTransactions500Response

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

array CategorizationCategorizeTransactionsResponse

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

object CategorizationMerchantData

{
  "type": "object",
  "nullable": true,
  "properties": {
    "logo": {
      "type": "string",
      "example": "https://www.apple.com/ac/structured-data/images/open_graph_logo.png?202110180743",
      "nullable": true,
      "description": "The URL to the merchant's logo."
    },
    "website": {
      "type": "string",
      "example": "https://www.apple.com/br/",
      "nullable": true,
      "description": "The URL to the merchant's website."
    },
    "merchant_name": {
      "type": "string",
      "example": "Apple, Inc",
      "description": "The name of the merchant."
    }
  },
  "description": "Additional data regarding the merchant involved in the transaction.\n"
}

object CategorizationRequest

{
  "type": "object",
  "required": [
    "language",
    "transactions"
  ],
  "properties": {
    "language": {
      "type": "string",
      "example": "pt",
      "description": "Two-letter ISO 639-1 code for the language of the transaction.\n"
    },
    "transactions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CategorizationBodyRequest"
      },
      "description": "An array of transaction objects that you want categorized.\n\n\n**Note:** Each object corresponds to one, unique transaction and you can send through up to 10,000 transactions per request.\n"
    }
  }
}

object ChangeAccessMode

{
  "type": "object",
  "required": [
    "access_mode"
  ],
  "properties": {
    "access_mode": {
      "$ref": "#/components/schemas/EnumLinkAccessModeRequest"
    }
  }
}

object CreditScore

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "example": "a4e0d6f8-aa0b-45e4-9cd2-38cc741a64ad",
      "description": "The unique ID for the credit score analysis.\n"
    },
    "score": {
      "type": "integer",
      "format": "int32",
      "example": 400,
      "description": "The credit score of the user.\n"
    },
    "date_to": {
      "type": "string",
      "format": "date",
      "example": "2023-06-01",
      "description": "The date that the credit score analysis ends, in `YYYY-MM-DD` format.\n"
    },
    "user_id": {
      "type": "string",
      "example": "AGH7890098789087",
      "description": "Your unique ID for the user.\n"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2023-06-01T12:00:00.000Z",
      "description": "The ISO-8601 timestamp when the credit score analysis was created.\n"
    },
    "reason_codes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CreditScoreReasonCode"
      },
      "minItems": 1,
      "description": "An array of codes that explain the reason behind the credit score."
    }
  },
  "description": "Credit Score response"
}

array CreditScoreDeleteSpecificScore404Response

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

array CreditScoreDeleteSpecificScoreResponse

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

array CreditScoreEyodGetUserCreditScore400Response

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

array CreditScoreEyodGetUserCreditScore401Response

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

array CreditScoreEyodGetUserCreditScore403Response

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

array CreditScoreEyodGetUserCreditScore500Response

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

array CreditScoreEyodGetUserCreditScoreRequest

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

array CreditScoreEyodGetUserCreditScoreResponse

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

array CreditScoreGetByLink401Response

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

array CreditScoreGetByLink408Response

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

array CreditScoreGetByLink428Response

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

array CreditScoreGetByLink500Response

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

array CreditScoreGetByLinkResponse

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