API - Account endpoints and schemas

/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

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.

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.

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

An optional object to filter /accounts/get results.

An array of account_ids to retrieve for the Account.

/accounts/get
1
2
3
4
5
const response = await client.getAccounts(accessToken).catch((err) => {
  // handle error
});
const accounts = response.accounts;

accounts/get

Response fields and example

An array of financial institution accounts associated with the Item. If /accounts/balance/get was called, each account will include real-time balance information.

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.

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.

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.

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, and current balance information is typically not updated intra-day. If you require realtime balance information, use the available balance as provided by /accounts/balance/get.

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.

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

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.

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

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.

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

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

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

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, gic, health reimbursement arrangement, hsa, isa, ira, lif, lira, lrif, lrsp, non-taxable brokerage account, other, 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, null

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: pending_automatic_verification, pending_manual_verification, manually_verified, verification_expired, verification_failed

Metadata about the Item.

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.

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

The URL registered to receive webhooks for the Item.

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.

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

The particular error code. Safe for programmatic use.

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

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.

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

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.

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.

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

Suggested steps for resolving the error

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, deposit_switch, standing_orders

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.

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

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.

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
requires_user_authentication - Item requires user interaction to be updated

Possible values: background, requires_user_authentication

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.

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

Checking account

Savings account

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

Certificate of deposit account

Money market account

PayPal depository account

Prepaid debit card

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

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

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

Bank-issued credit card

PayPal-issued credit card

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

Auto loan

Business loan

Commercial loan

Construction loan

Consumer loan

Home Equity Line of Credit (HELOC)

General loan

Mortgage loan

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

Pre-approved line of credit

Student loan

Other loan type or unknown loan type

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

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

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

Standard 401(k) retirement account (US)

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

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

Standard brokerage account

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

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

Fixed annuity

Guaranteed Investment Certificate (Canada)

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

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

Traditional Invididual Retirement Account (IRA) (US)

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

Keogh self-employed retirement plan (US)

Life Income Fund (LIF) retirement account (Canada)

Locked-in Retirement Account (LIRA) (Canada)

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

Locked-in Retirement Savings Plan (Canada)

Mutual fund account

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

Standard pension account

Prescribed Registered Retirement Income Fund (Canada)

Plan that gives employees share of company profits

Qualifying share account

Registered Disability Savings Plan (RSDP) (Canada)

Registered Education Savings Plan (Canada)

Retirement account not covered by other subtypes

Restricted Life Income Fund (RLIF) (Canada)

Roth IRA (US)

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

Registered Retirement Income Fund (RRIF) (Canada)

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

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

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

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

Self-Invested Personal Pension (SIPP) (UK)

Standard stock plan account

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

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

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

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

Tax-deferred capital accumulation annuity contract

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.

Currency code schema

The following currency codes are supported by Plaid.

Plaid supports all ISO 4217 currency codes.

List of unofficial currency codes

Cardano

Basic Attention Token

Bitcoin Cash

Binance Coin

Bitcoin

Bitcoin Gold

Chinese Yuan (offshore)

Dash

Dogecoin

Ethereum Classic

Ethereum

Pence sterling, i.e. British penny

Lisk

Neo

OmiseGO

Qtum

TehterUS

Stellar Lumen

Monero

Ripple

Zcash

Investment transaction subtypes schema

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

Fees paid for account maintenance

Assignment of short option holding

Purchase to open or increase a position

Purchase to close a short position

Inflow of assets into a tax-advantaged account

Inflow of cash into an account

Outflow of assets from a tax-advantaged account

Inflow of cash from a dividend

Purchase using proceeds from a cash dividend

Exercise of an option or warrant contract

Expiration of an option or warrant contract

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

Inflow of cash from interest

Inflow of cash from interest receivable

Purchase using proceeds from a cash interest payment

Fees paid for legal charges or services

Inflow of cash related to payment on a loan

Long-term capital gain received as cash

Purchase using long-term capital gain cash proceeds

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

Fees paid for maintaining margin debt

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

Fee associated with various account or holding actions

Inflow of cash from a non-qualified dividend

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

Pending inflow of cash

Pending outflow of cash

Inflow of cash from a qualified dividend

Rebalancing transaction (buy or sell) with no net impact to value in the account

Repayment of loan principal

Sell to close or decrease an existing holding

Sell to open a short position

Short-term capital gain received as cash

Purchase using short-term capital gain cash proceeds

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

Inflow of stock from a forward split of an existing holding

Inflow of stock from a distribution

Taxes paid on behalf of the investor

Taxes withheld on behalf of the customer

Movement of assets into or out of an account

Fees incurred for transfer of a holding or account

Fees related to adminstration of a trust account

Unqualified capital gain received as cash

Outflow of cash from an account