{
  "enum": [
    "TOTAL_LIMIT",
    "MODAL_LIMIT"
  ],
  "type": "string",
  "example": "TOTAL_LIMIT",
  "description": "The type of limit. We return one of the following values:\n\n  - `TOTAL_LIMIT`\n  - `MODAL_LIMIT`\n\n  > **Non-nullable:** A value must be returned by Brazil's open finance network.\n"
}

{
  "enum": [
    "NSS",
    "CURP"
  ],
  "type": "string",
  "example": "NSS",
  "nullable": true,
  "description": "The type of document related to the individual. We return one of the following values:\n\n  - `NSS`\n  - `CURP`\n  \n"
}

{
  "enum": [
    "EMPLOYED",
    "UNEMPLOYED"
  ],
  "type": "string",
  "example": "EMPLOYED",
  "nullable": true,
  "description": "Indicates whether or not the individual is currently `EMPLOYED` or `UNEMPLOYED`.\n"
}

{
  "enum": [
    "DISMISSED_RESIGNED",
    "SALARY_MODIFICATION",
    "HIRED",
    "VOLUNTARY_CONTRIBUTION",
    "ABSENCE",
    "SICK_LEAVE"
  ],
  "type": "string",
  "example": "HIRED",
  "nullable": true,
  "description": "The event that caused the change in employment status or salary. We return one of the following values:\n  \n  - `DISMISSED_RESIGNED`\n  - `SALARY_MODIFICATION`\n  - `HIRED`\n  - `VOLUNTARY_CONTRIBUTION`\n  - `ABSENCE`\n  - `SICK_LEAVE`\n  \n"
}

{
  "enum": [
    "HIGH",
    "MEDIUM",
    "LOW"
  ],
  "type": "string",
  "example": "HIGH",
  "description": "The minimum confidence level of the incomes you want to get information for.\n\nYou can send through one of the following values:\n\n  - `HIGH`\n  - `MEDIUM`\n  - `LOW`\n"
}

{
  "enum": [
    "BANK"
  ],
  "type": "string",
  "example": "BANK",
  "description": "The type of source we generate income insights from.\nWe return one of the following enum values:\n\n  - `BANK`\n"
}

{
  "enum": [
    "HIGH",
    "MEDIUM",
    "LOW"
  ],
  "type": "string",
  "example": "HIGH",
  "description": "Belvo's level of confidence for future incomes.\n\nWe return one of the following enum values:\n\n  - `HIGH`\n  - `MEDIUM`\n  - `LOW`\n"
}

{
  "enum": [
    "MONTHLY",
    "FORTNIGHTLY",
    "WEEKLY",
    "IRREGULAR",
    "SINGLE"
  ],
  "type": "string",
  "example": "MONTHLY",
  "description": "How often the income is received.\n\nWe return one of the following enum values:\n\n  - `MONTHLY` - For transactions that occur once per month.\n  - `FORTNIGHTLY` - For transactions that occur once every two weeks.\n  - `WEEKLY` - For transactions that occur once per week.\n  - `IRREGULAR` - For transactions that do not occur on a defined frequency pattern.\n  - `SINGLE` - For transactions that occur only once and do not repeat.\n"
}

{
  "enum": [
    "SALARY",
    "GOVERNMENT",
    "INTEREST",
    "RENT",
    "RETIREMENT",
    "FREELANCE",
    "ALTERNATIVE_INCOME",
    "TRANSFER",
    "DEPOSIT",
    "UNKNOWN"
  ],
  "type": "string",
  "example": "SALARY",
  "description": "The type of income used in the calculations.\n\nWe return one of the following enum values:\n\n  - `SALARY`\n  - `GOVERNMENT`\n  - `INTEREST`\n  - `RENT`\n  - `RETIREMENT`\n  - `FREELANCE`\n  - `ALTERNATIVE_INCOME`\n  - `TRANSFER`\n  - `DEPOSIT`\n  - `UNKNOWN`\n"
}

{
  "enum": [
    "CHECKING_ACCOUNT",
    "SAVINGS_ACCOUNT"
  ],
  "type": "string",
  "example": "CHECKING_ACCOUNT",
  "description": "The type of account.\n\nCan be either:\n  - `CHECKING_ACCOUNT`\n  - `SAVINGS_ACCOUNT`\n"
}

{
  "enum": [
    "INDIVIDUAL"
  ],
  "type": "string",
  "example": "INDIVIDUAL",
  "description": "The type of account holder. Can be:\n\n  - `INDIVIDUAL`\n"
}

{
  "enum": [
    "INFLOW"
  ],
  "type": "string",
  "example": "INFLOW",
  "nullable": true,
  "description": "The direction of the transaction:\n  \n- `INFLOW` indicates money coming into the account.\n"
}

{
  "enum": [
    "credentials",
    "openfinance"
  ],
  "type": "string",
  "example": "credentials",
  "description": "The type of technology used to access the institution. We return one of the following values:\n\n- `credentials`: Uses Belvo's scraping technology, combined with user credentials, to perform requests.\n- `openfinance`: Uses the bank's open finance API to perform requests.\n"
}

{
  "enum": [
    "healthy",
    "down"
  ],
  "type": "string",
  "example": "healthy",
  "description": "Indicates whether Belvo's integration with the institution is currently active (`healthy`) or undergoing maintenance (`down`).\n"
}

{
  "enum": [
    "bank",
    "fiscal",
    "employment"
  ],
  "type": "string",
  "description": "The type of institution. We return one of the following values:\n\n  - `bank`\n  - `fiscal`\n  - `employment`\n"
}

{
  "enum": [
    "SALARY",
    "GOVERNMENT",
    "INTEREST",
    "RENT",
    "RETIREMENT",
    "FREELANCE",
    "ALTERNATIVE_INCOME",
    "TRANSFER",
    "DEPOSIT",
    "UNKNOWN"
  ],
  "type": "string",
  "example": "SALARY",
  "description": "The categories of the incomes you want to get information for. \n\nYou can send through one or more of the following values:\n  - `SALARY`\n  - `GOVERNMENT`\n  - `INTEREST`\n  - `RENT`\n  - `RETIREMENT`\n  - `FREELANCE`\n  - `ALTERNATIVE_INCOME`\n  - `TRANSFER`\n  - `DEPOSIT`\n  - `UNKNOWN`\n"
}

{
  "enum": [
    "Factura Electrónica de Venta"
  ],
  "type": "string",
  "example": "Factura Electrónica de Venta",
  "nullable": true,
  "description": "The fiscal institution's classification of the invoice.\n\nFor Colombia's DIAN, we return one of the following values:\n\n  - `Factura Electrónica de Venta`\n"
}

{
  "enum": [
    "Contado",
    "Crédito",
    null
  ],
  "type": "string",
  "example": "Contado",
  "nullable": true,
  "description": "The payment method used for this invoice, as defined by the legal entity of the country.\n\nFor DIAN Colombia, we return one of the following values:\n\n  - `Contado`\n  - `Crédito`\n  - `null`\n"
}

{
  "enum": [
    "Egreso",
    "Ingreso",
    "Nómina",
    "Pago",
    "Traslado"
  ],
  "type": "string",
  "example": "Ingreso",
  "nullable": true,
  "description": "The fiscal institution's classification of the invoice.\n\nFor Mexico's SAT, we return one of the following values:\n\n  - `Egreso`\n  - `Ingreso`\n  - `Nómina`\n  - `Pago`\n  - `Traslado`\n"
}

{
  "enum": [
    "PUE",
    "PIP",
    "PPD",
    null
  ],
  "type": "string",
  "example": "PUE",
  "nullable": true,
  "description": "The payment method code used for this invoice, as defined by the legal entity of the country.\n\n- 🇲🇽 Mexico [SAT catalog reference article](https://developers.belvo.com/docs/sat-catalogs#payment-method). For Mexico, we return `PUE`, `PIP`, `PPD`, or `null`.\n"
}

{
  "enum": [
    "OUTFLOW",
    "INFLOW",
    null
  ],
  "type": "string",
  "example": "INFLOW",
  "nullable": true,
  "description": "The direction of the invoice (from the perspective of the Link owner).\n- `OUTFLOW` indicates a sent invoice.\n- `INFLOW` indicates a received invoice.\n"
}

{
  "enum": [
    "single",
    "recurrent"
  ],
  "type": "string",
  "default": "recurrent",
  "description": "The type of link to create.\n\n- Use `single` to do ad hoc one-time POST requests for accounts, owners, and transactions.\n- Use `recurrent` to have Belvo access information on a recurrent basis so you always have fresh account, owner, balance, and transaction data.\n\nFor more information, see our [Links](https://developers.belvo.com/docs/links-and-institutions#links) article.\n"
}

{
  "enum": [
    "single",
    "recurrent",
    null
  ],
  "type": "string",
  "example": "recurrent",
  "nullable": true,
  "description": "The link type.\nFor more information, see our [Links](https://developers.belvo.com/docs/links-and-institutions#links) article.\nWe return one of the following enum values:\n  - `single`\n  - `recurrent`\n  - `null`\n"
}

{
  "enum": [
    "6h",
    "12h",
    "24h",
    "7d",
    "30d",
    null
  ],
  "type": "string",
  "default": "7d",
  "example": "7d",
  "nullable": true,
  "description": "The update refresh rate for the recurrent link. For more information, check out our [recurrent link documentation](https://developers.belvo.com/docs/links-and-institutions#recurrent-links) in our DevPortal.\nWe return one of the following enum values:\n  - `6h`\n  - `12h`\n  - `24h`\n  - `7d` (default)\n  - `30d` (once a month)\n  - `null` (for single links)\n"
}

{
  "enum": [
    "valid",
    "invalid",
    "unconfirmed",
    "token_required"
  ],
  "type": "string",
  "example": "valid",
  "description": "The current status of the link. For more information, see our [Link](https://developers.belvo.com/docs/links-and-institutions#links) article in the devportal.\nWe return one of the following values:\n  - `valid`\n  - `invalid`\n  - `unconfirmed`\n  - `token_required`\n"
}

{
  "enum": [
    "OPERATION_FEE",
    "INSURANCE_FEE",
    "OTHERS"
  ],
  "type": "string",
  "example": "OPERATION_FEE",
  "description": "The type of fee. We return one of the following values:\n\n  - `OPERATION_FEE`\n  - `INSURANCE_FEE`\n  - `OTHERS`\n"
}

{
  "enum": [
    "MONTHLY",
    "YEARLY"
  ],
  "type": "string",
  "example": "MONTHLY",
  "nullable": true,
  "description": "The period that the interest is applied to the loan. We return one of the following values:\n\n  - `MONTHLY`\n  - `YEARLY`\n"
}

{
  "enum": [
    "DAILY",
    "WEEKLY",
    "FORTNIGHTLY",
    "MONTHLY",
    "BIMONTHLY",
    "QUARTERLY",
    "BIANNUALLY",
    "ANNUALLY",
    "OTHERS",
    null
  ],
  "type": "string",
  "example": "MONTHLY",
  "nullable": true,
  "description": "Indicates how often the business declares their revenue. We return one of the following values:\n  \n  - `DAILY`\n  - `WEEKLY`\n  - `FORTNIGHTLY`\n  - `MONTHLY`\n  - `BIMONTHLY`\n  - `QUARTERLY`\n  - `BIANNUALLY`\n  - `ANNUALLY`\n  - `OTHERS`\n  - `null`\n"
}

{
  "enum": [
    "SAVINGS_ACCOUNT",
    "CHECKING_ACCOUNT",
    null
  ],
  "type": "string",
  "example": "SAVINGS_ACCOUNT",
  "nullable": true,
  "description": "The additional products the business has at the institution. We return one of the following values:\n\n  - `SAVINGS_ACCOUNT`\n  - `CHECKING_ACCOUNT`\n  - `null`\n  \n"
}

{
  "enum": [
    "MOTHER",
    "FATHER",
    null
  ],
  "type": "string",
  "example": "MOTHER",
  "nullable": true,
  "description": "The familial relationship. We return one of the following values:\n\n  - `MOTHER`\n  - `FATHER`\n  - `null`\n  \n"
}

{
  "enum": [
    "FEMALE",
    "MALE",
    "OTHER"
  ],
  "type": "string",
  "example": "FEMALE",
  "nullable": true,
  "description": "The individual's gender. We return on of the following values:\n\n  - `FEMALE`\n  - `MALE`\n  - `OTHER`\n  \n"
}

{
  "enum": [
    "DRIVERS_LICENCE",
    "PASSPORT",
    "ID_CARD",
    "FISCAL_ID",
    "FOREIGNER_REGISTRATION_CARD",
    "OTHER",
    null
  ],
  "type": "string",
  "example": "DRIVERS_LICENCE",
  "nullable": true,
  "description": "The type of ID document. We return one of the following values:\n\n  - `DRIVERS_LICENCE`\n  - `PASSPORT`\n  - `ID_CARD`\n  - `FISCAL_ID`\n  - `FOREIGNER_REGISTRATION_CARD`\n  - `OTHER`\n  - `null`\n  \n"
}

{
  "enum": [
    "BRAZIL_PUBLIC_OFFICE",
    "BRAZIL_OCCUPATION_CODE",
    "OTHER",
    null
  ],
  "type": "string",
  "example": "BRAZIL_OCCUPATION_CODE",
  "nullable": true,
  "description": "The area of employment of the individual. We return one of the following values:\n\n  - `BRAZIL_PUBLIC_OFFICE`\n  - `BRAZIL_OCCUPATION_CODE`\n  - `OTHER`\n  - `null`\n"
}

{
  "enum": [
    "SAVINGS_ACCOUNT",
    "CHECKING_ACCOUNT",
    null
  ],
  "type": "string",
  "example": "SAVINGS_ACCOUNT",
  "nullable": true,
  "description": "The additional products the individual has at the institution. We return one of the following values:\n\n  - `SAVINGS_ACCOUNT`\n  - `CHECKING_ACCOUNT`\n  - `null`\n"
}

{
  "enum": [
    "DAILY",
    "WEEKLY",
    "FORTNIGHTLY",
    "MONTHLY",
    "BIMONTHLY",
    "QUARTERLY",
    "BIANNUALLY",
    "ANNUALLY",
    "OTHERS"
  ],
  "type": "string",
  "example": "MONTHLY",
  "nullable": true,
  "description": "Indicates how often the individual receives their salary. We return one of the following values:\n\n  - `DAILY`\n  - `WEEKLY`\n  - `FORTNIGHTLY`\n  - `MONTHLY`\n  - `BIMONTHLY`\n  - `QUARTERLY`\n  - `BIANNUALLY`\n  - `ANNUALLY`\n  - `OTHERS`\n"
}

{
  "enum": [
    "SINGLE",
    "MARRIED",
    "WIDOWED",
    "SEPARATED",
    "DIVORCED",
    "CIVIL_UNION",
    "OTHER"
  ],
  "type": "string",
  "example": "SINGLE",
  "nullable": true,
  "description": "The individual's marital status. We return one of the following values:\n\n  - `SINGLE`\n  - `MARRIED`\n  - `WIDOWED`\n  - `SEPARATED`\n  - `DIVORCED`\n  - `CIVIL_UNION`\n  - `OTHER`\n"
}

{
  "enum": [
    "CPF",
    "CNPJ",
    "OTHER_TRAVEL_DOCUMENT",
    "PASSPORT"
  ],
  "type": "string",
  "example": "CPF",
  "nullable": true,
  "description": "The type of ID document the party provided when being added to the account. We return one of the following values:\n\n  - `CPF`\n  - `CNPJ`\n  - `OTHER_TRAVEL_DOCUMENT`\n  - `PASSPORT`\n"
}

{
  "enum": [
    "INDIVIDUAL",
    "COMPANY"
  ],
  "type": "string",
  "example": "INDIVIDUAL",
  "nullable": true,
  "description": "The type of person that is an ownership party of the account. We return one of the following values:\n\n  - `INDIVIDUAL`\n  - `COMPANY`\n  \n"
}

{
  "enum": [
    "MEMBER",
    "ADMINISTRATOR"
  ],
  "type": "string",
  "example": "MEMBER",
  "nullable": true,
  "description": "The access type that the `person_type` has to the account. We return one of the following values:\n\n- `MEMBER` indicates that the `person_type` has read access to the account.\n- `ADMINISTRATOR` indicates that the `person_type` can perform all actions for the account (including transfers).\n"
}

{
  "enum": [
    "LANDLINE",
    "MOBILE",
    "OTHER",
    null
  ],
  "type": "string",
  "example": "MOBILE",
  "nullable": true,
  "description": "The type of phone number. We return one of the following values:\n\n  - `LANDLINE`\n  - `MOBILE`\n  - `OTHER`\n  - `null`\n"
}

{
  "enum": [
    "LEGAL_REPRESENTATIVE",
    "ATTORNEY",
    null
  ],
  "type": "string",
  "example": "LEGAL_REPRESENTATIVE",
  "nullable": true,
  "description": "The type of representative that can access and make changes to the account. We return one of the following values:\n\n  - `LEGAL_REPRESENTATIVE`\n  - `ATTORNEY`\n  - `null`\n  \n"
}

{
  "enum": [
    "Bills & Utilities",
    "Credits & Loans",
    "Insurance",
    "Online Platforms & Leisure",
    "Transport & Travel",
    "Taxes"
  ],
  "type": "string",
  "example": "Online Platforms & Leisure",
  "description": "The transaction category for the recurring expense. For more information on the available categories, please see our [Transaction categorization documentation](https://developers.belvo.com/docs/banking#categorizing-transactions).\n\n- `Online Platforms & Leisure` (Netflix, Spotify, Gym Memberships)\n- `Bills & Utilities` (electricity, telephone, internet)\n- `Credits & Loans` (credit card cash advances, student loan, watercraft lease)\n- `Insurance` (home, car, and health & life insurance)\n- `Transport & Travel` (Uber trip, airbnb, parking)\n- `Taxes` (service fee, donation, court taxes)\n"
}

{
  "enum": [
    "MONTHLY"
  ],
  "type": "string",
  "default": "MONTHLY",
  "example": "MONTHLY",
  "description": "The frequency at which this recurring expense occurs.\n\n\nℹ️ **Note:** Belvo only identifies `MONTHLY` frequencies.\n"
}

{
  "enum": [
    "SUBSCRIPTION",
    "REGULAR"
  ],
  "type": "string",
  "example": "SUBSCRIPTION",
  "nullable": true,
  "description": "The type of recurring expense. We return one of the following values:\n\n  - `SUBSCRIPTION`\n  - `REGULAR`\n"
}

{
  "enum": [
    "INFLOW",
    "OUTFLOW"
  ],
  "type": "string",
  "example": "INFLOW",
  "nullable": true,
  "description": "The direction of the transaction:\n  \n- `INFLOW` indicates money coming into the account.\n- `OUTFLOW` indicates money leaving the account.\n"
}

{
  "enum": [
    "POSITIVE",
    "NEGATIVE",
    "NO_OBLIGATIONS"
  ],
  "type": "string",
  "example": "NEGATIVE",
  "nullable": true,
  "description": "Indicates whether the taxpayer is complying to all their tax obligations\n(`POSITIVE`), if they are not (`NEGATIVE`), or have none to comply to\n(`NO_OBLIGATIONS`).\n"
}

{
  "enum": [
    "PAID",
    "PROVISIONED"
  ],
  "type": "string",
  "example": "PAID",
  "nullable": true,
  "description": "Indicates whether or not the tax has been paid or not. Can be either:\n  - `PAID`\n  - `PROVISIONED`\n"
}

{
  "enum": [
    "NATIONAL",
    "FOREIGN"
  ],
  "type": "string",
  "example": "NATIONAL",
  "nullable": true,
  "description": "Whether the invoice receiver is a Mexican national or not. If the receiver is not considered a Mexican national, the retained taxes can be calculated differently. Possible values:\n  - `NATIONAL`\n  - `FOREIGN`\n"
}

{
  "enum": [
    "OUTFLOW",
    "INFLOW"
  ],
  "type": "string",
  "example": "INFLOW",
  "description": "The type of tax retention in relation to the invoice (from the perspective of the Link owner).\n\n- `OUTFLOW` relates to a tax retention for a sent invoice.\n- `INFLOW` related to a tax retention for a received invoice.\n"
}

{
  "enum": [
    "PAID",
    "CLOSED",
    "OPEN",
    "FUTURE",
    null
  ],
  "type": "string",
  "example": "PAID",
  "nullable": true,
  "description": "The status of the bill that the transaction appears on. Can be one of:\n\n  - `PAID`: The bill has been paid in full.\n  - `CLOSED`: The bill has been closed by the institution.\n  - `OPEN`: The bill is currently open. (Note: This is the main bill that Belvo retrieves balance data from).\n  - `FUTURE`: The bill is pending.\n  - `null`: No bill status was identified.\n  \nℹ️ Note: Some banks consider CLOSED as PAID. \n"
}