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.
For items that went through the updated account selection pane, this endpoint only returns accounts that were permissioned by the user when they initially created the Item. If a user creates a new account after the initial link, you can capture this event through 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.
Request fields and example
client_idclient_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.secretsecret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.access_tokenoptions/accounts/get results.account_idsaccount_ids to retrieve for the Account.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 error9}Response fields and example
accounts/accounts/balance/get was called, each account will include real-time balance information.account_idaccount_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/accounts/balance/get.availableFor
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.double currentFor
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.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.double limitcredit-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.double iso_currency_codeunofficial_currency_code is non-null.unofficial_currency _codeiso_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_datetimeYYYY-MM-DDTHH:mm:ssZ) indicating the oldest acceptable balance when making a request to /accounts/balance/get.This field is only used and expected when the institution is
ins_128026 (Capital One) and the Item contains one or more accounts with a non-depository account type, in which case a value must be provided or an INVALID_REQUEST error with the code of INVALID_FIELD will be returned. For Capital One depository accounts as well as all other account types on all other institutions, this field is ignored. See account type schema for a full list of account types.If the balance that is pulled is older than the given timestamp for Items with this field required, an
INVALID_REQUEST error with the code of LAST_UPDATED_DATETIME_OUT_OF_RANGE will be returned with the most recent timestamp for the requested account contained in the response.date-time masknameofficial_nametypeinvestment: Investment account. In API versions 2018-05-22 and earlier, this type is called brokerage instead.credit: Credit carddepository: Depository accountloan: Loan accountother: Non-specified account typeSee the Account type schema for a full listing of account types and corresponding subtypes.
investment, credit, depository, loan, brokerage, othersubtype401a, 401k, 403B, 457b, 529, brokerage, cash isa, crypto exchange, education savings account, ebt, fixed annuity, gic, health reimbursement arrangement, hsa, isa, ira, lif, life insurance, lira, lrif, lrsp, non-custodial wallet, non-taxable brokerage account, other, other insurance, other annuity, prif, rdsp, resp, rlif, rrif, pension, profit sharing plan, retirement, roth, roth 401k, rrsp, sep ira, simple ira, sipp, stock plan, thrift savings plan, tfsa, trust, ugma, utma, variable annuity, credit card, paypal, cd, checking, savings, money market, prepaid, auto, business, commercial, construction, consumer, home equity, loan, mortgage, overdraft, line of credit, student, cash management, keogh, mutual fund, recurring, rewards, safe deposit, sarsep, payroll, nullverification_statuspending_automatic_verification: The Item is pending automatic verificationpending_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 verifiedverification_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.database_matched: The Item has successfully been verified using Plaid's data sources. Note: Database Match is currently a beta feature, please contact your account manager for more information.database_insights_pass: The Item's ACH numbers have been verified using Plaid's data sources and have strong signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.database_insights_pass_with_caution: The Item's ACH numbers have been verified using Plaid's data sources and have some signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.database_insights_fail: The Item's ACH numbers have been verified using Plaid's data sources and have signal for being invalid and/or have no signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.automatically_verified, pending_automatic_verification, pending_manual_verification, manually_verified, verification_expired, verification_failed, database_matched, database_insights_pass, database_insights_pass_with_caution, database_insights_failpersistent_account_iditemitem_iditem_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_idnull for Items created via Same Day Micro-deposits.webhookerrorerror_type. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. 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_typeINVALID_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_ERRORerror_codeerror_messagedisplay_messagenull if the error is not related to user action.This may change over time and is not safe for programmatic use.
request_idcausescauses will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified.causes will only be provided for the error_type ASSET_REPORT_ERROR. causes will also not be populated inside an error nested within a warning object.statusdocumentation_urlsuggested_actionavailable_productsbilled_products.assets, auth, balance, identity, identity_match, investments, investments_auth, liabilities, payment_initiation, identity_verification, transactions, credit_details, income, income_verification, deposit_switch, standing_orders, transfer, employment, recurring_transactions, signal, statements, processor_payments, processor_identitybilled_productsavailable_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.assets, auth, balance, identity, identity_match, investments, investments_auth, liabilities, payment_initiation, identity_verification, transactions, credit_details, income, income_verification, deposit_switch, standing_orders, transfer, employment, recurring_transactions, signal, statements, processor_payments, processor_identityproductsbilled_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.assets, auth, balance, identity, identity_match, investments, investments_auth, liabilities, payment_initiation, identity_verification, transactions, credit_details, income, income_verification, deposit_switch, standing_orders, transfer, employment, recurring_transactions, signal, statements, processor_payments, processor_identityconsented_productsassets, auth, balance, identity, identity_match, investments, investments_auth, liabilities, payment_initiation, identity_verification, transactions, credit_details, income, income_verification, deposit_switch, standing_orders, transfer, employment, recurring_transactions, signal, statements, processor_payments, processor_identityconsent_expiration _timeITEM_LOGIN_REQUIRED error state. To circumvent the ITEM_LOGIN_REQUIRED error and maintain continuous consent, the end user can reauthenticate via Link’s update mode in advance of the consent expiration time.Note - This is only relevant for certain OAuth-based institutions. For all other institutions, this field will be null.
date-time update_typebackground - Item can be updated in the backgrounduser_present_required - Item requires user interaction to be updatedbackground, user_present_requiredrequest_id1{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": null11 },12 "mask": "0000",13 "name": "Plaid Checking",14 "official_name": "Plaid Gold Standard 0% Interest Checking",15 "persistent_account_id": "8cfb8beb89b774ee43b090625f0d61d0814322b43bff984eaf60386e",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": null27 },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": null42 },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 "item_id": "DWVAAPWq4RHGlEaNyGKRTAnPLaEmo8Cvq7na6",65 "update_type": "background",66 "webhook": "https://www.genericwebhookurl.com/webhook"67 },68 "request_id": "bkVE1BHWMAZ9Rnr"69}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.
depositorydepository accounts are: Auth (checking and savings types only), Balance, Transactions, Identity, Payment Initiation, Assets, and Investments (cash management type only).checkingsavingshsacdmoney marketpaypalprepaidcash managementebtcreditcredit accounts are: Balance, Transactions, Identity, and Liabilities.credit cardpaypalloanloan accounts are: Balance, Liabilities, and Transactions.autobusinesscommercialconstructionconsumerhome equityloanmortgageoverdraftline of creditstudentotherinvestmentinvestment accounts are: Balance and Investments. In API versions 2018-05-22 and earlier, this type is called brokerage.529401a401k403B457bbrokeragecash isacrypto exchangeeducation savings accountfixed annuitygichealth reimbursement arrangementhsairaisakeoghliflife insuranceliralriflrspmutual fundnon-custodial walletnon-taxable brokerage accountotherother annuityother insurancepensionprifprofit sharing planqshrrdsprespretirementrlifrothroth 401krrifrrspsarsepsep irasimple irasippstock plantfsatrustugmautmavariable annuityotherother accounts are: Balance, Transactions, Identity, and Assets.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
checkingorsavingsdepository account. - Liabilities does not support
loantypes other thanstudentormortgage. - Transactions does not support
loantypes other thanstudent. - Investments does not support
depositorytypes other thancash 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.
| Product | Depository | Credit | Investments | Loan | Other |
|---|---|---|---|---|---|
| Auth | |||||
| Balance | * | ||||
| Transactions | |||||
| Identity | |||||
| Assets | |||||
| Investments | |||||
| Liabilities | |||||
| Payment Initiation (UK and Europe) | |||||
| Virtual Accounts (UK and Europe) | |||||
| Transfer | |||||
| Income (Bank Income flow) | |||||
| Signal |
* Investments holdings data is not priced intra-day.
Currency code schema
The following currency codes are supported by Plaid.
iso_currency_codeunofficial_currency _codeADABATBCHBNBBTCBTGBSVCNHDASHDOGEETCETHGBXLSKNEOOMGQTUMUSDTXLMXMRXRPZECZRXWas 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.
buyassignmentcontributionbuybuy to coverdividend reinvestmentinterest reinvestmentlong-term capital gain reinvestmentshort-term capital gain reinvestmentselldistributionexercisesellsell shortcancelcashaccount feecontributiondepositdividendstock distributioninterestlegal feelong-term capital gainmanagement feemargin expensenon-qualified dividendnon-resident taxpending creditpending debitqualified dividendshort-term capital gaintaxtax withheldtransfer feetrust feeunqualified gainwithdrawalfeeaccount feeadjustmentdividendinterestinterest receivablelong-term capital gainlegal feemanagement feemargin expensenon-qualified dividendnon-resident taxqualified dividendreturn of principalshort-term capital gainstock distributiontaxtax withheldtransfer feetrust feeunqualified gaintransferassignmentadjustmentexerciseexpiremergerrequestsendspin offsplittradetransfer