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.
This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, balances returned may not be up-to-date; for realtime balance information, use /accounts/balance/get instead. Note that some information is nullable.

accounts/get

Request fields and example

client_id
string
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
string
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
requiredstring
The access token associated with the Item data is being requested for.
options
object
An optional object to filter /accounts/get results.
account_ids
[string]
An array of account_ids to retrieve for the Account.
Select group for content switcher
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]
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
string
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
object
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
nullable 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
nullable 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.
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
nullable 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
nullable string
The ISO-4217 currency code of the balance. Always null if unofficial_currency_code is non-null.
unofficial_currency_code
nullable 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
nullable string
Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the last time that the balance for the given account has been updated
This is currently only provided when the min_last_updated_datetime is passed when calling /accounts/balance/get for ins_128026 (Capital One).

Format: date-time
mask
nullable string
The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user.
name
string
The name of the account, either assigned by the user or by the financial institution itself
official_name
nullable string
The official name of the account as given by the financial institution
type
string
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
nullable string
See the Account type schema for a full listing of account types and corresponding subtypes.

Possible values: 401a, 401k, 403B, 457b, 529, brokerage, cash isa, education savings account, ebt, fixed annuity, gic, health reimbursement arrangement, hsa, isa, ira, lif, life insurance, lira, lrif, lrsp, 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, null
verification_status
string
The current verification status of an Auth Item initiated through Automated or Manual micro-deposits. 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 two amounts.
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.

Possible values: automatically_verified, pending_automatic_verification, pending_manual_verification, manually_verified, verification_expired, verification_failed
item
object
Metadata about the Item.
item_id
string
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
nullable string
The Plaid Institution ID associated with the Item. Field is null for Items created via Same Day Micro-deposits.
webhook
nullable string
The URL registered to receive webhooks for the Item.
error
nullable object
We use standard HTTP response codes for success and failure notifications, and our errors are further classified by error_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. Error fields will be null if no error has occurred.
error_type
string
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
error_code
string
The particular error code. Safe for programmatic use.
error_message
string
A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.
display_message
nullable 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
string
A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.
causes
array
In the Assets 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 only be provided for the error_type ASSET_REPORT_ERROR. causes will also not be populated inside an error nested within a warning object.
status
nullable number
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
string
The URL of a Plaid documentation page with more information about the error
suggested_action
nullable string
Suggested steps for resolving the error
available_products
[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, identity, investments, liabilities, payment_initiation, transactions, credit_details, income, income_verification, deposit_switch, standing_orders, transfer, employment, recurring_transactions
billed_products
[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, identity, investments, liabilities, payment_initiation, transactions, credit_details, income, income_verification, deposit_switch, standing_orders, transfer, employment, recurring_transactions
products
[string]
A list of authorized products for the Item.

Possible values: assets, auth, balance, identity, investments, liabilities, payment_initiation, transactions, credit_details, income, income_verification, deposit_switch, standing_orders, transfer, employment, recurring_transactions
consented_products
[string]
Beta: A list of products that have gone through consent collection for the Item. Only present for those enabled in the beta.

Possible values: assets, auth, balance, identity, investments, liabilities, payment_initiation, transactions, credit_details, income, income_verification, deposit_switch, standing_orders, transfer, employment, recurring_transactions
consent_expiration_time
nullable string
The RFC 3339 timestamp after which the consent provided by the end user will expire. Upon consent expiration, the item will enter the ITEM_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.

Format: date-time
update_type
string
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
string
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      "mask": "0000",
13      "name": "Plaid Checking",
14      "official_name": "Plaid Gold Standard 0% Interest Checking",
15      "subtype": "checking",
16      "type": "depository"
17    },
18    {
19      "account_id": "6PdjjRP6LmugpBy5NgQvUqpRXMWxzktg3rwrk",
20      "balances": {
21        "available": null,
22        "current": 23631.9805,
23        "iso_currency_code": "USD",
24        "limit": null,
25        "unofficial_currency_code": null
26      },
27      "mask": "6666",
28      "name": "Plaid 401k",
29      "official_name": null,
30      "subtype": "401k",
31      "type": "investment"
32    },
33    {
34      "account_id": "XMBvvyMGQ1UoLbKByoMqH3nXMj84ALSdE5B58",
35      "balances": {
36        "available": null,
37        "current": 65262,
38        "iso_currency_code": "USD",
39        "limit": null,
40        "unofficial_currency_code": null
41      },
42      "mask": "7777",
43      "name": "Plaid Student Loan",
44      "official_name": null,
45      "subtype": "student",
46      "type": "loan"
47    }
48  ],
49  "item": {
50    "available_products": [
51      "balance",
52      "identity",
53      "payment_initiation",
54      "transactions"
55    ],
56    "billed_products": [
57      "assets",
58      "auth"
59    ],
60    "consent_expiration_time": null,
61    "error": null,
62    "institution_id": "ins_117650",
63    "item_id": "DWVAAPWq4RHGlEaNyGKRTAnPLaEmo8Cvq7na6",
64    "update_type": "background",
65    "webhook": "https://www.genericwebhookurl.com/webhook"
66  },
67  "request_id": "bkVE1BHWMAZ9Rnr"
68}

Account type schema

The schema below describes the various types and corresponding subtypes that Plaid recognizes and reports for financial institution accounts.

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

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 requires a debitable checking or savings depository account, and Liabilities does not support loan types other than student or mortgage. 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
Auth
Balance *
Transactions
Identity
Assets
Investments
Liabilities
Payment Initiation (UK and Europe)
Transfer (beta)
Income (Bank Income flow)

* Investments holdings data is not priced intra-day.

Currency code schema

The following currency codes are supported by Plaid.

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

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.

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