generated: '2026-10-12' method: derived generator: derive-vocabulary.py source: - openapi/plaid-account-information-api-openapi.yml - openapi/plaid-account-statements-api-openapi.yml - openapi/plaid-account-transactions-api-openapi.yml - openapi/plaid-asset-transfer-networks-information-api-openapi.yml - openapi/plaid-payment-networks-information-api-openapi.yml vocabulary: name: Plaid Domain Vocabulary description: 'Terms declared by Plaid''s own API contract: its resource groups, objects and enumerations, with the contract''s definitions. Derived, not authored.' version: '2026-10-12' terms: - term: Account Information definition: Search and view customer accounts tags: - Resource Group source: openapi/plaid-account-information-api-openapi.yml - term: Account Statements definition: Search and retrieve account statements tags: - Resource Group source: openapi/plaid-account-statements-api-openapi.yml - term: Account Transactions definition: Search and view account transactions tags: - Resource Group source: openapi/plaid-account-transactions-api-openapi.yml - term: Asset Transfer Networks Information definition: Search and view asset transfer networks tags: - Resource Group source: openapi/plaid-asset-transfer-networks-information-api-openapi.yml - term: Payment Networks Information definition: Search and view account payment networks tags: - Resource Group source: openapi/plaid-payment-networks-information-api-openapi.yml - term: Personal Information definition: Search and view customer or customers tags: - Resource Group source: openapi/plaid-personal-information-api-openapi.yml - term: ISO 4217 Code definition: Currency, fund and precious metal codes effective from June 25, 2024 per [ISO 4217 Currency Code Maintenance](https://www.six-group.com/en/products-services/financial-information/data-standards.html). ZWL (the Zimbabwean dollar) expires August 31, 2024 and is deprecated and replaced with ZWG (Zimbabwe Gold), effective on June 25, 2024. tags: - Enumeration source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/Iso4217Code - term: LineOfCreditAccountType definition: The account type. Plaid consumes basic balance account information from the `accounts/{accountId}` endpoint for a subset of the possible account types described in the FDX specification. tags: - Enumeration source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/LineOfCreditAccountType - term: Scheduled Payment Type definition: The type of a payment scheduled on the account tags: - Enumeration source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/ScheduledPaymentType - term: Loan Account entity definition: Full details of a loan account. The `accountType` field for loan accounts may be set to any of the [account types](#loan-account-types) listed below. Revolving debt, where the balance can be drawn on again after it is paid down, belongs under `LOC_ACCOUNT` instead. Plaid only consumes the `MORTGAGE` and `STUDENTLOAN` types for its [Liabilities API](https://plaid.com/docs/api/products/liabilities/) tags: - Object source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/LoanAccount - term: Tax Lot entity definition: Block of securities receiving the same tax treatment tags: - Object source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/TaxLot - term: CommercialAccountDescriptor definition: A commercial account. For example, a business deposit account. The `accountType` field for commercial accounts may be set to any of the [account types](#commercial-account-types) listed below. **Note:** Commercial accounts are discoverable-only. Plaid does not consume downstream data (balances, transactions, Auth) for commercial accounts. tags: - Object source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/CommercialAccountDescriptor - term: Bills entity definition: Statements of payments due for an account tags: - Object source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/Bills - term: InsuranceAccountType definition: The account type. Plaid consumes basic balance account information from the `accounts/{accountId}` endpoint for a subset of the possible account types described in the FDX specification. tags: - Enumeration source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/InsuranceAccountType - term: Funding Source definition: Accounts for customer's alternate funding sources from which FI can transfer funds to cover transactions if customer has overdraft protection from a consented account. In the order of which accounts will be attempted to transfer the coverage amount needed. Contains masked or truncated account number or nickname, account type and/or institution name for full clarity on an internal or external fundi tags: - Object source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/FundingSource - term: LineOfCreditAccount definition: Full details of a line of credit account. The `accountType` field for line of credit accounts may be set to any of the [account types](#line-of-credit-account-types) listed below. This category covers revolving debt, where the balance can be drawn on again after it is paid down; non-revolving debt belongs under `LOAN_ACCOUNT`. Plaid consumes the following parameters returned by the `GET /accounts` tags: - Object source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/LineOfCreditAccount - term: Paginated Array definition: Base class for results that may be paginated tags: - Object source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/PaginatedArray - term: Position Type definition: The type of an investment position tags: - Enumeration source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/PositionType - term: InsuranceAccountDescriptor definition: 'An insurance account. For example, whole life insurance or short-term disability. The `accountType` field for insurance accounts may be set to any of the following: - `LONGTERMDISABILITY`: Insurance that replaces a portion of the policyholder''s income due to a disability for an extended period of time, usually more than a year. - `SHORTTERMDISABILITY`: Insurance that replaces a portion of the poli' tags: - Object source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/InsuranceAccountDescriptor - term: DepositAccountType definition: The account type. Plaid consumes basic balance account information from the `accounts/{accountId}` endpoint for a subset of the possible account types described in the FDX specification. tags: - Enumeration source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/DepositAccountType - term: AnnuityAccountDescriptor definition: 'An annuity account. For example, a fixed or variable annuity account. The `accountType` field for annuity accounts may be set to any of the following: - `ANNUITY`: A form of insurance or investment entitling the investor to a series of annual sums. - `FIXEDANNUITY`: A type of insurance contract that promises to pay the buyer a specific, guaranteed interest rate on their contributions to the accoun' tags: - Object source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/AnnuityAccountDescriptor - term: InvestmentAccountDescriptor definition: 'An investment account. For example, a 401K or IRA. Plaid consumes the same details for all investment accounts. The `accountType` field for investment accounts may be set to any of the following: - `401A`: An employer-sponsored money-purchase retirement plan that allows dollar or percentage-based contributions from the employer, the employee, or both. - `401K`: An employer-sponsored defined-contri' tags: - Object source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/InvestmentAccountDescriptor - term: Timestamp definition: ISO 8601 date-time in format `YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm]` according to [IETF RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) Send UTC or a local time with its correct offset. Plaid doesn't normalize timestamps, so a local time labeled `Z` is read as UTC. tags: - Object source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/Timestamp - term: InvestmentAccount definition: 'Full details of an investment account. Plaid consumes all `InvestmentAccount` FDX fields for all types of investment accounts. In the holdings array, Plaid consumes fields depending on their relevancy to the holding type. See the `holdings` array for more information. Plaid expects a decimal amount with two places (to represent fractional values of the base currency) for all monetary amounts. For ' tags: - Object source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/InvestmentAccount - term: DigitalWalletType definition: The account type. Plaid consumes basic balance account information from the `accounts/{accountId}` endpoint for a subset of the possible account types described in the FDX specification. tags: - Enumeration source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/DigitalWalletType - term: Holding Type definition: Plaid maps the holding type to the Plaid [security type](https://plaid.com/docs/api/products/investments/#investments-holdings-get-response-securities-type). Plaid expects you to return `OTHER` and set the `holdingSubType` to indicate cash-type holdings (`CASH`, `MONEYMARKET`). tags: - Enumeration source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/HoldingType - term: DepositAccountDescriptor definition: 'A deposit account. For example, a checking, savings or money market account. Plaid consumes more detailed information for `CHECKING` and `SAVINGS` accounts. The `accountType` field for deposit accounts may be set to any of the following: - `CHECKING`: A deposit account held at a financial institution that allows withdrawals and deposits. - `SAVINGS`: An interest-bearing deposit account held at a b' tags: - Object source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/DepositAccountDescriptor - term: Account Descriptor entity definition: This descriptor provides minimal information about the account for use in lightweight arrays tags: - Object source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/AccountDescriptor - term: AnnuityAccountType definition: The account type. Plaid consumes basic balance account information from the `accounts/{accountId}` endpoint for a subset of the possible account types described in the FDX specification. tags: - Enumeration source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/AnnuityAccountType - term: Date String definition: ISO 8601 full-date in format 'YYYY-MM-DD' according to [IETF RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) tags: - Object source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/DateString - term: Security ID Type definition: Plaid consumes solely CUSIP, ISIN, and SEDOL. This field, along with `securityId` are **required** unless `symbol` is provided. **Note:** If `securityIdType` is provided, `securityId` is required. tags: - Enumeration source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/SecurityIdType - term: InvestmentAccountType definition: The account type. Plaid consumes basic balance account information from the `accounts/{accountId}` endpoint for a subset of the possible account types described in the FDX specification. tags: - Enumeration source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/InvestmentAccountType - term: Account entity definition: This provides an instance of an account without full details. Plaid expects that the `accountType` field is set to one of the [account types](#account-types) listed below tags: - Object source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/AccountWithDescriptor - term: Accounts entity definition: An optionally paginated array of account descriptors. Each account descriptor carries a required `accountCategory` field identifying its type; see the `AccountCategory` schema for the full list of values. tags: - Object source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/Accounts - term: Account Category type definition: The category of account. For example, annuity, commercial, deposit, digital wallet, insurance, investment, loan, or line of credit. tags: - Enumeration source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/AccountCategory - term: Holding entity definition: A holding in an investment account. Holdings in the investment account. Plaid maps the `holding` and the `investmentAccount` FDX models to its securities models, which hold universal information like the ticker symbol, and to its holdings models, which hold account-specific information like balances. For more information, see [Plaid investments](https://plaid.com/docs/investments/#securities-and-h tags: - Object source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/Holding - term: Currency entity definition: A currency object containing an [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. tags: - Object source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/Currency - term: Page Metadata definition: Contains the opaque identifier, `nextPageKey`, to indicate a paginated result set. The `nextOffset` identifier is deprecated and will be removed with a future major release. tags: - Object source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/PageMetadata - term: FI Attribute entity definition: 'Financial institution-specific attribute. Sent as an array of name/value pairs, not a keyed object, with string values: `[{"name": "isCashEquivalent", "value": "false"}]`, not `{"isCashEquivalent": false}`. `isCashEquivalent` must be `"true"` or `"false"`.' tags: - Object source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/FiAttribute - term: LineOfCreditAccountDescriptor definition: 'A line-of-credit account. For example, a credit card or home equity line of credit. This category covers revolving debt, where the balance can be drawn on again after it is paid down; non-revolving debt belongs under `LOAN_ACCOUNT`. Plaid consumes more detailed information for `CREDITCARD` accounts. The `accountType` field for line of credit accounts may be set to any of the following: - `LINEOFCR' tags: - Object source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/LineOfCreditAccountDescriptor - term: Interest Rate entity definition: Full description of a single interest rate tags: - Object source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/InterestRate - term: LoanAccountType definition: The account type. Plaid consumes basic balance account information from the `accounts/{accountId}` endpoint for a subset of the possible account types described in the FDX specification. tags: - Enumeration source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/LoanAccountType - term: Holding SubType definition: The subtype of an investment holding. Set this to `CASH` or `MONEYMARKET` to indicate a cash-type holding, with `holdingType` set to `OTHER`. tags: - Enumeration source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/HoldingSubType - term: DigitalWalletDescriptor definition: Information for a digital wallet account **Note:** Digital wallet accounts are discoverable-only. Plaid does not consume downstream data (balances, transactions, Auth) for digital wallet accounts. tags: - Object source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/DigitalWalletDescriptor - term: Scheduled Payments entity definition: The payments scheduled on the account tags: - Object source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/ScheduledPayments - term: CommercialAccountType definition: The account type. Plaid consumes basic balance account information from the `accounts/{accountId}` endpoint for a subset of the possible account types described in the FDX specification. tags: - Enumeration source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/CommercialAccountType - term: Account Status definition: Account status. Use `RESTRICTED`, with a normal 200, for a locked or limited account that's still open — not FDX error 705, which means closed. tags: - Enumeration source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/AccountStatus - term: Identifier definition: Value for a unique identifier tags: - Object source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/Identifier - term: Deposit Account Details entity definition: 'Full details of a deposit account. Plaid consumes the same information for all types of deposit accounts. Plaid expects a decimal amount with two places (to represent fractional values of the base currency) for all monetary amounts. For example, `"currentBalance": 192.00`. The `accountType` field for deposit accounts may be set to any of the [account types](#deposit-account-types) listed below.' tags: - Object source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/DepositAccount - term: Compounding Period definition: Interest compounding Period tags: - Enumeration source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/CompoundingPeriod - term: Account With Details entity definition: An account with full details. tags: - Object source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/AccountWithDetails - term: LoanAccountDescriptor definition: 'A loan account. For example, mortgage, student loan or auto loan. Revolving debt, where the balance can be drawn on again after it is paid down, belongs under `LOC_ACCOUNT` instead. Plaid consumes more detailed information for `MORTGAGE` and `STUDENTLOAN` accounts. The `accountType` field for loan accounts may be set to any of the following: - `AUTOLOAN`: A type of loan used to finance a car purch' tags: - Object source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/LoanAccountDescriptor - term: Security ID entity definition: Unique identifier for a security tags: - Object source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/SecurityId - term: Interest Rate Type definition: Specifies whether an interest rate is fixed or variable. This information is helpful for personal financial planning and advising. For example, it affects the potential benefits of refinancing, and informs whether a mortgage payment is expected to change in the future tags: - Enumeration source: openapi/plaid-account-information-api-openapi.yml#/components/schemas/InterestRateType - term: HATEOAS Link definition: HATEOAS (Hypermedia As The Engine Of Application State) link tags: - Object source: openapi/plaid-account-statements-api-openapi.yml#/components/schemas/HateoasLink - term: Statements entity definition: A paginated array of account statements. Return only statements within the requested window. Returning full history makes the same statement reappear on every extraction. tags: - Object source: openapi/plaid-account-statements-api-openapi.yml#/components/schemas/Statements - term: HATEOAS links array definition: An array of HATEOAS links tags: - Object source: openapi/plaid-account-statements-api-openapi.yml#/components/schemas/HateoasLinks - term: Statement entity definition: An account statement tags: - Object source: openapi/plaid-account-statements-api-openapi.yml#/components/schemas/Statement - term: Content Types definition: Types of document formats. (Suggested values) tags: - Enumeration source: openapi/plaid-account-statements-api-openapi.yml#/components/schemas/ContentTypes - term: Statement PDF definition: An account statement in PDF format. Each statement must carry distinct, non-empty binary content. Plaid rejects duplicates and invalid payloads. tags: - Object source: openapi/plaid-account-statements-api-openapi.yml#/components/schemas/StatementPDF - term: HTTP action type definition: The HTTP method to use for requests tags: - Enumeration source: openapi/plaid-account-statements-api-openapi.yml#/components/schemas/HttpAction - term: Investment Transaction Type definition: 'The type of an investment transaction. Plaid maps these enums to Plaid [investment transaction types](https://plaid.com/docs/api/accounts/#investment-transaction-types-schema). Plaid doesn''t map these enums to Plaid-specific transaction subtypes. Plaid maps these enums as follows: * ADJUSTMENT - fee * ATM - cash * CASH - cash * CHECK - cash * CLOSURE - Plaid suggests using SOLDTOCLOSE, PURCHASETOC' tags: - Enumeration source: openapi/plaid-account-transactions-api-openapi.yml#/components/schemas/InvestmentTransactionType - term: Transactions entity definition: A page of transactions for an account, spanning deposit, investment, loan, and line-of-credit transaction types. tags: - Object source: openapi/plaid-account-transactions-api-openapi.yml#/components/schemas/Transactions - term: Transaction definition: Base entity for financial transactions. For monetary amounts, Plaid expects a decimal amount, with two places to represent fractional values of the base currency, for example `101.99` tags: - Object source: openapi/plaid-account-transactions-api-openapi.yml#/components/schemas/Transaction - term: Investment Transaction entity definition: 'A transaction on an investment account. In addition to the required fields in the base `Transaction` model, Plaid requires the following fields for all transactions on an investment account: * `fees` * `transactionType` If the transaction involves a security, Plaid additionally requires the following fields: * `unitPrice` * `units` * `symbol` OR both `securityId` and `securityIdType`' tags: - Object source: openapi/plaid-account-transactions-api-openapi.yml#/components/schemas/InvestmentTransaction - term: Deposit Transaction entity definition: A transaction on a deposit account type tags: - Object source: openapi/plaid-account-transactions-api-openapi.yml#/components/schemas/DepositTransaction - term: Transaction Status definition: The status of a transaction. Plaid consumes solely the `PENDING` and `POSTED` enums, and treats `MEMO` and `AUTHORIZATION` as if they were `PENDING`. Plaid expects that pending and posted transactions have different `transactionIds`. * `AUTHORIZATION` * `MEMO` - A pending transaction to be completed at the end of this day * `PENDING` - A pending transaction * `POSTED` - A posted transaction tags: - Enumeration source: openapi/plaid-account-transactions-api-openapi.yml#/components/schemas/TransactionStatus - term: Unit Type definition: The units of an investment transaction tags: - Enumeration source: openapi/plaid-account-transactions-api-openapi.yml#/components/schemas/UnitType - term: String 255 definition: String with a maximum length of 255 characters tags: - Object source: openapi/plaid-account-transactions-api-openapi.yml#/components/schemas/String255 - term: Loan Transaction entity definition: A transaction on a loan account tags: - Object source: openapi/plaid-account-transactions-api-openapi.yml#/components/schemas/LoanTransaction - term: Line-Of-Credit Transaction entity definition: A line-of-credit transaction tags: - Object source: openapi/plaid-account-transactions-api-openapi.yml#/components/schemas/LineOfCreditTransaction - term: Loan Transaction Type definition: 'The type of a loan transaction. Plaid passes through all loan transaction types - `ADJUSTMENT`: Adjustment or correction. - `FEE`: Fee charge. For example, a late payment fee. - `INTEREST`: Interest charge. - `PAYMENT`: Required payment that satisfies the minimum payment (e.g. principal + interest for mortgages). - `LUMP_SUM_PAYMENT`: A single payment of money, as opposed to a series of payments m' tags: - Enumeration source: openapi/plaid-account-transactions-api-openapi.yml#/components/schemas/LoanTransactionType - term: Line-Of-Credit Transaction Type definition: The type of a line of credit (LOC) transaction. Plaid passes through all LOC transaction types tags: - Enumeration source: openapi/plaid-account-transactions-api-openapi.yml#/components/schemas/LineOfCreditTransactionType - term: Security Type definition: The type of a security tags: - Enumeration source: openapi/plaid-account-transactions-api-openapi.yml#/components/schemas/SecurityType - term: DebitCreditMemo definition: 'The posting type of a transaction. Because the transaction `amount` is an absolute value, this parameter is required to indicate the transaction direction and sign (+/-): - `DEBIT`: Money is leaving the account. The transaction amount will be exposed with a **positive** sign (+) - `CREDIT`: Money is entering the account. The transaction amount will be exposed with a **negative** sign (-) - `MEMO`:' tags: - Enumeration source: openapi/plaid-account-transactions-api-openapi.yml#/components/schemas/DebitCreditMemo - term: Payment Network Identifier Type definition: The type of identifier used to identify the account in the payment network tags: - Enumeration source: openapi/plaid-asset-transfer-networks-information-api-openapi.yml#/components/schemas/PaymentNetworkIdentifierType - term: Asset Transfer Type definition: The type of asset transfer tags: - Enumeration source: openapi/plaid-asset-transfer-networks-information-api-openapi.yml#/components/schemas/AssetTransferType - term: Asset Transfer Networks definition: A paginated array of asset transfer networks for the account tags: - Object source: openapi/plaid-asset-transfer-networks-information-api-openapi.yml#/components/schemas/AssetTransferNetworkList - term: Asset Transfer Network definition: Information required to facilitate asset transfer from this account tags: - Object source: openapi/plaid-asset-transfer-networks-information-api-openapi.yml#/components/schemas/AssetTransferNetwork - term: Payment Networks entity definition: Array of payment networks. Not all deposit accounts support ACH transfers. For example, a prepaid debit card account doesn't support ACH tags: - Object source: openapi/plaid-payment-networks-information-api-openapi.yml#/components/schemas/AccountPaymentNetworkList