Data Dictionary

Objects defined in the Plaid Exchange spec

Primitives

Basic types used in other definitions

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

Format: date
mcc
string
Merchant category code.

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
object
Geographic coordinates in EPSG:4326 WGS84 (lat/long)
lat
number
Latitude coordinate.
lon
number
Longitude coordinate.
city
string
City name.
region
string
ISO 3166-2 sub-national region identifier.
country
string
ISO 3166-1 two-character country identifier.
1{
2  "coordinates": {
3    "lat": 41.8574,
4    "lon": -71.39862
5  },
6  "city": "New York",
7  "region": "US",
8  "country": "US"
9}

GeoCoordinates

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

lat
number
Latitude coordinate.
lon
number
Longitude coordinate.
1{
2  "lat": 41.8574,
3  "lon": -71.39862
4}

Authentication

UserToken

Embeddable representation of user authorization.

user_id
string
An opaque user identifier, see Authentication API method.
auth_token
token
The authorization token Plaid wil use to aggregate this user's accounts.
1{
2  "user_id": "6gXfjEcgqcjTVnUgbTwDF3DTeiQ",
3  "auth_token": "19adfaa0-123012315ac8877-a14142343"
4}

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 assocation, including for-profit and not-for-profit organizations.
trust
Revocable or irrevocable trust.

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
Report accounts until they are closed, and continue reporting closed accounts until 90 days after closure.
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.
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: and 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
string
Permanent account identifier.
last_activity_at
string
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
string
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
[string]
References to the identities for the owner(s) of this account.
non_owner_identity_ids
[string]
References to the identities for the non-owner(s) related to this account, e.g. trustees, beneficiaries.
status
string
Status of an account.

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

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

Format: date
current_balance
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
available_balance
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
tax_advantaged
boolean
Indicates whether some activity on the account - deposits, gains, etc - benefits from tax deferral or exemption, e.g. HSA, IRA, 401(k) accounts.
currency
string
ISO 4217 currency code.
non_iso_currency
string
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": [
6    "string"
7  ],
8  "non_owner_identity_ids": [
9    "string"
10  ],
11  "status": "active",
12  "type": "depository",
13  "subtype": "cash management",
14  "name": "Vacation Money",
15  "official_name": "Pro Checking",
16  "display_mask": "9833",
17  "opening_date": "2018-01-31",
18  "current_balance": "100.95",
19  "available_balance": "100.95",
20  "tax_advantaged": true,
21  "currency": "USD",
22  "non_iso_currency": "string"
23}

DepositoryAccount

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

interest_rate
string
Fixed-point representation of a normalized rate, carried up to four decimal places.

Pattern: ^\d*(\.\d{1,4})?$
transfer_codes
object
Mapping between an account and various payment networks.
ach
object
Base model for depository account transfer identifiers.
account_number
string
The account number.
routing_number
string
The ABA routing transit number.
wire_routing_number
string
The institution's routing number for wire transfer.
supports_debit
boolean
Indicates account may be debited using transfer code.
supports_credit
boolean
Indicates account may be credited using transfer code.
eft
object
Base model for depository account transfer identifiers.
account_number
string
The account number.
institution_number
string
The institution's number assigned by Payments Canada.
branch_number
string
The branch number corresponding to the account.
supports_debit
boolean
Indicates account may be debited using transfer code.
supports_credit
boolean
Indicates account may be credited using transfer code.
iban
object
Base model for depository account transfer identifiers.
account_number
string
The full IBAN.
bank_code
string
Bank identifier.
country_code
string
The country code.
location_code
string
Location code for the bank's office.
branch_code
string
Optionally indicate a specific branch.
supports_debit
boolean
Indicates account may be debited using transfer code.
supports_credit
boolean
Indicates account may be credited using transfer code.
payment_card
object
Base model for depository account transfer identifiers.
card_number
string
The payment card number.
expiry_month
string
Month of card expiration, as a 2-digit value.
expiry_year
string
Year of card expiration.
security_code
string
CVV, CSC, or other card-not-present verification value.
supports_debit
boolean
Indicates account may be debited using transfer code.
supports_credit
boolean
Indicates account may be credited using transfer code.
acats
object
Base model for depository account transfer identifiers.
account_number
string
The account number.
receiving_member_identity
object
A lightweight identity container suitable for passing minimal identification.
organization
object
Describes an organization, e.g., a business or non-profit.
name
string
Name of the organization represented.
structure
string
Type of business structure.

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

Pattern: ^\d{4}$
owner_identity_ids
[string]
The identities of the organization owner(s).
tax_identifier
object
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
string
Name of the tax authority.
tax_payer_id
string
The tax payer ID, e.g. EIN, TIN, SSN.
person
object
Describes an individual, named person.
first_name
string
Legal given name of the personal entity.
middle_name
string
Middle name, use blank if none.
last_name
string
Last name or family name.
date_of_birth
string
The date of birth in ISO-8601 format.

Format: date
tax_identifier
object
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
string
Name of the tax authority.
tax_payer_id
string
The tax payer ID, e.g. EIN, TIN, SSN.
email
string
The email address where this entity can be contacted.
mailing_address
object
Description of a street address.
lines
[string]
The lines of the street address.

Min items: 1
city
string
The city of the mailing address.
region
string
ISO 3166-2 sub-national region identifier.
country
string
ISO 3166-1 two-character country identifier.
postal_code
string
The postal code.
phone
string
The phone number, formatted using ITU standard E. 123.
id
string
Permanent identity identifier.
name
string
The display name of this entity (insufficient for KYC purposes)
dtcc_clearing_ids
[string]
The DTCC institution identifiers for the institution holding the account.

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

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

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

Format: date
balance
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
document_url
string
A URL to a downloadable document form of this statement. Implementers should not assume that accessors of this URL are always authorized.
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            "string"
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",
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    "string"
97  ],
98  "non_owner_identity_ids": [
99    "string"
100  ],
101  "status": "active",
102  "type": "depository",
103  "subtype": "checking",
104  "name": "Vacation Money",
105  "official_name": "Pro Checking",
106  "display_mask": "9833",
107  "opening_date": "2018-01-31",
108  "current_balance": "850.55",
109  "available_balance": "149.45",
110  "tax_advantaged": true,
111  "currency": "USD",
112  "non_iso_currency": "string"
113}

DepositoryAccountStatement

Represents primary account statement details.

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

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

Format: date
balance
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
document_url
string
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}

TransferCodeMap

Mapping between an account and various payment networks.

ach
object
Base model for depository account transfer identifiers.
account_number
string
The account number.
routing_number
string
The ABA routing transit number.
wire_routing_number
string
The institution's routing number for wire transfer.
supports_debit
boolean
Indicates account may be debited using transfer code.
supports_credit
boolean
Indicates account may be credited using transfer code.
eft
object
Base model for depository account transfer identifiers.
account_number
string
The account number.
institution_number
string
The institution's number assigned by Payments Canada.
branch_number
string
The branch number corresponding to the account.
supports_debit
boolean
Indicates account may be debited using transfer code.
supports_credit
boolean
Indicates account may be credited using transfer code.
iban
object
Base model for depository account transfer identifiers.
account_number
string
The full IBAN.
bank_code
string
Bank identifier.
country_code
string
The country code.
location_code
string
Location code for the bank's office.
branch_code
string
Optionally indicate a specific branch.
supports_debit
boolean
Indicates account may be debited using transfer code.
supports_credit
boolean
Indicates account may be credited using transfer code.
payment_card
object
Base model for depository account transfer identifiers.
card_number
string
The payment card number.
expiry_month
string
Month of card expiration, as a 2-digit value.
expiry_year
string
Year of card expiration.
security_code
string
CVV, CSC, or other card-not-present verification value.
supports_debit
boolean
Indicates account may be debited using transfer code.
supports_credit
boolean
Indicates account may be credited using transfer code.
acats
object
Base model for depository account transfer identifiers.
account_number
string
The account number.
receiving_member_identity
object
A lightweight identity container suitable for passing minimal identification.
organization
object
Describes an organization, e.g., a business or non-profit.
name
string
Name of the organization represented.
structure
string
Type of business structure.

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

Pattern: ^\d{4}$
owner_identity_ids
[string]
The identities of the organization owner(s).
tax_identifier
object
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
string
Name of the tax authority.
tax_payer_id
string
The tax payer ID, e.g. EIN, TIN, SSN.
person
object
Describes an individual, named person.
first_name
string
Legal given name of the personal entity.
middle_name
string
Middle name, use blank if none.
last_name
string
Last name or family name.
date_of_birth
string
The date of birth in ISO-8601 format.

Format: date
tax_identifier
object
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
string
Name of the tax authority.
tax_payer_id
string
The tax payer ID, e.g. EIN, TIN, SSN.
email
string
The email address where this entity can be contacted.
mailing_address
object
Description of a street address.
lines
[string]
The lines of the street address.

Min items: 1
city
string
The city of the mailing address.
region
string
ISO 3166-2 sub-national region identifier.
country
string
ISO 3166-1 two-character country identifier.
postal_code
string
The postal code.
phone
string
The phone number, formatted using ITU standard E. 123.
id
string
Permanent identity identifier.
name
string
The display name of this entity (insufficient for KYC purposes)
dtcc_clearing_ids
[string]
The DTCC institution identifiers for the institution holding the account.

Min items: 1
supports_debit
boolean
Indicates account may be debited using transfer code.
supports_credit
boolean
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          "string"
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",
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}

DepositoryAccountTransferCode

Base model for depository account transfer identifiers.

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

AchTransferCode

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

account_number
string
The account number.
routing_number
string
The ABA routing transit number.
wire_routing_number
string
The institution's routing number for wire transfer.
supports_debit
boolean
Indicates account may be debited using transfer code.
supports_credit
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}

EftTransferCode

Identifiers for directing funds transfers in Canada.

account_number
string
The account number.
institution_number
string
The institution's number assigned by Payments Canada.
branch_number
string
The branch number corresponding to the account.
supports_debit
boolean
Indicates account may be debited using transfer code.
supports_credit
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}

IbanTransferCode

International Bank Account Number for directing international funds transfers.

account_number
string
The full IBAN.
bank_code
string
Bank identifier.
country_code
string
The country code.
location_code
string
Location code for the bank's office.
branch_code
string
Optionally indicate a specific branch.
supports_debit
boolean
Indicates account may be debited using transfer code.
supports_credit
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}

PaymentCardTransferCode

Identifiers for directing funds to/from payment cards.

card_number
string
The payment card number.
expiry_month
string
Month of card expiration, as a 2-digit value.
expiry_year
string
Year of card expiration.
security_code
string
CVV, CSC, or other card-not-present verification value.
supports_debit
boolean
Indicates account may be debited using transfer code.
supports_credit
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}

NotionalAccount

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

id
string
permanent account identifier. Should be an accountId.
type
string
major classification of this account. Should be one of the accountType values.
subtype
string
minor classification of this account. Should be one of the accountSubtype values.
access_authorized
deprecatedboolean
Indicate that the user has not authorized the account to participate in aggregation. should only be present/true for notional accounts.
name
string
The account’s user-given name, if the institution supports naming of accounts
official_name
string
The account’s marketing or brand name.
currency
string
The ISO-4217 currency in which this account’s transactions and balances are denominated.
non_iso_currency
string
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": "BTC"
9}

InvestmentAccount

Representation of brokerage accounts.

transfer_codes
object
Mapping between an account and various payment networks.
ach
object
Base model for depository account transfer identifiers.
account_number
string
The account number.
routing_number
string
The ABA routing transit number.
wire_routing_number
string
The institution's routing number for wire transfer.
supports_debit
boolean
Indicates account may be debited using transfer code.
supports_credit
boolean
Indicates account may be credited using transfer code.
eft
object
Base model for depository account transfer identifiers.
account_number
string
The account number.
institution_number
string
The institution's number assigned by Payments Canada.
branch_number
string
The branch number corresponding to the account.
supports_debit
boolean
Indicates account may be debited using transfer code.
supports_credit
boolean
Indicates account may be credited using transfer code.
iban
object
Base model for depository account transfer identifiers.
account_number
string
The full IBAN.
bank_code
string
Bank identifier.
country_code
string
The country code.
location_code
string
Location code for the bank's office.
branch_code
string
Optionally indicate a specific branch.
supports_debit
boolean
Indicates account may be debited using transfer code.
supports_credit
boolean
Indicates account may be credited using transfer code.
payment_card
object
Base model for depository account transfer identifiers.
card_number
string
The payment card number.
expiry_month
string
Month of card expiration, as a 2-digit value.
expiry_year
string
Year of card expiration.
security_code
string
CVV, CSC, or other card-not-present verification value.
supports_debit
boolean
Indicates account may be debited using transfer code.
supports_credit
boolean
Indicates account may be credited using transfer code.
acats
object
Base model for depository account transfer identifiers.
account_number
string
The account number.
receiving_member_identity
object
A lightweight identity container suitable for passing minimal identification.
organization
object
Describes an organization, e.g., a business or non-profit.
name
string
Name of the organization represented.
structure
string
Type of business structure.

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

Pattern: ^\d{4}$
owner_identity_ids
[string]
The identities of the organization owner(s).
tax_identifier
object
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
string
Name of the tax authority.
tax_payer_id
string
The tax payer ID, e.g. EIN, TIN, SSN.
person
object
Describes an individual, named person.
first_name
string
Legal given name of the personal entity.
middle_name
string
Middle name, use blank if none.
last_name
string
Last name or family name.
date_of_birth
string
The date of birth in ISO-8601 format.

Format: date
tax_identifier
object
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
string
Name of the tax authority.
tax_payer_id
string
The tax payer ID, e.g. EIN, TIN, SSN.
email
string
The email address where this entity can be contacted.
mailing_address
object
Description of a street address.
lines
[string]
The lines of the street address.

Min items: 1
city
string
The city of the mailing address.
region
string
ISO 3166-2 sub-national region identifier.
country
string
ISO 3166-1 two-character country identifier.
postal_code
string
The postal code.
phone
string
The phone number, formatted using ITU standard E. 123.
id
string
Permanent identity identifier.
name
string
The display name of this entity (insufficient for KYC purposes)
dtcc_clearing_ids
[string]
The DTCC institution identifiers for the institution holding the account.

Min items: 1
supports_debit
boolean
Indicates account may be debited using transfer code.
supports_credit
boolean
Indicates account may be credited using transfer code.
current_balance
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
available_balance
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
margin_balance
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
margin_limit
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
margin_equity
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
maintenance_margin
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
buying_power
string
Fixed-point decimal number, carried up to six decimal places.

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

Format: date-time
holdings
[object]
Descriptions of held assets in the account.
security_id
string
The identifier of the security referenced by this holding.
cost_basis
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
quantity
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
lots
object
Describes taxable lots of shares within a Holding.
id
string
The unique and permanent identifier for this lot.
acquired_at
string
The date at which the lot was acquired.

Format: date
acquired_price
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
quantity
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
currency
string
ISO 4217 currency code.
non_iso_currency
string
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            "string"
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",
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": "string"
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    "string"
109  ],
110  "non_owner_identity_ids": [
111    "string"
112  ],
113  "status": "active",
114  "type": "depository",
115  "subtype": "checking",
116  "name": "Vacation Money",
117  "official_name": "Pro Checking",
118  "display_mask": "9833",
119  "opening_date": "2018-01-31",
120  "tax_advantaged": true,
121  "currency": "USD",
122  "non_iso_currency": "string"
123}

AcatsTransferCode

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

account_number
string
The account number.
receiving_member_identity
object
A lightweight identity container suitable for passing minimal identification.
organization
object
Describes an organization, e.g., a business or non-profit.
name
string
Name of the organization represented.
structure
string
Type of business structure.

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

Pattern: ^\d{4}$
owner_identity_ids
[string]
The identities of the organization owner(s).
tax_identifier
object
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
string
Name of the tax authority.
tax_payer_id
string
The tax payer ID, e.g. EIN, TIN, SSN.
person
object
Describes an individual, named person.
first_name
string
Legal given name of the personal entity.
middle_name
string
Middle name, use blank if none.
last_name
string
Last name or family name.
date_of_birth
string
The date of birth in ISO-8601 format.

Format: date
tax_identifier
object
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
string
Name of the tax authority.
tax_payer_id
string
The tax payer ID, e.g. EIN, TIN, SSN.
email
string
The email address where this entity can be contacted.
mailing_address
object
Description of a street address.
lines
[string]
The lines of the street address.

Min items: 1
city
string
The city of the mailing address.
region
string
ISO 3166-2 sub-national region identifier.
country
string
ISO 3166-1 two-character country identifier.
postal_code
string
The postal code.
phone
string
The phone number, formatted using ITU standard E. 123.
id
string
Permanent identity identifier.
name
string
The display name of this entity (insufficient for KYC purposes)
dtcc_clearing_ids
[string]
The DTCC institution identifiers for the institution holding the account.

Min items: 1 
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        "string"
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",
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}

Security

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

id
string
The permanent identifier for this security, across all accounts and holdings.
isin
string
The ISO 6166-compliant ISIN for this security, if available.
name
string
A descriptive name for the security, suitable for display.
symbol
string
The security's trading symbol, if applicable. Otherwise, a short, commonly used identifier.
is_cash_equivalent
boolean
Indicates the security is highly-liquid, e.g. a money market account, and should be regarded as cash.
current_price
string
Fixed-point decimal number, carried up to six decimal places.

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

Format: date-time
close_price
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
type
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
string
ISO 4217 currency code.
non_iso_currency
string
If the account is denominated in a non-ISO currency, provide the currency's symbol.
1{
2  "id": "string",
3  "isin": "string",
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": "string"
13}

OptionSecurity

Representation of a Security with type of derivative.

expiry
string
The contract expiration date.

Format: date
contract_type
string
The type of option.

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

Possible values: euro, us
exercise_price
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
underlying_security_id
string
Reference to the security underlying this contract.
1{
2  "expiry": "2018-08-28",
3  "contract_type": "put",
4  "option_style": "euro",
5  "exercise_price": "100.95",
6  "underlying_security_id": "string",
7  "id": "string",
8  "isin": "string",
9  "name": "CISCO SYSTEMS INC",
10  "symbol": "CSCO",
11  "is_cash_equivalent": true,
12  "current_price": "100.95",
13  "current_as_of": "2020-10-02T12:45:01Z",
14  "close_price": "100.95",
15  "type": "mutual fund",
16  "currency": "USD",
17  "non_iso_currency": "string"
18}

ContractType

Describes available contract type

put
A put option
call
A call option

Holding

Instance of a held security.

security_id
string
The identifier of the security referenced by this holding.
cost_basis
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
quantity
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
lots
object
Describes taxable lots of shares within a Holding.
id
string
The unique and permanent identifier for this lot.
acquired_at
string
The date at which the lot was acquired.

Format: date
acquired_price
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
quantity
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
currency
string
ISO 4217 currency code.
non_iso_currency
string
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": "string"
13}

TaxLot

Describes taxable lots of shares within a Holding.

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

Format: date
acquired_price
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
quantity
string
Fixed-point decimal number, carried up to six decimal places.

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}

LoanAccount

Representation of short and long-term debt.

account_number
string
The account number for this loan.
reference_number
string
The loan's reference number.
servicer_identity_id
string
Reference to the udentity of the loan servicer.
interest_rate
string
Fixed-point representation of a normalized rate, carried up to four decimal places.

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

Possible values: fixed, adjustable, variable, other
interest_rate_schedule
[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
string
The date this rate became, or becomes, effective.

Format: date
end_date
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
string
Fixed-point representation of a normalized rate, carried up to four decimal places.

Pattern: ^\d*(\.\d{1,4})?$
term_months
integer
A natural number, i.e. a non-negative integer.

Minimum: 0
term_days
integer
A natural number, i.e. a non-negative integer.

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

Possible values: fully repaid, current, grace, deferment, forbearance, past due, delinquent, default, charged off, cancelled
principal_balance
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
payoff_quote
string
Fixed-point decimal number, carried up to six decimal places.

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

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

Format: date
origination_principal
string
Fixed-point decimal number, carried up to six decimal places.

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

Format: date
statements
[object]
Must describe statement periods for the account's entire history.
payment_paid_to_principal
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
payment_paid_to_interest
string
Fixed-point decimal number, carried up to six decimal places.

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

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

Format: date
balance_due
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
minimum_payment_due
string
Fixed-point decimal number, carried up to six decimal places.

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

Format: date
payment_received_date
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
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
document_url
string
A URL to a downloadable document form of this statement. Implementers should not assume that accessors of this URL are always authorized.
1{
2  "type": "depository",
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    "string"
43  ],
44  "non_owner_identity_ids": [
45    "string"
46  ],
47  "status": "active",
48  "subtype": "checking",
49  "name": "Vacation Money",
50  "official_name": "Pro Checking",
51  "display_mask": "9833",
52  "opening_date": "2018-01-31",
53  "current_balance": "850.55",
54  "available_balance": "149.45",
55  "tax_advantaged": true,
56  "currency": "USD",
57  "non_iso_currency": "string"
58}

LoanStatement

Description of a loan account statement.

payment_paid_to_principal
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
payment_paid_to_interest
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$ 
1{
2  "payment_paid_to_principal": "100.95",
3  "payment_paid_to_interest": "100.95",
4  "open_date": "2018-08-28",
5  "close_date": "2018-08-28",
6  "balance_due": "100.95",
7  "minimum_payment_due": "100.95",
8  "payment_due_date": "2018-08-28",
9  "payment_received_date": "2018-08-28",
10  "payment_received_amount": "100.95",
11  "document_url": "string"
12}

InterestRateType

Interest rate adjustment schemes.

fixed
string
fixed rate.
adjustable
string
Adjustable rate.
variable
string
Variable rate.
other
string
All other rate adjustment schemes.

InterestRatePeriod

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

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

Format: date
end_date
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
string
Fixed-point representation of a normalized rate, carried up to four decimal places.

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

LoanRepaymentStatus

Loan repayment status.

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

MortgageAccount

Representation of a home mortgage loan.

subtype
string
escrow_balance
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$ 
1{
2  "subtype": "checking",
3  "escrow_balance": "100.95",
4  "type": "depository",
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    "string"
45  ],
46  "non_owner_identity_ids": [
47    "string"
48  ],
49  "status": "active",
50  "name": "Vacation Money",
51  "official_name": "Pro Checking",
52  "display_mask": "9833",
53  "opening_date": "2018-01-31",
54  "current_balance": "850.55",
55  "available_balance": "149.45",
56  "tax_advantaged": true,
57  "currency": "USD",
58  "non_iso_currency": "string"
59}

StudentLoanAccount

Representational of a loan account that is specific to student loans

subtype
string
disbursement_schedule
[object]
The schedule for disbursement of funds.
disbursement_date
string
The date of disbursement.

Format: date
amount
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
guarantor_identity
object
A lightweight identity container suitable for passing minimal identification.
organization
object
Describes an organization, e.g., a business or non-profit.
name
string
Name of the organization represented.
structure
string
Type of business structure.

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

Pattern: ^\d{4}$
owner_identity_ids
[string]
The identities of the organization owner(s).
tax_identifier
object
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
string
Name of the tax authority.
tax_payer_id
string
The tax payer ID, e.g. EIN, TIN, SSN.
person
object
Describes an individual, named person.
first_name
string
Legal given name of the personal entity.
middle_name
string
Middle name, use blank if none.
last_name
string
Last name or family name.
date_of_birth
string
The date of birth in ISO-8601 format.

Format: date
tax_identifier
object
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
string
Name of the tax authority.
tax_payer_id
string
The tax payer ID, e.g. EIN, TIN, SSN.
email
string
The email address where this entity can be contacted.
mailing_address
object
Description of a street address.
lines
[string]
The lines of the street address.

Min items: 1
city
string
The city of the mailing address.
region
string
ISO 3166-2 sub-national region identifier.
country
string
ISO 3166-1 two-character country identifier.
postal_code
string
The postal code.
phone
string
The phone number, formatted using ITU standard E. 123.
id
string
Permanent identity identifier.
name
string
The display name of this entity (insufficient for KYC purposes)
pslf_eligibility
object
Student loan PSLF eligibility status information.
eligible
boolean
Indicates the loan's eligibility for PSLF.
qualifying_payments
integer
A natural number, i.e. a non-negative integer.

Minimum: 0
total_payments
integer
A natural number, i.e. a non-negative integer.

Minimum: 0
sequence_number
string
The loan's sequence number.
1{
2  "subtype": "checking",
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        "string"
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",
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": "depository",
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    "string"
94  ],
95  "non_owner_identity_ids": [
96    "string"
97  ],
98  "status": "active",
99  "name": "Vacation Money",
100  "official_name": "Pro Checking",
101  "display_mask": "9833",
102  "opening_date": "2018-01-31",
103  "current_balance": "850.55",
104  "available_balance": "149.45",
105  "tax_advantaged": true,
106  "currency": "USD",
107  "non_iso_currency": "string"
108}

Disbursement

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

disbursement_date
string
The date of disbursement.

Format: date
amount
string
Fixed-point decimal number, carried up to six decimal places.

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

PslfEligibility

Student loan PSLF eligibility status information.

eligible
boolean
Indicates the loan's eligibility for PSLF.
qualifying_payments
integer
A natural number, i.e. a non-negative integer.

Minimum: 0
total_payments
integer
A natural number, i.e. a non-negative integer.

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

CreditCardAccount

Representation of
 credit card.

type
string
Major classification of this account.

Possible values: loan
subtype
string
Minor classification of this account.

Possible values: credit card
current_balance
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
available_balance
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
reward_balance
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
credit_limit
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
spender_identity_ids
[string]
References to the Identities for non-owner authorized spenders.
interest_rates
[object]
Effective interest rates for different balances associated with this card.
start_date
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
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
string
The type of balance subject to this rate.

Possible values: purchase, cash advance, balance transfer
interest_rate
string
Fixed-point representation of a normalized rate, carried up to four decimal places.

Pattern: ^\d*(\.\d{1,4})?$
subject_balance
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
interest_charged
string
Fixed-point decimal number, carried up to six decimal places.

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

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

Format: date
balance_due
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
minimum_payment_due
string
Fixed-point decimal number, carried up to six decimal places.

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

Format: date
payment_received_date
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
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
document_url
string
A URL to a downloadable document form of this statement. Implementers should not assume that accessors of this URL are always authorized.
reward_currency
string
ISO 4217 currency code.
reward_non_iso_currency
string
If the account's reward balance is denominated in a non-ISO currency, provide the currency's symbol
art_asset_url
string
URL reference to an image of the payment card face.
1{
2  "type": "depository",
3  "subtype": "checking",
4  "current_balance": "850.55",
5  "available_balance": "149.45",
6  "reward_balance": "100.95",
7  "credit_limit": "100.95",
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": "BTC",
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    "string"
41  ],
42  "non_owner_identity_ids": [
43    "string"
44  ],
45  "status": "active",
46  "name": "Vacation Money",
47  "official_name": "Pro Checking",
48  "display_mask": "9833",
49  "opening_date": "2018-01-31",
50  "tax_advantaged": true,
51  "currency": "USD",
52  "non_iso_currency": "string"
53}

CreditCardStatement

Description of a credit card account statement.

open_date
string
The opening date of this statement period.

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

Format: date
balance_due
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
minimum_payment_due
string
Fixed-point decimal number, carried up to six decimal places.

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

Format: date
payment_received_date
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
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
document_url
string
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}

CreditCardInterestRate

Description of a credit card interest rate.

start_date
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
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
string
The type of balance subject to this rate.

Possible values: purchase, cash advance, balance transfer
interest_rate
string
Fixed-point representation of a normalized rate, carried up to four decimal places.

Pattern: ^\d*(\.\d{1,4})?$
subject_balance
string
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$
interest_charged
string
Fixed-point decimal number, carried up to six decimal places.

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}

CreditCardInterestRateType

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

purchase
string
Purchases.
cash advance
string
Cash advances.
balance transfer
string
Balance transfers (not payments).

Identity

BasicIdentity

A lightweight identity container suitable for passing minimal identification.

id
string
Permanent identity identifier.
name
string
The display name of this entity (insufficient for KYC purposes)
email
string
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}

FullIdentity

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

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

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

Pattern: ^\d{4}$
owner_identity_ids
[string]
The identities of the organization owner(s).
tax_identifier
object
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
string
Name of the tax authority.
tax_payer_id
string
The tax payer ID, e.g. EIN, TIN, SSN.
person
object
Describes an individual, named person.
first_name
string
Legal given