Plaid logo
Exchange
ALL DOCS

API reference

  • Data Definitions
  • Aggregation
  • Errors and Conditions
Open nav
Exchange
Plaid.comGet Started

Data Definitions

Plaid Exchange Data Definitions

Getting started

Before building your Plaid Exchange integration, please review the data definitions here. This will help you ensure your data is correctly formatted and that type matching requirements are met. Use this guide in combination with the API Reference for data aggregation and errors.

Notes
  • Non-required parameters may be left blank, sent as null, or omitted. We recommend sending a blank field, as this is slightly cleaner.

  • Some required parameters are nullable (description, settled_at). In these cases, the parameter will be marked as nullable in the parameters list.

Primitives

Basic types used in other definitions

id
stringstring
A globally unique identifier (accountId, transactionId, identityId, etc.) which can serve as a stable identifier for the associated entity.
amount
stringstring
Fixed point decimal number, carried up to six decimal places.
natural
integerinteger
A natural number i.e. a non-negative integer.
rate
stringstring
Fixed-point representation of a normalized rate, carried up to four decimal places.
iso4217
stringstring
ISO-4217 currency code.
iso8601
stringstring
ISO-8601 formatted date or timestamp.

Format: date
mcc
stringstring
Merchant category code.
Was this helpful?

Identifiers

Many compound definitions in this API will make use of ad hoc identifier types, e.g. accountId, identityId, transactionId. These are string values, expected to remain stable during the life of the associated entity, and enable us to reconcile entities across state transitions, e.g. transactions moving from pending to posted state, or a customer’s personal name change.

GeoLocation

Geographic location.

coordinates
objectobject
Geographic coordinates in EPSG:4326 WGS84 (lat/long)
lat
numbernumber
Latitude coordinate.
lon
numbernumber
Longitude coordinate.
city
stringstring
City name.
region
stringstring
Region identifier.
country
stringstring
Country identifier.
1{
2 "coordinates": {
3 "lat": 41.8574,
4 "lon": -71.39862
5 },
6 "city": "New York",
7 "region": "US-NY",
8 "country": "US"
9}
Was this helpful?

GeoCoordinates

Geographic coordinates in EPSG:4326 WGS84 (lat/long)

lat
requirednumberrequired, number
Latitude coordinate.
lon
requirednumberrequired, number
Longitude coordinate.
1{
2 "lat": 41.8574,
3 "lon": -71.39862
4}
Was this helpful?

Account

Currencies

All account subtypes include currency and non_iso_currency properties to indicate the currencies in which their balances are denominated. One and only one of these two fields should be set, with the other being unset (not present). If the account is denominated in a currency recognized under ISO-4217, then currency should be set to that currency’s alphabetic code under that standard.

However, if the balance is denominated in a non-ISO currency, e.g. Bitcoin, mileage, or reward points, then currency must be null and non_iso_currency should be used instead. In this case, Plaid does not guarantee that balances across accounts, and across institutions, refer to the same currency even when they use the same non_iso_currency values.

Account Ownership

When modeling account ownership, include only the identities that are interesting when understanding a user’s financial situation and capability. For example, joint account ownership between a husband and wife should be modeled as two owner_identity_ids. Business account ownership should be modeled as a single business owner (use BusinessIdentity), which then has owner_identity_ids related to it, representing the beneficial owners (those with at least a 25% stake). Identification of business-owned depository accounts is critical for funds transfer use cases (e.g. payments), e.g. in the US, ACH transfers are required to distinguish B2B transactions from individual or B2C transactions.

Interested non-ownership identities should be included when doing so would further illustrate the user’s situation. For example, when the user is a trustee of an account, their identity should be included in non_owner_identity_ids. Inclusion of personally identifying information should always be balanced against visibility and consent concerns. Identity information not necessary for the currently authorized user to transact against the account should be limited, and those identities should be modeled using BasicIdentity e.g. when the trustor on an account is transacting, identifying information about the trustee need not be extensive. Conversely, if the trustee were viewing the account, their entry in non_owner_identity_ids can be more complete, and the trustor’s entry can be more limited.

Plaid’s account ownership model is intended to support compliance with ownership guidelines set forth in the FDIC Publication, "Your Insured Deposits" and in the US Treasury FinCEN publication, "FIN-2018-G001" (Anti-Money Laundering Guidance document).

Ownership structure of an account.

individual
Individual account.
joint
Joint account ownership.
association
Ownership by a corporation, partnership, or unincorporated association, including for-profit and not-for-profit organizations.
trust
Revocable or irrevocable trust.
Was this helpful?

Account Status

Report accounts until they are closed, and continue reporting closed accounts until 90 days after closure.

active
Account has current activity and there are no issues outstanding.
inactive
Account has seen no activity for a standard period defined by the institution, and may be subject to fees or at risk of closure.
frozen
Access to and transaction against the account is prohibited due to legal or compliance concerns, e.g. assets subject to OFAC sanctions enforcement, assets subject to a discovery subpoena, etc.
locked
Access to the account is prohibited due to security concerns, e.g. fraudulent activity observed.
flagged
All activity is prohibited due to regulatory or policy requirements, e.g. monthly withdrawals from a savings account in excess of FRB Regulation D.
restricted
Activity on the account is restricted, e.g. withdrawals are subject to a daily limit, until the user meets certain conditions.
closed
The account is closed.
Was this helpful?
Suspended Access

There are multiple statuses listed here which, at first glance, seem to describe nearly identical conditions. Although frozen, flagged, and locked all describe conditions where the account’s assets cannot be accessed until they are released, the reasons for suspension differ,

  • frozen describes a condition in connection to legal action: use frozen to indicate than an account’s assets may be subject to seizure
  • flagged describes a condition where account activity is suspicious, or non-compliant with the customer agreement: use flagged to indicate that the account may be at risk of closure
  • locked describes a condition applied proactively to protect the account holder: use locked to indicate that assets are restricted to protect against loss

Account Type and Subtype

TypeSubtypeTransaction TypeDescription
depositorycash managementDepositoryTransactionCash management account
depositorycdDepositoryTransactionCash deposit (CD)
depositorycheckingDepositoryTransactionChecking account
depositorysavingsDepositoryTransactionSavings account
depositorymoney marketDepositoryTransactionMoney market account
depositoryhealthDepositoryTransactionAny health savings or reimbursement account, e.g. HSA, FSA, HRA etc.
depositoryprepaidDepositoryTransactionPrepaid account, typically debit card
depositorygicDepositoryTransactionGuaranteed investment certificate (Canada)
loanautoLoanTransactionAuto loan
loancommercialLoanTransactionCommercial loan
loanconstructionLoanTransactionConstruction loan, e.g. 203(k)
loanconsumerLoanTransactionConsumer installment loan
loancredit cardCreditTransactionCredit card
loanhome equityLoanTransactionLoan or line of credit against home collateral, e.g. a HELOC
loanmortgageLoanTransactionHome mortgage
loanoverdraftLoanTransactionOverdraft protection line of credit
loanline of creditCreditTransactionLine of credit
loanstudentLoanTransactionStudent loan
investment401aInvestmentTransactionIRC 401(a) governmental and nonprofit employee retirement plan
investment401kInvestmentTransactionIRC 401(k) retirement plan
investment403bInvestmentTransactionIRC 403(b) annuity retirement plan
investment457bInvestmentTransactionIRC 457(b) retirement savings account
investment529InvestmentTransactionIRC 529 educational savings plan
investmentbrokerageInvestmentTransactionOrdinary investment account
investmentesaInvestmentTransactionNon-529 education savings account (e.g. Coverdell)
investmentiraInvestmentTransactionTraditional IRA
investmentisaInvestmentTransactionIndividual savings account (UK)
investmentliraInvestmentTransactionLocked-in retirement account (Canada)
investmentotherInvestmentTransactionOther investment vehicle not covered here
investmentrifInvestmentTransactionRetirement income fund, includes LIF, LRIF, RRIF, PRIF and other income funds (Canada)
investmentrspInvestmentTransactionRetirement savings plan, includes RRSP, RDSP, RESP, LRSP and other savings plans (Canada)
investmentpensionInvestmentTransactionTraditional defined-benefit plan
investmentprofit-sharingInvestmentTransactionEmployee profit sharing plan
investmentroth iraInvestmentTransactionRoth IRA
investmentroth 401kInvestmentTransactionRoth 401(k)
investmentsep iraInvestmentTransactionSimplified employee plan IRA
investmentsimple iraInvestmentTransactionSIMPLE IRA
investmentsippInvestmentTransactionSelf-invested personal pension
investmentstock planInvestmentTransactionStock purchase plan, e.g. ESPP
investmenttspInvestmentTransactionThrift savings plan
investmenttfsaInvestmentTransactionTax-free savings account (Canada)
investmentcustodialInvestmentTransactionAccount covered under UGMA/UTMA
investmentvariable annuityInvestmentTransactionVariable annuity tax-deferred retirement vehicle

BaseAccount

List of all accounts for which this user is an owner or interested non-owner.

id
requiredstringrequired, string
Permanent account identifier. Do not use a full or masked account number for this value as this increases the risk of revealing Personally Identifiable Information (PII).
last_activity_at
stringstring
Date of most recent change to, or activity on this account, e.g. new transactions, or changes to account metadata. Used to provide hints for optimal scheduling of updates.

Format: date-time
ownership_type
stringstring
Indicates the ownership type of the account, not the relationship the current user has over the account.

Possible values: individual, joint, association, trust
owner_identity_ids
required[string]required, [string]
References to the identities for the owner(s) of this account.
non_owner_identity_ids
[string][string]
References to the identities for the non-owner(s) related to this account, e.g. trustees, beneficiaries.
status
requiredstringrequired, string
Status of this account.

Possible values: active, inactive, frozen, locked, flagged, restricted, closed
type
requiredstringrequired, string
Major classification of this account.

Possible values: depository, loan, investment
subtype
requiredstringrequired, string
Minor classification of this account.

Possible values: cash management, cd, checking, savings, money market, health, prepaid, gic, auto, commercial, construction, consumer, credit card, home equity, mortgage, overdraft, line of credit, student, 401a, 401k, 403B, 457b, 529, brokerage, esa, ira, isa, lira, other, rif, rsp, pension, profit-sharing, roth ira, roth 401k, sep ira, simple ira, sipp, stock plan, tsp, tfsa, custodial, variable annuity
name
stringstring
The account's user-given name, if the institution supports naming of accounts.
official_name
requiredstringrequired, string
The account's marketing or brand name.
display_mask
requiredstringrequired, string
A short alpha-numeric string to assist users in identifying the account, e.g. last four digits of the account number.
opening_date
stringstring
The date on which the account was opened.

Format: date
current_balance
requiredstringrequired, string
The total balance in the account, typically including pending transactions. See individual account types for specific definitions of this value.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
available_balance
requiredstringrequired, string
The immediately available balance in the account, typically the amount available to withdraw at the moment.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
tax_advantaged
booleanboolean
Indicates whether some activity on the account - deposits, gains, etc - benefits from tax deferral or exemption, e.g. HSA, IRA, 401(k) accounts.
currency
stringstring
The ISO-4217 currency in which this account’s transactions and balances are denominated.
non_iso_currency
stringstring
If the account is denominated in a non-ISO currency, provide the currency's symbol.
1{
2 "id": "R13oiR6lC5jNC5jK",
3 "last_activity_at": "2020-04-21T12:45:00+00:00",
4 "ownership_type": "individual",
5 "owner_identity_ids": null,
6 "non_owner_identity_ids": [
7 "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
8 ],
9 "status": "active",
10 "type": "depository",
11 "subtype": "checking",
12 "name": "Vacation Money",
13 "official_name": "Pro Checking",
14 "display_mask": "9833",
15 "opening_date": "2018-01-31",
16 "current_balance": "850.55",
17 "available_balance": "149.45",
18 "tax_advantaged": true,
19 "currency": "USD",
20 "non_iso_currency": null
21}
Was this helpful?

DepositoryAccount

Represents depository accounts, e.g. checking, savings, CDs.

interest_rate
stringstring
The rate at which this account earns interest.

Pattern: ^\d*(\.\d{1,4})?$
transfer_codes
requiredobjectrequired, object
Account identifiers necessary for funds transfers.
ach
objectobject
ACH (US) account identifiers.
account_number
stringstring
The account number.
routing_number
stringstring
The ABA routing transit number.
wire_routing_number
stringstring
The institution's routing number for wire transfer.
supports_debit
booleanboolean
Indicates account may be debited using transfer code.
supports_credit
booleanboolean
Indicates account may be credited using transfer code.
eft
objectobject
EFT (Canada) account identifiers.
account_number
stringstring
The account number.
institution_number
stringstring
The institution's number assigned by Payments Canada.
branch_number
stringstring
The branch number corresponding to the account.
supports_debit
booleanboolean
Indicates account may be debited using transfer code.
supports_credit
booleanboolean
Indicates account may be credited using transfer code.
iban
objectobject
IBAN account identifiers.
account_number
stringstring
The full IBAN.
bank_code
stringstring
Bank identifier.
country_code
stringstring
The country code.
location_code
stringstring
Location code for the bank's office.
branch_code
stringstring
Optionally indicate a specific branch.
supports_debit
booleanboolean
Indicates account may be debited using transfer code.
supports_credit
booleanboolean
Indicates account may be credited using transfer code.
payment_card
objectobject
Payment card account identifiers.
card_number
stringstring
The payment card number.
expiry_month
stringstring
Month of card expiration, as a 2-digit value.
expiry_year
stringstring
Year of card expiration.
security_code
stringstring
CVV, CSC, or other card-not-present verification value.
supports_debit
booleanboolean
Indicates account may be debited using transfer code.
supports_credit
booleanboolean
Indicates account may be credited using transfer code.
acats
objectobject
ACATS account identifiers.
account_number
stringstring
The account number.
receiving_member_identity
objectobject
Identity of the receiving brokerage (including organization).
organization
objectobject
Describes an organization, e.g., a business or non-profit.
name
stringstring
Name of the organization represented.
structure
stringstring
Type of business structure.

Possible values: sole, partnership, llc, corp
mcc
stringstring
The ISO-18245 merchant category code for this business.

Pattern: ^\d{4}$
owner_identity_ids
[string][string]
The identities of the organization owner(s).
tax_identifier
objectobject
The tax authority ID.
tax_authority
stringstring
Name of the tax authority.
tax_payer_id
stringstring
The tax payer ID, e.g. EIN, TIN, SSN.
country
stringstring
The national jurisdiction of the tax authority in ISO 3166-1 format.
subdivision
stringstring
If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.
person
objectobject
Describes an individual, named person.
first_name
stringstring
Legal given name of the personal entity.
middle_name
stringstring
Middle name, use blank if none.
last_name
stringstring
Last name or family name.
date_of_birth
stringstring
The date of birth in ISO-8601 format.

Format: date
tax_identifier
objectobject
The tax authority ID.
tax_authority
stringstring
Name of the tax authority.
tax_payer_id
stringstring
The tax payer ID, e.g. EIN, TIN, SSN.
country
stringstring
The national jurisdiction of the tax authority in ISO 3166-1 format.
subdivision
stringstring
If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.
email
stringstring
The email address where this entity can be contacted.
mailing_address
objectobject
Description of a street address.
lines
[string][string]
The lines of the street address.

Min items: 1
city
stringstring
The city of the mailing address.
region
stringstring
The first-level administrative subdivision, e.g., a state, province or district. Use ISO 3166-2 subdivisions (note: not ISO-3166-alpha-2).
country
stringstring
The ISO 3166-alpha-2 country code.
postal_code
stringstring
The postal code.
phone
stringstring
The phone number, formatted using ITU standard E. 123.
id
stringstring
Permanent identity identifier.
name
stringstring
The display name of this entity (insufficient for KYC purposes)
dtcc_clearing_ids
[string][string]
The DTCC institution identifiers for the institution holding the account.

Min items: 1
supports_debit
booleanboolean
Indicates account may be debited using transfer code.
supports_credit
booleanboolean
Indicates account may be credited using transfer code.
maturity_date
stringstring
The date of maturity for fixed-term instruments, e.g. CDs.

Format: date
statements
[object][object]
Must describe statement periods for previous two years.
statement_id
stringstring
Globally unique identifier for this statement.
open_date
stringstring
The opening date of this statement period.

Format: date
close_date
stringstring
The closing date of this statement period, use a future date if the statement period has not closed.

Format: date
balance
stringstring
The balance at the close of the statement period.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
document_url
stringstring
A URL to a downloadable document form of this statement. Implementers should not assume that accessors of this URL are always authorized.
id
requiredstringrequired, string
Permanent account identifier. Do not use a full or masked account number for this value as this increases the risk of revealing Personally Identifiable Information (PII).
last_activity_at
stringstring
Date of most recent change to, or activity on this account, e.g. new transactions, or changes to account metadata. Used to provide hints for optimal scheduling of updates.

Format: date-time
ownership_type
stringstring
Indicates the ownership type of the account, not the relationship the current user has over the account.

Possible values: individual, joint, association, trust
owner_identity_ids
required[string]required, [string]
References to the identities for the owner(s) of this account.
non_owner_identity_ids
[string][string]
References to the identities for the non-owner(s) related to this account, e.g. trustees, beneficiaries.
status
requiredstringrequired, string
Status of this account.

Possible values: active, inactive, frozen, locked, flagged, restricted, closed
type
requiredstringrequired, string
Major classification of this account.

Possible values: depository, loan, investment
subtype
requiredstringrequired, string
Minor classification of this account.

Possible values: cash management, cd, checking, savings, money market, health, prepaid, gic, auto, commercial, construction, consumer, credit card, home equity, mortgage, overdraft, line of credit, student, 401a, 401k, 403B, 457b, 529, brokerage, esa, ira, isa, lira, other, rif, rsp, pension, profit-sharing, roth ira, roth 401k, sep ira, simple ira, sipp, stock plan, tsp, tfsa, custodial, variable annuity
name
stringstring
The account's user-given name, if the institution supports naming of accounts.
official_name
requiredstringrequired, string
The account's marketing or brand name.
display_mask
requiredstringrequired, string
A short alpha-numeric string to assist users in identifying the account, e.g. last four digits of the account number.
opening_date
stringstring
The date on which the account was opened.

Format: date
current_balance
requiredstringrequired, string
The total balance in the account, typically including pending transactions. See individual account types for specific definitions of this value.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
available_balance
requiredstringrequired, string
The immediately available balance in the account, typically the amount available to withdraw at the moment.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
tax_advantaged
booleanboolean
Indicates whether some activity on the account - deposits, gains, etc - benefits from tax deferral or exemption, e.g. HSA, IRA, 401(k) accounts.
currency
stringstring
The ISO-4217 currency in which this account’s transactions and balances are denominated.
non_iso_currency
stringstring
If the account is denominated in a non-ISO currency, provide the currency's symbol.
1{
2 "interest_rate": "0.0199",
3 "transfer_codes": {
4 "ach": {
5 "account_number": "string",
6 "routing_number": "031176110",
7 "wire_routing_number": "string",
8 "supports_debit": true,
9 "supports_credit": true
10 },
11 "eft": {
12 "account_number": "string",
13 "institution_number": "004",
14 "branch_number": "1320",
15 "supports_debit": true,
16 "supports_credit": true
17 },
18 "iban": {
19 "account_number": "string",
20 "bank_code": "NORD",
21 "country_code": "FR",
22 "location_code": "ZZ",
23 "branch_code": "80A",
24 "supports_debit": true,
25 "supports_credit": true
26 },
27 "payment_card": {
28 "card_number": "string",
29 "expiry_month": "01",
30 "expiry_year": "2021",
31 "security_code": "363",
32 "supports_debit": true,
33 "supports_credit": true
34 },
35 "acats": {
36 "account_number": "string",
37 "receiving_member_identity": {
38 "organization": {
39 "name": "Doe Business, Inc.",
40 "structure": "sole",
41 "mcc": "5542",
42 "owner_identity_ids": [
43 "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
44 ],
45 "tax_identifier": {
46 "tax_authority": "IRS",
47 "tax_payer_id": "string"
48 }
49 },
50 "person": {
51 "first_name": "Jane",
52 "middle_name": "Joan",
53 "last_name": "Doe",
54 "date_of_birth": "1987-01-31",
55 "tax_identifier": {
56 "tax_authority": "IRS",
57 "tax_payer_id": "string"
58 }
59 },
60 "email": "jane@plaid.com",
61 "mailing_address": {
62 "lines": [
63 "413 Leeward Way",
64 "Apt 3A"
65 ],
66 "city": "San Francisco",
67 "region": "US-CA",
68 "country": "US",
69 "postal_code": "94106",
70 "phone": "+1 415 555 1212"
71 },
72 "id": "d7f1b8b9-0006-4135-91c0-b5532045a314",
73 "name": "Jane Doe"
74 },
75 "dtcc_clearing_ids": [
76 "string"
77 ],
78 "supports_debit": true,
79 "supports_credit": true
80 }
81 },
82 "maturity_date": "2018-08-28",
83 "statements": [
84 {
85 "statement_id": "string",
86 "open_date": "2018-08-28",
87 "close_date": "2018-08-28",
88 "balance": "100.95",
89 "document_url": "string"
90 }
91 ],
92 "id": "R13oiR6lC5jNC5jK",
93 "last_activity_at": "2020-04-21T12:45:00+00:00",
94 "ownership_type": "individual",
95 "owner_identity_ids": [
96 "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
97 ],
98 "non_owner_identity_ids": null,
99 "status": "active",
100 "type": "depository",
101 "subtype": "checking",
102 "name": "Vacation Money",
103 "official_name": "Pro Checking",
104 "display_mask": "9833",
105 "opening_date": "2018-01-31",
106 "current_balance": "850.55",
107 "available_balance": "149.45",
108 "tax_advantaged": true,
109 "currency": "USD",
110 "non_iso_currency": null
111}
Was this helpful?

DepositoryAccountStatement

Represents primary account statement details.

statement_id
requiredstringrequired, string
Globally unique identifier for this statement.
open_date
stringstring
The opening date of this statement period.

Format: date
close_date
stringstring
The closing date of this statement period, use a future date if the statement period has not closed.

Format: date
balance
stringstring
The balance at the close of the statement period.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
document_url
stringstring
A URL to a downloadable document form of this statement. Implementers should not assume that accessors of this URL are always authorized.
1{
2 "statement_id": "string",
3 "open_date": "2018-08-28",
4 "close_date": "2018-08-28",
5 "balance": "100.95",
6 "document_url": "string"
7}
Was this helpful?

TransferCodeMap

Mapping between an account and various payment networks.

ach
objectobject
ACH (US) account identifiers.
account_number
stringstring
The account number.
routing_number
stringstring
The ABA routing transit number.
wire_routing_number
stringstring
The institution's routing number for wire transfer.
supports_debit
booleanboolean
Indicates account may be debited using transfer code.
supports_credit
booleanboolean
Indicates account may be credited using transfer code.
eft
objectobject
EFT (Canada) account identifiers.
account_number
stringstring
The account number.
institution_number
stringstring
The institution's number assigned by Payments Canada.
branch_number
stringstring
The branch number corresponding to the account.
supports_debit
booleanboolean
Indicates account may be debited using transfer code.
supports_credit
booleanboolean
Indicates account may be credited using transfer code.
iban
objectobject
IBAN account identifiers.
account_number
stringstring
The full IBAN.
bank_code
stringstring
Bank identifier.
country_code
stringstring
The country code.
location_code
stringstring
Location code for the bank's office.
branch_code
stringstring
Optionally indicate a specific branch.
supports_debit
booleanboolean
Indicates account may be debited using transfer code.
supports_credit
booleanboolean
Indicates account may be credited using transfer code.
payment_card
objectobject
Payment card account identifiers.
card_number
stringstring
The payment card number.
expiry_month
stringstring
Month of card expiration, as a 2-digit value.
expiry_year
stringstring
Year of card expiration.
security_code
stringstring
CVV, CSC, or other card-not-present verification value.
supports_debit
booleanboolean
Indicates account may be debited using transfer code.
supports_credit
booleanboolean
Indicates account may be credited using transfer code.
acats
objectobject
ACATS account identifiers.
account_number
stringstring
The account number.
receiving_member_identity
objectobject
Identity of the receiving brokerage (including organization).
organization
objectobject
Describes an organization, e.g., a business or non-profit.
name
stringstring
Name of the organization represented.
structure
stringstring
Type of business structure.

Possible values: sole, partnership, llc, corp
mcc
stringstring
The ISO-18245 merchant category code for this business.

Pattern: ^\d{4}$
owner_identity_ids
[string][string]
The identities of the organization owner(s).
tax_identifier
objectobject
The tax authority ID.
tax_authority
stringstring
Name of the tax authority.
tax_payer_id
stringstring
The tax payer ID, e.g. EIN, TIN, SSN.
country
stringstring
The national jurisdiction of the tax authority in ISO 3166-1 format.
subdivision
stringstring
If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.
person
objectobject
Describes an individual, named person.
first_name
stringstring
Legal given name of the personal entity.
middle_name
stringstring
Middle name, use blank if none.
last_name
stringstring
Last name or family name.
date_of_birth
stringstring
The date of birth in ISO-8601 format.

Format: date
tax_identifier
objectobject
The tax authority ID.
tax_authority
stringstring
Name of the tax authority.
tax_payer_id
stringstring
The tax payer ID, e.g. EIN, TIN, SSN.
country
stringstring
The national jurisdiction of the tax authority in ISO 3166-1 format.
subdivision
stringstring
If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.
email
stringstring
The email address where this entity can be contacted.
mailing_address
objectobject
Description of a street address.
lines
[string][string]
The lines of the street address.

Min items: 1
city
stringstring
The city of the mailing address.
region
stringstring
The first-level administrative subdivision, e.g., a state, province or district. Use ISO 3166-2 subdivisions (note: not ISO-3166-alpha-2).
country
stringstring
The ISO 3166-alpha-2 country code.
postal_code
stringstring
The postal code.
phone
stringstring
The phone number, formatted using ITU standard E. 123.
id
stringstring
Permanent identity identifier.
name
stringstring
The display name of this entity (insufficient for KYC purposes)
dtcc_clearing_ids
[string][string]
The DTCC institution identifiers for the institution holding the account.

Min items: 1
supports_debit
booleanboolean
Indicates account may be debited using transfer code.
supports_credit
booleanboolean
Indicates account may be credited using transfer code.
1{
2 "ach": {
3 "account_number": "string",
4 "routing_number": "031176110",
5 "wire_routing_number": "string",
6 "supports_debit": true,
7 "supports_credit": true
8 },
9 "eft": {
10 "account_number": "string",
11 "institution_number": "004",
12 "branch_number": "1320",
13 "supports_debit": true,
14 "supports_credit": true
15 },
16 "iban": {
17 "account_number": "string",
18 "bank_code": "NORD",
19 "country_code": "FR",
20 "location_code": "ZZ",
21 "branch_code": "80A",
22 "supports_debit": true,
23 "supports_credit": true
24 },
25 "payment_card": {
26 "card_number": "string",
27 "expiry_month": "01",
28 "expiry_year": "2021",
29 "security_code": "363",
30 "supports_debit": true,
31 "supports_credit": true
32 },
33 "acats": {
34 "account_number": "string",
35 "receiving_member_identity": {
36 "organization": {
37 "name": "Doe Business, Inc.",
38 "structure": "sole",
39 "mcc": "5542",
40 "owner_identity_ids": [
41 "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
42 ],
43 "tax_identifier": {
44 "tax_authority": "IRS",
45 "tax_payer_id": "string"
46 }
47 },
48 "person": {
49 "first_name": "Jane",
50 "middle_name": "Joan",
51 "last_name": "Doe",
52 "date_of_birth": "1987-01-31",
53 "tax_identifier": {
54 "tax_authority": "IRS",
55 "tax_payer_id": "string"
56 }
57 },
58 "email": "jane@plaid.com",
59 "mailing_address": {
60 "lines": [
61 "413 Leeward Way",
62 "Apt 3A"
63 ],
64 "city": "San Francisco",
65 "region": "US-CA",
66 "country": "US",
67 "postal_code": "94106",
68 "phone": "+1 415 555 1212"
69 },
70 "id": "d7f1b8b9-0006-4135-91c0-b5532045a314",
71 "name": "Jane Doe"
72 },
73 "dtcc_clearing_ids": [
74 "string"
75 ],
76 "supports_debit": true,
77 "supports_credit": true
78 }
79}
Was this helpful?

DepositoryAccountTransferCode

Base model for depository account transfer identifiers.

supports_debit
requiredbooleanrequired, boolean
Indicates account may be debited using transfer code.
supports_credit
requiredbooleanrequired, boolean
Indicates account may be credited using transfer code.
1{
2 "supports_debit": true,
3 "supports_credit": true
4}
Was this helpful?

AchTransferCode

Account and routing number for directing funds transfers in the US.

account_number
requiredstringrequired, string
The account number.
routing_number
requiredstringrequired, string
The ABA routing transit number.
wire_routing_number
stringstring
The institution's routing number for wire transfer.
supports_debit
requiredbooleanrequired, boolean
Indicates account may be debited using transfer code.
supports_credit
requiredbooleanrequired, boolean
Indicates account may be credited using transfer code.
1{
2 "account_number": "121212454545",
3 "routing_number": "031176110",
4 "wire_routing_number": "1234-5678-0",
5 "supports_debit": true,
6 "supports_credit": true
7}
Was this helpful?

EftTransferCode

Identifiers for directing funds transfers in Canada.

account_number
requiredstringrequired, string
The account number.
institution_number
requiredstringrequired, string
The institution's number assigned by Payments Canada.
branch_number
requiredstringrequired, string
The branch number corresponding to the account.
supports_debit
requiredbooleanrequired, boolean
Indicates account may be debited using transfer code.
supports_credit
requiredbooleanrequired, boolean
Indicates account may be credited using transfer code.
1{
2 "account_number": "string",
3 "institution_number": "004",
4 "branch_number": "1320",
5 "supports_debit": true,
6 "supports_credit": true
7}
Was this helpful?

IbanTransferCode

International Bank Account Number for directing international funds transfers.

account_number
requiredstringrequired, string
The full IBAN.
bank_code
requiredstringrequired, string
Bank identifier.
country_code
requiredstringrequired, string
The country code.
location_code
requiredstringrequired, string
Location code for the bank's office.
branch_code
stringstring
Optionally indicate a specific branch.
supports_debit
requiredbooleanrequired, boolean
Indicates account may be debited using transfer code.
supports_credit
requiredbooleanrequired, boolean
Indicates account may be credited using transfer code.
1{
2 "account_number": "string",
3 "bank_code": "NORD",
4 "country_code": "FR",
5 "location_code": "ZZ",
6 "branch_code": "80A",
7 "supports_debit": true,
8 "supports_credit": true
9}
Was this helpful?

PaymentCardTransferCode

Identifiers for directing funds to/from payment cards.

card_number
requiredstringrequired, string
The payment card number.
expiry_month
requiredstringrequired, string
Month of card expiration, as a 2-digit value.
expiry_year
requiredstringrequired, string
Year of card expiration.
security_code
requiredstringrequired, string
CVV, CSC, or other card-not-present verification value.
supports_debit
requiredbooleanrequired, boolean
Indicates account may be debited using transfer code.
supports_credit
requiredbooleanrequired, boolean
Indicates account may be credited using transfer code.
1{
2 "card_number": "string",
3 "expiry_month": "01",
4 "expiry_year": "2021",
5 "security_code": "363",
6 "supports_debit": true,
7 "supports_credit": true
8}
Was this helpful?

NotionalAccount

A placeholder entity, capable of indicating only basic facts about an account.

id
requiredstringrequired, string
Permanent account identifier. Should be an accountId. Do not use a full or masked account number for this value as this increases the risk of revealing Personally Identifiable Information (PII).
type
requiredstringrequired, string
Major classification of this account. Should be one of the accountType values.
subtype
requiredstringrequired, string
Minor classification of this account. Should be one of the accountSubtype values.
access_authorized
deprecatedbooleandeprecated, boolean
Indicate that the user has not authorized the account to participate in aggregation. should only be present/true for notional accounts.
name
stringstring
The account’s user-given name, if the institution supports naming of accounts
official_name
requiredstringrequired, string
The account’s marketing or brand name.
currency
stringstring
The ISO-4217 currency in which this account’s transactions and balances are denominated.
non_iso_currency
stringstring
If the account is denominated in a non-ISO currency, provide the currency’s symbol.
1{
2 "id": "R13oiR6lC5jNC5jK",
3 "type": "depository",
4 "subtype": "checking",
5 "name": "Vacation money",
6 "official_name": "Pro Checking",
7 "currency": "USD",
8 "non_iso_currency": null
9}
Was this helpful?

InvestmentAccount

Representation of brokerage accounts.

transfer_codes
objectobject
Account identifiers necessary for portfolio transfers.
ach
objectobject
ACH (US) account identifiers.
account_number
stringstring
The account number.
routing_number
stringstring
The ABA routing transit number.
wire_routing_number
stringstring
The institution's routing number for wire transfer.
supports_debit
booleanboolean
Indicates account may be debited using transfer code.
supports_credit
booleanboolean
Indicates account may be credited using transfer code.
eft
objectobject
EFT (Canada) account identifiers.
account_number
stringstring
The account number.
institution_number
stringstring
The institution's number assigned by Payments Canada.
branch_number
stringstring
The branch number corresponding to the account.
supports_debit
booleanboolean
Indicates account may be debited using transfer code.
supports_credit
booleanboolean
Indicates account may be credited using transfer code.
iban
objectobject
IBAN account identifiers.
account_number
stringstring
The full IBAN.
bank_code
stringstring
Bank identifier.
country_code
stringstring
The country code.
location_code
stringstring
Location code for the bank's office.
branch_code
stringstring
Optionally indicate a specific branch.
supports_debit
booleanboolean
Indicates account may be debited using transfer code.
supports_credit
booleanboolean
Indicates account may be credited using transfer code.
payment_card
objectobject
Payment card account identifiers.
card_number
stringstring
The payment card number.
expiry_month
stringstring
Month of card expiration, as a 2-digit value.
expiry_year
stringstring
Year of card expiration.
security_code
stringstring
CVV, CSC, or other card-not-present verification value.
supports_debit
booleanboolean
Indicates account may be debited using transfer code.
supports_credit
booleanboolean
Indicates account may be credited using transfer code.
acats
objectobject
ACATS account identifiers.
account_number
stringstring
The account number.
receiving_member_identity
objectobject
Identity of the receiving brokerage (including organization).
organization
objectobject
Describes an organization, e.g., a business or non-profit.
name
stringstring
Name of the organization represented.
structure
stringstring
Type of business structure.

Possible values: sole, partnership, llc, corp
mcc
stringstring
The ISO-18245 merchant category code for this business.

Pattern: ^\d{4}$
owner_identity_ids
[string][string]
The identities of the organization owner(s).
tax_identifier
objectobject
The tax authority ID.
tax_authority
stringstring
Name of the tax authority.
tax_payer_id
stringstring
The tax payer ID, e.g. EIN, TIN, SSN.
country
stringstring
The national jurisdiction of the tax authority in ISO 3166-1 format.
subdivision
stringstring
If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.
person
objectobject
Describes an individual, named person.
first_name
stringstring
Legal given name of the personal entity.
middle_name
stringstring
Middle name, use blank if none.
last_name
stringstring
Last name or family name.
date_of_birth
stringstring
The date of birth in ISO-8601 format.

Format: date
tax_identifier
objectobject
The tax authority ID.
tax_authority
stringstring
Name of the tax authority.
tax_payer_id
stringstring
The tax payer ID, e.g. EIN, TIN, SSN.
country
stringstring
The national jurisdiction of the tax authority in ISO 3166-1 format.
subdivision
stringstring
If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.
email
stringstring
The email address where this entity can be contacted.
mailing_address
objectobject
Description of a street address.
lines
[string][string]
The lines of the street address.

Min items: 1
city
stringstring
The city of the mailing address.
region
stringstring
The first-level administrative subdivision, e.g., a state, province or district. Use ISO 3166-2 subdivisions (note: not ISO-3166-alpha-2).
country
stringstring
The ISO 3166-alpha-2 country code.
postal_code
stringstring
The postal code.
phone
stringstring
The phone number, formatted using ITU standard E. 123.
id
stringstring
Permanent identity identifier.
name
stringstring
The display name of this entity (insufficient for KYC purposes)
dtcc_clearing_ids
[string][string]
The DTCC institution identifiers for the institution holding the account.

Min items: 1
supports_debit
booleanboolean
Indicates account may be debited using transfer code.
supports_credit
booleanboolean
Indicates account may be credited using transfer code.
current_balance
requiredstringrequired, string
The total balance in the account, typically including pending transactions. See individual account types for specific definitions of this value.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
available_balance
requiredstringrequired, string
The immediately available balance in the account, typically the amount available to withdraw at the moment.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
margin_balance
stringstring
The amount that is on loan. Provide as a negative amount.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
margin_limit
stringstring
The total limit of the margin extended to the account.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
margin_equity
stringstring
The amount of marginable assets owned in the account.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
maintenance_margin
stringstring
The minimum equity needed to hold the positions in the account.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
buying_power
stringstring
Total amount of funds available for making transactions, includes margin.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
current_as_of
stringstring
The time at which current_balance was current.

Format: date-time
holdings
required[object]required, [object]
Descriptions of held assets in the account.
security_id
stringstring
The identifier of the security referenced by this holding.
cost_basis
stringstring
The total cost of acquiring this holding, inclusive of fees.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
quantity
stringstring
The amount of the security (typically, number of shares) comprising this holding.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
lots
objectobject
The tax lots constituting this holding.
id
stringstring
The unique and permanent identifier for this lot.
acquired_at
stringstring
The date at which the lot was acquired.

Format: date
acquired_price
stringstring
The total price at which this lot was acquired.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
quantity
stringstring
The quantity held in this lot.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
currency
stringstring
The ISO-4217 currency in which this account’s transactions and balances are denominated.
non_iso_currency
stringstring
If the account is denominated in a non-ISO currency, provide the currency's symbol.
id
requiredstringrequired, string
Permanent account identifier. Do not use a full or masked account number for this value as this increases the risk of revealing Personally Identifiable Information (PII).
last_activity_at
stringstring
Date of most recent change to, or activity on this account, e.g. new transactions, or changes to account metadata. Used to provide hints for optimal scheduling of updates.

Format: date-time
ownership_type
stringstring
Indicates the ownership type of the account, not the relationship the current user has over the account.

Possible values: individual, joint, association, trust
owner_identity_ids
required[string]required, [string]
References to the identities for the owner(s) of this account.
non_owner_identity_ids
[string][string]
References to the identities for the non-owner(s) related to this account, e.g. trustees, beneficiaries.
status
requiredstringrequired, string
Status of this account.

Possible values: active, inactive, frozen, locked, flagged, restricted, closed
type
requiredstringrequired, string
Major classification of this account.

Possible values: depository, loan, investment
subtype
requiredstringrequired, string
Minor classification of this account.

Possible values: cash management, cd, checking, savings, money market, health, prepaid, gic, auto, commercial, construction, consumer, credit card, home equity, mortgage, overdraft, line of credit, student, 401a, 401k, 403B, 457b, 529, brokerage, esa, ira, isa, lira, other, rif, rsp, pension, profit-sharing, roth ira, roth 401k, sep ira, simple ira, sipp, stock plan, tsp, tfsa, custodial, variable annuity
name
stringstring
The account's user-given name, if the institution supports naming of accounts.
official_name
requiredstringrequired, string
The account's marketing or brand name.
display_mask
requiredstringrequired, string
A short alpha-numeric string to assist users in identifying the account, e.g. last four digits of the account number.
opening_date
stringstring
The date on which the account was opened.

Format: date
tax_advantaged
booleanboolean
Indicates whether some activity on the account - deposits, gains, etc - benefits from tax deferral or exemption, e.g. HSA, IRA, 401(k) accounts.
currency
stringstring
The ISO-4217 currency in which this account’s transactions and balances are denominated.
non_iso_currency
stringstring
If the account is denominated in a non-ISO currency, provide the currency's symbol.
1{
2 "transfer_codes": {
3 "ach": {
4 "account_number": "string",
5 "routing_number": "031176110",
6 "wire_routing_number": "string",
7 "supports_debit": true,
8 "supports_credit": true
9 },
10 "eft": {
11 "account_number": "string",
12 "institution_number": "004",
13 "branch_number": "1320",
14 "supports_debit": true,
15 "supports_credit": true
16 },
17 "iban": {
18 "account_number": "string",
19 "bank_code": "NORD",
20 "country_code": "FR",
21 "location_code": "ZZ",
22 "branch_code": "80A",
23 "supports_debit": true,
24 "supports_credit": true
25 },
26 "payment_card": {
27 "card_number": "string",
28 "expiry_month": "01",
29 "expiry_year": "2021",
30 "security_code": "363",
31 "supports_debit": true,
32 "supports_credit": true
33 },
34 "acats": {
35 "account_number": "string",
36 "receiving_member_identity": {
37 "organization": {
38 "name": "Doe Business, Inc.",
39 "structure": "sole",
40 "mcc": "5542",
41 "owner_identity_ids": [
42 "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
43 ],
44 "tax_identifier": {
45 "tax_authority": "IRS",
46 "tax_payer_id": "string"
47 }
48 },
49 "person": {
50 "first_name": "Jane",
51 "middle_name": "Joan",
52 "last_name": "Doe",
53 "date_of_birth": "1987-01-31",
54 "tax_identifier": {
55 "tax_authority": "IRS",
56 "tax_payer_id": "string"
57 }
58 },
59 "email": "jane@plaid.com",
60 "mailing_address": {
61 "lines": [
62 "413 Leeward Way",
63 "Apt 3A"
64 ],
65 "city": "San Francisco",
66 "region": "US-CA",
67 "country": "US",
68 "postal_code": "94106",
69 "phone": "+1 415 555 1212"
70 },
71 "id": "d7f1b8b9-0006-4135-91c0-b5532045a314",
72 "name": "Jane Doe"
73 },
74 "dtcc_clearing_ids": [
75 "string"
76 ],
77 "supports_debit": true,
78 "supports_credit": true
79 }
80 },
81 "current_balance": "850.55",
82 "available_balance": "149.45",
83 "margin_balance": "100.95",
84 "margin_limit": "100.95",
85 "margin_equity": "100.95",
86 "maintenance_margin": "100.95",
87 "buying_power": "100.95",
88 "current_as_of": "2018-08-28",
89 "holdings": [
90 {
91 "security_id": "string",
92 "cost_basis": "100.95",
93 "quantity": "100.95",
94 "lots": {
95 "id": "string",
96 "acquired_at": "2018-08-28",
97 "acquired_price": "100.95",
98 "quantity": "100.95"
99 },
100 "currency": "USD",
101 "non_iso_currency": null
102 }
103 ],
104 "id": "R13oiR6lC5jNC5jK",
105 "last_activity_at": "2020-04-21T12:45:00+00:00",
106 "ownership_type": "individual",
107 "owner_identity_ids": [
108 "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
109 ],
110 "non_owner_identity_ids": null,
111 "status": "active",
112 "type": "investment",
113 "subtype": "401k",
114 "name": "Vacation Money",
115 "official_name": "401k Account",
116 "display_mask": "9833",
117 "opening_date": "2018-01-31",
118 "tax_advantaged": true,
119 "currency": "USD",
120 "non_iso_currency": null
121}
Was this helpful?

AcatsTransferCode

Automated Customer Account Transfer Service identifiers for transferring stock portfolios between brokerages.

account_number
requiredstringrequired, string
The account number.
receiving_member_identity
requiredobjectrequired, object
Identity of the receiving brokerage (including organization).
organization
objectobject
Describes an organization, e.g., a business or non-profit.
name
stringstring
Name of the organization represented.
structure
stringstring
Type of business structure.

Possible values: sole, partnership, llc, corp
mcc
stringstring
The ISO-18245 merchant category code for this business.

Pattern: ^\d{4}$
owner_identity_ids
[string][string]
The identities of the organization owner(s).
tax_identifier
objectobject
The tax authority ID.
tax_authority
stringstring
Name of the tax authority.
tax_payer_id
stringstring
The tax payer ID, e.g. EIN, TIN, SSN.
country
stringstring
The national jurisdiction of the tax authority in ISO 3166-1 format.
subdivision
stringstring
If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.
person
objectobject
Describes an individual, named person.
first_name
stringstring
Legal given name of the personal entity.
middle_name
stringstring
Middle name, use blank if none.
last_name
stringstring
Last name or family name.
date_of_birth
stringstring
The date of birth in ISO-8601 format.

Format: date
tax_identifier
objectobject
The tax authority ID.
tax_authority
stringstring
Name of the tax authority.
tax_payer_id
stringstring
The tax payer ID, e.g. EIN, TIN, SSN.
country
stringstring
The national jurisdiction of the tax authority in ISO 3166-1 format.
subdivision
stringstring
If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.
email
stringstring
The email address where this entity can be contacted.
mailing_address
objectobject
Description of a street address.
lines
[string][string]
The lines of the street address.

Min items: 1
city
stringstring
The city of the mailing address.
region
stringstring
The first-level administrative subdivision, e.g., a state, province or district. Use ISO 3166-2 subdivisions (note: not ISO-3166-alpha-2).
country
stringstring
The ISO 3166-alpha-2 country code.
postal_code
stringstring
The postal code.
phone
stringstring
The phone number, formatted using ITU standard E. 123.
id
stringstring
Permanent identity identifier.
name
stringstring
The display name of this entity (insufficient for KYC purposes)
dtcc_clearing_ids
required[string]required, [string]
The DTCC institution identifiers for the institution holding the account.

Min items: 1
supports_debit
requiredbooleanrequired, boolean
Indicates account may be debited using transfer code.
supports_credit
requiredbooleanrequired, boolean
Indicates account may be credited using transfer code.
1{
2 "account_number": "string",
3 "receiving_member_identity": {
4 "organization": {
5 "name": "Doe Business, Inc.",
6 "structure": "sole",
7 "mcc": "5542",
8 "owner_identity_ids": [
9 "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
10 ],
11 "tax_identifier": {
12 "tax_authority": "IRS",
13 "tax_payer_id": "string"
14 }
15 },
16 "person": {
17 "first_name": "Jane",
18 "middle_name": "Joan",
19 "last_name": "Doe",
20 "date_of_birth": "1987-01-31",
21 "tax_identifier": {
22 "tax_authority": "IRS",
23 "tax_payer_id": "string"
24 }
25 },
26 "email": "jane@plaid.com",
27 "mailing_address": {
28 "lines": [
29 "413 Leeward Way",
30 "Apt 3A"
31 ],
32 "city": "San Francisco",
33 "region": "US-CA",
34 "country": "US",
35 "postal_code": "94106",
36 "phone": "+1 415 555 1212"
37 },
38 "id": "d7f1b8b9-0006-4135-91c0-b5532045a314",
39 "name": "Jane Doe"
40 },
41 "dtcc_clearing_ids": [
42 "string"
43 ],
44 "supports_debit": true,
45 "supports_credit": true
46}
Was this helpful?

Security

Description of a security (i.e. stocks, bonds, derivatives, etc.)

id
requiredstringrequired, string
The permanent identifier for this security, across all accounts and holdings. Do not use a full or masked account number for this value as this increases the risk of revealing Personally Identifiable Information (PII).
isin
stringstring
The ISO 6166-compliant ISIN for this security, if available.
name
requiredstringrequired, string
A descriptive name for the security, suitable for display.
symbol
requiredstringrequired, string
The security's trading symbol, if applicable. Otherwise, a short, commonly used identifier.
is_cash_equivalent
requiredbooleanrequired, boolean
Indicates the security is highly-liquid, e.g. a money market account, and should be regarded as cash.
current_price
requiredstringrequired, string
The instantaneous trading price of the security.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
current_as_of
requiredstringrequired, string
The time at which current_price was current, in ISO 8601 format.

Format: date-time
close_price
stringstring
The price of the security at the most recent close of trading. For securities that are traded continuously throughout the day, use the price at 11:59PM of the previous day, in the institution's time zone.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
type
requiredstringrequired, string
The security type. For detailed descriptions of available types, see Plaid API security types.

Possible values: cash, derivative, equity, etf, fixed income, loan, mutual fund, other
currency
stringstring
The ISO 4217 currency in which this account’s transactions and balances are denominated.
non_iso_currency
stringstring
If the account is denominated in a non-ISO currency, provide the currency's symbol.
1{
2 "id": "account_5921",
3 "isin": "US17275R1023",
4 "name": "CISCO SYSTEMS INC",
5 "symbol": "CSCO",
6 "is_cash_equivalent": true,
7 "current_price": "100.95",
8 "current_as_of": "2018-08-28",
9 "close_price": "100.95",
10 "type": "cash",
11 "currency": "USD",
12 "non_iso_currency": null
13}
Was this helpful?

OptionSecurity

Representation of a Security with type of derivative.

expiry
requiredstringrequired, string
The contract expiration date.

Format: date
contract_type
requiredstringrequired, string
The type of option.

Possible values: put, call
option_style
stringstring
The style of option (US or European)

Possible values: euro, us
exercise_price
stringstring
The price at which the contract owner may transact.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
underlying_security_id
requiredstringrequired, string
Reference to the security underlying this contract.
id
requiredstringrequired, string
The permanent identifier for this security, across all accounts and holdings. Do not use a full or masked account number for this value as this increases the risk of revealing Personally Identifiable Information (PII).
isin
stringstring
The ISO 6166-compliant ISIN for this security, if available.
name
requiredstringrequired, string
A descriptive name for the security, suitable for display.
symbol
requiredstringrequired, string
The security's trading symbol, if applicable. Otherwise, a short, commonly used identifier.
is_cash_equivalent
requiredbooleanrequired, boolean
Indicates the security is highly-liquid, e.g. a money market account, and should be regarded as cash.
current_price
requiredstringrequired, string
The instantaneous trading price of the security.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
current_as_of
requiredstringrequired, string
The time at which current_price was current, in ISO 8601 format.

Format: date-time
close_price
stringstring
The price of the security at the most recent close of trading. For securities that are traded continuously throughout the day, use the price at 11:59PM of the previous day, in the institution's time zone.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
type
requiredstringrequired, string
The security type. For detailed descriptions of available types, see Plaid API security types.

Possible values: cash, derivative, equity, etf, fixed income, loan, mutual fund, other
currency
stringstring
The ISO 4217 currency in which this account’s transactions and balances are denominated.
non_iso_currency
stringstring
If the account is denominated in a non-ISO currency, provide the currency's symbol.
1{
2 "id": "account_5921",
3 "isin": "US17275R1023",
4 "name": "CISCO SYSTEMS INC",
5 "symbol": "CSCO",
6 "is_cash_equivalent": true,
7 "current_price": "100.95",
8 "current_as_of": "2018-08-28",
9 "close_price": "100.95",
10 "type": "cash",
11 "currency": "USD",
12 "non_iso_currency": null
13}
Was this helpful?

ContractType

Describes available contract type

put
A put option
call
A call option
Was this helpful?

Holding

Instance of a held security.

security_id
requiredstringrequired, string
The identifier of the security referenced by this holding.
cost_basis
stringstring
The total cost of acquiring this holding, inclusive of fees.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
quantity
requiredstringrequired, string
The amount of the security (typically, number of shares) comprising this holding.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
lots
objectobject
The tax lots constituting this holding.
id
stringstring
The unique and permanent identifier for this lot.
acquired_at
stringstring
The date at which the lot was acquired.

Format: date
acquired_price
stringstring
The total price at which this lot was acquired.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
quantity
stringstring
The quantity held in this lot.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
currency
stringstring
The ISO-4217 currency in which this account’s transactions and balances are denominated.
non_iso_currency
stringstring
If the account is denominated in a non-ISO currency, provide the currency's symbol.
1{
2 "security_id": "string",
3 "cost_basis": "100.95",
4 "quantity": "100.95",
5 "lots": {
6 "id": "string",
7 "acquired_at": "2018-08-28",
8 "acquired_price": "100.95",
9 "quantity": "100.95"
10 },
11 "currency": "USD",
12 "non_iso_currency": null
13}
Was this helpful?

TaxLot

Describes taxable lots of shares within a Holding.

id
requiredstringrequired, string
The unique and permanent identifier for this lot.
acquired_at
requiredstringrequired, string
The date at which the lot was acquired.

Format: date
acquired_price
requiredstringrequired, string
The total price at which this lot was acquired.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
quantity
requiredstringrequired, string
The quantity held in this lot.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
1{
2 "id": "string",
3 "acquired_at": "2018-08-28",
4 "acquired_price": "100.95",
5 "quantity": "100.95"
6}
Was this helpful?

LoanAccount

Representation of short and long-term debt.

account_number
stringstring
The account number for this loan.
reference_number
stringstring
The loan's reference number.
servicer_identity_id
stringstring
Reference to the identity of the loan servicer.
interest_rate
requiredstringrequired, string
The current interest rate for this loan.

Pattern: ^\d*(\.\d{1,4})?$
interest_rate_type
requiredstringrequired, string
The interest rate adjustment scheme for this loan.

Possible values: fixed, adjustable, variable, other
interest_rate_schedule
[object][object]
A history of effective rates on this loan. For adjustable rate loans, include dates of future adjustments. Do not use to describe fixed-rate loans.
start_date
stringstring
The date this rate became, or becomes, effective.

Format: date
end_date
stringstring
The date this rate became, or becomes, ineffective. Use null if the end date is not known or not fixed.

Format: date
interest_rate
stringstring
The effective rate during the period described.

Pattern: ^\d*(\.\d{1,4})?$
term_months
integerinteger
The full length of the loan's term, in months.

Minimum: 0
term_days
integerinteger
The full length of the loan's term, in days.

Minimum: 0
repayment_status
requiredstringrequired, string
The loan's repayment status.

Possible values: fully repaid, current, grace, deferment, forbearance, past due, delinquent, default, charged off, cancelled
principal_balance
requiredstringrequired, string
The loan's remaining principal.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
payoff_quote
stringstring
The instantaneous payoff quote.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
payoff_expiry
stringstring
The date until which payoff_quote is considered current.

Format: date
origination_date
requiredstringrequired, string
The loan's date of origination.

Format: date
origination_principal
stringstring
The original principal balance.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
maturity_date
stringstring
The loan's date of maturity.

Format: date
statements
[object][object]
Must describe statement periods for the account's entire history.
payment_paid_to_principal
stringstring
The amount of the payment paid to principal.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
payment_paid_to_interest
stringstring
The amount of the payment paid to interest.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
open_date
stringstring
The opening date of this statement period.

Format: date
close_date
stringstring
The closing date of this statement period. Use a future date if the statement period has not closed.

Format: date
balance_due
stringstring
The statement balance.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
minimum_payment_due
stringstring
The minimum payment due on this statement. If the statement is paid, this should be 0.00.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
payment_due_date
stringstring
The date payment is, or was, due for this statement.

Format: date
payment_received_date
stringstring
The date payment was received. If multiple payments were made during the period, count the date that payment_received_amount exceeded minimum_payment_due.

Format: date
payment_received_amount
stringstring
The sum of all payments received during the period.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
document_url
stringstring
A URL to a downloadable document form of this statement. Implementers should not assume that accessors of this URL are always authorized.
id
requiredstringrequired, string
Permanent account identifier. Do not use a full or masked account number for this value as this increases the risk of revealing Personally Identifiable Information (PII).
last_activity_at
stringstring
Date of most recent change to, or activity on this account, e.g. new transactions, or changes to account metadata. Used to provide hints for optimal scheduling of updates.

Format: date-time
ownership_type
stringstring
Indicates the ownership type of the account, not the relationship the current user has over the account.

Possible values: individual, joint, association, trust
owner_identity_ids
required[string]required, [string]
References to the identities for the owner(s) of this account.
non_owner_identity_ids
[string][string]
References to the identities for the non-owner(s) related to this account, e.g. trustees, beneficiaries.
status
requiredstringrequired, string
Status of this account.

Possible values: active, inactive, frozen, locked, flagged, restricted, closed
type
requiredstringrequired, string
Major classification of this account.

Possible values: depository, loan, investment
subtype
requiredstringrequired, string
Minor classification of this account.

Possible values: cash management, cd, checking, savings, money market, health, prepaid, gic, auto, commercial, construction, consumer, credit card, home equity, mortgage, overdraft, line of credit, student, 401a, 401k, 403B, 457b, 529, brokerage, esa, ira, isa, lira, other, rif, rsp, pension, profit-sharing, roth ira, roth 401k, sep ira, simple ira, sipp, stock plan, tsp, tfsa, custodial, variable annuity
name
stringstring
The account's user-given name, if the institution supports naming of accounts.
official_name
requiredstringrequired, string
The account's marketing or brand name.
display_mask
requiredstringrequired, string
A short alpha-numeric string to assist users in identifying the account, e.g. last four digits of the account number.
opening_date
stringstring
The date on which the account was opened.

Format: date
current_balance
requiredstringrequired, string
The total balance in the account, typically including pending transactions. See individual account types for specific definitions of this value.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
available_balance
requiredstringrequired, string
The immediately available balance in the account, typically the amount available to withdraw at the moment.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
tax_advantaged
booleanboolean
Indicates whether some activity on the account - deposits, gains, etc - benefits from tax deferral or exemption, e.g. HSA, IRA, 401(k) accounts.
currency
stringstring
The ISO-4217 currency in which this account’s transactions and balances are denominated.
non_iso_currency
stringstring
If the account is denominated in a non-ISO currency, provide the currency's symbol.
1{
2 "type": "loan",
3 "account_number": "string",
4 "reference_number": "string",
5 "servicer_identity_id": "string",
6 "interest_rate": "0.0199",
7 "interest_rate_type": "fixed",
8 "interest_rate_schedule": [
9 {
10 "start_date": "2018-08-28",
11 "end_date": "2018-08-28",
12 "interest_rate": "0.0199"
13 }
14 ],
15 "term_months": 0,
16 "term_days": 0,
17 "repayment_status": "fully repaid",
18 "principal_balance": "100.95",
19 "payoff_quote": "100.95",
20 "payoff_expiry": "2018-08-28",
21 "origination_date": "2018-08-28",
22 "origination_principal": "100.95",
23 "maturity_date": "2018-08-28",
24 "statements": [
25 {
26 "payment_paid_to_principal": "100.95",
27 "payment_paid_to_interest": "100.95",
28 "open_date": "2018-08-28",
29 "close_date": "2018-08-28",
30 "balance_due": "100.95",
31 "minimum_payment_due": "100.95",
32 "payment_due_date": "2018-08-28",
33 "payment_received_date": "2018-08-28",
34 "payment_received_amount": "100.95",
35 "document_url": "string"
36 }
37 ],
38 "id": "R13oiR6lC5jNC5jK",
39 "last_activity_at": "2020-04-21T12:45:00+00:00",
40 "ownership_type": "individual",
41 "owner_identity_ids": [
42 "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
43 ],
44 "non_owner_identity_ids": null,
45 "status": "active",
46 "subtype": "consumer",
47 "name": "Vacation Money",
48 "official_name": "Pro Checking",
49 "display_mask": "9833",
50 "opening_date": "2018-01-31",
51 "current_balance": "850.55",
52 "available_balance": "149.45",
53 "tax_advantaged": true,
54 "currency": "USD",
55 "non_iso_currency": null
56}
Was this helpful?

LoanStatement

Description of a loan account statement.

payment_paid_to_principal
stringstring
The amount of the payment paid to principal.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
payment_paid_to_interest
stringstring
The amount of the payment paid to interest.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
open_date
requiredstringrequired, string
The opening date of this statement period.

Format: date
close_date
requiredstringrequired, string
The closing date of this statement period. Use a future date if the statement period has not closed.

Format: date
balance_due
requiredstringrequired, string
The statement balance.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
minimum_payment_due
requiredstringrequired, string
The minimum payment due on this statement. If the statement is paid, this should be 0.00.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
payment_due_date
requiredstringrequired, string
The date payment is, or was, due for this statement.

Format: date
payment_received_date
requiredstringrequired, string
The date payment was received. If multiple payments were made during the period, count the date that payment_received_amount exceeded minimum_payment_due.

Format: date
payment_received_amount
requiredstringrequired, string
The sum of all payments received during the period.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
document_url
stringstring
A URL to a downloadable document form of this statement. Implementers should not assume that accessors of this URL are always authorized.
1{
2 "open_date": "2018-08-28",
3 "close_date": "2018-08-28",
4 "balance_due": "100.95",
5 "minimum_payment_due": "100.95",
6 "payment_due_date": "2018-08-28",
7 "payment_received_date": "2018-08-28",
8 "payment_received_amount": "100.95",
9 "document_url": "string"
10}
Was this helpful?

InterestRateType

Interest rate adjustment schemes.

fixed
stringstring
fixed rate.
adjustable
stringstring
Adjustable rate.
variable
stringstring
Variable rate.
other
stringstring
All other rate adjustment schemes.
Was this helpful?

InterestRatePeriod

Time-bound description of interest rates and their effective periods.

start_date
requiredstringrequired, string
The date this rate became, or becomes, effective.

Format: date
end_date
requiredstringrequired, string
The date this rate became, or becomes, ineffective. Use null if the end date is not known or not fixed.

Format: date
interest_rate
requiredstringrequired, string
The effective rate during the period described.

Pattern: ^\d*(\.\d{1,4})?$
1{
2 "start_date": "2018-08-28",
3 "end_date": "2018-08-28",
4 "interest_rate": "0.0199"
5}
Was this helpful?

LoanRepaymentStatus

Loan repayment status.

fully repaid
stringstring
The loan is fully repaid.
current
stringstring
The loan is current and the borrow is in good standing with respect to this loan.
grace
stringstring
Loan payments have not begun, and interest is not accruing.
deferment
stringstring
Loan payments are reduced or suspended, and interest is not accruing.
forbearance
stringstring
Loan payments are reduced or suspended, but deferred interest is accruing.
past due
stringstring
The borrower is past due, but can return the account to current.
delinquent
stringstring
The borrower is severely past due and the institution may begin Dunning.
default
stringstring
The borrower has defaulted and the institution may be pursuing other remedies.
charged off
stringstring
The borrower has defaulted and the institution has completed actions in connection with the default.
cancelled
stringstring
The lender has cancelled this loan (use also for forgiven or discharged loans).
Was this helpful?

MortgageAccount

Representation of a home mortgage loan.

subtype
requiredstringrequired, string
Minor classification of this account.

Possible values: cash management, cd, checking, savings, money market, health, prepaid, gic, auto, commercial, construction, consumer, credit card, home equity, mortgage, overdraft, line of credit, student, 401a, 401k, 403B, 457b, 529, brokerage, esa, ira, isa, lira, other, rif, rsp, pension, profit-sharing, roth ira, roth 401k, sep ira, simple ira, sipp, stock plan, tsp, tfsa, custodial, variable annuity
escrow_balance
stringstring
The total amount held in escrow for this loan, if applicable.
Fixed-point decimal number, carried up to six decimal places.


Pattern: ^-?(\d*)(?:\.\d{1,2})?$
id
requiredstringrequired, string
Permanent account identifier. Do not use a full or masked account number for this value as this increases the risk of revealing Personally Identifiable Information (PII).
last_activity_at
stringstring
Date of most recent change to, or activity on this account, e.g. new transactions, or changes to account metadata. Used to provide hints for optimal scheduling of updates.

Format: date-time
ownership_type
stringstring
Indicates the ownership type of the account, not the relationship the current user has over the account.

Possible values: individual, joint, association, trust
owner_identity_ids
required[string]required, [string]
References to the identities for the owner(s) of this account.
non_owner_identity_ids
[string][string]
References to the identities for the non-owner(s) related to this account, e.g. trustees, beneficiaries.
status
requiredstringrequired, string
Status of this account.

Possible values: active, inactive, frozen, locked, flagged, restricted, closed
type
requiredstringrequired, string
Major classification of this account.

Possible values: depository, loan, investment
name
stringstring
The account's user-given name, if the institution supports naming of accounts.
official_name
requiredstringrequired, string
The account's marketing or brand name.
display_mask
requiredstringrequired, string
A short alpha-numeric string to assist users in identifying the account, e.g. last four digits of the account number.
opening_date
stringstring
The date on which the account was opened.

Format: date
current_balance
requiredstringrequired, string
The total balance in the account, typically including pending transactions. See individual account types for specific definitions of this value.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
available_balance
requiredstringrequired, string
The immediately available balance in the account, typically the amount available to withdraw at the moment.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
tax_advantaged
booleanboolean
Indicates whether some activity on the account - deposits, gains, etc - benefits from tax deferral or exemption, e.g. HSA, IRA, 401(k) accounts.
currency
stringstring
The ISO-4217 currency in which this account’s transactions and balances are denominated.
non_iso_currency
stringstring
If the account is denominated in a non-ISO currency, provide the currency's symbol.
1{
2 "subtype": "mortgage",
3 "escrow_balance": "100.95",
4 "type": "loan",
5 "account_number": "string",
6 "reference_number": "string",
7 "servicer_identity_id": "string",
8 "interest_rate": "0.0199",
9 "interest_rate_type": "fixed",
10 "interest_rate_schedule": [
11 {
12 "start_date": "2018-08-28",
13 "end_date": "2018-08-28",
14 "interest_rate": "0.0199"
15 }
16 ],
17 "term_months": 0,
18 "term_days": 0,
19 "repayment_status": "fully repaid",
20 "principal_balance": "100.95",
21 "payoff_quote": "100.95",
22 "payoff_expiry": "2018-08-28",
23 "origination_date": "2018-08-28",
24 "origination_principal": "100.95",
25 "maturity_date": "2018-08-28",
26 "statements": [
27 {
28 "payment_paid_to_principal": "100.95",
29 "payment_paid_to_interest": "100.95",
30 "open_date": "2018-08-28",
31 "close_date": "2018-08-28",
32 "balance_due": "100.95",
33 "minimum_payment_due": "100.95",
34 "payment_due_date": "2018-08-28",
35 "payment_received_date": "2018-08-28",
36 "payment_received_amount": "100.95",
37 "document_url": "string"
38 }
39 ],
40 "id": "R13oiR6lC5jNC5jK",
41 "last_activity_at": "2020-04-21T12:45:00+00:00",
42 "ownership_type": "individual",
43 "owner_identity_ids": [
44 "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
45 ],
46 "non_owner_identity_ids": null,
47 "status": "active",
48 "name": "Vacation Money",
49 "official_name": "Pro Checking",
50 "display_mask": "9833",
51 "opening_date": "2018-01-31",
52 "current_balance": "850.55",
53 "available_balance": "149.45",
54 "tax_advantaged": true,
55 "currency": "USD",
56 "non_iso_currency": null
57}
Was this helpful?

StudentLoanAccount

Representational of a loan account that is specific to student loans

subtype
requiredstringrequired, string
Minor classification of this account.

Possible values: cash management, cd, checking, savings, money market, health, prepaid, gic, auto, commercial, construction, consumer, credit card, home equity, mortgage, overdraft, line of credit, student, 401a, 401k, 403B, 457b, 529, brokerage, esa, ira, isa, lira, other, rif, rsp, pension, profit-sharing, roth ira, roth 401k, sep ira, simple ira, sipp, stock plan, tsp, tfsa, custodial, variable annuity
disbursement_schedule
[object][object]
The schedule for disbursement of funds.
disbursement_date
stringstring
The date of disbursement.

Format: date
amount
stringstring
The amount disbursed.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
guarantor_identity
objectobject
The company or agency guaranteeing the loan.
organization
objectobject
Describes an organization, e.g., a business or non-profit.
name
stringstring
Name of the organization represented.
structure
stringstring
Type of business structure.

Possible values: sole, partnership, llc, corp
mcc
stringstring
The ISO-18245 merchant category code for this business.

Pattern: ^\d{4}$
owner_identity_ids
[string][string]
The identities of the organization owner(s).
tax_identifier
objectobject
The tax authority ID.
tax_authority
stringstring
Name of the tax authority.
tax_payer_id
stringstring
The tax payer ID, e.g. EIN, TIN, SSN.
country
stringstring
The national jurisdiction of the tax authority in ISO 3166-1 format.
subdivision
stringstring
If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.
person
objectobject
Describes an individual, named person.
first_name
stringstring
Legal given name of the personal entity.
middle_name
stringstring
Middle name, use blank if none.
last_name
stringstring
Last name or family name.
date_of_birth
stringstring
The date of birth in ISO-8601 format.

Format: date
tax_identifier
objectobject
The tax authority ID.
tax_authority
stringstring
Name of the tax authority.
tax_payer_id
stringstring
The tax payer ID, e.g. EIN, TIN, SSN.
country
stringstring
The national jurisdiction of the tax authority in ISO 3166-1 format.
subdivision
stringstring
If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.
email
stringstring
The email address where this entity can be contacted.
mailing_address
objectobject
Description of a street address.
lines
[string][string]
The lines of the street address.

Min items: 1
city
stringstring
The city of the mailing address.
region
stringstring
The first-level administrative subdivision, e.g., a state, province or district. Use ISO 3166-2 subdivisions (note: not ISO-3166-alpha-2).
country
stringstring
The ISO 3166-alpha-2 country code.
postal_code
stringstring
The postal code.
phone
stringstring
The phone number, formatted using ITU standard E. 123.
id
stringstring
Permanent identity identifier.
name
stringstring
The display name of this entity (insufficient for KYC purposes)
pslf_eligibility
objectobject
Description of the loan's eligibility for public service forgiveness.
eligible
booleanboolean
Indicates the loan's eligibility for PSLF.
qualifying_payments
integerinteger
The number of payments made which qualify under PSLF.

Minimum: 0
total_payments
integerinteger
Total payments required for forgiveness.

Minimum: 0
sequence_number
stringstring
The loan's sequence number.
id
requiredstringrequired, string
Permanent account identifier. Do not use a full or masked account number for this value as this increases the risk of revealing Personally Identifiable Information (PII).
last_activity_at
stringstring
Date of most recent change to, or activity on this account, e.g. new transactions, or changes to account metadata. Used to provide hints for optimal scheduling of updates.

Format: date-time
ownership_type
stringstring
Indicates the ownership type of the account, not the relationship the current user has over the account.

Possible values: individual, joint, association, trust
owner_identity_ids
required[string]required, [string]
References to the identities for the owner(s) of this account.
non_owner_identity_ids
[string][string]
References to the identities for the non-owner(s) related to this account, e.g. trustees, beneficiaries.
status
requiredstringrequired, string
Status of this account.

Possible values: active, inactive, frozen, locked, flagged, restricted, closed
type
requiredstringrequired, string
Major classification of this account.

Possible values: depository, loan, investment
name
stringstring
The account's user-given name, if the institution supports naming of accounts.
official_name
requiredstringrequired, string
The account's marketing or brand name.
display_mask
requiredstringrequired, string
A short alpha-numeric string to assist users in identifying the account, e.g. last four digits of the account number.
opening_date
stringstring
The date on which the account was opened.

Format: date
current_balance
requiredstringrequired, string
The total balance in the account, typically including pending transactions. See individual account types for specific definitions of this value.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
available_balance
requiredstringrequired, string
The immediately available balance in the account, typically the amount available to withdraw at the moment.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
tax_advantaged
booleanboolean
Indicates whether some activity on the account - deposits, gains, etc - benefits from tax deferral or exemption, e.g. HSA, IRA, 401(k) accounts.
currency
stringstring
The ISO-4217 currency in which this account’s transactions and balances are denominated.
non_iso_currency
stringstring
If the account is denominated in a non-ISO currency, provide the currency's symbol.
1{
2 "subtype": "student",
3 "disbursement_schedule": [
4 {
5 "disbursement_date": "2018-08-28",
6 "amount": "100.95"
7 }
8 ],
9 "guarantor_identity": {
10 "organization": {
11 "name": "Doe Business, Inc.",
12 "structure": "sole",
13 "mcc": "5542",
14 "owner_identity_ids": [
15 "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
16 ],
17 "tax_identifier": {
18 "tax_authority": "IRS",
19 "tax_payer_id": "string"
20 }
21 },
22 "person": {
23 "first_name": "Jane",
24 "middle_name": "Joan",
25 "last_name": "Doe",
26 "date_of_birth": "1987-01-31",
27 "tax_identifier": {
28 "tax_authority": "IRS",
29 "tax_payer_id": "string"
30 }
31 },
32 "email": "jane@plaid.com",
33 "mailing_address": {
34 "lines": [
35 "413 Leeward Way",
36 "Apt 3A"
37 ],
38 "city": "San Francisco",
39 "region": "US-CA",
40 "country": "US",
41 "postal_code": "94106",
42 "phone": "+1 415 555 1212"
43 },
44 "id": "d7f1b8b9-0006-4135-91c0-b5532045a314",
45 "name": "Jane Doe"
46 },
47 "pslf_eligibility": {
48 "eligible": true,
49 "qualifying_payments": 0,
50 "total_payments": 0
51 },
52 "sequence_number": "string",
53 "type": "loan",
54 "account_number": "string",
55 "reference_number": "string",
56 "servicer_identity_id": "string",
57 "interest_rate": "0.0199",
58 "interest_rate_type": "fixed",
59 "interest_rate_schedule": [
60 {
61 "start_date": "2018-08-28",
62 "end_date": "2018-08-28",
63 "interest_rate": "0.0199"
64 }
65 ],
66 "term_months": 0,
67 "term_days": 0,
68 "repayment_status": "fully repaid",
69 "principal_balance": "100.95",
70 "payoff_quote": "100.95",
71 "payoff_expiry": "2018-08-28",
72 "origination_date": "2018-08-28",
73 "origination_principal": "100.95",
74 "maturity_date": "2018-08-28",
75 "statements": [
76 {
77 "payment_paid_to_principal": "100.95",
78 "payment_paid_to_interest": "100.95",
79 "open_date": "2018-08-28",
80 "close_date": "2018-08-28",
81 "balance_due": "100.95",
82 "minimum_payment_due": "100.95",
83 "payment_due_date": "2018-08-28",
84 "payment_received_date": "2018-08-28",
85 "payment_received_amount": "100.95",
86 "document_url": "string"
87 }
88 ],
89 "id": "R13oiR6lC5jNC5jK",
90 "last_activity_at": "2020-04-21T12:45:00+00:00",
91 "ownership_type": "individual",
92 "owner_identity_ids": [
93 "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
94 ],
95 "non_owner_identity_ids": null,
96 "status": "active",
97 "name": "Vacation Money",
98 "official_name": "Pro Checking",
99 "display_mask": "9833",
100 "opening_date": "2018-01-31",
101 "current_balance": "850.55",
102 "available_balance": "149.45",
103 "tax_advantaged": true,
104 "currency": "USD",
105 "non_iso_currency": null
106}
Was this helpful?

Disbursement

Description of a loan (typically student loan) disbursement event.

disbursement_date
requiredstringrequired, string
The date of disbursement.

Format: date
amount
requiredstringrequired, string
The amount disbursed.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
1{
2 "disbursement_date": "2018-08-28",
3 "amount": "100.95"
4}
Was this helpful?

PslfEligibility

Student loan PSLF eligibility status information.

eligible
requiredbooleanrequired, boolean
Indicates the loan's eligibility for PSLF.
qualifying_payments
integerinteger
The number of payments made which qualify under PSLF.

Minimum: 0
total_payments
integerinteger
Total payments required for forgiveness.

Minimum: 0
1{
2 "eligible": true,
3 "qualifying_payments": 0,
4 "total_payments": 0
5}
Was this helpful?

CreditCardAccount

Representation of
 credit card.

type
requiredstringrequired, string
Major classification of this account.

Possible values: depository, loan, investment
subtype
requiredstringrequired, string
Minor classification of this account.

Possible values: cash management, cd, checking, savings, money market, health, prepaid, gic, auto, commercial, construction, consumer, credit card, home equity, mortgage, overdraft, line of credit, student, 401a, 401k, 403B, 457b, 529, brokerage, esa, ira, isa, lira, other, rif, rsp, pension, profit-sharing, roth ira, roth 401k, sep ira, simple ira, sipp, stock plan, tsp, tfsa, custodial, variable annuity
current_balance
requiredstringrequired, string
The total balance in the account, typically including pending transactions. See individual account types for specific definitions of this value.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
available_balance
requiredstringrequired, string
The immediately available balance in the account, typically the amount available to withdraw at the moment.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
reward_balance
stringstring
The balance of any rewards associated with this account.
Fixed-point decimal number, carried up to six decimal places.


Pattern: ^-?(\d*)(?:\.\d{1,2})?$
credit_limit
requiredstringrequired, string
The total credit limit for this account. If card has no limit, use null.
Fixed-point decimal number, carried up to six decimal places.


Pattern: ^-?(\d*)(?:\.\d{1,2})?$
spender_identity_ids
[string][string]
References to the Identities for non-owner authorized spenders.
interest_rates
[object][object]
Effective interest rates for different balances associated with this card.
start_date
stringstring
The date this rate came into effect, typical of special offer rates, e.g. 0% purchase rate for 12 months. Use start_date and end_date to represent changes in the purchase APR as well.

Format: date
end_date
stringstring
The date this rate ends being effective for this rate type. Use null when the rate does not have a set end date.

Format: date
type
stringstring
The type of balance subject to this rate.

Possible values: purchase, cash advance, balance transfer
interest_rate
stringstring
The APR covering this balance.

Pattern: ^\d*(\.\d{1,4})?$
subject_balance
stringstring
The current balance subject to this rate, following the definition of current_balance.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
interest_charged
stringstring
The amount within the subject_balance that was generated by this interest rate.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
statements
[object][object]
Must describe statement periods for previous two years.
open_date
stringstring
The opening date of this statement period.

Format: date
close_date
stringstring
The closing date of this statement period. Use a future date if the statement period has not closed.

Format: date
balance_due
stringstring
The statement balance.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
minimum_payment_due
stringstring
The minimum payment due on this statement. If the statement is paid, this should be 0.00.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
payment_due_date
stringstring
The date payment is, or was, due for this statement.

Format: date
payment_received_date
stringstring
The date payment was received. If multiple payments were made during the period, count the date that payment_received_amount exceeded minimum_payment_due.

Format: date
payment_received_amount
stringstring
The sum of all payments received during the period.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
document_url
stringstring
A URL to a downloadable document form of this statement. Implementers should not assume that accessors of this URL are always authorized.
reward_currency
stringstring
The ISO-4217 currency in which this account's reward balances are denominated
reward_non_iso_currency
stringstring
If the account's reward balance is denominated in a non-ISO currency, provide the currency's symbol
art_asset_url
stringstring
URL reference to an image of the payment card face.
id
requiredstringrequired, string
Permanent account identifier. Do not use a full or masked account number for this value as this increases the risk of revealing Personally Identifiable Information (PII).
last_activity_at
stringstring
Date of most recent change to, or activity on this account, e.g. new transactions, or changes to account metadata. Used to provide hints for optimal scheduling of updates.

Format: date-time
ownership_type
stringstring
Indicates the ownership type of the account, not the relationship the current user has over the account.

Possible values: individual, joint, association, trust
owner_identity_ids
required[string]required, [string]
References to the identities for the owner(s) of this account.
non_owner_identity_ids
[string][string]
References to the identities for the non-owner(s) related to this account, e.g. trustees, beneficiaries.
status
requiredstringrequired, string
Status of this account.

Possible values: active, inactive, frozen, locked, flagged, restricted, closed
name
stringstring
The account's user-given name, if the institution supports naming of accounts.
official_name
requiredstringrequired, string
The account's marketing or brand name.
display_mask
requiredstringrequired, string
A short alpha-numeric string to assist users in identifying the account, e.g. last four digits of the account number.
opening_date
stringstring
The date on which the account was opened.

Format: date
tax_advantaged
booleanboolean
Indicates whether some activity on the account - deposits, gains, etc - benefits from tax deferral or exemption, e.g. HSA, IRA, 401(k) accounts.
currency
stringstring
The ISO-4217 currency in which this account’s transactions and balances are denominated.
non_iso_currency
stringstring
If the account is denominated in a non-ISO currency, provide the currency's symbol.
1{
2 "type": "loan",
3 "subtype": "credit card",
4 "current_balance": "850.55",
5 "available_balance": "149.45",
6 "reward_balance": "100.95",
7 "credit_limit": "1000",
8 "spender_identity_ids": [
9 "string"
10 ],
11 "interest_rates": [
12 {
13 "start_date": "2018-08-28",
14 "end_date": "2018-08-28",
15 "type": "purchase",
16 "interest_rate": "0.0199",
17 "subject_balance": "100.95",
18 "interest_charged": "100.95"
19 }
20 ],
21 "statements": [
22 {
23 "open_date": "2018-08-28",
24 "close_date": "2018-08-28",
25 "balance_due": "100.95",
26 "minimum_payment_due": "100.95",
27 "payment_due_date": "2018-08-28",
28 "payment_received_date": "2018-08-28",
29 "payment_received_amount": "100.95",
30 "document_url": "string"
31 }
32 ],
33 "reward_currency": "USD",
34 "reward_non_iso_currency": null,
35 "art_asset_url": "string",
36 "id": "R13oiR6lC5jNC5jK",
37 "last_activity_at": "2020-04-21T12:45:00+00:00",
38 "ownership_type": "individual",
39 "owner_identity_ids": [
40 "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
41 ],
42 "non_owner_identity_ids": null,
43 "status": "active",
44 "name": "Vacation Money",
45 "official_name": "Pro Checking",
46 "display_mask": "9833",
47 "opening_date": "2018-01-31",
48 "tax_advantaged": true,
49 "currency": "USD",
50 "non_iso_currency": null
51}
Was this helpful?

CreditCardStatement

Description of a credit card account statement.

open_date
requiredstringrequired, string
The opening date of this statement period.

Format: date
close_date
requiredstringrequired, string
The closing date of this statement period. Use a future date if the statement period has not closed.

Format: date
balance_due
requiredstringrequired, string
The statement balance.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
minimum_payment_due
requiredstringrequired, string
The minimum payment due on this statement. If the statement is paid, this should be 0.00.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
payment_due_date
requiredstringrequired, string
The date payment is, or was, due for this statement.

Format: date
payment_received_date
requiredstringrequired, string
The date payment was received. If multiple payments were made during the period, count the date that payment_received_amount exceeded minimum_payment_due.

Format: date
payment_received_amount
requiredstringrequired, string
The sum of all payments received during the period.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
document_url
stringstring
A URL to a downloadable document form of this statement. Implementers should not assume that accessors of this URL are always authorized.
1{
2 "open_date": "2018-08-28",
3 "close_date": "2018-08-28",
4 "balance_due": "100.95",
5 "minimum_payment_due": "100.95",
6 "payment_due_date": "2018-08-28",
7 "payment_received_date": "2018-08-28",
8 "payment_received_amount": "100.95",
9 "document_url": "string"
10}
Was this helpful?

CreditCardInterestRate

Description of a credit card interest rate.

start_date
requiredstringrequired, string
The date this rate came into effect, typical of special offer rates, e.g. 0% purchase rate for 12 months. Use start_date and end_date to represent changes in the purchase APR as well.

Format: date
end_date
requiredstringrequired, string
The date this rate ends being effective for this rate type. Use null when the rate does not have a set end date.

Format: date
type
requiredstringrequired, string
The type of balance subject to this rate.

Possible values: purchase, cash advance, balance transfer
interest_rate
requiredstringrequired, string
The APR covering this balance.

Pattern: ^\d*(\.\d{1,4})?$
subject_balance
requiredstringrequired, string
The current balance subject to this rate, following the definition of current_balance.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
interest_charged
requiredstringrequired, string
The amount within the subject_balance that was generated by this interest rate.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
1{
2 "start_date": "2018-08-28",
3 "end_date": "2018-08-28",
4 "type": "purchase",
5 "interest_rate": "0.0199",
6 "subject_balance": "100.95",
7 "interest_charged": "100.95"
8}
Was this helpful?

CreditCardInterestRateType

Describes a type of interest rate covering a credit card balance.

purchase
stringstring
Purchases.
cash advance
stringstring
Cash advances.
balance transfer
stringstring
Balance transfers (not payments).
Was this helpful?

Identity

BasicIdentity

A lightweight identity container suitable for passing minimal identification.

id
requiredstringrequired, string
Permanent identity identifier.
name
requiredstringrequired, string
The display name of this entity (insufficient for KYC purposes)
email
stringstring
The email address where this entity can be contacted.
1{
2 "id": "d7f1b8b9-0006-4135-91c0-b5532045a314",
3 "name": "Jane Doe",
4 "email": "jane@plaid.com"
5}
Was this helpful?

FullIdentity

Full identity container compatible with most PII-exchange use cases.

organization
objectobject
Describes an organization, e.g., a business or non-profit.
name
stringstring
Name of the organization represented.
structure
stringstring
Type of business structure.

Possible values: sole, partnership, llc, corp
mcc
stringstring
The ISO-18245 merchant category code for this business.

Pattern: ^\d{4}$
owner_identity_ids
[string][string]
The identities of the organization owner(s).
tax_identifier
objectobject
The tax authority ID.
tax_authority
stringstring
Name of the tax authority.
tax_payer_id
stringstring
The tax payer ID, e.g. EIN, TIN, SSN.
country
stringstring
The national jurisdiction of the tax authority in ISO 3166-1 format.
subdivision
stringstring
If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.
person
objectobject
Describes an individual, named person.
first_name
stringstring
Legal given name of the personal entity.
middle_name
stringstring
Middle name, use blank if none.
last_name
stringstring
Last name or family name.
date_of_birth
stringstring
The date of birth in ISO-8601 format.

Format: date
tax_identifier
objectobject
The tax authority ID.
tax_authority
stringstring
Name of the tax authority.
tax_payer_id
stringstring
The tax payer ID, e.g. EIN, TIN, SSN.
country
stringstring
The national jurisdiction of the tax authority in ISO 3166-1 format.
subdivision
stringstring
If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.
email
requiredstringrequired, string
The email address where this entity can be contacted.
mailing_address
objectobject
Description of a street address.
lines
[string][string]
The lines of the street address.

Min items: 1
city
stringstring
The city of the mailing address.
region
stringstring
The first-level administrative subdivision, e.g., a state, province or district. Use ISO 3166-2 subdivisions (note: not ISO-3166-alpha-2).
country
stringstring
The ISO 3166-alpha-2 country code.
postal_code
stringstring
The postal code.
phone
stringstring
The phone number, formatted using ITU standard E. 123.
id
requiredstringrequired, string
Permanent identity identifier.
name
requiredstringrequired, string
The display name of this entity (insufficient for KYC purposes)
1{
2 "organization": {
3 "name": "Doe Business, Inc.",
4 "structure": "sole",
5 "mcc": "5542",
6 "owner_identity_ids": [
7 "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
8 ],
9 "tax_identifier": {
10 "tax_authority": "IRS",
11 "tax_payer_id": "string"
12 }
13 },
14 "person": {
15 "first_name": "Jane",
16 "middle_name": "Joan",
17 "last_name": "Doe",
18 "date_of_birth": "1987-01-31",
19 "tax_identifier": {
20 "tax_authority": "IRS",
21 "tax_payer_id": "string"
22 }
23 },
24 "email": "jane@plaid.com",
25 "mailing_address": {
26 "lines": [
27 "413 Leeward Way",
28 "Apt 3A"
29 ],
30 "city": "San Francisco",
31 "region": "US-CA",
32 "country": "US",
33 "postal_code": "94106",
34 "phone": "+1 415 555 1212"
35 },
36 "id": "d7f1b8b9-0006-4135-91c0-b5532045a314",
37 "name": "Jane Doe"
38}
Was this helpful?

MailingAddress

Description of a street address.

lines
required[string]required, [string]
The lines of the street address.

Min items: 1
city
requiredstringrequired, string
The city of the mailing address.
region
stringstring
The first-level administrative subdivision, e.g., a state, province or district. Use ISO 3166-2 subdivisions (note: not ISO-3166-alpha-2).
country
requiredstringrequired, string
The ISO 3166-alpha-2 country code.
postal_code
stringstring
The postal code.
phone
stringstring
The phone number, formatted using ITU standard E. 123.
1{
2 "lines": [
3 "413 Leeward Way",
4 "Apt 3A"
5 ],
6 "city": "San Francisco",
7 "region": "US-CA",
8 "country": "US",
9 "postal_code": "94106",
10 "phone": "+1 415 555 1212"
11}
Was this helpful?

PersonalEntity

Describes an individual, named person.

first_name
requiredstringrequired, string
Legal given name of the personal entity.
middle_name
requiredstringrequired, string
Middle name, use blank if none.
last_name
requiredstringrequired, string
Last name or family name.
date_of_birth
stringstring
The date of birth in ISO-8601 format.

Format: date
tax_identifier
objectobject
The tax authority ID.
tax_authority
stringstring
Name of the tax authority.
tax_payer_id
stringstring
The tax payer ID, e.g. EIN, TIN, SSN.
country
stringstring
The national jurisdiction of the tax authority in ISO 3166-1 format.
subdivision
stringstring
If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.
1{
2 "first_name": "Jane",
3 "middle_name": "Joan",
4 "last_name": "Doe",
5 "date_of_birth": "1987-01-31",
6 "tax_identifier": {
7 "tax_authority": "IRS",
8 "tax_payer_id": "string"
9 }
10}
Was this helpful?

OrganizationalEntity

Describes an organization, e.g., a business or non-profit.

name
requiredstringrequired, string
Name of the organization represented.
structure
stringstring
Type of business structure.

Possible values: sole, partnership, llc, corp
mcc
stringstring
The ISO-18245 merchant category code for this business.

Pattern: ^\d{4}$
owner_identity_ids
[string][string]
The identities of the organization owner(s).
tax_identifier
objectobject
The tax authority ID.
tax_authority
stringstring
Name of the tax authority.
tax_payer_id
stringstring
The tax payer ID, e.g. EIN, TIN, SSN.
country
stringstring
The national jurisdiction of the tax authority in ISO 3166-1 format.
subdivision
stringstring
If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.
1{
2 "name": "Doe Business, Inc.",
3 "structure": "sole",
4 "mcc": 5542,
5 "owner_identity_ids": [
6 "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
7 ],
8 "tax_identifier": {
9 "tax_authority": "IRS",
10 "tax_payer_id": "string",
11 "country": "US"
12 }
13}
Was this helpful?

USBusinessStructure

Enumeration of business structures in the U.S.

sole
stringstring
Sole proprietorship.
partnership
stringstring
Partnership, e.g. limited partnership, general partnership.
llc
stringstring
Limited liability company.
corp
stringstring
C-corp, S-corp, not-for-profit, etc.
Was this helpful?

TaxIdentifier

Tax identifiers model an international-compliant identity within a tax authority. Use these to communicate a taxable entity’s identity within a jurisdiction.

tax_authority
requiredstringrequired, string
Name of the tax authority.
tax_payer_id
requiredstringrequired, string
The tax payer ID, e.g. EIN, TIN, SSN.
country
requiredstringrequired, string
The national jurisdiction of the tax authority in ISO 3166-1 format.
subdivision
stringstring
If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.
1{
2 "tax_authority": "IRS",
3 "tax_payer_id": "string",
4 "country": "US",
5 "subdivision": ""
6}
Was this helpful?

Transaction

BaseTransaction

Base properties for all transactions.

id
requiredstringrequired, string
Permanent, unique transaction identifier. Must survive changes to pending status or amount.
account_id
requiredstringrequired, string
References to the account that this transaction is posting against.
description
requiredstringrequired, string
Description of the transaction.
Nullable: true
memo
stringstring
Addenda or distinguishing information for the transaction.
category
[string][string]
Hierarchical categorization, use multi-valued array to indicate hierarchy.
tags
[string][string]
Flat categorization. For hashtags omit leading #.
ending_balance
stringstring
The balance of the account after this transaction posts.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
transacted_at
requiredstringrequired, string
The date/time when the transaction was authorized, in the time zone local to the transaction or to the customer.

Format: date-time
settled_at
requiredstringrequired, string
The date/time when the transaction settled, in the time zone local to the customer. Must be null if the transaction is pending.
Nullable: true


Format: date-time
spender_identity_id
stringstring
Reference to the identity of the authorized spender who conducted this transaction.
merchant_identity_id
stringstring
Reference to the identity of the merchant related to this transaction.
geolocation
objectobject
Geographic location where this transaction occurs.
coordinates
objectobject
Geographic coordinates in EPSG:4326 WGS84 (lat/long)
lat
numbernumber
Latitude coordinate.
lon
numbernumber
Longitude coordinate.
city
stringstring
City name.
region
stringstring
Region identifier.
country
stringstring
Country identifier.
reward_currency
stringstring
The ISO 4217 currency in which this transaction's reward contribution is denominated. example: USD
reward_non_iso_currency
stringstring
If the reward contribution is denominated in a non-ISO currency, provide the currency's symbol.
currency
stringstring
The ISO 4217 currency in which this transaction is denominated. One of either the currency or non_iso_currency fields is required.
non_iso_currency
stringstring
If the transaction is denominated in a non-ISO currency, provide the currency's symbol.
1{
2 "id": "6AOU0jwFQw3sMZJ",
3 "account_id": 100273,
4 "description": "Finance Charge",
5 "memo": "Check #318",
6 "category": [
7 "electronics",
8 "desktop",
9 "accessories"
10 ],
11 "tags": [
12 "electronics",
13 "accessories"
14 ],
15 "ending_balance": "100.95",
16 "transacted_at": "2019-08-22T14:15:22Z",
17 "settled_at": "2019-08-25T08:15:42Z",
18 "spender_identity_id": "uid_1234",
19 "merchant_identity_id": "amazon_880",
20 "geolocation": {
21 "coordinates": {
22 "lat": 40.7128,
23 "lon": 74.006
24 },
25 "city": "New York",
26 "region": "US-NY",
27 "country": "US"
28 },
29 "reward_non_iso_currency": null,
30 "currency": "USD",
31 "non_iso_currency": null
32}
Was this helpful?

DepositoryOrCreditTransaction

Describes a transaction against a depository or credit card account.

type
stringstring
Classification of DepositoryOrCreditTransaction by purpose as an enum. transfer: A transfer between accounts, or balance transfer (for credit cards). cash: Cash withdrawal, or cash advance (for credit cards) including check drafts. fee: Finance charges, or fees associated with account management, e.g. ATM fees, overdraft charges, etc. purchase: Ordinary purchase activity, subject to the purchase APR (for credit cards). interest: Interest earned, not finance charges on carried balance (use fee). deposit: Cash or electronic deposit from an external account, not a transfer; or a payment (for credit cards).

Possible values: transfer, cash, fee, purchase, interest, deposit
pending
requiredbooleanrequired, boolean
Indicates that this transaction has not posted.
amount
requiredstringrequired, string
The amount of the transaction. Use a positive amount for transactions where money is flowing out of the account, and a negative amount for those where money flows into the account.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
fee_amount
stringstring
The amount of fees associated with this transaction.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
reward_amount
stringstring
The amount of rewards associated with this transaction.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
reward_rate
stringstring
The effective rate of reward for this transaction.

Pattern: ^\d*(\.\d{1,4})?$
transfer_account_id
stringstring
If this transaction is an internal transfer type, references the account_id associated with this transaction.
method
stringstring
Classification of DepositoryOrCreditTransaction by method. card present: Transaction was conducted by a physical payment card interaction (e.g. swipe, chip-and-sign, contactless). card not present: Card was not physically present for transaction (e.g. online or phone order). check: Check drafted against account. eft: Electronic funds transfer.

Possible values: card present, card not present, check, eft
id
requiredstringrequired, string
Permanent, unique transaction identifier. Must survive changes to pending status or amount.
account_id
requiredstringrequired, string
References to the account that this transaction is posting against.
description
requiredstringrequired, string
Description of the transaction.
Nullable: true
memo
stringstring
Addenda or distinguishing information for the transaction.
category
[string][string]
Hierarchical categorization, use multi-valued array to indicate hierarchy.
tags
[string][string]
Flat categorization. For hashtags omit leading #.
ending_balance
stringstring
The balance of the account after this transaction posts.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
transacted_at
requiredstringrequired, string
The date/time when the transaction was authorized, in the time zone local to the transaction or to the customer.

Format: date-time
settled_at
requiredstringrequired, string
The date/time when the transaction settled, in the time zone local to the customer. Must be null if the transaction is pending.
Nullable: true


Format: date-time
spender_identity_id
stringstring
Reference to the identity of the authorized spender who conducted this transaction.
merchant_identity_id
stringstring
Reference to the identity of the merchant related to this transaction.
geolocation
objectobject
Geographic location where this transaction occurs.
coordinates
objectobject
Geographic coordinates in EPSG:4326 WGS84 (lat/long)
lat
numbernumber
Latitude coordinate.
lon
numbernumber
Longitude coordinate.
city
stringstring
City name.
region
stringstring
Region identifier.
country
stringstring
Country identifier.
reward_currency
stringstring
The ISO 4217 currency in which this transaction's reward contribution is denominated. example: USD
reward_non_iso_currency
stringstring
If the reward contribution is denominated in a non-ISO currency, provide the currency's symbol.
currency
stringstring
The ISO 4217 currency in which this transaction is denominated. One of either the currency or non_iso_currency fields is required.
non_iso_currency
stringstring
If the transaction is denominated in a non-ISO currency, provide the currency's symbol.
1{
2 "type": "purchase",
3 "pending": false,
4 "amount": "100.95",
5 "fee_amount": "0",
6 "reward_amount": "2.01",
7 "reward_rate": "0.0199",
8 "transfer_account_id": null,
9 "method": "card present",
10 "id": "6AOU0jwFQw3sMZJ",
11 "account_id": "account1234",
12 "description": "Finance Charge",
13 "memo": "Check #318",
14 "category": [
15 "grocery",
16 "meat"
17 ],
18 "tags": [
19 "grocery"
20 ],
21 "ending_balance": "100.95",
22 "transacted_at": "2019-08-24T14:15:22Z",
23 "settled_at": "2019-08-25T08:45:03Z",
24 "spender_identity_id": "uid_1234",
25 "merchant_identity_id": "target",
26 "geolocation": {
27 "coordinates": {
28 "lat": 40.7128,
29 "lon": 74.006
30 },
31 "city": "New York",
32 "region": "US-NY",
33 "country": "US"
34 },
35 "reward_currency": "USD",
36 "reward_non_iso_currency": null,
37 "currency": "USD",
38 "non_iso_currency": null
39}
Was this helpful?

DepositoryOrCreditTransactionType

Classification of DepositoryOrCreditTransaction by purpose as an enum.

transfer
stringstring
A transfer between accounts, or balance transfer (for credit cards).
cash
stringstring
Cash withdrawal, or cash advance (for credit cards) including check drafts.
fee
stringstring
Finance charges, or fees associated with account management, e.g. ATM fees, overdraft charges, etc.
purchase
stringstring
Ordinary purchase activity, subject to the purchase APR (for credit cards).
interest
stringstring
Interest earned, not finance charges on carried balance (use fee).
deposit
stringstring
Cash or electronic deposit from an external account, not a transfer; or a payment (for credit cards).
Was this helpful?

DepositoryOrCreditTransactionMethod

Classification of DepositoryOrCreditTransaction by method.

card present
stringstring
Transaction was conducted by a physical payment card interaction (e.g. swipe, chip-and-sign, contactless).
card not present
stringstring
Card was not physically present for transaction (e.g. online or phone order).
check
stringstring
Check drafted against account.
eft
stringstring
Electronic funds transfer.
Was this helpful?

InvestmentTransaction

Describes a transaction in an investment account.

amount
requiredstringrequired, string
The amount associated with this transaction. Should be the product of price and quantity, plus fees.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
type
requiredstringrequired, string
Classification of InvestmentTransaction by purpose. Values: buy: Activity increasing the quantity of a holding. sell: Activity decreasing the quantity of a holding. cash: Activity modifying the account’s cash position. fee: Fees on the account, e.g. commission, bookkeeping, options-related charges. transfer: Activity which modifies a position, outside of buying/selling activity e.g., options exercise, portfolio transfer. purchase: Ordinary purchase activity, subject to the purchase APR (for credit cards). interest: Interest earned, not finance charges on carried balance (use fee). deposit: Cash or electronic deposit from an external account, not a transfer; or a payment (for credit cards).

Possible values: buy, sell, cash, fee, transfer, purchase, interest, deposit
security_id
requiredstringrequired, string
Reference to the security that the transaction is posting for.
quantity
requiredstringrequired, string
The quantity of the security involved in this transaction.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
price
requiredstringrequired, string
The price of the security at which the transaction occured.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
fees
stringstring
The total combined fees associated with this transaction.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
status
requiredstringrequired, string
Status of an InvestmentTransaction. pending: The trade is in progress, or transfer is pending. settled: The transaction has completed. cancelled: The transaction was cancelled, or represents the cancelled portion of a previous order.

Possible values: pending, settled, cancelled
cancel_transaction_id
stringstring
If the status is cancelled, but this transaction represents the unfulfilled portion of a partially filled order, provide the transaction_id of the transaction representing the filled portion.
id
requiredstringrequired, string
Permanent, unique transaction identifier. Must survive changes to pending status or amount.
account_id
requiredstringrequired, string
References to the account that this transaction is posting against.
description
requiredstringrequired, string
Description of the transaction.
Nullable: true
memo
stringstring
Addenda or distinguishing information for the transaction.
category
[string][string]
Hierarchical categorization, use multi-valued array to indicate hierarchy.
tags
[string][string]
Flat categorization. For hashtags omit leading #.
ending_balance
stringstring
The balance of the account after this transaction posts.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
transacted_at
requiredstringrequired, string
The date/time when the transaction was authorized, in the time zone local to the transaction or to the customer.

Format: date-time
settled_at
requiredstringrequired, string
The date/time when the transaction settled, in the time zone local to the customer. Must be null if the transaction is pending.
Nullable: true


Format: date-time
spender_identity_id
stringstring
Reference to the identity of the authorized spender who conducted this transaction.
merchant_identity_id
stringstring
Reference to the identity of the merchant related to this transaction.
geolocation
objectobject
Geographic location where this transaction occurs.
coordinates
objectobject
Geographic coordinates in EPSG:4326 WGS84 (lat/long)
lat
numbernumber
Latitude coordinate.
lon
numbernumber
Longitude coordinate.
city
stringstring
City name.
region
stringstring
Region identifier.
country
stringstring
Country identifier.
reward_currency
stringstring
The ISO 4217 currency in which this transaction's reward contribution is denominated. example: USD
reward_non_iso_currency
stringstring
If the reward contribution is denominated in a non-ISO currency, provide the currency's symbol.
currency
stringstring
The ISO 4217 currency in which this transaction is denominated. One of either the currency or non_iso_currency fields is required.
non_iso_currency
stringstring
If the transaction is denominated in a non-ISO currency, provide the currency's symbol.
1{
2 "value": {
3 "amount": "100.95",
4 "type": "buy",
5 "security_id": "string",
6 "quantity": "100.95",
7 "price": "100.95",
8 "fees": "100.95",
9 "status": "settled",
10 "cancel_transaction_id": "string",
11 "id": "6AOU0jwFQw3sMZJ",
12 "account_id": "account_1234",
13 "description": "Finance Charge",
14 "memo": "Check #318",
15 "category": [
16 "electronics",
17 "desktop",
18 "accessories"
19 ],
20 "tags": [
21 "electronics",
22 "desktop"
23 ],
24 "ending_balance": "100.95",
25 "transacted_at": "2019-08-24T14:15:22Z",
26 "settled_at": "2019-08-25T08:15:42Z",
27 "spender_identity_id": "uid_1234",
28 "merchant_identity_id": null,
29 "geolocation": {
30 "coordinates": {
31 "lat": 40.7128,
32 "lon": 74.006
33 },
34 "city": "New York",
35 "region": "US-NY",
36 "country": "US"
37 },
38 "reward_currency": "USD",
39 "reward_non_iso_currency": null,
40 "currency": "USD",
41 "non_iso_currency": null
42 },
43 "description": "Classification of `InvestmentTransaction` by purpose."
44}
Was this helpful?

InvestmentTransactionType

Classification of InvestmentTransaction by purpose.

buy
stringstring
Activity increasing the quantity of a holding.
cash
stringstring
Activity modifying the account’s cash position.
fee
stringstring
Fees on the account, e.g. commission, bookkeeping, options-related charges.
sell
stringstring
Activity decreasing the quantity of a holding.
transfer
stringstring
Activity which modifies a position, outside of buying/selling activity e.g., options exercise, portfolio transfer.
purchase
stringstring
Ordinary purchase activity, subject to the purchase APR (for credit cards).
interest
stringstring
Interest earned, not finance charges on carried balance (use fee).
deposit
stringstring
Cash or electronic deposit from an external account, not a transfer; or a payment (for credit cards).
Was this helpful?

InvestmentTransactionStatus

Status of an InvestmentTransaction.

pending
stringstring
The trade is in progress, or transfer is pending.
settled
stringstring
The transaction has completed.
cancelled
stringstring
The transaction was cancelled, or represents the cancelled portion of a previous order.
Was this helpful?

LoanTransaction

Describes a transaction in a loan account.

amount
requiredstringrequired, string
The amount associated with this transaction. Should be the sum of principal_amount, interest_amount, and escrow_amount (if present).

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
type
stringstring
Classification of LoanTransaction by purpose or effect. payment: The transaction describes a payment on the loan. principal: The transaction advances or reduces the principal. interest: The transaction advances or reduces interest. adjustment: The transaction adjusts the loan’s balances, unrelated to a loan payment.

Possible values: pending, settled, cancelled
principal_amount
requiredstringrequired, string
The amount affecting the principal balance.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
interest_amount
requiredstringrequired, string
The amount affecting the interest balance.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
escrow_amount
stringstring
The amount affecting the escrow account (mortgages only, required.)

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
id
requiredstringrequired, string
Permanent, unique transaction identifier. Must survive changes to pending status or amount.
account_id
requiredstringrequired, string
References to the account that this transaction is posting against.
description
requiredstringrequired, string
Description of the transaction.
Nullable: true
memo
stringstring
Addenda or distinguishing information for the transaction.
category
[string][string]
Hierarchical categorization, use multi-valued array to indicate hierarchy.
tags
[string][string]
Flat categorization. For hashtags omit leading #.
ending_balance
stringstring
The balance of the account after this transaction posts.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
transacted_at
requiredstringrequired, string
The date/time when the transaction was authorized, in the time zone local to the transaction or to the customer.

Format: date-time
settled_at
requiredstringrequired, string
The date/time when the transaction settled, in the time zone local to the customer. Must be null if the transaction is pending.
Nullable: true


Format: date-time
spender_identity_id
stringstring
Reference to the identity of the authorized spender who conducted this transaction.
merchant_identity_id
stringstring
Reference to the identity of the merchant related to this transaction.
geolocation
objectobject
Geographic location where this transaction occurs.
coordinates
objectobject
Geographic coordinates in EPSG:4326 WGS84 (lat/long)
lat
numbernumber
Latitude coordinate.
lon
numbernumber
Longitude coordinate.
city
stringstring
City name.
region
stringstring
Region identifier.
country
stringstring
Country identifier.
reward_currency
stringstring
The ISO 4217 currency in which this transaction's reward contribution is denominated. example: USD
reward_non_iso_currency
stringstring
If the reward contribution is denominated in a non-ISO currency, provide the currency's symbol.
currency
stringstring
The ISO 4217 currency in which this transaction is denominated. One of either the currency or non_iso_currency fields is required.
non_iso_currency
stringstring
If the transaction is denominated in a non-ISO currency, provide the currency's symbol.
1{
2 "amount": "100.95",
3 "type": "payment",
4 "principal_amount": "100.95",
5 "interest_amount": "2.95",
6 "escrow_amount": "1.95",
7 "id": "6AOU0jwFQw3sMZJ",
8 "account_id": "account1234",
9 "description": "Finance Charge",
10 "memo": "Check #318",
11 "category": [
12 "electronics",
13 "desktop",
14 "accessories"
15 ],
16 "tags": [
17 "electronics",
18 "desktop"
19 ],
20 "ending_balance": "100.95",
21 "transacted_at": "2019-08-24T14:15:22Z",
22 "settled_at": "2019-08-25T08:15:42Z",
23 "spender_identity_id": "uid_1234",
24 "merchant_identity_id": "apex_rentals_091",
25 "geolocation": {
26 "coordinates": {
27 "lat": 40.7128,
28 "lon": 74.006
29 },
30 "city": "New York",
31 "region": "US-NY",
32 "country": "US"
33 },
34 "reward_currency": "USD",
35 "reward_non_iso_currency": null,
36 "currency": "USD",
37 "non_iso_currency": null
38}
Was this helpful?

LoanTransactionType

Classification of LoanTransaction by purpose or effect.

payment
stringstring
The transaction describes a payment on the loan.
principal
stringstring
The transaction advances or reduces the principal.
interest
stringstring
The transaction advances or reduces interest.
adjustment
stringstring
The transaction adjusts the loan’s balances, unrelated to a loan payment.
Was this helpful?

Acquisition

PlaidProductDataType

Scope of requested account features or content for a PlaidApplication, represented as an enum.

ACCOUNT_BALANCE
stringstring
Balance for each of the user's accounts. Used in various Plaid products, such as Auth.
ACCOUNT_TRANSACTIONS
stringstring
Historical and current transactions for each of the user's accounts. Used in the Plaid Transactions product.
ACCOUNT_USER_INFO
stringstring
User's personally identifying information, including account and routing numbers. Used in the Plaid Identity product.
Was this helpful?

PlaidProduct

Plaid products that a PlaidApplication uses.

auth
stringstring
Auth, funds transfer principals.
identity
stringstring
Identity, personally identifying information
transactions
stringstring
Transactions, historical and current.
Was this helpful?

NewAccountApplicant

Describes an application to open a new bank account.

id
stringstring
The ID of this applicant.
identity
stringstring
The FullIdentity of the applicant.
funding_transfer_code
stringstring
The transfer code for the funding account if applicant opts to fund the account on opening.'
funding_amount
stringstring
The amount to transfer into the account upon opening.
Was this helpful?

Application

Application

Describes a Plaid-powered application.

application_id
requiredstringrequired, string
The application’s unique ID.
name
requiredstringrequired, string
The name of the application.
logo
stringstring
A URL that links to the application logo image.
application_url
stringstring
A URL that links to the application’s website.
reason_for_access
stringstring
A string provided by the connected app stating why they use their respective enabled products.
1{
2 "application_id": "123123-123123-application_id",
3 "name": "App Name",
4 "logo": "https://www.plaid.com/logo",
5 "application_url": "https://www.application.com",
6 "reason_for_access": "Need balance"
7}
Was this helpful?

ConnectedApplication

Scope

Scopes

The scopes object

product_access
objectobject
Allow or disallow product access across all accounts. If unset, defaults to all products allowed.
statements
booleanboolean
Allow access to statements.

Default: true
identity
booleanboolean
Allow access to the Identity product (name, email, phone, address).

Default: true
auth
booleanboolean
Allow access to account number details.

Default: true
transactions
booleanboolean
Allow access to transaction details.

Default: true
accounts
arrayarray
Allow or disallow product access by account. Unlisted (e.g. missing) accounts will be considered new_accounts.

Min items: 1
new_accounts
booleanboolean
Allow access to newly opened accounts as they are opened.

Default: true
1{
2 "product_access": {
3 "identity": false,
4 "statement": false,
5 "auth": true,
6 "transactions": false
7 },
8 "accounts": [
9 {
10 "unique_id": "915ace15f",
11 "selected": true
12 },
13 {
14 "unique_id": "1512343cc",
15 "selected": true
16 }
17 ],
18 "new_accounts": true
19}
Was this helpful?

RequestedScope

AccountSelectionCardinality

The application requires that accounts be limited to a specific cardinality. Represented as an enum.

enum_values
stringstring
Enum values

Possible values: SINGLE_SELECT, MULTI_SELECT, ALL
Was this helpful?

AccountAccess

Allow or disallow product access by account. Unlisted (e.g. missing) accounts will be considered new_accounts.

unique_id
requiredstringrequired, string
The unique account identifier for this account. This value must match that returned by the data access API for this account. Do not use a full or masked account number for this value as this increases the risk of revealing Personally Identifiable Information (PII).
authorized
booleanboolean
Allow the application to see this account (and associated details, including balance) in the list of accounts.

Default: true
1{
2 "unique_id": "abc1241f975",
3 "authorized": true
4}
Was this helpful?

AccountFilter

Describes the account subtypes that the application wishes for the user to be able to select from. For more details please refer to Plaid documentation on account filters.

depository
Depository subtypes required.
subtypes
stringstring
List of account subtypes.
credit
AccountFilterSubtypesAccountFilterSubtypes
Credit subtypes required.
subtypes
stringstring
List of account subtypes.
loan
AccountFilterSubtypesAccountFilterSubtypes
Loan subtypes required.
subtypes
stringstring
List of account subtypes.
investment
AccountFilterSubtypesAccountFilterSubtypes
Investment subtypes required.
subtypes
stringstring
List of account subtypes.
1{
2 "depository": {
3 "account_subtypes": [
4 "checking",
5 "savings"
6 ]
7 }
8}
Was this helpful?

AccountFilterSubtypes

A list of account subtypes to be filtered.

subtypes
stringstring
List of account subtypes.
1[
2 "checking",
3 "savings"
4]
Was this helpful?

ProductAccess

Allow or disallow product access across all accounts. If unset, defaults to all products allowed.

statements
booleanboolean
Allow access to statements.

Default: true
identity
booleanboolean
Allow access to the Identity product (name, email, phone, address).

Default: true
auth
booleanboolean
Allow access to account number details.

Default: true
transactions
booleanboolean
Allow access to transaction details.

Default: true
1{
2 "auth": true,
3 "identity": false,
4 "statements": false,
5 "transactions": false
6}
Was this helpful?

Errors

BasicError

Generic error object.

id
requiredstringrequired, string
Opaque identifier, expected to be consistent for errors which have the same cause.
message
requiredstringrequired, string
Brief description of the error, intended for display purposes. Under certain conditions, Plaid may modify or replace the message e.g. in response to suspicious user activity.
1{
2 "id": "E00001",
3 "message": "string"
4}
Was this helpful?

AuthenticationError

Authentication-specific error object.

reason
requiredstringrequired, string
Reason code for authentication failures.

Possible values: credentials, configuration, mfa, not permitted, unsupported, other
id
requiredstringrequired, string
Opaque identifier, expected to be consistent for errors which have the same cause.
message
requiredstringrequired, string
Brief description of the error, intended for display purposes. Under certain conditions, Plaid may modify or replace the message e.g. in response to suspicious user activity.
1{
2 "reason": "credentials",
3 "id": "E00001",
4 "message": "The submitted credentials are not valid."
5}
Was this helpful?

InstitutionError

Error schema for planned institution downtime.

retry_at
stringstring
The time, in UTC, when the institution is expected to support aggregation again.

Format: date-time
id
requiredstringrequired, string
Opaque identifier, expected to be consistent for errors which have the same cause.
message
requiredstringrequired, string
Brief description of the error, intended for display purposes. Under certain conditions, Plaid may modify or replace the message e.g. in response to suspicious user activity.
1{
2 "retry_at": "2020-10-02T00:15:00.000+0000",
3 "id": "E00001",
4 "message": "string"
5}
Was this helpful?