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
Properties
idstring
A globally unique identifier (
accountId, transactionId, identityId, etc.) which can serve as a stable identifier for the associated entity.amountstring
Fixed point decimal number, carried up to six decimal places.
naturalinteger
A natural number i.e. a non-negative integer.
ratestring
Fixed-point representation of a normalized rate, carried up to four decimal places.
iso4217string
ISO-4217 currency code.
iso8601string
ISO-8601 formatted date or timestamp.
Format:
date mccstring
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.
Properties
coordinatesobject
Geographic coordinates in EPSG:4326 WGS84 (lat/long)
citystring
City name.
regionstring
Region identifier.
countrystring
Country identifier.
API Object
{
"coordinates": {
"lat": 41.8574,
"lon": -71.39862
},
"city": "New York",
"region": "US-NY",
"country": "US"
}GeoCoordinates
Geographic coordinates in EPSG:4326 WGS84 (lat/long)
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.
Properties
individualIndividual account.
jointJoint account ownership.
associationOwnership by a corporation, partnership, or unincorporated association, including for-profit and not-for-profit organizations.
trustRevocable or irrevocable trust.
Account Status
Report accounts until they are closed, and continue reporting closed accounts until 90 days after closure.
Properties
activeAccount has current activity and there are no issues outstanding.
inactiveAccount has seen no activity for a standard period defined by the institution, and may be subject to fees or at risk of closure.
frozenAccess 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.
lockedAccess to the account is prohibited due to security concerns, e.g. fraudulent activity observed.
flaggedAll activity is prohibited due to regulatory or policy requirements, e.g. monthly withdrawals from a savings account in excess of FRB Regulation D.
restrictedActivity on the account is restricted, e.g. withdrawals are subject to a daily limit, until the user meets certain conditions.
closedThe 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,
frozendescribes a condition in connection to legal action: use frozen to indicate than an account’s assets may be subject to seizureflaggeddescribes 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 closurelockeddescribes 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
| Type | Subtype | Transaction Type | Description |
|---|---|---|---|
| depository | cash management | DepositoryTransaction | Cash management account |
| depository | cd | DepositoryTransaction | Cash deposit (CD) |
| depository | checking | DepositoryTransaction | Checking account |
| depository | savings | DepositoryTransaction | Savings account |
| depository | money market | DepositoryTransaction | Money market account |
| depository | health | DepositoryTransaction | Any health savings or reimbursement account, e.g. HSA, FSA, HRA etc. |
| depository | prepaid | DepositoryTransaction | Prepaid account, typically debit card |
| depository | gic | DepositoryTransaction | Guaranteed investment certificate (Canada) |
| loan | auto | LoanTransaction | Auto loan |
| loan | commercial | LoanTransaction | Commercial loan |
| loan | construction | LoanTransaction | Construction loan, e.g. 203(k) |
| loan | consumer | LoanTransaction | Consumer installment loan |
| loan | credit card | CreditTransaction | Credit card |
| loan | home equity | LoanTransaction | Loan or line of credit against home collateral, e.g. a HELOC |
| loan | mortgage | LoanTransaction | Home mortgage |
| loan | overdraft | LoanTransaction | Overdraft protection line of credit |
| loan | line of credit | CreditTransaction | Line of credit |
| loan | student | LoanTransaction | Student loan |
| investment | 401a | InvestmentTransaction | IRC 401(a) governmental and nonprofit employee retirement plan |
| investment | 401k | InvestmentTransaction | IRC 401(k) retirement plan |
| investment | 403b | InvestmentTransaction | IRC 403(b) annuity retirement plan |
| investment | 457b | InvestmentTransaction | IRC 457(b) retirement savings account |
| investment | 529 | InvestmentTransaction | IRC 529 educational savings plan |
| investment | brokerage | InvestmentTransaction | Ordinary investment account |
| investment | esa | InvestmentTransaction | Non-529 education savings account (e.g. Coverdell) |
| investment | ira | InvestmentTransaction | Traditional IRA |
| investment | isa | InvestmentTransaction | Individual savings account (UK) |
| investment | lira | InvestmentTransaction | Locked-in retirement account (Canada) |
| investment | other | InvestmentTransaction | Other investment vehicle not covered here |
| investment | rif | InvestmentTransaction | Retirement income fund, includes LIF, LRIF, RRIF, PRIF and other income funds (Canada) |
| investment | rsp | InvestmentTransaction | Retirement savings plan, includes RRSP, RDSP, RESP, LRSP and other savings plans (Canada) |
| investment | pension | InvestmentTransaction | Traditional defined-benefit plan |
| investment | profit-sharing | InvestmentTransaction | Employee profit sharing plan |
| investment | roth ira | InvestmentTransaction | Roth IRA |
| investment | roth 401k | InvestmentTransaction | Roth 401(k) |
| investment | sep ira | InvestmentTransaction | Simplified employee plan IRA |
| investment | simple ira | InvestmentTransaction | SIMPLE IRA |
| investment | sipp | InvestmentTransaction | Self-invested personal pension |
| investment | stock plan | InvestmentTransaction | Stock purchase plan, e.g. ESPP |
| investment | tsp | InvestmentTransaction | Thrift savings plan |
| investment | tfsa | InvestmentTransaction | Tax-free savings account (Canada) |
| investment | custodial | InvestmentTransaction | Account covered under UGMA/UTMA |
| investment | variable annuity | InvestmentTransaction | Variable annuity tax-deferred retirement vehicle |
BaseAccount
List of all accounts for which this user is an owner or interested non-owner.
Properties
idrequiredstring
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_atstring
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_typestring
Indicates the ownership type of the account, not the relationship the current user has over the account.
Possible values:
individual, joint, association, trustowner_identity_idsrequired[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.
statusrequiredstring
Status of this account.
Possible values:
active, inactive, frozen, locked, flagged, restricted, closedtyperequiredstring
Major classification of this account.
Possible values:
depository, loan, investmentsubtyperequiredstring
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 annuitynamestring
The account's user-given name, if the institution supports naming of accounts.
official_namerequiredstring
The account's marketing or brand name.
display_maskrequiredstring
A short alpha-numeric string to assist users in identifying the account, e.g. last four digits of the account number.
opening_datestring
The date on which the account was opened.
Format:
date current_balancerequiredstring
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_balancerequiredstring
The immediately available balance in the account, typically the amount available to withdraw at the moment.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ tax_advantagedboolean
Indicates whether some activity on the account - deposits, gains, etc - benefits from tax deferral or exemption, e.g. HSA, IRA, 401(k) accounts.
currencystring
The ISO-4217 currency in which this account’s transactions and balances are denominated.
non_iso_currencystring
If the account is denominated in a non-ISO currency, provide the currency's symbol.
API Object
{
"id": "R13oiR6lC5jNC5jK",
"last_activity_at": "2020-04-21T12:45:00+00:00",
"ownership_type": "individual",
"owner_identity_ids": null,
"non_owner_identity_ids": [
"6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
],
"status": "active",
"type": "depository",
"subtype": "checking",
"name": "Vacation Money",
"official_name": "Pro Checking",
"display_mask": "9833",
"opening_date": "2018-01-31",
"current_balance": "850.55",
"available_balance": "149.45",
"tax_advantaged": true,
"currency": "USD",
"non_iso_currency": null
}DepositoryAccount
Represents depository accounts, e.g. checking, savings, CDs.
Properties
interest_ratestring
The rate at which this account earns interest.
Pattern:
^\d*(\.\d{1,4})?$ transfer_codesrequiredobject
Account identifiers necessary for funds transfers.
achobject
ACH (US) account identifiers.
account_numberstring
The account number.
routing_numberstring
The ABA routing transit number.
wire_routing_numberstring
The institution's routing number for wire transfer.
supports_debitboolean
Indicates account may be debited using transfer code.
supports_creditboolean
Indicates account may be credited using transfer code.
eftobject
EFT (Canada) account identifiers.
account_numberstring
The account number.
institution_numberstring
The institution's number assigned by Payments Canada.
branch_numberstring
The branch number corresponding to the account.
supports_debitboolean
Indicates account may be debited using transfer code.
supports_creditboolean
Indicates account may be credited using transfer code.
ibanobject
IBAN account identifiers.
account_numberstring
The full IBAN.
bank_codestring
Bank identifier.
country_codestring
The country code.
location_codestring
Location code for the bank's office.
branch_codestring
Optionally indicate a specific branch.
supports_debitboolean
Indicates account may be debited using transfer code.
supports_creditboolean
Indicates account may be credited using transfer code.
payment_cardobject
Payment card account identifiers.
card_numberstring
The payment card number.
expiry_monthstring
Month of card expiration, as a 2-digit value.
expiry_yearstring
Year of card expiration.
security_codestring
CVV, CSC, or other card-not-present verification value.
supports_debitboolean
Indicates account may be debited using transfer code.
supports_creditboolean
Indicates account may be credited using transfer code.
acatsobject
ACATS account identifiers.
account_numberstring
The account number.
receiving_memberobject
Identity of the receiving brokerage (including
organization).organizationobject
Describes an organization, e.g., a business or non-profit.
namestring
Name of the organization represented.
structurestring
Type of business structure.
Possible values:
sole, partnership, llc, corpmccstring
The ISO-18245 merchant category code for this business.
Pattern:
^\d{4}$ owner_identity_ids[string]
The identities of the organization owner(s).
tax_identifierobject
The tax authority ID.
tax_authoritystring
Name of the tax authority.
tax_payer_idstring
The tax payer ID, e.g. EIN, TIN, SSN.
countrystring
The national jurisdiction of the tax authority in ISO 3166-1 format.
subdivisionstring
If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.
personobject
Describes an individual, named person.
first_namestring
Legal given name of the personal entity.
middle_namestring
Middle name, use blank if none.
last_namestring
Last name or family name.
date_of_birthstring
The date of birth in ISO-8601 format.
Format:
date tax_identifierobject
The tax authority ID.
tax_authoritystring
Name of the tax authority.
tax_payer_idstring
The tax payer ID, e.g. EIN, TIN, SSN.
countrystring
The national jurisdiction of the tax authority in ISO 3166-1 format.
subdivisionstring
If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.
emailstring
The email address where this entity can be contacted.
mailing_addressobject
Description of a street address.
lines[string]
The lines of the street address.
Min items:
1 citystring
The city of the mailing address.
regionstring
The first-level administrative subdivision, e.g., a state, province or district. Use ISO 3166-2 subdivisions (note: not ISO-3166-alpha-2).
countrystring
The ISO 3166-alpha-2 country code.
postal_codestring
The postal code.
phonestring
The phone number, formatted using ITU standard E. 123.
idstring
Permanent identity identifier.
namestring
The display name of this entity (insufficient for KYC purposes)
dtcc_clearing_ids[string]
supports_debitboolean
Indicates account may be debited using transfer code.
supports_creditboolean
Indicates account may be credited using transfer code.
maturity_datestring
The date of maturity for fixed-term instruments, e.g. CDs.
Format:
date statements[object]
Must describe statement periods for previous two years.
statement_idstring
Globally unique identifier for this statement.
open_datestring
The opening date of this statement period.
Format:
date close_datestring
The closing date of this statement period, use a future date if the statement period has not closed.
Format:
date balancestring
The balance at the close of the statement period.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ document_urlstring
A URL to a downloadable document form of this statement. Implementers should not assume that accessors of this URL are always authorized.
idrequiredstring
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_atstring
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_typestring
Indicates the ownership type of the account, not the relationship the current user has over the account.
Possible values:
individual, joint, association, trustowner_identity_idsrequired[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.
statusrequiredstring
Status of this account.
Possible values:
active, inactive, frozen, locked, flagged, restricted, closedtyperequiredstring
Major classification of this account.
Possible values:
depository, loan, investmentsubtyperequiredstring
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 annuitynamestring
The account's user-given name, if the institution supports naming of accounts.
official_namerequiredstring
The account's marketing or brand name.
display_maskrequiredstring
A short alpha-numeric string to assist users in identifying the account, e.g. last four digits of the account number.
opening_datestring
The date on which the account was opened.
Format:
date current_balancerequiredstring
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_balancerequiredstring
The immediately available balance in the account, typically the amount available to withdraw at the moment.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ tax_advantagedboolean
Indicates whether some activity on the account - deposits, gains, etc - benefits from tax deferral or exemption, e.g. HSA, IRA, 401(k) accounts.
currencystring
The ISO-4217 currency in which this account’s transactions and balances are denominated.
non_iso_currencystring
If the account is denominated in a non-ISO currency, provide the currency's symbol.
API Object
{
"interest_rate": "0.0199",
"transfer_codes": {
"ach": {
"account_number": "string",
"routing_number": "031176110",
"wire_routing_number": "string",
"supports_debit": true,
"supports_credit": true
},
"eft": {
"account_number": "string",
"institution_number": "004",
"branch_number": "1320",
"supports_debit": true,
"supports_credit": true
},
"iban": {
"account_number": "string",
"bank_code": "NORD",
"country_code": "FR",
"location_code": "ZZ",
"branch_code": "80A",
"supports_debit": true,
"supports_credit": true
},
"payment_card": {
"card_number": "string",
"expiry_month": "01",
"expiry_year": "2021",
"security_code": "363",
"supports_debit": true,
"supports_credit": true
},
"acats": {
"account_number": "string",
"receiving_member_identity": {
"organization": {
"name": "Doe Business, Inc.",
"structure": "sole",
"mcc": "5542",
"owner_identity_ids": [
"6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
],
"tax_identifier": {
"tax_authority": "IRS",
"tax_payer_id": "string"
}
},
"person": {
"first_name": "Jane",
"middle_name": "Joan",
"last_name": "Doe",
"date_of_birth": "1987-01-31",
"tax_identifier": {
"tax_authority": "IRS",
"tax_payer_id": "string"
}
},
"email": "jane@plaid.com",
"mailing_address": {
"lines": [
"413 Leeward Way",
"Apt 3A"
],
"city": "San Francisco",
"region": "US-CA",
"country": "US",
"postal_code": "94106",
"phone": "+1 415 555 1212"
},
"id": "d7f1b8b9-0006-4135-91c0-b5532045a314",
"name": "Jane Doe"
},
"dtcc_clearing_ids": [
"string"
],
"supports_debit": true,
"supports_credit": true
}
},
"maturity_date": "2018-08-28",
"statements": [
{
"statement_id": "string",
"open_date": "2018-08-28",
"close_date": "2018-08-28",
"balance": "100.95",
"document_url": "string"
}
],
"id": "R13oiR6lC5jNC5jK",
"last_activity_at": "2020-04-21T12:45:00+00:00",
"ownership_type": "individual",
"owner_identity_ids": [
"6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
],
"non_owner_identity_ids": null,
"status": "active",
"type": "depository",
"subtype": "checking",
"name": "Vacation Money",
"official_name": "Pro Checking",
"display_mask": "9833",
"opening_date": "2018-01-31",
"current_balance": "850.55",
"available_balance": "149.45",
"tax_advantaged": true,
"currency": "USD",
"non_iso_currency": null
}DepositoryAccountStatement
Represents primary account statement details.
Properties
statement_idrequiredstring
Globally unique identifier for this statement.
open_datestring
The opening date of this statement period.
Format:
date close_datestring
The closing date of this statement period, use a future date if the statement period has not closed.
Format:
date balancestring
The balance at the close of the statement period.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ document_urlstring
A URL to a downloadable document form of this statement. Implementers should not assume that accessors of this URL are always authorized.
API Object
{
"statement_id": "string",
"open_date": "2018-08-28",
"close_date": "2018-08-28",
"balance": "100.95",
"document_url": "string"
}TransferCodeMap
Mapping between an account and various payment networks.
Properties
achobject
ACH (US) account identifiers.
account_numberstring
The account number.
routing_numberstring
The ABA routing transit number.
wire_routing_numberstring
The institution's routing number for wire transfer.
supports_debitboolean
Indicates account may be debited using transfer code.
supports_creditboolean
Indicates account may be credited using transfer code.
eftobject
EFT (Canada) account identifiers.
account_numberstring
The account number.
institution_numberstring
The institution's number assigned by Payments Canada.
branch_numberstring
The branch number corresponding to the account.
supports_debitboolean
Indicates account may be debited using transfer code.
supports_creditboolean
Indicates account may be credited using transfer code.
ibanobject
IBAN account identifiers.
account_numberstring
The full IBAN.
bank_codestring
Bank identifier.
country_codestring
The country code.
location_codestring
Location code for the bank's office.
branch_codestring
Optionally indicate a specific branch.
supports_debitboolean
Indicates account may be debited using transfer code.
supports_creditboolean
Indicates account may be credited using transfer code.
payment_cardobject
Payment card account identifiers.
card_numberstring
The payment card number.
expiry_monthstring
Month of card expiration, as a 2-digit value.
expiry_yearstring
Year of card expiration.
security_codestring
CVV, CSC, or other card-not-present verification value.
supports_debitboolean
Indicates account may be debited using transfer code.
supports_creditboolean
Indicates account may be credited using transfer code.
acatsobject
ACATS account identifiers.
account_numberstring
The account number.
receiving_memberobject
Identity of the receiving brokerage (including
organization).organizationobject
Describes an organization, e.g., a business or non-profit.
namestring
Name of the organization represented.
structurestring
Type of business structure.
Possible values:
sole, partnership, llc, corpmccstring
The ISO-18245 merchant category code for this business.
Pattern:
^\d{4}$ owner_identity_ids[string]
The identities of the organization owner(s).
tax_identifierobject
The tax authority ID.
tax_authoritystring
Name of the tax authority.
tax_payer_idstring
The tax payer ID, e.g. EIN, TIN, SSN.
countrystring
The national jurisdiction of the tax authority in ISO 3166-1 format.
subdivisionstring
If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.
personobject
Describes an individual, named person.
first_namestring
Legal given name of the personal entity.
middle_namestring
Middle name, use blank if none.
last_namestring
Last name or family name.
date_of_birthstring
The date of birth in ISO-8601 format.
Format:
date tax_identifierobject
The tax authority ID.
tax_authoritystring
Name of the tax authority.
tax_payer_idstring
The tax payer ID, e.g. EIN, TIN, SSN.
countrystring
The national jurisdiction of the tax authority in ISO 3166-1 format.
subdivisionstring
If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.
emailstring
The email address where this entity can be contacted.
mailing_addressobject
Description of a street address.
lines[string]
The lines of the street address.
Min items:
1 citystring
The city of the mailing address.
regionstring
The first-level administrative subdivision, e.g., a state, province or district. Use ISO 3166-2 subdivisions (note: not ISO-3166-alpha-2).
countrystring
The ISO 3166-alpha-2 country code.
postal_codestring
The postal code.
phonestring
The phone number, formatted using ITU standard E. 123.
idstring
Permanent identity identifier.
namestring
The display name of this entity (insufficient for KYC purposes)
dtcc_clearing_ids[string]
supports_debitboolean
Indicates account may be debited using transfer code.
supports_creditboolean
Indicates account may be credited using transfer code.
API Object
{
"ach": {
"account_number": "string",
"routing_number": "031176110",
"wire_routing_number": "string",
"supports_debit": true,
"supports_credit": true
},
"eft": {
"account_number": "string",
"institution_number": "004",
"branch_number": "1320",
"supports_debit": true,
"supports_credit": true
},
"iban": {
"account_number": "string",
"bank_code": "NORD",
"country_code": "FR",
"location_code": "ZZ",
"branch_code": "80A",
"supports_debit": true,
"supports_credit": true
},
"payment_card": {
"card_number": "string",
"expiry_month": "01",
"expiry_year": "2021",
"security_code": "363",
"supports_debit": true,
"supports_credit": true
},
"acats": {
"account_number": "string",
"receiving_member_identity": {
"organization": {
"name": "Doe Business, Inc.",
"structure": "sole",
"mcc": "5542",
"owner_identity_ids": [
"6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
],
"tax_identifier": {
"tax_authority": "IRS",
"tax_payer_id": "string"
}
},
"person": {
"first_name": "Jane",
"middle_name": "Joan",
"last_name": "Doe",
"date_of_birth": "1987-01-31",
"tax_identifier": {
"tax_authority": "IRS",
"tax_payer_id": "string"
}
},
"email": "jane@plaid.com",
"mailing_address": {
"lines": [
"413 Leeward Way",
"Apt 3A"
],
"city": "San Francisco",
"region": "US-CA",
"country": "US",
"postal_code": "94106",
"phone": "+1 415 555 1212"
},
"id": "d7f1b8b9-0006-4135-91c0-b5532045a314",
"name": "Jane Doe"
},
"dtcc_clearing_ids": [
"string"
],
"supports_debit": true,
"supports_credit": true
}
}DepositoryAccountTransferCode
Base model for depository account transfer identifiers.
Properties
supports_debitrequiredboolean
Indicates account may be debited using transfer code.
supports_creditrequiredboolean
Indicates account may be credited using transfer code.
API Object
{
"supports_debit": true,
"supports_credit": true
}AchTransferCode
Account and routing number for directing funds transfers in the US.
Properties
account_numberrequiredstring
The account number.
routing_numberrequiredstring
The ABA routing transit number.
wire_routing_numberstring
The institution's routing number for wire transfer.
supports_debitrequiredboolean
Indicates account may be debited using transfer code.
supports_creditrequiredboolean
Indicates account may be credited using transfer code.
API Object
{
"account_number": "121212454545",
"routing_number": "031176110",
"wire_routing_number": "1234-5678-0",
"supports_debit": true,
"supports_credit": true
}EftTransferCode
Identifiers for directing funds transfers in Canada.
Properties
account_numberrequiredstring
The account number.
institution_numberrequiredstring
The institution's number assigned by Payments Canada.
branch_numberrequiredstring
The branch number corresponding to the account.
supports_debitrequiredboolean
Indicates account may be debited using transfer code.
supports_creditrequiredboolean
Indicates account may be credited using transfer code.
API Object
{
"account_number": "string",
"institution_number": "004",
"branch_number": "1320",
"supports_debit": true,
"supports_credit": true
}IbanTransferCode
International Bank Account Number for directing international funds transfers.
Properties
account_numberrequiredstring
The full IBAN.
bank_coderequiredstring
Bank identifier.
country_coderequiredstring
The country code.
location_coderequiredstring
Location code for the bank's office.
branch_codestring
Optionally indicate a specific branch.
supports_debitrequiredboolean
Indicates account may be debited using transfer code.
supports_creditrequiredboolean
Indicates account may be credited using transfer code.
API Object
{
"account_number": "string",
"bank_code": "NORD",
"country_code": "FR",
"location_code": "ZZ",
"branch_code": "80A",
"supports_debit": true,
"supports_credit": true
}PaymentCardTransferCode
Identifiers for directing funds to/from payment cards.
Properties
card_numberrequiredstring
The payment card number.
expiry_monthrequiredstring
Month of card expiration, as a 2-digit value.
expiry_yearrequiredstring
Year of card expiration.
security_coderequiredstring
CVV, CSC, or other card-not-present verification value.
supports_debitrequiredboolean
Indicates account may be debited using transfer code.
supports_creditrequiredboolean
Indicates account may be credited using transfer code.
API Object
{
"card_number": "string",
"expiry_month": "01",
"expiry_year": "2021",
"security_code": "363",
"supports_debit": true,
"supports_credit": true
}NotionalAccount
A placeholder entity, capable of indicating only basic facts about an account.
Properties
idrequiredstring
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).typerequiredstring
Major classification of this account. Should be one of the
accountType values.subtyperequiredstring
Minor classification of this account. Should be one of the
accountSubtype values.access_authorizeddeprecatedboolean
Indicate that the user has not authorized the account to participate in aggregation. should only be present/true for notional accounts.
namestring
The account’s user-given name, if the institution supports naming of accounts
official_namerequiredstring
The account’s marketing or brand name.
currencystring
The ISO-4217 currency in which this account’s transactions and balances are denominated.
non_iso_currencystring
If the account is denominated in a non-ISO currency, provide the currency’s symbol.
API Object
{
"id": "R13oiR6lC5jNC5jK",
"type": "depository",
"subtype": "checking",
"name": "Vacation money",
"official_name": "Pro Checking",
"currency": "USD",
"non_iso_currency": null
}InvestmentAccount
Representation of brokerage accounts.
Properties
transfer_codesobject
Account identifiers necessary for portfolio transfers.
achobject
ACH (US) account identifiers.
account_numberstring
The account number.
routing_numberstring
The ABA routing transit number.
wire_routing_numberstring
The institution's routing number for wire transfer.
supports_debitboolean
Indicates account may be debited using transfer code.
supports_creditboolean
Indicates account may be credited using transfer code.
eftobject
EFT (Canada) account identifiers.
account_numberstring
The account number.
institution_numberstring
The institution's number assigned by Payments Canada.
branch_numberstring
The branch number corresponding to the account.
supports_debitboolean
Indicates account may be debited using transfer code.
supports_creditboolean
Indicates account may be credited using transfer code.
ibanobject
IBAN account identifiers.
account_numberstring
The full IBAN.
bank_codestring
Bank identifier.
country_codestring
The country code.
location_codestring
Location code for the bank's office.
branch_codestring
Optionally indicate a specific branch.
supports_debitboolean
Indicates account may be debited using transfer code.
supports_creditboolean
Indicates account may be credited using transfer code.
payment_cardobject
Payment card account identifiers.
card_numberstring
The payment card number.
expiry_monthstring
Month of card expiration, as a 2-digit value.
expiry_yearstring
Year of card expiration.
security_codestring
CVV, CSC, or other card-not-present verification value.
supports_debitboolean
Indicates account may be debited using transfer code.
supports_creditboolean
Indicates account may be credited using transfer code.
acatsobject
ACATS account identifiers.
account_numberstring
The account number.
receiving_memberobject
Identity of the receiving brokerage (including
organization).organizationobject
Describes an organization, e.g., a business or non-profit.
namestring
Name of the organization represented.
structurestring
Type of business structure.
Possible values:
sole, partnership, llc, corpmccstring
The ISO-18245 merchant category code for this business.
Pattern:
^\d{4}$ owner_identity_ids[string]
The identities of the organization owner(s).
tax_identifierobject
The tax authority ID.
tax_authoritystring
Name of the tax authority.
tax_payer_idstring
The tax payer ID, e.g. EIN, TIN, SSN.
countrystring
The national jurisdiction of the tax authority in ISO 3166-1 format.
subdivisionstring
If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.
personobject
Describes an individual, named person.
first_namestring
Legal given name of the personal entity.
middle_namestring
Middle name, use blank if none.
last_namestring
Last name or family name.
date_of_birthstring
The date of birth in ISO-8601 format.
Format:
date tax_identifierobject
The tax authority ID.
tax_authoritystring
Name of the tax authority.
tax_payer_idstring
The tax payer ID, e.g. EIN, TIN, SSN.
countrystring
The national jurisdiction of the tax authority in ISO 3166-1 format.
subdivisionstring
If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.
emailstring
The email address where this entity can be contacted.
mailing_addressobject
Description of a street address.
lines[string]
The lines of the street address.
Min items:
1 citystring
The city of the mailing address.
regionstring
The first-level administrative subdivision, e.g., a state, province or district. Use ISO 3166-2 subdivisions (note: not ISO-3166-alpha-2).
countrystring
The ISO 3166-alpha-2 country code.
postal_codestring
The postal code.
phonestring
The phone number, formatted using ITU standard E. 123.
idstring
Permanent identity identifier.
namestring
The display name of this entity (insufficient for KYC purposes)
dtcc_clearing_ids[string]
supports_debitboolean
Indicates account may be debited using transfer code.
supports_creditboolean
Indicates account may be credited using transfer code.
current_balancerequiredstring
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_balancerequiredstring
The immediately available balance in the account, typically the amount available to withdraw at the moment.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ margin_balancestring
The amount that is on loan. Provide as a negative amount.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ margin_limitstring
The total limit of the margin extended to the account.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ margin_equitystring
The amount of marginable assets owned in the account.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ maintenance_marginstring
The minimum equity needed to hold the positions in the account.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ buying_powerstring
Total amount of funds available for making transactions, includes margin.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ current_as_ofstring
The time at which
current_balance was current.Format:
date-time holdingsrequired[object]
Descriptions of held assets in the account.
security_idstring
The identifier of the security referenced by this holding.
cost_basisstring
The total cost of acquiring this holding, inclusive of fees.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ quantitystring
The amount of the security (typically, number of shares) comprising this holding.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ lotsobject
The tax lots constituting this holding.
idstring
The unique and permanent identifier for this lot.
acquired_atstring
The date at which the lot was acquired.
Format:
date acquired_pricestring
The total price at which this lot was acquired.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ quantitystring
The quantity held in this lot.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ currencystring
The ISO-4217 currency in which this account’s transactions and balances are denominated.
non_iso_currencystring
If the account is denominated in a non-ISO currency, provide the currency's symbol.
idrequiredstring
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_atstring
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_typestring
Indicates the ownership type of the account, not the relationship the current user has over the account.
Possible values:
individual, joint, association, trustowner_identity_idsrequired[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.
statusrequiredstring
Status of this account.
Possible values:
active, inactive, frozen, locked, flagged, restricted, closedtyperequiredstring
Major classification of this account.
Possible values:
depository, loan, investmentsubtyperequiredstring
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 annuitynamestring
The account's user-given name, if the institution supports naming of accounts.
official_namerequiredstring
The account's marketing or brand name.
display_maskrequiredstring
A short alpha-numeric string to assist users in identifying the account, e.g. last four digits of the account number.
opening_datestring
The date on which the account was opened.
Format:
date tax_advantagedboolean
Indicates whether some activity on the account - deposits, gains, etc - benefits from tax deferral or exemption, e.g. HSA, IRA, 401(k) accounts.
currencystring
The ISO-4217 currency in which this account’s transactions and balances are denominated.
non_iso_currencystring
If the account is denominated in a non-ISO currency, provide the currency's symbol.
API Object
{
"transfer_codes": {
"ach": {
"account_number": "string",
"routing_number": "031176110",
"wire_routing_number": "string",
"supports_debit": true,
"supports_credit": true
},
"eft": {
"account_number": "string",
"institution_number": "004",
"branch_number": "1320",
"supports_debit": true,
"supports_credit": true
},
"iban": {
"account_number": "string",
"bank_code": "NORD",
"country_code": "FR",
"location_code": "ZZ",
"branch_code": "80A",
"supports_debit": true,
"supports_credit": true
},
"payment_card": {
"card_number": "string",
"expiry_month": "01",
"expiry_year": "2021",
"security_code": "363",
"supports_debit": true,
"supports_credit": true
},
"acats": {
"account_number": "string",
"receiving_member_identity": {
"organization": {
"name": "Doe Business, Inc.",
"structure": "sole",
"mcc": "5542",
"owner_identity_ids": [
"6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
],
"tax_identifier": {
"tax_authority": "IRS",
"tax_payer_id": "string"
}
},
"person": {
"first_name": "Jane",
"middle_name": "Joan",
"last_name": "Doe",
"date_of_birth": "1987-01-31",
"tax_identifier": {
"tax_authority": "IRS",
"tax_payer_id": "string"
}
},
"email": "jane@plaid.com",
"mailing_address": {
"lines": [
"413 Leeward Way",
"Apt 3A"
],
"city": "San Francisco",
"region": "US-CA",
"country": "US",
"postal_code": "94106",
"phone": "+1 415 555 1212"
},
"id": "d7f1b8b9-0006-4135-91c0-b5532045a314",
"name": "Jane Doe"
},
"dtcc_clearing_ids": [
"string"
],
"supports_debit": true,
"supports_credit": true
}
},
"current_balance": "850.55",
"available_balance": "149.45",
"margin_balance": "100.95",
"margin_limit": "100.95",
"margin_equity": "100.95",
"maintenance_margin": "100.95",
"buying_power": "100.95",
"current_as_of": "2018-08-28",
"holdings": [
{
"security_id": "string",
"cost_basis": "100.95",
"quantity": "100.95",
"lots": {
"id": "string",
"acquired_at": "2018-08-28",
"acquired_price": "100.95",
"quantity": "100.95"
},
"currency": "USD",
"non_iso_currency": null
}
],
"id": "R13oiR6lC5jNC5jK",
"last_activity_at": "2020-04-21T12:45:00+00:00",
"ownership_type": "individual",
"owner_identity_ids": [
"6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
],
"non_owner_identity_ids": null,
"status": "active",
"type": "investment",
"subtype": "401k",
"name": "Vacation Money",
"official_name": "401k Account",
"display_mask": "9833",
"opening_date": "2018-01-31",
"tax_advantaged": true,
"currency": "USD",
"non_iso_currency": null
}AcatsTransferCode
Automated Customer Account Transfer Service identifiers for transferring stock portfolios between brokerages.
Properties
account_numberrequiredstring
The account number.
receiving_memberrequiredobject
Identity of the receiving brokerage (including
organization).organizationobject
Describes an organization, e.g., a business or non-profit.
namestring
Name of the organization represented.
structurestring
Type of business structure.
Possible values:
sole, partnership, llc, corpmccstring
The ISO-18245 merchant category code for this business.
Pattern:
^\d{4}$ owner_identity_ids[string]
The identities of the organization owner(s).
tax_identifierobject
The tax authority ID.
tax_authoritystring
Name of the tax authority.
tax_payer_idstring
The tax payer ID, e.g. EIN, TIN, SSN.
countrystring
The national jurisdiction of the tax authority in ISO 3166-1 format.
subdivisionstring
If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.
personobject
Describes an individual, named person.
first_namestring
Legal given name of the personal entity.
middle_namestring
Middle name, use blank if none.
last_namestring
Last name or family name.
date_of_birthstring
The date of birth in ISO-8601 format.
Format:
date tax_identifierobject
The tax authority ID.
tax_authoritystring
Name of the tax authority.
tax_payer_idstring
The tax payer ID, e.g. EIN, TIN, SSN.
countrystring
The national jurisdiction of the tax authority in ISO 3166-1 format.
subdivisionstring
If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.
emailstring
The email address where this entity can be contacted.
mailing_addressobject
Description of a street address.
lines[string]
The lines of the street address.
Min items:
1 citystring
The city of the mailing address.
regionstring
The first-level administrative subdivision, e.g., a state, province or district. Use ISO 3166-2 subdivisions (note: not ISO-3166-alpha-2).
countrystring
The ISO 3166-alpha-2 country code.
postal_codestring
The postal code.
phonestring
The phone number, formatted using ITU standard E. 123.
idstring
Permanent identity identifier.
namestring
The display name of this entity (insufficient for KYC purposes)
dtcc_clearing_idsrequired[string]
supports_debitrequiredboolean
Indicates account may be debited using transfer code.
supports_creditrequiredboolean
Indicates account may be credited using transfer code.
API Object
{
"account_number": "string",
"receiving_member_identity": {
"organization": {
"name": "Doe Business, Inc.",
"structure": "sole",
"mcc": "5542",
"owner_identity_ids": [
"6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
],
"tax_identifier": {
"tax_authority": "IRS",
"tax_payer_id": "string"
}
},
"person": {
"first_name": "Jane",
"middle_name": "Joan",
"last_name": "Doe",
"date_of_birth": "1987-01-31",
"tax_identifier": {
"tax_authority": "IRS",
"tax_payer_id": "string"
}
},
"email": "jane@plaid.com",
"mailing_address": {
"lines": [
"413 Leeward Way",
"Apt 3A"
],
"city": "San Francisco",
"region": "US-CA",
"country": "US",
"postal_code": "94106",
"phone": "+1 415 555 1212"
},
"id": "d7f1b8b9-0006-4135-91c0-b5532045a314",
"name": "Jane Doe"
},
"dtcc_clearing_ids": [
"string"
],
"supports_debit": true,
"supports_credit": true
}Security
Description of a security (i.e. stocks, bonds, derivatives, etc.)
Properties
idrequiredstring
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).
namerequiredstring
A descriptive name for the security, suitable for display.
symbolrequiredstring
The security's trading symbol, if applicable. Otherwise, a short, commonly used identifier.
is_cash_equivalentrequiredboolean
Indicates the security is highly-liquid, e.g. a money market account, and should be regarded as cash.
current_pricerequiredstring
The instantaneous trading price of the security.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ current_as_ofrequiredstring
The time at which
current_price was current, in ISO 8601 format.Format:
date-time close_pricestring
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})?$ typerequiredstring
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, othercurrencystring
The ISO 4217 currency in which this account’s transactions and balances are denominated.
non_iso_currencystring
If the account is denominated in a non-ISO currency, provide the currency's symbol.
API Object
{
"id": "account_5921",
"isin": "US17275R1023",
"name": "CISCO SYSTEMS INC",
"symbol": "CSCO",
"is_cash_equivalent": true,
"current_price": "100.95",
"current_as_of": "2018-08-28",
"close_price": "100.95",
"type": "cash",
"currency": "USD",
"non_iso_currency": null
}OptionSecurity
Representation of a Security with type of derivative.
Properties
expiryrequiredstring
The contract expiration date.
Format:
date contract_typerequiredstring
The type of option.
Possible values:
put, calloption_stylestring
The style of option (US or European)
Possible values:
euro, usexercise_pricestring
The price at which the contract owner may transact.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ underlying_security_idrequiredstring
Reference to the security underlying this contract.
idrequiredstring
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).
namerequiredstring
A descriptive name for the security, suitable for display.
symbolrequiredstring
The security's trading symbol, if applicable. Otherwise, a short, commonly used identifier.
is_cash_equivalentrequiredboolean
Indicates the security is highly-liquid, e.g. a money market account, and should be regarded as cash.
current_pricerequiredstring
The instantaneous trading price of the security.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ current_as_ofrequiredstring
The time at which
current_price was current, in ISO 8601 format.Format:
date-time close_pricestring
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})?$ typerequiredstring
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, othercurrencystring
The ISO 4217 currency in which this account’s transactions and balances are denominated.
non_iso_currencystring
If the account is denominated in a non-ISO currency, provide the currency's symbol.
API Object
{
"id": "account_5921",
"isin": "US17275R1023",
"name": "CISCO SYSTEMS INC",
"symbol": "CSCO",
"is_cash_equivalent": true,
"current_price": "100.95",
"current_as_of": "2018-08-28",
"close_price": "100.95",
"type": "cash",
"currency": "USD",
"non_iso_currency": null
}ContractType
Holding
Instance of a held security.
Properties
security_idrequiredstring
The identifier of the security referenced by this holding.
cost_basisstring
The total cost of acquiring this holding, inclusive of fees.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ quantityrequiredstring
The amount of the security (typically, number of shares) comprising this holding.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ lotsobject
The tax lots constituting this holding.
idstring
The unique and permanent identifier for this lot.
acquired_atstring
The date at which the lot was acquired.
Format:
date acquired_pricestring
The total price at which this lot was acquired.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ quantitystring
The quantity held in this lot.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ currencystring
The ISO-4217 currency in which this account’s transactions and balances are denominated.
non_iso_currencystring
If the account is denominated in a non-ISO currency, provide the currency's symbol.
API Object
{
"security_id": "string",
"cost_basis": "100.95",
"quantity": "100.95",
"lots": {
"id": "string",
"acquired_at": "2018-08-28",
"acquired_price": "100.95",
"quantity": "100.95"
},
"currency": "USD",
"non_iso_currency": null
}TaxLot
Describes taxable lots of shares within a Holding.
Properties
idrequiredstring
The unique and permanent identifier for this lot.
acquired_atrequiredstring
The date at which the lot was acquired.
Format:
date acquired_pricerequiredstring
The total price at which this lot was acquired.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ quantityrequiredstring
The quantity held in this lot.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ API Object
{
"id": "string",
"acquired_at": "2018-08-28",
"acquired_price": "100.95",
"quantity": "100.95"
}LoanAccount
Representation of short and long-term debt.
Properties
account_numberstring
The account number for this loan.
reference_numberstring
The loan's reference number.
servicer_identity_idstring
Reference to the identity of the loan servicer.
interest_raterequiredstring
The current interest rate for this loan.
Pattern:
^\d*(\.\d{1,4})?$ interest_rate_typerequiredstring
The interest rate adjustment scheme for this loan.
Possible values:
fixed, adjustable, variable, otherinterest_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_datestring
The date this rate became, or becomes, effective.
Format:
date end_datestring
The date this rate became, or becomes, ineffective. Use
null if the end date is not known or not fixed.Format:
date interest_ratestring
The effective rate during the period described.
Pattern:
^\d*(\.\d{1,4})?$ term_monthsinteger
The full length of the loan's term, in months.
Minimum:
0 term_daysinteger
The full length of the loan's term, in days.
Minimum:
0 repayment_statusrequiredstring
The loan's repayment status.
Possible values:
fully repaid, current, grace, deferment, forbearance, past due, delinquent, default, charged off, cancelledprincipal_balancerequiredstring
The loan's remaining principal.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ payoff_quotestring
The instantaneous payoff quote.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ payoff_expirystring
The date until which
payoff_quote is considered current.Format:
date origination_daterequiredstring
The loan's date of origination.
Format:
date origination_principalstring
The original principal balance.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ maturity_datestring
The loan's date of maturity.
Format:
date statements[object]
Must describe statement periods for the account's entire history.
payment_paid_tostring
The amount of the payment paid to principal.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ payment_paid_tostring
The amount of the payment paid to interest.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ open_datestring
The opening date of this statement period.
Format:
date close_datestring
The closing date of this statement period. Use a future date if the statement period has not closed.
Format:
date balance_duestring
The statement balance.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ minimum_payment_duestring
The minimum payment due on this statement. If the statement is paid, this should be 0.00.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ payment_due_datestring
The date payment is, or was, due for this statement.
Format:
date payment_received_datestring
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_receivedstring
The sum of all payments received during the period.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ document_urlstring
A URL to a downloadable document form of this statement. Implementers should not assume that accessors of this URL are always authorized.
idrequiredstring
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_atstring
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_typestring
Indicates the ownership type of the account, not the relationship the current user has over the account.
Possible values:
individual, joint, association, trustowner_identity_idsrequired[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.
statusrequiredstring
Status of this account.
Possible values:
active, inactive, frozen, locked, flagged, restricted, closedtyperequiredstring
Major classification of this account.
Possible values:
depository, loan, investmentsubtyperequiredstring
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 annuitynamestring
The account's user-given name, if the institution supports naming of accounts.
official_namerequiredstring
The account's marketing or brand name.
display_maskrequiredstring
A short alpha-numeric string to assist users in identifying the account, e.g. last four digits of the account number.
opening_datestring
The date on which the account was opened.
Format:
date current_balancerequiredstring
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_balancerequiredstring
The immediately available balance in the account, typically the amount available to withdraw at the moment.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ tax_advantagedboolean
Indicates whether some activity on the account - deposits, gains, etc - benefits from tax deferral or exemption, e.g. HSA, IRA, 401(k) accounts.
currencystring
The ISO-4217 currency in which this account’s transactions and balances are denominated.
non_iso_currencystring
If the account is denominated in a non-ISO currency, provide the currency's symbol.
API Object
{
"type": "loan",
"account_number": "string",
"reference_number": "string",
"servicer_identity_id": "string",
"interest_rate": "0.0199",
"interest_rate_type": "fixed",
"interest_rate_schedule": [
{
"start_date": "2018-08-28",
"end_date": "2018-08-28",
"interest_rate": "0.0199"
}
],
"term_months": 0,
"term_days": 0,
"repayment_status": "fully repaid",
"principal_balance": "100.95",
"payoff_quote": "100.95",
"payoff_expiry": "2018-08-28",
"origination_date": "2018-08-28",
"origination_principal": "100.95",
"maturity_date": "2018-08-28",
"statements": [
{
"payment_paid_to_principal": "100.95",
"payment_paid_to_interest": "100.95",
"open_date": "2018-08-28",
"close_date": "2018-08-28",
"balance_due": "100.95",
"minimum_payment_due": "100.95",
"payment_due_date": "2018-08-28",
"payment_received_date": "2018-08-28",
"payment_received_amount": "100.95",
"document_url": "string"
}
],
"id": "R13oiR6lC5jNC5jK",
"last_activity_at": "2020-04-21T12:45:00+00:00",
"ownership_type": "individual",
"owner_identity_ids": [
"6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
],
"non_owner_identity_ids": null,
"status": "active",
"subtype": "consumer",
"name": "Vacation Money",
"official_name": "Pro Checking",
"display_mask": "9833",
"opening_date": "2018-01-31",
"current_balance": "850.55",
"available_balance": "149.45",
"tax_advantaged": true,
"currency": "USD",
"non_iso_currency": null
}LoanStatement
Description of a loan account statement.
Properties
payment_paid_tostring
The amount of the payment paid to principal.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ payment_paid_tostring
The amount of the payment paid to interest.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ open_daterequiredstring
The opening date of this statement period.
Format:
date close_daterequiredstring
The closing date of this statement period. Use a future date if the statement period has not closed.
Format:
date balance_duerequiredstring
The statement balance.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ minimum_payment_duerequiredstring
The minimum payment due on this statement. If the statement is paid, this should be 0.00.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ payment_due_daterequiredstring
The date payment is, or was, due for this statement.
Format:
date payment_received_daterequiredstring
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_receivedrequiredstring
The sum of all payments received during the period.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ document_urlstring
A URL to a downloadable document form of this statement. Implementers should not assume that accessors of this URL are always authorized.
API Object
{
"open_date": "2018-08-28",
"close_date": "2018-08-28",
"balance_due": "100.95",
"minimum_payment_due": "100.95",
"payment_due_date": "2018-08-28",
"payment_received_date": "2018-08-28",
"payment_received_amount": "100.95",
"document_url": "string"
}InterestRateType
Interest rate adjustment schemes.
Properties
fixedstring
fixed rate.
adjustablestring
Adjustable rate.
variablestring
Variable rate.
otherstring
All other rate adjustment schemes.
InterestRatePeriod
Time-bound description of interest rates and their effective periods.
Properties
start_daterequiredstring
The date this rate became, or becomes, effective.
Format:
date end_daterequiredstring
The date this rate became, or becomes, ineffective. Use
null if the end date is not known or not fixed.Format:
date interest_raterequiredstring
The effective rate during the period described.
Pattern:
^\d*(\.\d{1,4})?$ API Object
{
"start_date": "2018-08-28",
"end_date": "2018-08-28",
"interest_rate": "0.0199"
}LoanRepaymentStatus
Loan repayment status.
Properties
fully repaidstring
The loan is fully repaid.
currentstring
The loan is current and the borrow is in good standing with respect to this loan.
gracestring
Loan payments have not begun, and interest is not accruing.
defermentstring
Loan payments are reduced or suspended, and interest is not accruing.
forbearancestring
Loan payments are reduced or suspended, but deferred interest is accruing.
past duestring
The borrower is past due, but can return the account to current.
delinquentstring
The borrower is severely past due and the institution may begin Dunning.
defaultstring
The borrower has defaulted and the institution may be pursuing other remedies.
charged offstring
The borrower has defaulted and the institution has completed actions in connection with the default.
cancelledstring
The lender has cancelled this loan (use also for forgiven or discharged loans).
MortgageAccount
Representation of a home mortgage loan.
Properties
subtyperequiredstring
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 annuityescrow_balancestring
The total amount held in escrow for this loan, if applicable.
Fixed-point decimal number, carried up to six decimal places.
Fixed-point decimal number, carried up to six decimal places.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ idrequiredstring
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_atstring
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_typestring
Indicates the ownership type of the account, not the relationship the current user has over the account.
Possible values:
individual, joint, association, trustowner_identity_idsrequired[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.
statusrequiredstring
Status of this account.
Possible values:
active, inactive, frozen, locked, flagged, restricted, closedtyperequiredstring
Major classification of this account.
Possible values:
depository, loan, investmentnamestring
The account's user-given name, if the institution supports naming of accounts.
official_namerequiredstring
The account's marketing or brand name.
display_maskrequiredstring
A short alpha-numeric string to assist users in identifying the account, e.g. last four digits of the account number.
opening_datestring
The date on which the account was opened.
Format:
date current_balancerequiredstring
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_balancerequiredstring
The immediately available balance in the account, typically the amount available to withdraw at the moment.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ tax_advantagedboolean
Indicates whether some activity on the account - deposits, gains, etc - benefits from tax deferral or exemption, e.g. HSA, IRA, 401(k) accounts.
currencystring
The ISO-4217 currency in which this account’s transactions and balances are denominated.
non_iso_currencystring
If the account is denominated in a non-ISO currency, provide the currency's symbol.
API Object
{
"subtype": "mortgage",
"escrow_balance": "100.95",
"type": "loan",
"account_number": "string",
"reference_number": "string",
"servicer_identity_id": "string",
"interest_rate": "0.0199",
"interest_rate_type": "fixed",
"interest_rate_schedule": [
{
"start_date": "2018-08-28",
"end_date": "2018-08-28",
"interest_rate": "0.0199"
}
],
"term_months": 0,
"term_days": 0,
"repayment_status": "fully repaid",
"principal_balance": "100.95",
"payoff_quote": "100.95",
"payoff_expiry": "2018-08-28",
"origination_date": "2018-08-28",
"origination_principal": "100.95",
"maturity_date": "2018-08-28",
"statements": [
{
"payment_paid_to_principal": "100.95",
"payment_paid_to_interest": "100.95",
"open_date": "2018-08-28",
"close_date": "2018-08-28",
"balance_due": "100.95",
"minimum_payment_due": "100.95",
"payment_due_date": "2018-08-28",
"payment_received_date": "2018-08-28",
"payment_received_amount": "100.95",
"document_url": "string"
}
],
"id": "R13oiR6lC5jNC5jK",
"last_activity_at": "2020-04-21T12:45:00+00:00",
"ownership_type": "individual",
"owner_identity_ids": [
"6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
],
"non_owner_identity_ids": null,
"status": "active",
"name": "Vacation Money",
"official_name": "Pro Checking",
"display_mask": "9833",
"opening_date": "2018-01-31",
"current_balance": "850.55",
"available_balance": "149.45",
"tax_advantaged": true,
"currency": "USD",
"non_iso_currency": null
}StudentLoanAccount
Representational of a loan account that is specific to student loans
Properties
subtyperequiredstring
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 annuitydisbursement_schedule[object]
The schedule for disbursement of funds.
disbursement_datestring
The date of disbursement.
Format:
date amountstring
The amount disbursed.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ guarantor_identityobject
The company or agency guaranteeing the loan.
organizationobject
Describes an organization, e.g., a business or non-profit.
namestring
Name of the organization represented.
structurestring
Type of business structure.
Possible values:
sole, partnership, llc, corpmccstring
The ISO-18245 merchant category code for this business.
Pattern:
^\d{4}$ owner_identity_ids[string]
The identities of the organization owner(s).
tax_identifierobject
The tax authority ID.
tax_authoritystring
Name of the tax authority.
tax_payer_idstring
The tax payer ID, e.g. EIN, TIN, SSN.
countrystring
The national jurisdiction of the tax authority in ISO 3166-1 format.
subdivisionstring
If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.
personobject
Describes an individual, named person.
first_namestring
Legal given name of the personal entity.
middle_namestring
Middle name, use blank if none.
last_namestring
Last name or family name.
date_of_birthstring
The date of birth in ISO-8601 format.
Format:
date tax_identifierobject
The tax authority ID.
tax_authoritystring
Name of the tax authority.
tax_payer_idstring
The tax payer ID, e.g. EIN, TIN, SSN.
countrystring
The national jurisdiction of the tax authority in ISO 3166-1 format.
subdivisionstring
If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.
emailstring
The email address where this entity can be contacted.
mailing_addressobject
Description of a street address.
lines[string]
The lines of the street address.
Min items:
1 citystring
The city of the mailing address.
regionstring
The first-level administrative subdivision, e.g., a state, province or district. Use ISO 3166-2 subdivisions (note: not ISO-3166-alpha-2).
countrystring
The ISO 3166-alpha-2 country code.
postal_codestring
The postal code.
phonestring
The phone number, formatted using ITU standard E. 123.
idstring
Permanent identity identifier.
namestring
The display name of this entity (insufficient for KYC purposes)
pslf_eligibilityobject
Description of the loan's eligibility for public service forgiveness.
eligibleboolean
Indicates the loan's eligibility for PSLF.
qualifying_paymentsinteger
The number of payments made which qualify under PSLF.
Minimum:
0 total_paymentsinteger
Total payments required for forgiveness.
Minimum:
0 sequence_numberstring
The loan's sequence number.
idrequiredstring
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_atstring
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_typestring
Indicates the ownership type of the account, not the relationship the current user has over the account.
Possible values:
individual, joint, association, trustowner_identity_idsrequired[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.
statusrequiredstring
Status of this account.
Possible values:
active, inactive, frozen, locked, flagged, restricted, closedtyperequiredstring
Major classification of this account.
Possible values:
depository, loan, investmentnamestring
The account's user-given name, if the institution supports naming of accounts.
official_namerequiredstring
The account's marketing or brand name.
display_maskrequiredstring
A short alpha-numeric string to assist users in identifying the account, e.g. last four digits of the account number.
opening_datestring
The date on which the account was opened.
Format:
date current_balancerequiredstring
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_balancerequiredstring
The immediately available balance in the account, typically the amount available to withdraw at the moment.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ tax_advantagedboolean
Indicates whether some activity on the account - deposits, gains, etc - benefits from tax deferral or exemption, e.g. HSA, IRA, 401(k) accounts.
currencystring
The ISO-4217 currency in which this account’s transactions and balances are denominated.
non_iso_currencystring
If the account is denominated in a non-ISO currency, provide the currency's symbol.
API Object
{
"subtype": "student",
"disbursement_schedule": [
{
"disbursement_date": "2018-08-28",
"amount": "100.95"
}
],
"guarantor_identity": {
"organization": {
"name": "Doe Business, Inc.",
"structure": "sole",
"mcc": "5542",
"owner_identity_ids": [
"6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
],
"tax_identifier": {
"tax_authority": "IRS",
"tax_payer_id": "string"
}
},
"person": {
"first_name": "Jane",
"middle_name": "Joan",
"last_name": "Doe",
"date_of_birth": "1987-01-31",
"tax_identifier": {
"tax_authority": "IRS",
"tax_payer_id": "string"
}
},
"email": "jane@plaid.com",
"mailing_address": {
"lines": [
"413 Leeward Way",
"Apt 3A"
],
"city": "San Francisco",
"region": "US-CA",
"country": "US",
"postal_code": "94106",
"phone": "+1 415 555 1212"
},
"id": "d7f1b8b9-0006-4135-91c0-b5532045a314",
"name": "Jane Doe"
},
"pslf_eligibility": {
"eligible": true,
"qualifying_payments": 0,
"total_payments": 0
},
"sequence_number": "string",
"type": "loan",
"account_number": "string",
"reference_number": "string",
"servicer_identity_id": "string",
"interest_rate": "0.0199",
"interest_rate_type": "fixed",
"interest_rate_schedule": [
{
"start_date": "2018-08-28",
"end_date": "2018-08-28",
"interest_rate": "0.0199"
}
],
"term_months": 0,
"term_days": 0,
"repayment_status": "fully repaid",
"principal_balance": "100.95",
"payoff_quote": "100.95",
"payoff_expiry": "2018-08-28",
"origination_date": "2018-08-28",
"origination_principal": "100.95",
"maturity_date": "2018-08-28",
"statements": [
{
"payment_paid_to_principal": "100.95",
"payment_paid_to_interest": "100.95",
"open_date": "2018-08-28",
"close_date": "2018-08-28",
"balance_due": "100.95",
"minimum_payment_due": "100.95",
"payment_due_date": "2018-08-28",
"payment_received_date": "2018-08-28",
"payment_received_amount": "100.95",
"document_url": "string"
}
],
"id": "R13oiR6lC5jNC5jK",
"last_activity_at": "2020-04-21T12:45:00+00:00",
"ownership_type": "individual",
"owner_identity_ids": [
"6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
],
"non_owner_identity_ids": null,
"status": "active",
"name": "Vacation Money",
"official_name": "Pro Checking",
"display_mask": "9833",
"opening_date": "2018-01-31",
"current_balance": "850.55",
"available_balance": "149.45",
"tax_advantaged": true,
"currency": "USD",
"non_iso_currency": null
}Disbursement
Description of a loan (typically student loan) disbursement event.
Properties
disbursement_daterequiredstring
The date of disbursement.
Format:
date amountrequiredstring
The amount disbursed.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ API Object
{
"disbursement_date": "2018-08-28",
"amount": "100.95"
}PslfEligibility
Student loan PSLF eligibility status information.
Properties
eligiblerequiredboolean
Indicates the loan's eligibility for PSLF.
qualifying_paymentsinteger
The number of payments made which qualify under PSLF.
Minimum:
0 total_paymentsinteger
Total payments required for forgiveness.
Minimum:
0 API Object
{
"eligible": true,
"qualifying_payments": 0,
"total_payments": 0
}CreditCardAccount
Representation of
 credit card.
Properties
typerequiredstring
Major classification of this account.
Possible values:
depository, loan, investmentsubtyperequiredstring
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 annuitycurrent_balancerequiredstring
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_balancerequiredstring
The immediately available balance in the account, typically the amount available to withdraw at the moment.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ reward_balancestring
The balance of any rewards associated with this account.
Fixed-point decimal number, carried up to six decimal places.
Fixed-point decimal number, carried up to six decimal places.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ credit_limitrequiredstring
The total credit limit for this account. If card has no limit, use
Fixed-point decimal number, carried up to six decimal places.
null.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_datestring
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_datestring
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 typestring
The type of balance subject to this rate.
Possible values:
purchase, cash advance, balance transferinterest_ratestring
The APR covering this balance.
Pattern:
^\d*(\.\d{1,4})?$ subject_balancestring
The current balance subject to this rate, following the definition of
current_balance.Pattern:
^-?(\d*)(?:\.\d{1,2})?$ interest_chargedstring
The amount within the
subject_balance that was generated by this interest rate.Pattern:
^-?(\d*)(?:\.\d{1,2})?$ statements[object]
Must describe statement periods for previous two years.
open_datestring
The opening date of this statement period.
Format:
date close_datestring
The closing date of this statement period. Use a future date if the statement period has not closed.
Format:
date balance_duestring
The statement balance.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ minimum_payment_duestring
The minimum payment due on this statement. If the statement is paid, this should be 0.00.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ payment_due_datestring
The date payment is, or was, due for this statement.
Format:
date payment_received_datestring
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_receivedstring
The sum of all payments received during the period.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ document_urlstring
A URL to a downloadable document form of this statement. Implementers should not assume that accessors of this URL are always authorized.
reward_currencystring
The ISO-4217 currency in which this account's reward balances are denominated
reward_non_isostring
If the account's reward balance is denominated in a non-ISO currency, provide the currency's symbol
art_asset_urlstring
URL reference to an image of the payment card face.
idrequiredstring
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_atstring
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_typestring
Indicates the ownership type of the account, not the relationship the current user has over the account.
Possible values:
individual, joint, association, trustowner_identity_idsrequired[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.
statusrequiredstring
Status of this account.
Possible values:
active, inactive, frozen, locked, flagged, restricted, closednamestring
The account's user-given name, if the institution supports naming of accounts.
official_namerequiredstring
The account's marketing or brand name.
display_maskrequiredstring
A short alpha-numeric string to assist users in identifying the account, e.g. last four digits of the account number.
opening_datestring
The date on which the account was opened.
Format:
date tax_advantagedboolean
Indicates whether some activity on the account - deposits, gains, etc - benefits from tax deferral or exemption, e.g. HSA, IRA, 401(k) accounts.
currencystring
The ISO-4217 currency in which this account’s transactions and balances are denominated.
non_iso_currencystring
If the account is denominated in a non-ISO currency, provide the currency's symbol.
API Object
{
"type": "loan",
"subtype": "credit card",
"current_balance": "850.55",
"available_balance": "149.45",
"reward_balance": "100.95",
"credit_limit": "1000",
"spender_identity_ids": [
"string"
],
"interest_rates": [
{
"start_date": "2018-08-28",
"end_date": "2018-08-28",
"type": "purchase",
"interest_rate": "0.0199",
"subject_balance": "100.95",
"interest_charged": "100.95"
}
],
"statements": [
{
"open_date": "2018-08-28",
"close_date": "2018-08-28",
"balance_due": "100.95",
"minimum_payment_due": "100.95",
"payment_due_date": "2018-08-28",
"payment_received_date": "2018-08-28",
"payment_received_amount": "100.95",
"document_url": "string"
}
],
"reward_currency": "USD",
"reward_non_iso_currency": null,
"art_asset_url": "string",
"id": "R13oiR6lC5jNC5jK",
"last_activity_at": "2020-04-21T12:45:00+00:00",
"ownership_type": "individual",
"owner_identity_ids": [
"6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
],
"non_owner_identity_ids": null,
"status": "active",
"name": "Vacation Money",
"official_name": "Pro Checking",
"display_mask": "9833",
"opening_date": "2018-01-31",
"tax_advantaged": true,
"currency": "USD",
"non_iso_currency": null
}CreditCardStatement
Description of a credit card account statement.
Properties
open_daterequiredstring
The opening date of this statement period.
Format:
date close_daterequiredstring
The closing date of this statement period. Use a future date if the statement period has not closed.
Format:
date balance_duerequiredstring
The statement balance.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ minimum_payment_duerequiredstring
The minimum payment due on this statement. If the statement is paid, this should be 0.00.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ payment_due_daterequiredstring
The date payment is, or was, due for this statement.
Format:
date payment_received_daterequiredstring
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_receivedrequiredstring
The sum of all payments received during the period.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ document_urlstring
A URL to a downloadable document form of this statement. Implementers should not assume that accessors of this URL are always authorized.
API Object
{
"open_date": "2018-08-28",
"close_date": "2018-08-28",
"balance_due": "100.95",
"minimum_payment_due": "100.95",
"payment_due_date": "2018-08-28",
"payment_received_date": "2018-08-28",
"payment_received_amount": "100.95",
"document_url": "string"
}CreditCardInterestRate
Description of a credit card interest rate.
Properties
start_daterequiredstring
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_daterequiredstring
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 typerequiredstring
The type of balance subject to this rate.
Possible values:
purchase, cash advance, balance transferinterest_raterequiredstring
The APR covering this balance.
Pattern:
^\d*(\.\d{1,4})?$ subject_balancerequiredstring
The current balance subject to this rate, following the definition of
current_balance.Pattern:
^-?(\d*)(?:\.\d{1,2})?$ interest_chargedrequiredstring
The amount within the
subject_balance that was generated by this interest rate.Pattern:
^-?(\d*)(?:\.\d{1,2})?$ API Object
{
"start_date": "2018-08-28",
"end_date": "2018-08-28",
"type": "purchase",
"interest_rate": "0.0199",
"subject_balance": "100.95",
"interest_charged": "100.95"
}CreditCardInterestRateType
Describes a type of interest rate covering a credit card balance.
Properties
purchasestring
Purchases.
cash advancestring
Cash advances.
balance transferstring
Balance transfers (not payments).
Identity
BasicIdentity
A lightweight identity container suitable for passing minimal identification.
API Object
{
"id": "d7f1b8b9-0006-4135-91c0-b5532045a314",
"name": "Jane Doe",
"email": "jane@plaid.com"
}FullIdentity
Full identity container compatible with most PII-exchange use cases.
Properties
organizationobject
Describes an organization, e.g., a business or non-profit.
namestring
Name of the organization represented.
structurestring
Type of business structure.
Possible values:
sole, partnership, llc, corpmccstring
The ISO-18245 merchant category code for this business.
Pattern:
^\d{4}$ owner_identity_ids[string]
The identities of the organization owner(s).
tax_identifierobject
The tax authority ID.
tax_authoritystring
Name of the tax authority.
tax_payer_idstring
The tax payer ID, e.g. EIN, TIN, SSN.
countrystring
The national jurisdiction of the tax authority in ISO 3166-1 format.
subdivisionstring
If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.
personobject
Describes an individual, named person.
first_namestring
Legal given name of the personal entity.
middle_namestring
Middle name, use blank if none.
last_namestring
Last name or family name.
date_of_birthstring
The date of birth in ISO-8601 format.
Format:
date tax_identifierobject
The tax authority ID.
tax_authoritystring
Name of the tax authority.
tax_payer_idstring
The tax payer ID, e.g. EIN, TIN, SSN.
countrystring
The national jurisdiction of the tax authority in ISO 3166-1 format.
subdivisionstring
If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.
emailrequiredstring
The email address where this entity can be contacted.
mailing_addressobject
Description of a street address.
lines[string]
The lines of the street address.
Min items:
1 citystring
The city of the mailing address.
regionstring
The first-level administrative subdivision, e.g., a state, province or district. Use ISO 3166-2 subdivisions (note: not ISO-3166-alpha-2).
countrystring
The ISO 3166-alpha-2 country code.
postal_codestring
The postal code.
phonestring
The phone number, formatted using ITU standard E. 123.
idrequiredstring
Permanent identity identifier.
namerequiredstring
The display name of this entity (insufficient for KYC purposes)
API Object
{
"organization": {
"name": "Doe Business, Inc.",
"structure": "sole",
"mcc": "5542",
"owner_identity_ids": [
"6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
],
"tax_identifier": {
"tax_authority": "IRS",
"tax_payer_id": "string"
}
},
"person": {
"first_name": "Jane",
"middle_name": "Joan",
"last_name": "Doe",
"date_of_birth": "1987-01-31",
"tax_identifier": {
"tax_authority": "IRS",
"tax_payer_id": "string"
}
},
"email": "jane@plaid.com",
"mailing_address": {
"lines": [
"413 Leeward Way",
"Apt 3A"
],
"city": "San Francisco",
"region": "US-CA",
"country": "US",
"postal_code": "94106",
"phone": "+1 415 555 1212"
},
"id": "d7f1b8b9-0006-4135-91c0-b5532045a314",
"name": "Jane Doe"
}MailingAddress
Description of a street address.
Properties
linesrequired[string]
The lines of the street address.
Min items:
1 cityrequiredstring
The city of the mailing address.
regionstring
The first-level administrative subdivision, e.g., a state, province or district. Use ISO 3166-2 subdivisions (note: not ISO-3166-alpha-2).
countryrequiredstring
The ISO 3166-alpha-2 country code.
postal_codestring
The postal code.
phonestring
The phone number, formatted using ITU standard E. 123.
API Object
{
"lines": [
"413 Leeward Way",
"Apt 3A"
],
"city": "San Francisco",
"region": "US-CA",
"country": "US",
"postal_code": "94106",
"phone": "+1 415 555 1212"
}PersonalEntity
Describes an individual, named person.
Properties
first_namerequiredstring
Legal given name of the personal entity.
middle_namerequiredstring
Middle name, use blank if none.
last_namerequiredstring
Last name or family name.
date_of_birthstring
The date of birth in ISO-8601 format.
Format:
date tax_identifierobject
The tax authority ID.
tax_authoritystring
Name of the tax authority.
tax_payer_idstring
The tax payer ID, e.g. EIN, TIN, SSN.
countrystring
The national jurisdiction of the tax authority in ISO 3166-1 format.
subdivisionstring
If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.
API Object
{
"first_name": "Jane",
"middle_name": "Joan",
"last_name": "Doe",
"date_of_birth": "1987-01-31",
"tax_identifier": {
"tax_authority": "IRS",
"tax_payer_id": "string"
}
}OrganizationalEntity
Describes an organization, e.g., a business or non-profit.
Properties
namerequiredstring
Name of the organization represented.
structurestring
Type of business structure.
Possible values:
sole, partnership, llc, corpmccstring
The ISO-18245 merchant category code for this business.
Pattern:
^\d{4}$ owner_identity_ids[string]
The identities of the organization owner(s).
tax_identifierobject
The tax authority ID.
tax_authoritystring
Name of the tax authority.
tax_payer_idstring
The tax payer ID, e.g. EIN, TIN, SSN.
countrystring
The national jurisdiction of the tax authority in ISO 3166-1 format.
subdivisionstring
If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.
API Object
{
"name": "Doe Business, Inc.",
"structure": "sole",
"mcc": 5542,
"owner_identity_ids": [
"6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
],
"tax_identifier": {
"tax_authority": "IRS",
"tax_payer_id": "string",
"country": "US"
}
}USBusinessStructure
Enumeration of business structures in the U.S.
Properties
solestring
Sole proprietorship.
partnershipstring
Partnership, e.g. limited partnership, general partnership.
llcstring
Limited liability company.
corpstring
C-corp, S-corp, not-for-profit, etc.
TaxIdentifier
Tax identifiers model an international-compliant identity within a tax authority. Use these to communicate a taxable entity’s identity within a jurisdiction.
Properties
tax_authorityrequiredstring
Name of the tax authority.
tax_payer_idrequiredstring
The tax payer ID, e.g. EIN, TIN, SSN.
countryrequiredstring
The national jurisdiction of the tax authority in ISO 3166-1 format.
subdivisionstring
If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.
API Object
{
"tax_authority": "IRS",
"tax_payer_id": "string",
"country": "US",
"subdivision": ""
}Transaction
BaseTransaction
Base properties for all transactions.
Properties
idrequiredstring
Permanent, unique transaction identifier. Must survive changes to pending status or amount.
account_idrequiredstring
References to the account that this transaction is posting against.
descriptionrequiredstring
Description of the transaction.
Nullable: true
Nullable: true
memostring
Addenda or distinguishing information for the transaction.
category[string]
Hierarchical categorization, use multi-valued array to indicate hierarchy.
tags[string]
Flat categorization. For hashtags omit leading
#.ending_balancestring
The balance of the account after this transaction posts.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ transacted_atrequiredstring
The date/time when the transaction was authorized, in the time zone local to the transaction or to the customer.
Format:
date-time settled_atrequiredstring
The date/time when the transaction settled, in the time zone local to the customer. Must be
Nullable: true
null if the transaction is pending.Nullable: true
Format:
date-time spender_identity_idstring
Reference to the identity of the authorized spender who conducted this transaction.
merchant_identity_idstring
Reference to the identity of the merchant related to this transaction.
geolocationobject
Geographic location where this transaction occurs.
coordinatesobject
Geographic coordinates in EPSG:4326 WGS84 (lat/long)
citystring
City name.
regionstring
Region identifier.
countrystring
Country identifier.
reward_currencystring
The ISO 4217 currency in which this transaction's reward contribution is denominated.
example: USD
reward_non_isostring
If the reward contribution is denominated in a non-ISO currency, provide the currency's symbol.
currencystring
The ISO 4217 currency in which this transaction is denominated. One of either the
currency or non_iso_currency fields is required.non_iso_currencystring
If the transaction is denominated in a non-ISO currency, provide the currency's symbol.
API Object
{
"id": "6AOU0jwFQw3sMZJ",
"account_id": 100273,
"description": "Finance Charge",
"memo": "Check #318",
"category": [
"electronics",
"desktop",
"accessories"
],
"tags": [
"electronics",
"accessories"
],
"ending_balance": "100.95",
"transacted_at": "2019-08-22T14:15:22Z",
"settled_at": "2019-08-25T08:15:42Z",
"spender_identity_id": "uid_1234",
"merchant_identity_id": "amazon_880",
"geolocation": {
"coordinates": {
"lat": 40.7128,
"lon": 74.006
},
"city": "New York",
"region": "US-NY",
"country": "US"
},
"reward_non_iso_currency": null,
"currency": "USD",
"non_iso_currency": null
}DepositoryOrCreditTransaction
Describes a transaction against a depository or credit card account.
Properties
typestring
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, depositpendingrequiredboolean
Indicates that this transaction has not posted.
amountrequiredstring
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_amountstring
The amount of fees associated with this transaction.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ reward_amountstring
The amount of rewards associated with this transaction.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ reward_ratestring
The effective rate of reward for this transaction.
Pattern:
^\d*(\.\d{1,4})?$ transfer_account_idstring
If this transaction is an internal transfer type, references the
account_id associated with this transaction.methodstring
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, eftidrequiredstring
Permanent, unique transaction identifier. Must survive changes to pending status or amount.
account_idrequiredstring
References to the account that this transaction is posting against.
descriptionrequiredstring
Description of the transaction.
Nullable: true
Nullable: true
memostring
Addenda or distinguishing information for the transaction.
category[string]
Hierarchical categorization, use multi-valued array to indicate hierarchy.
tags[string]
Flat categorization. For hashtags omit leading
#.ending_balancestring
The balance of the account after this transaction posts.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ transacted_atrequiredstring
The date/time when the transaction was authorized, in the time zone local to the transaction or to the customer.
Format:
date-time settled_atrequiredstring
The date/time when the transaction settled, in the time zone local to the customer. Must be
Nullable: true
null if the transaction is pending.Nullable: true
Format:
date-time spender_identity_idstring
Reference to the identity of the authorized spender who conducted this transaction.
merchant_identity_idstring
Reference to the identity of the merchant related to this transaction.
geolocationobject
Geographic location where this transaction occurs.
coordinatesobject
Geographic coordinates in EPSG:4326 WGS84 (lat/long)
citystring
City name.
regionstring
Region identifier.
countrystring
Country identifier.
reward_currencystring
The ISO 4217 currency in which this transaction's reward contribution is denominated.
example: USD
reward_non_isostring
If the reward contribution is denominated in a non-ISO currency, provide the currency's symbol.
currencystring
The ISO 4217 currency in which this transaction is denominated. One of either the
currency or non_iso_currency fields is required.non_iso_currencystring
If the transaction is denominated in a non-ISO currency, provide the currency's symbol.
API Object
{
"type": "purchase",
"pending": false,
"amount": "100.95",
"fee_amount": "0",
"reward_amount": "2.01",
"reward_rate": "0.0199",
"transfer_account_id": null,
"method": "card present",
"id": "6AOU0jwFQw3sMZJ",
"account_id": "account1234",
"description": "Finance Charge",
"memo": "Check #318",
"category": [
"grocery",
"meat"
],
"tags": [
"grocery"
],
"ending_balance": "100.95",
"transacted_at": "2019-08-24T14:15:22Z",
"settled_at": "2019-08-25T08:45:03Z",
"spender_identity_id": "uid_1234",
"merchant_identity_id": "target",
"geolocation": {
"coordinates": {
"lat": 40.7128,
"lon": 74.006
},
"city": "New York",
"region": "US-NY",
"country": "US"
},
"reward_currency": "USD",
"reward_non_iso_currency": null,
"currency": "USD",
"non_iso_currency": null
}DepositoryOrCreditTransactionType
Classification of DepositoryOrCreditTransaction by purpose as an enum.
Properties
transferstring
A transfer between accounts, or balance transfer (for credit cards).
cashstring
Cash withdrawal, or cash advance (for credit cards) including check drafts.
feestring
Finance charges, or fees associated with account management, e.g. ATM fees, overdraft charges, etc.
purchasestring
Ordinary purchase activity, subject to the purchase APR (for credit cards).
intereststring
Interest earned, not finance charges on carried balance (use fee).
depositstring
Cash or electronic deposit from an external account, not a transfer; or a payment (for credit cards).
DepositoryOrCreditTransactionMethod
Classification of DepositoryOrCreditTransaction by method.
Properties
card presentstring
Transaction was conducted by a physical payment card interaction (e.g. swipe, chip-and-sign, contactless).
card not presentstring
Card was not physically present for transaction (e.g. online or phone order).
checkstring
Check drafted against account.
eftstring
Electronic funds transfer.
InvestmentTransaction
Describes a transaction in an investment account.
Properties
amountrequiredstring
The amount associated with this transaction. Should be the product of price and quantity, plus fees.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ typerequiredstring
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, depositsecurity_idrequiredstring
Reference to the security that the transaction is posting for.
quantityrequiredstring
The quantity of the security involved in this transaction.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ pricerequiredstring
The price of the security at which the transaction occured.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ feesstring
The total combined fees associated with this transaction.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ statusrequiredstring
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, cancelledcancel_transaction_idstring
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.idrequiredstring
Permanent, unique transaction identifier. Must survive changes to pending status or amount.
account_idrequiredstring
References to the account that this transaction is posting against.
descriptionrequiredstring
Description of the transaction.
Nullable: true
Nullable: true
memostring
Addenda or distinguishing information for the transaction.
category[string]
Hierarchical categorization, use multi-valued array to indicate hierarchy.
tags[string]
Flat categorization. For hashtags omit leading
#.ending_balancestring
The balance of the account after this transaction posts.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ transacted_atrequiredstring
The date/time when the transaction was authorized, in the time zone local to the transaction or to the customer.
Format:
date-time settled_atrequiredstring
The date/time when the transaction settled, in the time zone local to the customer. Must be
Nullable: true
null if the transaction is pending.Nullable: true
Format:
date-time spender_identity_idstring
Reference to the identity of the authorized spender who conducted this transaction.
merchant_identity_idstring
Reference to the identity of the merchant related to this transaction.
geolocationobject
Geographic location where this transaction occurs.
coordinatesobject
Geographic coordinates in EPSG:4326 WGS84 (lat/long)
citystring
City name.
regionstring
Region identifier.
countrystring
Country identifier.
reward_currencystring
The ISO 4217 currency in which this transaction's reward contribution is denominated.
example: USD
reward_non_isostring
If the reward contribution is denominated in a non-ISO currency, provide the currency's symbol.
currencystring
The ISO 4217 currency in which this transaction is denominated. One of either the
currency or non_iso_currency fields is required.non_iso_currencystring
If the transaction is denominated in a non-ISO currency, provide the currency's symbol.
API Object
{
"value": {
"amount": "100.95",
"type": "buy",
"security_id": "string",
"quantity": "100.95",
"price": "100.95",
"fees": "100.95",
"status": "settled",
"cancel_transaction_id": "string",
"id": "6AOU0jwFQw3sMZJ",
"account_id": "account_1234",
"description": "Finance Charge",
"memo": "Check #318",
"category": [
"electronics",
"desktop",
"accessories"
],
"tags": [
"electronics",
"desktop"
],
"ending_balance": "100.95",
"transacted_at": "2019-08-24T14:15:22Z",
"settled_at": "2019-08-25T08:15:42Z",
"spender_identity_id": "uid_1234",
"merchant_identity_id": null,
"geolocation": {
"coordinates": {
"lat": 40.7128,
"lon": 74.006
},
"city": "New York",
"region": "US-NY",
"country": "US"
},
"reward_currency": "USD",
"reward_non_iso_currency": null,
"currency": "USD",
"non_iso_currency": null
},
"description": "Classification of `InvestmentTransaction` by purpose."
}InvestmentTransactionType
Classification of InvestmentTransaction by purpose.
Properties
buystring
Activity increasing the quantity of a holding.
cashstring
Activity modifying the account’s cash position.
feestring
Fees on the account, e.g. commission, bookkeeping, options-related charges.
sellstring
Activity decreasing the quantity of a holding.
transferstring
Activity which modifies a position, outside of buying/selling activity e.g., options exercise, portfolio transfer.
purchasestring
Ordinary purchase activity, subject to the purchase APR (for credit cards).
intereststring
Interest earned, not finance charges on carried balance (use fee).
depositstring
Cash or electronic deposit from an external account, not a transfer; or a payment (for credit cards).
InvestmentTransactionStatus
Status of an InvestmentTransaction.
LoanTransaction
Describes a transaction in a loan account.
Properties
amountrequiredstring
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})?$ typestring
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, cancelledprincipal_amountrequiredstring
The amount affecting the principal balance.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ interest_amountrequiredstring
The amount affecting the interest balance.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ escrow_amountstring
The amount affecting the escrow account (mortgages only, required.)
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ idrequiredstring
Permanent, unique transaction identifier. Must survive changes to pending status or amount.
account_idrequiredstring
References to the account that this transaction is posting against.
descriptionrequiredstring
Description of the transaction.
Nullable: true
Nullable: true
memostring
Addenda or distinguishing information for the transaction.
category[string]
Hierarchical categorization, use multi-valued array to indicate hierarchy.
tags[string]
Flat categorization. For hashtags omit leading
#.ending_balancestring
The balance of the account after this transaction posts.
Pattern:
^-?(\d*)(?:\.\d{1,2})?$ transacted_atrequiredstring
The date/time when the transaction was authorized, in the time zone local to the transaction or to the customer.
Format:
date-time settled_atrequiredstring
The date/time when the transaction settled, in the time zone local to the customer. Must be
Nullable: true
null if the transaction is pending.Nullable: true
Format:
date-time spender_identity_idstring
Reference to the identity of the authorized spender who conducted this transaction.
merchant_identity_idstring
Reference to the identity of the merchant related to this transaction.
geolocationobject
Geographic location where this transaction occurs.
coordinatesobject
Geographic coordinates in EPSG:4326 WGS84 (lat/long)
citystring
City name.
regionstring
Region identifier.
countrystring
Country identifier.
reward_currencystring
The ISO 4217 currency in which this transaction's reward contribution is denominated.
example: USD
reward_non_isostring
If the reward contribution is denominated in a non-ISO currency, provide the currency's symbol.
currencystring
The ISO 4217 currency in which this transaction is denominated. One of either the
currency or non_iso_currency fields is required.non_iso_currencystring
If the transaction is denominated in a non-ISO currency, provide the currency's symbol.
API Object
{
"amount": "100.95",
"type": "payment",
"principal_amount": "100.95",
"interest_amount": "2.95",
"escrow_amount": "1.95",
"id": "6AOU0jwFQw3sMZJ",
"account_id": "account1234",
"description": "Finance Charge",
"memo": "Check #318",
"category": [
"electronics",
"desktop",
"accessories"
],
"tags": [
"electronics",
"desktop"
],
"ending_balance": "100.95",
"transacted_at": "2019-08-24T14:15:22Z",
"settled_at": "2019-08-25T08:15:42Z",
"spender_identity_id": "uid_1234",
"merchant_identity_id": "apex_rentals_091",
"geolocation": {
"coordinates": {
"lat": 40.7128,
"lon": 74.006
},
"city": "New York",
"region": "US-NY",
"country": "US"
},
"reward_currency": "USD",
"reward_non_iso_currency": null,
"currency": "USD",
"non_iso_currency": null
}LoanTransactionType
Classification of LoanTransaction by purpose or effect.
Properties
paymentstring
The transaction describes a payment on the loan.
principalstring
The transaction advances or reduces the principal.
intereststring
The transaction advances or reduces interest.
adjustmentstring
The transaction adjusts the loan’s balances, unrelated to a loan payment.
Acquisition
PlaidProductDataType
Scope of requested account features or content for a PlaidApplication, represented as an enum.
Properties
ACCOUNT_BALANCEstring
Balance for each of the user's accounts. Used in various Plaid products, such as Auth.
ACCOUNT_TRANSACTIONSstring
Historical and current transactions for each of the user's accounts. Used in the Plaid Transactions product.
ACCOUNT_USER_INFOstring
User's personally identifying information, including account and routing numbers. Used in the Plaid Identity product.
PlaidProduct
Plaid products that a PlaidApplication uses.
Properties
transactionsstring
Transactions, historical and current.
NewAccountApplicant
Describes an application to open a new bank account.
Properties
idstring
The ID of this applicant.
identitystring
The
FullIdentity of the applicant.funding_transfer_codestring
The transfer code for the funding account if applicant opts to fund the account on opening.'
funding_amountstring
The amount to transfer into the account upon opening.
Application
Application
Describes a Plaid-powered application.
Properties
application_idrequiredstring
The application’s unique ID.
namerequiredstring
The name of the application.
logostring
A URL that links to the application logo image.
application_urlstring
A URL that links to the application’s website.
reason_for_accessstring
A string provided by the connected app stating why they use their
respective enabled products.
API Object
{
"application_id": "123123-123123-application_id",
"name": "App Name",
"logo": "https://www.plaid.com/logo",
"application_url": "https://www.application.com",
"reason_for_access": "Need balance"
}ConnectedApplication
Scope
Scopes
The scopes object
Properties
product_accessobject
Allow or disallow product access across all accounts. If unset, defaults to all products allowed.
statementsboolean
Allow access to statements.
Default:
true identityboolean
Allow access to the Identity product (name, email, phone, address).
Default:
true authboolean
Allow access to account number details.
Default:
true transactionsboolean
Allow access to transaction details.
Default:
true accountsarray
Allow or disallow product access by account. Unlisted (e.g. missing) accounts will be considered
new_accounts.Min items:
1 new_accountsboolean
Allow access to newly opened accounts as they are opened.
Default:
true API Object
{
"product_access": {
"identity": false,
"statement": false,
"auth": true,
"transactions": false
},
"accounts": [
{
"unique_id": "915ace15f",
"selected": true
},
{
"unique_id": "1512343cc",
"selected": true
}
],
"new_accounts": true
}RequestedScope
AccountSelectionCardinality
The application requires that accounts be limited to a specific cardinality. Represented as an enum.
Properties
enum_valuesstring
Enum values
Possible values:
SINGLE_SELECT, MULTI_SELECT, ALLAccountAccess
Allow or disallow product access by account. Unlisted (e.g. missing) accounts will be considered new_accounts.
Properties
unique_idrequiredstring
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).
authorizedboolean
Allow the application to see this account (and associated details, including balance) in the list of accounts.
Default:
true API Object
{
"unique_id": "abc1241f975",
"authorized": true
}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.
Properties
API Object
{
"depository": {
"account_subtypes": [
"checking",
"savings"
]
}
}AccountFilterSubtypes
A list of account subtypes to be filtered.
Properties
subtypesstring
List of account subtypes.
API Object
[
"checking",
"savings"
]ProductAccess
Allow or disallow product access across all accounts. If unset, defaults to all products allowed.
Properties
statementsboolean
Allow access to statements.
Default:
true identityboolean
Allow access to the Identity product (name, email, phone, address).
Default:
true authboolean
Allow access to account number details.
Default:
true transactionsboolean
Allow access to transaction details.
Default:
true API Object
{
"auth": true,
"identity": false,
"statements": false,
"transactions": false
}Errors
BasicError
Generic error object.
Properties
API Object
{
"id": "E00001",
"message": "string"
}AuthenticationError
Authentication-specific error object.
Properties
reasonrequiredstring
Reason code for authentication failures.
Possible values:
credentials, configuration, mfa, not permitted, unsupported, otheridrequiredstring
Opaque identifier, expected to be consistent for errors which have the same cause.
messagerequiredstring
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.
API Object
{
"reason": "credentials",
"id": "E00001",
"message": "The submitted credentials are not valid."
}InstitutionError
Error schema for planned institution downtime.
Properties
retry_atstring
The time, in UTC, when the institution is expected to support aggregation again.
Format:
date-time idrequiredstring
Opaque identifier, expected to be consistent for errors which have the same cause.
messagerequiredstring
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.
API Object
{
"retry_at": "2020-10-02T00:15:00.000+0000",
"id": "E00001",
"message": "string"
}