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 information for any linked Item. Note that some information is nullable. Plaid will only return active bank accounts, i.e. accounts that are not closed and are capable of carrying a balance.
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.

accounts/get

Request fields and example

client_idstring

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.

secretstring

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_tokenrequiredstring

The access token associated with the Item data is being requested for.

optionsobject

An optional object to filter /accounts/get results.

account_ids[string]

An array of account_ids to retrieve for the Account.

/accounts/get
1
2
3
4
5
6
7
8
9
const request: AccountsGetRequest = {
  access_token: ACCESS_TOKEN,
};
try {
  const response = await plaidClient.accountsGet(request);
  const accounts = response.data.accounts;
} catch (error) {
  // handle error
}

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_idstring

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.

balancesobject

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.

availablenullablenumber

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, 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.

currentnullablenumber

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, 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.

limitnullablenumber

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.

iso_currency_codenullablestring

The ISO-4217 currency code of the balance. Always null if unofficial_currency_code is non-null.

unofficial_currency_codenullablestring

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_datetimenullablestring

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

masknullablestring

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.

namestring

The name of the account, either assigned by the user or by the financial institution itself

official_namenullablestring

The official name of the account as given by the financial institution

typestring

investment: Investment account
credit: Credit card
depository: Depository account
loan: Loan account
brokerage: An investment account. Used for /assets/ endpoints only; other endpoints use investment.
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

subtypenullablestring

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, home equity, loan, mortgage, overdraft, line of credit, student, cash management, keogh, mutual fund, recurring, rewards, safe deposit, sarsep, payroll, null

verification_statusstring

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

itemobject

Metadata about the Item.

item_idstring

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_idnullablestring

The Plaid Institution ID associated with the Item. Field is null for Items created via Same Day Micro-deposits.

webhooknullablestring

The URL registered to receive webhooks for the Item.

errornullableobject

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_typestring

A broad categorization of the error. Safe for programatic 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_codestring

The particular error code. Safe for programmatic use.

error_messagestring

A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.

display_messagenullablestring

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_idstring

A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.

causesarray

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.

statusnullablenumber

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_urlstring

The URL of a Plaid documentation page with more information about the error

suggested_actionstring

Suggested steps for resolving the error

available_products[string]

A list of products available for the Item that have not yet been accessed.

Possible values: assets, auth, balance, identity, investments, liabilities, payment_initiation, transactions, credit_details, income, income_verification, deposit_switch, standing_orders, transfer

billed_products[string]

A list of products that have been billed for the Item. Note - billed_products is populated in all environments but only requests in Production are billed.

consent_expiration_timenullablestring

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_typestring

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_idstring

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

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

Account type schema

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

depositorystring

An account type holding cash, in which funds are deposited. Supported products for depository accounts are: Auth, Balance, Transactions, Identity, Payment Initiation, and Assets.

checkingstring

Checking account

savingsstring

Savings account

hsastring

Health Savings Account (US only) that can only hold cash

cdstring

Certificate of deposit account

money marketstring

Money market account

paypalstring

PayPal depository account

prepaidstring

Prepaid debit card

cash managementstring

A cash management account, typically a cash account at a brokerage

ebtstring

An Electronic Benefit Transfer (EBT) account, used by certain public assistance programs to distribute funds (US only)

creditstring

A credit card type account. Supported products for credit accounts are: Balance, Transactions, Identity, and Liabilities.

credit cardstring

Bank-issued credit card

paypalstring

PayPal-issued credit card

loanstring

A loan type account. Supported products for loan accounts are: Balance, Liabilities, and Transactions.

autostring

Auto loan

businessstring

Business loan

commercialstring

Commercial loan

constructionstring

Construction loan

consumerstring

Consumer loan

home equitystring

Home Equity Line of Credit (HELOC)

loanstring

General loan

mortgagestring

Mortgage loan

overdraftstring

Pre-approved overdraft account, usually tied to a checking account

line of creditstring

Pre-approved line of credit

studentstring

Student loan

otherstring

Other loan type or unknown loan type

investmentstring

An investment account. Supported products for investment accounts are: Balance and Investments.

529string

Tax-advantaged college savings and prepaid tuition 529 plans (US)

401astring

Employer-sponsored money-purchase 401(a) retirement plan (US)

401kstring

Standard 401(k) retirement account (US)

403Bstring

403(b) retirement savings account for non-profits and schools (US)

457bstring

Tax-advantaged deferred-compensation 457(b) retirement plan for governments and non-profits (US)

brokeragestring

Standard brokerage account

cash isastring

Individual Savings Account (ISA) that pays interest tax-free (UK)

education savings accountstring

Tax-advantaged Coverdell Education Savings Account (ESA) (US)

fixed annuitystring

Fixed annuity

gicstring

Guaranteed Investment Certificate (Canada)

health reimbursement arrangementstring

Tax-advantaged Health Reimbursement Arrangement (HRA) benefit plan (US)

hsastring

Non-cash tax-advantaged medical Health Savings Account (HSA) (US)

irastring

Traditional Invididual Retirement Account (IRA) (US)

isastring

Non-cash Individual Savings Account (ISA) (UK)

keoghstring

Keogh self-employed retirement plan (US)

lifstring

Life Income Fund (LIF) retirement account (Canada)

life insurancestring

Life insurance account

lirastring

Locked-in Retirement Account (LIRA) (Canada)

lrifstring

Locked-in Retirement Income Fund (LRIF) (Canada)

lrspstring

Locked-in Retirement Savings Plan (Canada)

mutual fundstring

Mutual fund account

non-taxable brokerage accountstring

A non-taxable brokerage account that is not covered by a more specific subtype

otherstring

An account whose type could not be determined

other annuitystring

An annuity account not covered by other subtypes

other insurancestring

An insurance account not covered by other subtypes

pensionstring

Standard pension account

prifstring

Prescribed Registered Retirement Income Fund (Canada)

profit sharing planstring

Plan that gives employees share of company profits

qshrstring

Qualifying share account

rdspstring

Registered Disability Savings Plan (RSDP) (Canada)

respstring

Registered Education Savings Plan (Canada)

retirementstring

Retirement account not covered by other subtypes

rlifstring

Restricted Life Income Fund (RLIF) (Canada)

rothstring

Roth IRA (US)

roth 401kstring

Employer-sponsored Roth 401(k) plan (US)

rrifstring

Registered Retirement Income Fund (RRIF) (Canada)

rrspstring

Registered Retirement Savings Plan (Canadian, similar to US 401(k))

sarsepstring

Salary Reduction Simplified Employee Pension Plan (SARSEP), discontinued retirement plan (US)

sep irastring

Simplified Employee Pension IRA (SEP IRA), retirement plan for small businesses and self-employed (US)

simple irastring

Savings Incentive Match Plan for Employees IRA, retirement plan for small businesses (US)

sippstring

Self-Invested Personal Pension (SIPP) (UK)

stock planstring

Standard stock plan account

tfsastring

Tax-Free Savings Account (TFSA), a retirement plan similar to a Roth IRA (Canada)

truststring

Account representing funds or assets held by a trustee for the benefit of a beneficiary. Includes both revocable and irrevocable trusts.

ugmastring

'Uniform Gift to Minors Act' (brokerage account for minors, US)

utmastring

'Uniform Transfers to Minors Act' (brokerage account for minors, US)

variable annuitystring

Tax-deferred capital accumulation annuity contract

otherstring

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.

Product	Depository	Credit	Investments	Loan	Other
Auth
Balance			*
Transactions
Identity
Assets
Investments
Liabilities
Payment Initiation (UK and Europe)
Bank Transfers (beta)

* Investments holdings data is not priced intra-day.

The Income product does not directly interface with any of the account types listed in the table above. Instead, it verifies income using paystubs uploaded by the end user. Paystubs typically contain information about the depository account receiving payment.

Currency code schema

The following currency codes are supported by Plaid.

iso_currency_codestring

Plaid supports all ISO 4217 currency codes.

unofficial_currency_codestring

List of unofficial currency codes

ADAstring

Cardano

BATstring

Basic Attention Token

BCHstring

Bitcoin Cash

BNBstring

Binance Coin

BTCstring

Bitcoin

BTGstring

Bitcoin Gold

BSVstring

Bitcoin Satoshi Vision

CNHstring

Chinese Yuan (offshore)

DASHstring

Dash

DOGEstring

Dogecoin

ETCstring

Ethereum Classic

ETHstring

Ethereum

GBXstring

Pence sterling, i.e. British penny

LSKstring

Lisk

NEOstring

Neo

OMGstring

OmiseGO

QTUMstring

Qtum

USDTstring

TehterUS

XLMstring

Stellar Lumen

XMRstring

Monero

XRPstring

Ripple

ZECstring

Zcash

ZRXstring

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.

buystring

Buying an investment

assignmentstring

Assignment of short option holding

contributionstring

Inflow of assets into a tax-advantaged account

buystring

Purchase to open or increase a position

buy to coverstring

Purchase to close a short position

dividend reinvestmentstring

Purchase using proceeds from a cash dividend

interest reinvestmentstring

Purchase using proceeds from a cash interest payment

long-term capital gain reinvestmentstring

Purchase using long-term capital gain cash proceeds

short-term capital gain reinvestmentstring

Purchase using short-term capital gain cash proceeds

sellstring

Selling an investment

distributionstring

Outflow of assets from a tax-advantaged account

exercisestring

Exercise of an option or warrant contract

sellstring

Sell to close or decrease an existing holding

sell shortstring

Sell to open a short position

cancelstring

A cancellation of a pending transaction

cashstring

Activity that modifies a cash position

account feestring

Fees paid for account maintenance

contributionstring

Inflow of assets into a tax-advantaged account

depositstring

Inflow of cash into an account

dividendstring

Inflow of cash from a dividend

stock distributionstring

Inflow of stock from a distribution

intereststring

Inflow of cash from interest

legal feestring

Fees paid for legal charges or services

long-term capital gainstring

Long-term capital gain received as cash

management feestring

Fees paid for investment management of a mutual fund or other pooled investment vehicle

margin expensestring

Fees paid for maintaining margin debt

non-qualified dividendstring

Inflow of cash from a non-qualified dividend

non-resident taxstring

Taxes paid on behalf of the investor for non-residency in investment jurisdiction

pending creditstring

Pending inflow of cash

pending debitstring

Pending outflow of cash

qualified dividendstring

Inflow of cash from a qualified dividend

short-term capital gainstring

Short-term capital gain received as cash

taxstring

Taxes paid on behalf of the investor

tax withheldstring

Taxes withheld on behalf of the customer

transfer feestring

Fees incurred for transfer of a holding or account

trust feestring

Fees related to adminstration of a trust account

unqualified gainstring

Unqualified capital gain received as cash

withdrawalstring

Outflow of cash from an account

feestring

Fees on the account, e.g. commission, bookkeeping, options-related.

account feestring

Fees paid for account maintenance

adjustmentstring

Increase or decrease in quantity of item

dividendstring

Inflow of cash from a dividend

intereststring

Inflow of cash from interest

interest receivablestring

Inflow of cash from interest receivable

long-term capital gainstring

Long-term capital gain received as cash

legal feestring

Fees paid for legal charges or services

management feestring

Fees paid for investment management of a mutual fund or other pooled investment vehicle

margin expensestring

Fees paid for maintaining margin debt

non-qualified dividendstring

Inflow of cash from a non-qualified dividend

non-resident taxstring

Taxes paid on behalf of the investor for non-residency in investment jurisdiction

qualified dividendstring

Inflow of cash from a qualified dividend

return of principalstring

Repayment of loan principal

short-term capital gainstring

Short-term capital gain received as cash

stock distributionstring

Inflow of stock from a distribution

taxstring

Taxes paid on behalf of the investor

tax withheldstring

Taxes withheld on behalf of the customer

transfer feestring

Fees incurred for transfer of a holding or account

trust feestring

Fees related to adminstration of a trust account

unqualified gainstring

Unqualified capital gain received as cash

transferstring

Activity that modifies a position, but not through buy/sell activity e.g. options exercise, portfolio transfer

assignmentstring

Assignment of short option holding

adjustmentstring

Increase or decrease in quantity of item

exercisestring

Exercise of an option or warrant contract

expirestring

Expiration of an option or warrant contract

mergerstring

Stock exchanged at a pre-defined ratio as part of a merger between companies

spin offstring

Inflow of stock from spin-off transaction of an existing holding

splitstring

Inflow of stock from a forward split of an existing holding

transferstring

Movement of assets into or out of an account