array CreditScoreGetDetailsById404Response
{
  "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 CreditScoreGetDetailsByIdResponse
{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/UnauthorizedError"
      },
      {
        "$ref": "#/components/schemas/401_consent_without_accounts_error"
      }
    ]
  }
}
array CreditScoreListAllResponse
{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/UnauthorizedError"
      },
      {
        "$ref": "#/components/schemas/401_consent_without_accounts_error"
      }
    ]
  }
}
object CreditScorePaginatedResponse
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/common_pagination_properties"
    },
    {
      "properties": {
        "results": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/CreditScore"
          },
          "description": "Array of credit score objects."
        }
      }
    }
  ]
}
object CreditScoreReasonCode
{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "example": "C06",
      "pattern": "[A-Z][0-9]{2}",
      "description": "The reason code for the credit score.\n"
    },
    "description": {
      "type": "string",
      "example": "Out of Pattern transaction checking deposit day",
      "pattern": "^.{1,160}$",
      "maxLength": 160,
      "minLength": 1,
      "description": "A description of the reason code.\n"
    }
  },
  "description": "An array of codes that explain the reason behind the credit score."
}
object CreditScoreRequest
{
  "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."
    },
    "date_to": {
      "type": "string",
      "example": "2023-02-28",
      "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}",
      "description": "The date until when you want to calculate the credit score for, in `YYYY-MM-DD` format.\n\nIf not provided, we calculate the credit score using from the time of the request and use up to 365 days of data (if available).\n\n\n⚠️ The value of `date_to` cannot be greater than today's date (in other words, no future dates).\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"
    }
  }
}
object DocumentIdBusiness
{
  "type": "object",
  "required": [
    "document_type",
    "document_number"
  ],
  "properties": {
    "document_type": {
      "type": "string",
      "example": "NIT",
      "description": "The type of ID document."
    },
    "document_number": {
      "type": "string",
      "example": "8312224477",
      "description": "The number of the ID document."
    }
  },
  "description": "Object containing information about the ID document of the tax payer."
}
object DocumentIdIndividual
{
  "type": "object",
  "required": [
    "document_type",
    "document_number"
  ],
  "properties": {
    "document_type": {
      "type": "string",
      "example": "NIT",
      "description": "The type of ID document."
    },
    "document_number": {
      "type": "string",
      "example": "7113223466",
      "description": "The number of the ID document."
    }
  },
  "description": "Object containing information about the ID document of the tax payer."
}
object DocumentInformationBusiness
{
  "type": "object",
  "required": [
    "name",
    "type",
    "form_number",
    "year"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "Declaracion de Renta y Complementario o de Ingresos y Patrimonio para Personas Juridicas y Asimiladas y Personas Naturales y Asimiladas no Residentes y Sucesiones Iliquidas de Causantes no Residentes",
      "description": "The name of the tax document."
    },
    "type": {
      "type": "string",
      "example": "110",
      "description": "The type of tax declaration form. For DIAN, this will be either `110` or `210`."
    },
    "year": {
      "type": "integer",
      "example": 2021,
      "nullable": true,
      "description": "The year of this tax declaration.\n"
    },
    "form_number": {
      "type": "string",
      "example": "2117680087604",
      "description": "The institution-provided identifier for the tax declaration."
    }
  },
  "description": "Object containing detailed information about the fiscal document."
}
object DocumentInformationIndividual
{
  "type": "object",
  "required": [
    "name",
    "type",
    "form_number",
    "year"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "Declaracion de Renta y Complementario o de Ingresos y Patrimonio para Personas Juridicas y Asimiladas y Personas Naturales y Asimiladas no Residentes y Sucesiones Iliquidas de Causantes no Residentes",
      "description": "The name of the tax document."
    },
    "type": {
      "type": "string",
      "example": "110",
      "description": "The type of tax declaration form. For DIAN, this will be either `110` or `210`."
    },
    "year": {
      "type": "integer",
      "example": 2021,
      "nullable": true,
      "description": "The year of this tax declaration.\n"
    },
    "form_number": {
      "type": "string",
      "example": "2117680087604",
      "description": "Institution-provided identifier for the tax declaration."
    }
  },
  "description": "Object containing detailed information about the fiscal document."
}
object EmploymentRecord
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "example": "fef05fc8-7357-4a4a-9d29-55038ea31a04",
      "description": "The unique identifier created by Belvo for the current IMSS statement."
    },
    "link": {
      "type": "string",
      "format": "uuid",
      "example": "27c1d5cf-e8fb-433a-a2f7-d246de199c01",
      "description": "The unique identifier created by Belvo for the current user."
    },
    "files": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EmploymentRecordFile"
      },
      "nullable": true,
      "description": "Additional PDF binary files relating to the individual's employment."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2020-04-23T21:32:55.336854+00:00",
      "description": "The ISO-8601 timestamp of when the data point was initially created in Belvo's database."
    },
    "report_date": {
      "type": "string",
      "format": "date",
      "example": "2023-01-19",
      "description": "The date when the employment record report was generated, in `YYYY-MM-DD` format."
    },
    "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."
    },
    "personal_data": {
      "$ref": "#/components/schemas/EmploymentRecordPersonalData"
    },
    "employment_records": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EmploymentRecordDetail"
      },
      "description": "Details regarding the individual's employment history."
    },
    "internal_identification": {
      "type": "string",
      "example": "BLPM951331IONVGR54",
      "description": "Unique ID for user according to the institution. For IMSS Mexico, this is the CURP."
    },
    "social_security_summary": {
      "$ref": "#/components/schemas/EmploymentRecordSocialSecuritySummary"
    }
  },
  "description": "Employment record response payload"
}
object EmploymentRecordDetail
{
  "type": "object",
  "properties": {
    "state": {
      "type": "string",
      "example": "DISTRITO FEDERAL",
      "description": "In what geographical state the individual was employed, according to the country.\n"
    },
    "currency": {
      "type": "string",
      "example": "MXN",
      "description": "The three-letter currency code in which the salary is paid.\n"
    },
    "employer": {
      "type": "string",
      "example": "Batman Enterprises CDMX",
      "description": "The official name of the employer.\n"
    },
    "end_date": {
      "type": "string",
      "format": "date",
      "example": "2019-12-31",
      "nullable": true,
      "description": "Date when employment finished, in `YYYY-MM-DD` format.\n"
    },
    "start_date": {
      "type": "string",
      "format": "date",
      "example": "2019-10-10",
      "description": "Date when employment started, in `YYYY-MM-DD` format.\n"
    },
    "employer_id": {
      "type": "string",
      "example": "780-BAT-88769-CDMX",
      "description": "The official ID of the employer, according to the country.\n"
    },
    "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."
    },
    "monthly_salary": {
      "type": "number",
      "format": "float",
      "description": "The monthly salary of the individual, including any additional perks.\n"
    },
    "weeks_employed": {
      "type": "integer",
      "format": "int32",
      "example": 12,
      "description": "Number of weeks that the individual was employed.\n"
    },
    "most_recent_base_salary": {
      "type": "number",
      "format": "float",
      "example": 762.54,
      "description": "The most recent base salary the individual earned.\n\nFor Mexico, this is the *daily* rate that the individual earned, including the perks that the individual is entitled to throughout the year.\n"
    },
    "employment_status_updates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EmploymentRecordEmploymentStatusUpdates"
      },
      "nullable": true,
      "description": "Details regarding any employment changes of the individual."
    }
  },
  "description": "Details regarding the individual's employment history."
}
object EmploymentRecordDocumentId
{
  "type": "object",
  "properties": {
    "document_type": {
      "$ref": "#/components/schemas/EnumEmploymentRecordDocumentType"
    },
    "document_number": {
      "type": "string",
      "example": "10277663582",
      "nullable": true,
      "description": "The ID document's number (as a string).\n"
    }
  },
  "description": "Details regarding the individual's ID documents."
}
object EmploymentRecordEmploymentStatusUpdates
{
  "type": "object",
  "nullable": true,
  "properties": {
    "event": {
      "$ref": "#/components/schemas/EnumEmploymentRecordStatusUpdateEvents"
    },
    "base_salary": {
      "type": "number",
      "format": "float",
      "example": 1033.09,
      "description": "The base salary of the individual, current as of the `update_date`.\n"
    },
    "update_date": {
      "type": "string",
      "format": "date",
      "example": "2021-09-01",
      "description": "The date that the employment event occurred, in `YYYY-MM-DD` format.\n"
    }
  },
  "description": "Details regarding any employment changes of the individual."
}
object EmploymentRecordEntitlement
{
  "type": "object",
  "properties": {
    "status": {
      "$ref": "#/components/schemas/EnumEmploymentRecordStatus"
    },
    "valid_until": {
      "type": "string",
      "format": "date",
      "example": null,
      "nullable": true,
      "description": "Date until when the individual is covered by health insurance and/or company benefits. If `null` the employee is currently working and no end date is required.\n"
    },
    "entitled_to_company_benefits": {
      "type": "boolean",
      "example": true,
      "description": "Indicates whether or not the individual is entitled to company benefits.\n"
    },
    "entitled_to_health_insurance": {
      "type": "boolean",
      "example": true,
      "description": "Indicated whether or not the individual is entitled to health insurance.\n"
    }
  },
  "description": "Details regarding the benefits the individual is entitled to."
}
object EmploymentRecordFile
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "example": "ReporteSemanasCotizadas_190123",
      "description": "The title of the document.\n"
    },
    "value": {
      "type": "string",
      "example": "=PDF_BINARY=",
      "nullable": true,
      "description": "The PDF binary of the file (as a string).\n\n> **Note**: In our sandbox environment, this field will return `null`.\n"
    }
  },
  "description": "Additional PDF binary files relating to the individual's employment."
}
object EmploymentRecordPersonalData
{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "example": "bruce.banner@avengers.com",
      "nullable": true,
      "deprecated": true,
      "description": "The email address of the individual.\n"
    },
    "last_name": {
      "type": "string",
      "example": "Banner del Torro",
      "nullable": true,
      "description": "The last name of the individual.\n"
    },
    "birth_date": {
      "type": "string",
      "format": "date",
      "example": "2022-02-09",
      "nullable": true,
      "description": "The date of birth of the individual, in `YYYY-MM-DD` format.\n"
    },
    "first_name": {
      "type": "string",
      "example": "Bruce",
      "nullable": true,
      "description": "The first name of the individual.\n"
    },
    "document_ids": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EmploymentRecordDocumentId"
      },
      "description": "Details regarding the individual's ID documents."
    },
    "entitlements": {
      "$ref": "#/components/schemas/EmploymentRecordEntitlement"
    },
    "official_name": {
      "type": "string",
      "example": "Bruce Banner del Torro",
      "nullable": true,
      "description": "The legal name of the individual\n"
    }
  },
  "description": "Details regarding the personal information of the individual."
}
object EmploymentRecordRequest
{
  "type": "object",
  "required": [
    "link"
  ],
  "properties": {
    "link": {
      "type": "string",
      "format": "uuid",
      "example": "d686c617-6d9e-4bc6-9801-5ac276ccb6a2",
      "description": "The `link.id` you want to retrieve employment records for."
    },
    "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"
    },
    "attach_pdf": {
      "type": "boolean",
      "default": false,
      "description": "When set to `true`, you will receive the PDF in binary format in the response.\n"
    }
  }
}
object EmploymentRecordSocialSecuritySummary
{
  "type": "object",
  "properties": {
    "weeks_redeemed": {
      "type": "integer",
      "format": "int32",
      "example": 0,
      "nullable": true,
      "description": "Number of weeks the individual needed to take out of their pension.\n"
    },
    "weeks_reinstated": {
      "type": "integer",
      "format": "int32",
      "example": 0,
      "nullable": true,
      "description": "Number of weeks the individual has paid back into their pension (*AFORE*), after having redeemed them previously.\n"
    },
    "weeks_contributed": {
      "type": "integer",
      "format": "int32",
      "example": 188,
      "nullable": true,
      "description": "Number of weeks the individual has contributed to their social security, based on the number of weeks the individual has worked according to IMSS.\n"
    }
  },
  "description": "Details regarding the individual's social security contributions."
}
array EmploymentRecordsMexicoDeleteRecord404Response
{
  "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 EmploymentRecordsMexicoDeleteRecordResponse
{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/UnauthorizedError"
      },
      {
        "$ref": "#/components/schemas/401_consent_without_accounts_error"
      }
    ]
  }
}
array EmploymentRecordsMexicoGetDetails201Response
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/EmploymentRecord"
  }
}
array EmploymentRecordsMexicoGetDetails400Response
{
  "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 EmploymentRecordsMexicoGetDetails401Response
{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/UnauthorizedError"
      },
      {
        "$ref": "#/components/schemas/401_consent_without_accounts_error"
      }
    ]
  }
}
array EmploymentRecordsMexicoGetDetails404Response
{
  "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 EmploymentRecordsMexicoGetDetails408Response
{
  "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 EmploymentRecordsMexicoGetDetails428Response
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/TokenRequiredResponse"
  }
}
array EmploymentRecordsMexicoGetDetails500Response
{
  "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 EmploymentRecordsMexicoGetDetailsResponse
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/EmploymentRecord"
  }
}
array EmploymentRecordsMexicoListAllResponse
{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/UnauthorizedError"
      },
      {
        "$ref": "#/components/schemas/401_consent_without_accounts_error"
      }
    ]
  }
}
object EmploymentRecordsPaginatedResponse
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/common_pagination_properties"
    },
    {
      "properties": {
        "results": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/EmploymentRecord"
          },
          "description": "Array of employment record objects."
        }
      }
    }
  ]
}
string EnumAccountCategory
{
  "enum": [
    "CHECKING_ACCOUNT",
    "CREDIT_CARD",
    "INVESTMENT_ACCOUNT",
    "LOAN_ACCOUNT",
    "PENSION_FUND_ACCOUNT",
    "SAVINGS_ACCOUNT",
    "UNCATEGORIZED",
    null
  ],
  "type": "string",
  "example": "CHECKING_ACCOUNT",
  "nullable": true,
  "description": "The type of account.\nWe return one of the following enum values:\n  - `CHECKING_ACCOUNT`\n  - `CREDIT_CARD`\n  - `INVESTMENT_ACCOUNT`\n  - `LOAN_ACCOUNT`\n  - `PENSION_FUND_ACCOUNT`\n  - `SAVINGS_ACCOUNT`\n  - `UNCATEGORIZED`\n  - `null`\n"
}
string EnumAccountCategoryOpenFinance
{
  "enum": [
    "ADVANCE_DEPOSIT_ACCOUNT",
    "CHECKING_ACCOUNT",
    "CREDIT_CARD",
    "FINANCING_ACCOUNT",
    "INVESTMENT_ACCOUNT",
    "INVOICE_FINANCING_ACCOUNT",
    "LOAN_ACCOUNT",
    "PENSION_FUND_ACCOUNT",
    "SAVINGS_ACCOUNT",
    "UNCATEGORIZED"
  ],
  "type": "string",
  "example": "CHECKING_ACCOUNT",
  "nullable": true,
  "description": "The type of account.\nWe return one of the following enum values:\n  - `ADVANCE_DEPOSIT_ACCOUNT`\n  - `CHECKING_ACCOUNT`\n  - `CREDIT_CARD`\n  - `FINANCING_ACCOUNT`\n  - `INVESTMENT_ACCOUNT`\n  - `INVOICE_FINANCING_ACCOUNT`\n  - `LOAN_ACCOUNT`\n  - `PENSION_FUND_ACCOUNT`\n  - `SAVINGS_ACCOUNT`\n  - `UNCATEGORIZED`\n"
}
string EnumAccountCreditCardNetwork
{
  "enum": [
    "VISA",
    "MASTERCARD",
    "AMERICAN_EXPRESS",
    "DINERS_CLUB",
    "HIPERCARD",
    "BANDEIRA_PROPRIA",
    "CHEQUE_ELETRONICO",
    "ELO",
    "OTHER"
  ],
  "type": "string",
  "example": "MASTERCARD",
  "description": "The credit network that the card is associated with. We return one of the following values:\n\n  - `VISA`\n  - `MASTERCARD`\n  - `AMERICAN_EXPRESS`\n  - `DINERS_CLUB`\n  - `HIPERCARD`\n  - `BANDEIRA_PROPRIA`\n  - `CHEQUE_ELETRONICO`\n  - `ELO`\n  - `OTHER`\n\n  > **Non-nullable:** A value must be returned by Brazil's open finance network.\n"
}
string EnumAccountLoanDataContractRemainingFrequency
{
  "enum": [
    "DAY",
    "WEEK",
    "MONTH",
    "YEAR",
    "NO_DEADLINE_REMAINING",
    null
  ],
  "type": "string",
  "example": "MONTH",
  "nullable": true,
  "description": "The frequency of the remaining contracted installment payments, as defined when the contract was first signed. We return one of the following:\n- `DAY`\n- `WEEK`\n- `MONTH`\n- `YEAR`\n- `NO_DEADLINE_REMAINING`\n- `null`\n"
}
string EnumAccountLoanDataContractedChargeType
{
  "enum": [
    "LATE_PAYMENT_INTEREST_FEE",
    "LATE_PAYMENT_PENALTY_FEE",
    "DEFAULT_INTEREST_FEE",
    "LOAN_CONTRACT_TAX",
    "LATE_PAYMENT_TAX",
    "NO_CHARGE",
    "OTHER"
  ],
  "type": "string",
  "example": "LATE_PAYMENT_INTEREST_FEE",
  "description": "The type of contracted charge. We return one of the following values:\n\n  - `LATE_PAYMENT_INTEREST_FEE`\n  - `LATE_PAYMENT_PENALTY_FEE`\n  - `DEFAULT_INTEREST_FEE`\n  - `LOAN_CONTRACT_TAX`\n  - `LATE_PAYMENT_TAX`\n  - `NO_CHARGE`\n  - `OTHER`\n\n  > **Non-nullable:** A value must be returned by Brazil's open finance network if the `contracted_charges` field is available.\n"
}
string EnumAccountLoanDataFeeCharge
{
  "enum": [
    "MINIMUM",
    "MAXIMUM",
    "FIXED",
    "PERCENTAGE"
  ],
  "type": "string",
  "example": "FIXED",
  "description": "Billing method, as agreed upon with the institution. We return one of the following values:\n\n  - `MINIMUM`\n  - `MAXIMUM`\n  - `FIXED`\n  - `PERCENTAGE`\n\n   > **Non-nullable:** A value must be returned by Brazil's open finance network if the `fees` field is available.\n"
}
string EnumAccountLoanDataFeeChargeType
{
  "enum": [
    "SINGLE",
    "PER_INSTALLMENT"
  ],
  "type": "string",
  "example": "SINGLE",
  "description": "Indicates the type of charge. We return one of the following values:\n\n  - `SINGLE`\n  - `PER_INSTALLMENT`\n\n   > **Non-nullable:** A value must be returned by Brazil's open finance network if the `fees` field is available.\n"
}
string EnumAccountLoanDataFeeType
{
  "enum": [
    "OPERATION_FEE",
    "INSURANCE_FEE",
    "OTHERS",
    null
  ],
  "type": "string",
  "example": null,
  "nullable": true,
  "description": "**Note:** This field is not applicable for OF Brazil and will return null.\n"
}
string EnumAccountLoanDataInstallmentFrequency
{
  "enum": [
    "IRREGULAR",
    "WEEKLY",
    "FORTNIGHTLY",
    "MONTHLY",
    "BIMONTHLY",
    "QUARTERLY",
    "BIANNUALLY",
    "ANNUALLY",
    "OTHER"
  ],
  "type": "string",
  "example": "MONTHLY",
  "description": "The frequency that the installments are paid. We return one of the following values:\n\n  - `IRREGULAR`\n  - `WEEKLY`\n  - `FORTNIGHTLY`\n  - `MONTHLY`\n  - `BIMONTHLY`\n  - `QUARTERLY`\n  - `BIANNUALLY`\n  - `ANNUALLY`\n  - `OTHER`\n\n  > **Non-nullable:** A value must be returned by Brazil's open finance network.\n"
}
string EnumAccountLoanDataInterestRateDataRateType
{
  "enum": [
    "SIMPLE",
    "COMPOUND"
  ],
  "type": "string",
  "example": "SIMPLE",
  "description": "The type of interest rate. We return one of the following values:\n\n  - `SIMPLE`\n  - `COMPOUND`\n\n  > **Non-nullable:** A value must be returned by Brazil's open finance network.\n"
}
string EnumAccountLoanDataInterestRateDataReferenceIndexType
{
  "enum": [
    "WITHOUT_INDEX_TYPE",
    "PRE_FIXED",
    "POST_FIXED",
    "FLOATING",
    "INDEXED_PRICE",
    "RURAL_CREDIT",
    "OTHER_INDEX"
  ],
  "type": "string",
  "example": "FLOATING",
  "description": "The reference index rate. We return one of the following values:\n\n  - `WITHOUT_INDEX_TYPE`\n  - `PRE_FIXED`\n  - `POST_FIXED`\n  - `FLOATING`\n  - `INDEXED_PRICE`\n  - `RURAL_CREDIT`\n  - `OTHER_INDEX`\n\n  > **Non-nullable:** A value must be returned by Brazil's open finance network.\n"
}
string EnumAccountLoanDataInterestRateDataTaxType
{
  "enum": [
    "NOMINAL",
    "EFFECTIVE"
  ],
  "type": "string",
  "example": "NOMINAL",
  "description": "The type of interest rate tax. We return one of the following values:\n\n  - `NOMINAL`\n  - `EFFECTIVE`\n  \n  > **Non-nullable:** A value must be returned by Brazil's open finance network.\n"
}
string EnumAccountLoanDataInterestRateType
{
  "enum": [
    "MONTHLY",
    "YEARLY"
  ],
  "type": "string",
  "example": "MONTHLY",
  "description": "The period that the interest is applied to the loan.\n\n> **Non-nullable:** A value must be returned by Brazil's open finance network.\n"
}
string EnumAccountsLoanDataContractInstallmentFrequency
{
  "enum": [
    "DAY",
    "WEEK",
    "MONTH",
    "YEAR",
    "NO_DEADLINE_REMAINING",
    null
  ],
  "type": "string",
  "example": "MONTH",
  "nullable": true,
  "description": "The frequency of contracted installment payments, as defined when the contract was first signed. We return one of the following:\n\n  - `DAY`\n  - `WEEK`\n  - `MONTH`\n  - `YEAR`\n  - `NO_DEADLINE_REMAINING`\n  - `null`\n"
}
string EnumCategorizationAccountCategory
{
  "enum": [
    "CHECKING_ACCOUNT",
    "CREDIT_CARD",
    "LOAN_ACCOUNT",
    "SAVINGS_ACCOUNT"
  ],
  "type": "string",
  "example": "CREDIT_CARD",
  "description": "The type of account.\n\nCan be either:\n  - `CHECKING_ACCOUNT`\n  - `CREDIT_CARD`\n  - `LOAN_ACCOUNT`\n  - `SAVINGS_ACCOUNT`\n"
}
string EnumCategorizationAccountHolderType
{
  "enum": [
    "INDIVIDUAL",
    "BUSINESS"
  ],
  "type": "string",
  "example": "INDIVIDUAL",
  "description": "The type of account holder.\n\nCan be either:\n\n  - `INDIVIDUAL`\n  - `BUSINESS`\n"
}
string EnumCategorizationTransactionCategory
{
  "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 category to which this transaction belongs. For more info about this feature, check our [Transaction categorization](https://developers.belvo.com/docs/banking#categorizing-transactions) article. \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"
}
string EnumCategorizationTransactionSubcategory
{
  "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 transactions subcategory. For more info about this feature, check our [Transaction categorization](https://developers.belvo.com/docs/banking#categorizing-transactions) article. \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"
}
string EnumCategorizationTransactionType
{
  "enum": [
    "INFLOW",
    "OUTFLOW"
  ],
  "type": "string",
  "example": "OUTFLOW",
  "description": "The direction of the transaction.\n\nCan be either:\n\n  - `INFLOW` indicates a received transaction.\n  - `OUTFLOW` indicates a sent transaction.\n"
}
Load more schemas