Plaid logo
Docs
ALL DOCS

API

  • Overview
  • Libraries
  • API versioning
  • Postman Collection
  • Webhooks
Payments and Funding
  • Auth
  • Balance
  • Identity
  • Signal
  • Transfer
  • Investments Move
  • Payment Initiation
  • Virtual Accounts
Financial Insights
  • Transactions
  • Investments
  • Liabilities
  • Enrich
KYC/AML and anti-fraud
  • Look up Dashboard users
  • Identity Verification
  • Protect
  • Monitor
  • Beacon (beta)
Instant Onboarding
  • Layer
Credit and Underwriting
  • Consumer Report (by Plaid Check)
  • Assets
  • Statements
  • Income
Fundamentals
  • Items
  • Accounts
  • Institutions
  • Sandbox
  • Link
  • Users
  • Consent
  • Network
  • OAuth
Partnerships
  • Processor tokens
  • Processor partners
  • Reseller partners
Plaid logo
Docs
Close search modal
Ask Bill!
Ask Bill!
Hi! I'm Bill! You can ask me all about the Plaid API. Try asking questions like:
    Note: Bill isn't perfect. He's just a robot platypus that reads our docs for fun. You should treat his answers with the same healthy skepticism you might treat any other answer on the internet. This chat may be logged for quality and training purposes. Please don't send Bill any PII -- he's scared of intimacy. All chats with Bill are subject to Plaid's Privacy Policy.
    Plaid.com
    Log in
    Get API Keys
    Open nav

    Accounts

    API reference for retrieving account information and seeing all possible account types and subtypes

    /accounts/get

    Retrieve accounts

    The /accounts/get endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts — that is, accounts that are not closed and are capable of carrying a balance. To return new accounts that were created after the user linked their Item, you can listen for the NEW_ACCOUNTS_AVAILABLE webhook and then use Link's update mode to request that the user share this new account with you.
    /accounts/get is free to use and retrieves cached information, rather than extracting fresh information from the institution. The balance returned will reflect the balance at the time of the last successful Item update. If the Item is enabled for a regularly updating product, such as Transactions, Investments, or Liabilities, the balance will typically update about once a day, as long as the Item is healthy. If the Item is enabled only for products that do not frequently update, such as Auth or Identity, balance data may be much older.
    For realtime balance information, use the paid endpoint /accounts/balance/get instead.

    accounts/get

    Request fields and example

    client_id
    stringstring
    Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.
    secret
    stringstring
    Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.
    access_token
    requiredstringrequired, string
    The access token associated with the Item data is being requested for.
    options
    objectobject
    An optional object to filter /accounts/get results.
    account_ids
    [string][string]
    An array of account_ids to retrieve for the Account.
    Select group for content switcher
    Select Language
    1const request: AccountsGetRequest = {
    2 access_token: ACCESS_TOKEN,
    3};
    4try {
    5 const response = await plaidClient.accountsGet(request);
    6 const accounts = response.data.accounts;
    7} catch (error) {
    8 // handle error
    9}
    accounts/get

    Response fields and example

    accounts
    [object][object]
    An array of financial institution accounts associated with the Item. If /accounts/balance/get was called, each account will include real-time balance information.
    account_id
    stringstring
    Plaid’s unique identifier for the account. This value will not change unless Plaid can't reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new account_id will be assigned to the account.
    The account_id can also change if the access_token is deleted and the same credentials that were used to generate that access_token are used to generate a new access_token on a later date. In that case, the new account_id will be different from the old account_id.
    If an account with a specific account_id disappears instead of changing, the account is likely closed. Closed accounts are not returned by the Plaid API.
    Like all Plaid identifiers, the account_id is case sensitive.
    balances
    objectobject
    A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by /accounts/balance/get.
    available
    nullablenumbernullable, number
    The amount of funds available to be withdrawn from the account, as determined by the financial institution.
    For credit-type accounts, the available balance typically equals the limit less the current balance, less any pending outflows plus any pending inflows.
    For depository-type accounts, the available balance typically equals the current balance less any pending outflows plus any pending inflows. For depository-type accounts, the available balance does not include the overdraft limit.
    For investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier), the available balance is the total cash available to withdraw as presented by the institution.
    Note that not all institutions calculate the available balance. In the event that available balance is unavailable, Plaid will return an available balance value of null.
    Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by /accounts/balance/get.
    If current is null this field is guaranteed not to be null.


    Format: double
    current
    nullablenumbernullable, number
    The total amount of funds in or owed by the account.
    For credit-type accounts, a positive balance indicates the amount owed; a negative amount indicates the lender owing the account holder.
    For loan-type accounts, the current balance is the principal remaining on the loan, except in the case of student loan accounts at Sallie Mae (ins_116944). For Sallie Mae student loans, the account's balance includes both principal and any outstanding interest. Similar to credit-type accounts, a positive balance is typically expected, while a negative amount indicates the lender owing the account holder.
    For investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier), the current balance is the total value of assets as presented by the institution.
    Note that balance information may be cached unless the value was returned by /accounts/balance/get; if the Item is enabled for Transactions, the balance will be at least as recent as the most recent Transaction update. If you require realtime balance information, use the available balance as provided by /accounts/balance/get.
    When returned by /accounts/balance/get, this field may be null. When this happens, available is guaranteed not to be null.


    Format: double
    limit
    nullablenumbernullable, number
    For credit-type accounts, this represents the credit limit.
    For depository-type accounts, this represents the pre-arranged overdraft limit, which is common for current (checking) accounts in Europe.
    In North America, this field is typically only available for credit-type accounts.


    Format: double
    iso_currency_code
    nullablestringnullable, string
    The ISO-4217 currency code of the balance. Always null if unofficial_currency_code is non-null.
    unofficial_currency_code
    nullablestringnullable, string
    The unofficial currency code associated with the balance. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
    See the currency code schema for a full listing of supported unofficial_currency_codes.
    last_updated_datetime
    nullablestringnullable, string
    Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the last time the balance was updated.
    This field is returned only when the institution is ins_128026 (Capital One).


    Format: date-time
    mask
    nullablestringnullable, string
    The last 2-4 alphanumeric characters of either the account’s displayed mask or the account’s official account number. Note that the mask may be non-unique between an Item’s accounts.
    name
    stringstring
    The name of the account, either assigned by the user or by the financial institution itself
    official_name
    nullablestringnullable, string
    The official name of the account as given by the financial institution
    type
    stringstring
    investment: Investment account. In API versions 2018-05-22 and earlier, this type is called brokerage instead.
    credit: Credit card
    depository: Depository account
    loan: Loan account
    other: Non-specified account type
    See the Account type schema for a full listing of account types and corresponding subtypes.


    Possible values: investment, credit, depository, loan, brokerage, other
    subtype
    nullablestringnullable, string
    See the Account type schema for a full listing of account types and corresponding subtypes.

    Possible values: 401a, 401k, 403B, 457b, 529, auto, brokerage, business, cash isa, cash management, cd, checking, commercial, construction, consumer, credit card, crypto exchange, ebt, education savings account, fixed annuity, gic, health reimbursement arrangement, home equity, hsa, isa, ira, keogh, lif, life insurance, line of credit, lira, loan, lrif, lrsp, money market, mortgage, mutual fund, non-custodial wallet, non-taxable brokerage account, other, other insurance, other annuity, overdraft, paypal, payroll, pension, prepaid, prif, profit sharing plan, rdsp, resp, retirement, rlif, roth, roth 401k, rrif, rrsp, sarsep, savings, sep ira, simple ira, sipp, stock plan, student, thrift savings plan, tfsa, trust, ugma, utma, variable annuity
    verification_status
    stringstring
    The current verification status of an Auth Item initiated through micro-deposits or database verification. Returned for Auth Items only.
    pending_automatic_verification: The Item is pending automatic verification
    pending_manual_verification: The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the micro-deposit.
    automatically_verified: The Item has successfully been automatically verified
    manually_verified: The Item has successfully been manually verified
    verification_expired: Plaid was unable to automatically verify the deposit within 7 calendar days and will no longer attempt to validate the Item. Users may retry by submitting their information again through Link.
    verification_failed: The Item failed manual micro-deposit verification because the user exhausted all 3 verification attempts. Users may retry by submitting their information again through Link.
    unsent: The Item is pending micro-deposit verification, but Plaid has not yet sent the micro-deposit.
    database_matched: The Item has successfully been verified using Plaid's data sources. Only returned for Auth Items created via Database Match.
    database_insights_pass: The Item's numbers have been verified using Plaid's data sources: the routing and account number match a routing and account number of an account recognized on the Plaid network, and the account is not known by Plaid to be frozen or closed. Only returned for Auth Items created via Database Auth.
    database_insights_pass_with_caution:The Item's numbers have been verified using Plaid's data sources and have some signal for being valid: the routing and account number were not recognized on the Plaid network, but the routing number is valid and the account number is a potential valid account number for that routing number. Only returned for Auth Items created via Database Auth.
    database_insights_fail: The Item's numbers have been verified using Plaid's data sources and have signal for being invalid and/or have no signal for being valid. Typically this indicates that the routing number is invalid, the account number does not match the account number format associated with the routing number, or the account has been reported as closed or frozen. Only returned for Auth Items created via Database Auth.


    Possible values: automatically_verified, pending_automatic_verification, pending_manual_verification, unsent, manually_verified, verification_expired, verification_failed, database_matched, database_insights_pass, database_insights_pass_with_caution, database_insights_fail
    verification_name
    stringstring
    The account holder name that was used for micro-deposit and/or database verification. Only returned for Auth Items created via micro-deposit or database verification. This name was manually-entered by the user during Link, unless it was otherwise provided via the user.legal_name request field in /link/token/create for the Link session that created the Item.
    verification_insights
    objectobject
    Insights from performing database verification for the account. Only returned for Auth Items using Database Auth.
    name_match_score
    nullableintegernullable, integer
    Indicates the score of the name match between the given name provided during database verification (available in the verification_name field) and matched Plaid network accounts. If defined, will be a value between 0 and 100. Will be undefined if name matching was not enabled for the database verification session or if there were no eligible Plaid network matches to compare the given name with.
    network_status
    objectobject
    Status information about the account and routing number in the Plaid network.
    has_numbers_match
    booleanboolean
    Indicates whether we found at least one matching account for the ACH account and routing number.
    is_numbers_match_verified
    booleanboolean
    Indicates if at least one matching account for the ACH account and routing number is already verified.
    previous_returns
    objectobject
    Information about known ACH returns for the account and routing number.
    has_previous_administrative_return
    booleanboolean
    Indicates whether Plaid's data sources include a known administrative ACH return for account and routing number.
    account_number_format
    stringstring
    Indicator of account number format validity for institution.
    valid: indicates that the account number has a correct format for the institution.
    invalid: indicates that the account number has an incorrect format for the institution.
    unknown: indicates that there was not enough information to determine whether the format is correct for the institution.


    Possible values: valid, invalid, unknown
    persistent_account_id
    stringstring
    A unique and persistent identifier for accounts that can be used to trace multiple instances of the same account across different Items for depository accounts. This field is currently supported only for Items at institutions that use Tokenized Account Numbers (i.e., Chase and PNC, and in May 2025 US Bank). Because these accounts have a different account number each time they are linked, this field may be used instead of the account number to uniquely identify an account across multiple Items for payments use cases, helping to reduce duplicate Items or attempted fraud. In Sandbox, this field is populated for TAN-based institutions (ins_56, ins_13) as well as the OAuth Sandbox institution (ins_127287); in Production, it will only be populated for accounts at applicable institutions.
    holder_category
    nullablestringnullable, string
    Indicates the account's categorization as either a personal or a business account. This field is currently in beta; to request access, contact your account manager.

    Possible values: business, personal, unrecognized
    item
    objectobject
    Metadata about the Item.
    item_id
    stringstring
    The Plaid Item ID. The item_id is always unique; linking the same account at the same institution twice will result in two Items with different item_id values. Like all Plaid identifiers, the item_id is case-sensitive.
    institution_id
    nullablestringnullable, string
    The Plaid Institution ID associated with the Item. Field is null for Items created without an institution connection, such as Items created via Same Day Micro-deposits.
    institution_name
    nullablestringnullable, string
    The name of the institution associated with the Item. Field is null for Items created without an institution connection, such as Items created via Same Day Micro-deposits.
    webhook
    nullablestringnullable, string
    The URL registered to receive webhooks for the Item.
    auth_method
    nullablestringnullable, string
    The method used to populate Auth data for the Item. This field is only populated for Items that have had Auth numbers data set on at least one of its accounts, and will be null otherwise. For info about the various flows, see our Auth coverage documentation.
    INSTANT_AUTH: The Item's Auth data was provided directly by the user's institution connection.
    INSTANT_MATCH: The Item's Auth data was provided via the Instant Match fallback flow.
    AUTOMATED_MICRODEPOSITS: The Item's Auth data was provided via the Automated Micro-deposits flow.
    SAME_DAY_MICRODEPOSITS: The Item's Auth data was provided via the Same Day Micro-deposits flow.
    INSTANT_MICRODEPOSITS: The Item's Auth data was provided via the Instant Micro-deposits flow.
    DATABASE_MATCH: The Item's Auth data was provided via the Database Match flow.
    DATABASE_INSIGHTS: The Item's Auth data was provided via the Database Insights flow.
    TRANSFER_MIGRATED: The Item's Auth data was provided via /transfer/migrate_account.
    INVESTMENTS_FALLBACK: The Item's Auth data for Investments Move was provided via a fallback flow.


    Possible values: INSTANT_AUTH, INSTANT_MATCH, AUTOMATED_MICRODEPOSITS, SAME_DAY_MICRODEPOSITS, INSTANT_MICRODEPOSITS, DATABASE_MATCH, DATABASE_INSIGHTS, TRANSFER_MIGRATED, INVESTMENTS_FALLBACK
    error
    nullableobjectnullable, object
    Errors are identified by error_code and categorized by error_type. Use these in preference to HTTP status codes to identify and handle specific errors. HTTP status codes are set and provide the broadest categorization of errors: 4xx codes are for developer- or user-related errors, and 5xx codes are for Plaid-related errors, and the status will be 2xx in non-error cases. An Item with a non-null error object will only be part of an API response when calling /item/get to view Item status. Otherwise, error fields will be null if no error has occurred; if an error has occurred, an error code will be returned instead.
    error_type
    stringstring
    A broad categorization of the error. Safe for programmatic use.

    Possible values: INVALID_REQUEST, INVALID_RESULT, INVALID_INPUT, INSTITUTION_ERROR, RATE_LIMIT_EXCEEDED, API_ERROR, ITEM_ERROR, ASSET_REPORT_ERROR, RECAPTCHA_ERROR, OAUTH_ERROR, PAYMENT_ERROR, BANK_TRANSFER_ERROR, INCOME_VERIFICATION_ERROR, MICRODEPOSITS_ERROR, SANDBOX_ERROR, PARTNER_ERROR, TRANSACTIONS_ERROR, TRANSACTION_ERROR, TRANSFER_ERROR, CHECK_REPORT_ERROR, CONSUMER_REPORT_ERROR
    error_code
    stringstring
    The particular error code. Safe for programmatic use.
    error_code_reason
    nullablestringnullable, string
    The specific reason for the error code. Currently, reasons are only supported OAuth-based item errors; null will be returned otherwise. Safe for programmatic use.
    Possible values: OAUTH_INVALID_TOKEN: The user’s OAuth connection to this institution has been invalidated.
    OAUTH_CONSENT_EXPIRED: The user's access consent for this OAuth connection to this institution has expired.
    OAUTH_USER_REVOKED: The user’s OAuth connection to this institution is invalid because the user revoked their connection.
    error_message
    stringstring
    A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.
    display_message
    nullablestringnullable, string
    A user-friendly representation of the error code. null if the error is not related to user action.
    This may change over time and is not safe for programmatic use.
    request_id
    stringstring
    A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.
    causes
    arrayarray
    In this product, a request can pertain to more than one Item. If an error is returned for such a request, causes will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified.
    causes will be provided for the error_type ASSET_REPORT_ERROR or CHECK_REPORT_ERROR. causes will also not be populated inside an error nested within a warning object.
    status
    nullableintegernullable, integer
    The HTTP status code associated with the error. This will only be returned in the response body when the error information is provided via a webhook.
    documentation_url
    stringstring
    The URL of a Plaid documentation page with more information about the error
    suggested_action
    nullablestringnullable, string
    Suggested steps for resolving the error
    available_products
    [string][string]
    A list of products available for the Item that have not yet been accessed. The contents of this array will be mutually exclusive with billed_products.

    Possible values: assets, auth, balance, balance_plus, beacon, identity, identity_match, investments, investments_auth, liabilities, payment_initiation, identity_verification, transactions, credit_details, income, income_verification, standing_orders, transfer, employment, recurring_transactions, transactions_refresh, signal, statements, processor_payments, processor_identity, profile, cra_base_report, cra_income_insights, cra_partner_insights, cra_network_insights, cra_cashflow_insights, layer, pay_by_bank, protect_linked_bank
    billed_products
    [string][string]
    A list of products that have been billed for the Item. The contents of this array will be mutually exclusive with available_products. Note - billed_products is populated in all environments but only requests in Production are billed. Also note that products that are billed on a pay-per-call basis rather than a pay-per-Item basis, such as balance, will not appear here.

    Possible values: assets, auth, balance, balance_plus, beacon, identity, identity_match, investments, investments_auth, liabilities, payment_initiation, identity_verification, transactions, credit_details, income, income_verification, standing_orders, transfer, employment, recurring_transactions, transactions_refresh, signal, statements, processor_payments, processor_identity, profile, cra_base_report, cra_income_insights, cra_partner_insights, cra_network_insights, cra_cashflow_insights, layer, pay_by_bank, protect_linked_bank
    products
    [string][string]
    A list of products added to the Item. In almost all cases, this will be the same as the billed_products field. For some products, it is possible for the product to be added to an Item but not yet billed (e.g. Assets, before /asset_report/create has been called, or Auth or Identity when added as Optional Products but before their endpoints have been called), in which case the product may appear in products but not in billed_products.

    Possible values: assets, auth, balance, balance_plus, beacon, identity, identity_match, investments, investments_auth, liabilities, payment_initiation, identity_verification, transactions, credit_details, income, income_verification, standing_orders, transfer, employment, recurring_transactions, transactions_refresh, signal, statements, processor_payments, processor_identity, profile, cra_base_report, cra_income_insights, cra_partner_insights, cra_network_insights, cra_cashflow_insights, layer, pay_by_bank, protect_linked_bank
    consented_products
    [string][string]
    A list of products that the user has consented to for the Item via Data Transparency Messaging. This will consist of all products where both of the following are true: the user has consented to the required data scopes for that product and you have Production access for that product.

    Possible values: assets, auth, balance, balance_plus, beacon, identity, identity_match, investments, investments_auth, liabilities, transactions, income, income_verification, transfer, employment, recurring_transactions, signal, statements, processor_payments, processor_identity, cra_base_report, cra_income_insights, cra_partner_insights, cra_cashflow_insights, layer
    consent_expiration_time
    nullablestringnullable, string
    The date and time at which the Item's access consent will expire, in ISO 8601 format. If the Item does not have consent expiration scheduled, this field will be null. Currently, only institutions in Europe and a small number of institutions in the US have expiring consent. Closer to the 1033 compliance deadline of April 1, 2026, expiration times will be populated more widely. For more details, see Data Transparency Messaging consent expiration.

    Format: date-time
    update_type
    stringstring
    Indicates whether an Item requires user interaction to be updated, which can be the case for Items with some forms of two-factor authentication.
    background - Item can be updated in the background
    user_present_required - Item requires user interaction to be updated


    Possible values: background, user_present_required
    request_id
    stringstring
    A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
    1{
    2 "accounts": [
    3 {
    4 "account_id": "blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo",
    5 "balances": {
    6 "available": 100,
    7 "current": 110,
    8 "iso_currency_code": "USD",
    9 "limit": null,
    10 "unofficial_currency_code": null
    11 },
    12 "holder_category": "personal",
    13 "mask": "0000",
    14 "name": "Plaid Checking",
    15 "official_name": "Plaid Gold Standard 0% Interest Checking",
    16 "subtype": "checking",
    17 "type": "depository"
    18 },
    19 {
    20 "account_id": "6PdjjRP6LmugpBy5NgQvUqpRXMWxzktg3rwrk",
    21 "balances": {
    22 "available": null,
    23 "current": 23631.9805,
    24 "iso_currency_code": "USD",
    25 "limit": null,
    26 "unofficial_currency_code": null
    27 },
    28 "mask": "6666",
    29 "name": "Plaid 401k",
    30 "official_name": null,
    31 "subtype": "401k",
    32 "type": "investment"
    33 },
    34 {
    35 "account_id": "XMBvvyMGQ1UoLbKByoMqH3nXMj84ALSdE5B58",
    36 "balances": {
    37 "available": null,
    38 "current": 65262,
    39 "iso_currency_code": "USD",
    40 "limit": null,
    41 "unofficial_currency_code": null
    42 },
    43 "mask": "7777",
    44 "name": "Plaid Student Loan",
    45 "official_name": null,
    46 "subtype": "student",
    47 "type": "loan"
    48 }
    49 ],
    50 "item": {
    51 "available_products": [
    52 "balance",
    53 "identity",
    54 "payment_initiation",
    55 "transactions"
    56 ],
    57 "billed_products": [
    58 "assets",
    59 "auth"
    60 ],
    61 "consent_expiration_time": null,
    62 "error": null,
    63 "institution_id": "ins_117650",
    64 "institution_name": "Royal Bank of Plaid",
    65 "item_id": "DWVAAPWq4RHGlEaNyGKRTAnPLaEmo8Cvq7na6",
    66 "update_type": "background",
    67 "webhook": "https://www.genericwebhookurl.com/webhook",
    68 "auth_method": "INSTANT_AUTH"
    69 },
    70 "request_id": "bkVE1BHWMAZ9Rnr"
    71}
    Was this helpful?

    Account type schema

    The schema below describes the various types and corresponding subtypes that Plaid recognizes and reports for financial institution accounts. For a mapping of supported types and subtypes to Plaid products, see the Account type / product support matrix.

    Properties

    depository
    stringstring
    An account type holding cash, in which funds are deposited.
    checking
    stringstring
    Checking account
    savings
    stringstring
    Savings account
    hsa
    stringstring
    Health Savings Account (US only) that can only hold cash
    cd
    stringstring
    Certificate of deposit account
    money market
    stringstring
    Money market account
    paypal
    stringstring
    PayPal depository account
    prepaid
    stringstring
    Prepaid debit card
    cash management
    stringstring
    A cash management account, typically a cash account at a brokerage
    ebt
    stringstring
    An Electronic Benefit Transfer (EBT) account, used by certain public assistance programs to distribute funds (US only)
    credit
    stringstring
    A credit card type account.
    credit card
    stringstring
    Bank-issued credit card
    paypal
    stringstring
    PayPal-issued credit card
    loan
    stringstring
    A loan type account.
    auto
    stringstring
    Auto loan
    business
    stringstring
    Business loan
    commercial
    stringstring
    Commercial loan
    construction
    stringstring
    Construction loan
    consumer
    stringstring
    Consumer loan
    home equity
    stringstring
    Home Equity Line of Credit (HELOC)
    loan
    stringstring
    General loan
    mortgage
    stringstring
    Mortgage loan
    overdraft
    stringstring
    Pre-approved overdraft account, usually tied to a checking account
    line of credit
    stringstring
    Pre-approved line of credit
    student
    stringstring
    Student loan
    other
    stringstring
    Other loan type or unknown loan type
    investment
    stringstring
    An investment account. In API versions 2018-05-22 and earlier, this type is called brokerage.
    529
    stringstring
    Tax-advantaged college savings and prepaid tuition 529 plans (US)
    401a
    stringstring
    Employer-sponsored money-purchase 401(a) retirement plan (US)
    401k
    stringstring
    Standard 401(k) retirement account (US)
    403B
    stringstring
    403(b) retirement savings account for non-profits and schools (US)
    457b
    stringstring
    Tax-advantaged deferred-compensation 457(b) retirement plan for governments and non-profits (US)
    brokerage
    stringstring
    Standard brokerage account
    cash isa
    stringstring
    Individual Savings Account (ISA) that pays interest tax-free (UK)
    crypto exchange
    stringstring
    Standard cryptocurrency exchange account
    education savings account
    stringstring
    Tax-advantaged Coverdell Education Savings Account (ESA) (US)
    fixed annuity
    stringstring
    Fixed annuity
    gic
    stringstring
    Guaranteed Investment Certificate (Canada)
    health reimbursement arrangement
    stringstring
    Tax-advantaged Health Reimbursement Arrangement (HRA) benefit plan (US)
    hsa
    stringstring
    Non-cash tax-advantaged medical Health Savings Account (HSA) (US)
    ira
    stringstring
    Traditional Individual Retirement Account (IRA) (US)
    isa
    stringstring
    Non-cash Individual Savings Account (ISA) (UK)
    keogh
    stringstring
    Keogh self-employed retirement plan (US)
    lif
    stringstring
    Life Income Fund (LIF) retirement account (Canada)
    life insurance
    stringstring
    Life insurance account
    lira
    stringstring
    Locked-in Retirement Account (LIRA) (Canada)
    lrif
    stringstring
    Locked-in Retirement Income Fund (LRIF) (Canada)
    lrsp
    stringstring
    Locked-in Retirement Savings Plan (Canada)
    mutual fund
    stringstring
    Mutual fund account
    non-custodial wallet
    stringstring
    A cryptocurrency wallet where the user controls the private key
    non-taxable brokerage account
    stringstring
    A non-taxable brokerage account that is not covered by a more specific subtype
    other
    stringstring
    An account whose type could not be determined
    other annuity
    stringstring
    An annuity account not covered by other subtypes
    other insurance
    stringstring
    An insurance account not covered by other subtypes
    pension
    stringstring
    Standard pension account
    prif
    stringstring
    Prescribed Registered Retirement Income Fund (Canada)
    profit sharing plan
    stringstring
    Plan that gives employees share of company profits
    qshr
    stringstring
    Qualifying share account
    rdsp
    stringstring
    Registered Disability Savings Plan (RSDP) (Canada)
    resp
    stringstring
    Registered Education Savings Plan (Canada)
    retirement
    stringstring
    Retirement account not covered by other subtypes
    rlif
    stringstring
    Restricted Life Income Fund (RLIF) (Canada)
    roth
    stringstring
    Roth IRA (US)
    roth 401k
    stringstring
    Employer-sponsored Roth 401(k) plan (US)
    rrif
    stringstring
    Registered Retirement Income Fund (RRIF) (Canada)
    rrsp
    stringstring
    Registered Retirement Savings Plan (Canadian, similar to US 401(k))
    sarsep
    stringstring
    Salary Reduction Simplified Employee Pension Plan (SARSEP), discontinued retirement plan (US)
    sep ira
    stringstring
    Simplified Employee Pension IRA (SEP IRA), retirement plan for small businesses and self-employed (US)
    simple ira
    stringstring
    Savings Incentive Match Plan for Employees IRA, retirement plan for small businesses (US)
    sipp
    stringstring
    Self-Invested Personal Pension (SIPP) (UK)
    stock plan
    stringstring
    Standard stock plan account
    tfsa
    stringstring
    Tax-Free Savings Account (TFSA), a retirement plan similar to a Roth IRA (Canada)
    trust
    stringstring
    Account representing funds or assets held by a trustee for the benefit of a beneficiary. Includes both revocable and irrevocable trusts.
    ugma
    stringstring
    'Uniform Gift to Minors Act' (brokerage account for minors, US)
    utma
    stringstring
    'Uniform Transfers to Minors Act' (brokerage account for minors, US)
    variable annuity
    stringstring
    Tax-deferred capital accumulation annuity contract
    other
    stringstring
    Other or unknown account type.
    Was this helpful?

    Account type / product support matrix

    The chart below indicates which products can be used with which account types. Note that some products can only be used with certain subtypes:

    • Auth and Signal require a debitable checking, savings, or cash management account.
    • Liabilities does not support loan types other than student or mortgage.
    • Transactions does not support loan types other than student. (For Canadian institutions, Transactions also supports the mortgage loan type.)
    • Investments does not support depository types other than cash management.

    Also note that not all institutions support all products; for details on which products a given institution supports, use /institutions/get_by_id or look up the institution on the Plaid Dashboard status page.

    ProductDepositoryCreditInvestmentsLoanOther
    Balance *
    Transactions
    Identity
    Assets
    Consumer Reports by Plaid Check
    Investments
    Investments Move
    Liabilities
    Auth
    Transfer
    Income (Bank Income flow)
    Statements
    Signal
    Payment Initiation (UK and Europe)
    Virtual Accounts (UK and Europe)

    * Investments holdings data is not priced intra-day.

    Currency code schema

    The following currency codes are supported by Plaid.

    Properties

    iso_currency_code
    stringstring
    Plaid supports all ISO 4217 currency codes.
    unofficial_currency_code
    stringstring
    List of unofficial currency codes
    ADA
    stringstring
    Cardano
    BAT
    stringstring
    Basic Attention Token
    BCH
    stringstring
    Bitcoin Cash
    BNB
    stringstring
    Binance Coin
    BTC
    stringstring
    Bitcoin
    BTG
    stringstring
    Bitcoin Gold
    BSV
    stringstring
    Bitcoin Satoshi Vision
    CNH
    stringstring
    Chinese Yuan (offshore)
    DASH
    stringstring
    Dash
    DOGE
    stringstring
    Dogecoin
    ETC
    stringstring
    Ethereum Classic
    ETH
    stringstring
    Ethereum
    GBX
    stringstring
    Pence sterling, i.e. British penny
    LSK
    stringstring
    Lisk
    NEO
    stringstring
    Neo
    OMG
    stringstring
    OmiseGO
    QTUM
    stringstring
    Qtum
    USDT
    stringstring
    Tether
    XLM
    stringstring
    Stellar Lumen
    XMR
    stringstring
    Monero
    XRP
    stringstring
    Ripple
    ZEC
    stringstring
    Zcash
    ZRX
    stringstring
    0x
    Was this helpful?

    Investment transaction types schema

    Valid values for investment transaction types and subtypes. Note that transactions representing inflow of cash will appear as negative amounts, outflow of cash will appear as positive amounts.

    Properties

    buy
    stringstring
    Buying an investment
    assignment
    stringstring
    Assignment of short option holding
    contribution
    stringstring
    Inflow of assets into a tax-advantaged account
    buy
    stringstring
    Purchase to open or increase a position
    buy to cover
    stringstring
    Purchase to close a short position
    dividend reinvestment
    stringstring
    Purchase using proceeds from a cash dividend
    interest reinvestment
    stringstring
    Purchase using proceeds from a cash interest payment
    long-term capital gain reinvestment
    stringstring
    Purchase using long-term capital gain cash proceeds
    short-term capital gain reinvestment
    stringstring
    Purchase using short-term capital gain cash proceeds
    sell
    stringstring
    Selling an investment
    distribution
    stringstring
    Outflow of assets from a tax-advantaged account
    exercise
    stringstring
    Exercise of an option or warrant contract
    sell
    stringstring
    Sell to close or decrease an existing holding
    sell short
    stringstring
    Sell to open a short position
    cancel
    stringstring
    A cancellation of a pending transaction
    cash
    stringstring
    Activity that modifies a cash position
    account fee
    stringstring
    Fees paid for account maintenance
    contribution
    stringstring
    Inflow of assets into a tax-advantaged account
    deposit
    stringstring
    Inflow of cash into an account
    dividend
    stringstring
    Inflow of cash from a dividend
    stock distribution
    stringstring
    Inflow of stock from a distribution
    interest
    stringstring
    Inflow of cash from interest
    legal fee
    stringstring
    Fees paid for legal charges or services
    long-term capital gain
    stringstring
    Long-term capital gain received as cash
    management fee
    stringstring
    Fees paid for investment management of a mutual fund or other pooled investment vehicle
    margin expense
    stringstring
    Fees paid for maintaining margin debt
    non-qualified dividend
    stringstring
    Inflow of cash from a non-qualified dividend
    non-resident tax
    stringstring
    Taxes paid on behalf of the investor for non-residency in investment jurisdiction
    pending credit
    stringstring
    Pending inflow of cash
    pending debit
    stringstring
    Pending outflow of cash
    qualified dividend
    stringstring
    Inflow of cash from a qualified dividend
    short-term capital gain
    stringstring
    Short-term capital gain received as cash
    tax
    stringstring
    Taxes paid on behalf of the investor
    tax withheld
    stringstring
    Taxes withheld on behalf of the customer
    transfer fee
    stringstring
    Fees incurred for transfer of a holding or account
    trust fee
    stringstring
    Fees related to administration of a trust account
    unqualified gain
    stringstring
    Unqualified capital gain received as cash
    withdrawal
    stringstring
    Outflow of cash from an account
    fee
    stringstring
    Fees on the account, e.g. commission, bookkeeping, options-related.
    account fee
    stringstring
    Fees paid for account maintenance
    adjustment
    stringstring
    Increase or decrease in quantity of item
    dividend
    stringstring
    Inflow of cash from a dividend
    interest
    stringstring
    Inflow of cash from interest
    interest receivable
    stringstring
    Inflow of cash from interest receivable
    long-term capital gain
    stringstring
    Long-term capital gain received as cash
    legal fee
    stringstring
    Fees paid for legal charges or services
    management fee
    stringstring
    Fees paid for investment management of a mutual fund or other pooled investment vehicle
    margin expense
    stringstring
    Fees paid for maintaining margin debt
    non-qualified dividend
    stringstring
    Inflow of cash from a non-qualified dividend
    non-resident tax
    stringstring
    Taxes paid on behalf of the investor for non-residency in investment jurisdiction
    qualified dividend
    stringstring
    Inflow of cash from a qualified dividend
    return of principal
    stringstring
    Repayment of loan principal
    short-term capital gain
    stringstring
    Short-term capital gain received as cash
    stock distribution
    stringstring
    Inflow of stock from a distribution
    tax
    stringstring
    Taxes paid on behalf of the investor
    tax withheld
    stringstring
    Taxes withheld on behalf of the customer
    transfer fee
    stringstring
    Fees incurred for transfer of a holding or account
    trust fee
    stringstring
    Fees related to administration of a trust account
    unqualified gain
    stringstring
    Unqualified capital gain received as cash
    transfer
    stringstring
    Activity that modifies a position, but not through buy/sell activity e.g. options exercise, portfolio transfer
    assignment
    stringstring
    Assignment of short option holding
    adjustment
    stringstring
    Increase or decrease in quantity of item
    exercise
    stringstring
    Exercise of an option or warrant contract
    expire
    stringstring
    Expiration of an option or warrant contract
    merger
    stringstring
    Stock exchanged at a pre-defined ratio as part of a merger between companies
    request
    stringstring
    Request fiat or cryptocurrency to an address or email
    send
    stringstring
    Inflow or outflow of fiat or cryptocurrency to an address or email
    spin off
    stringstring
    Inflow of stock from spin-off transaction of an existing holding
    split
    stringstring
    Inflow of stock from a forward split of an existing holding
    trade
    stringstring
    Trade of one cryptocurrency for another
    transfer
    stringstring
    Movement of assets into or out of an account
    Was this helpful?
    Developer community
    GitHub
    GitHub
    Stack Overflow
    Stack Overflow
    YouTube
    YouTube
    Discord
    Discord