Data Definitions
Plaid Exchange Data Definitions
Getting started
Before building your Plaid Exchange integration, please review the data definitions here. This will help you ensure your data is correctly formatted and that type matching requirements are met. Use this guide in combination with the API Reference for data aggregation and errors.
Notes
Non-required parameters may be left blank, sent as
null
, or omitted. We recommend sending a blank field, as this is slightly cleaner.Some required parameters are nullable (
description
,settled_at
). In these cases, the parameter will be marked as nullable in the parameters list.
Primitives
Basic types used in other definitions
id
accountId
, transactionId
, identityId
, etc.) which can serve as a stable identifier for the associated entity.amount
natural
rate
iso4217
iso8601
date
mcc
Was this helpful?
Identifiers
Many compound definitions in this API will make use of ad hoc identifier types, e.g. accountId
, identityId
, transactionId
. These are string
values, expected to remain stable during the life of the associated entity, and enable us to reconcile entities across state transitions, e.g.
transactions moving from pending to posted state, or a customer’s personal name change.
GeoLocation
Geographic location.
coordinates
city
region
country
1{2 "coordinates": {3 "lat": 41.8574,4 "lon": -71.398625 },6 "city": "New York",7 "region": "US-NY",8 "country": "US"9}
Was this helpful?
GeoCoordinates
Account
Currencies
All account subtypes include currency
and non_iso_currency
properties to indicate the currencies in which their balances are denominated. One and only one of these two fields should be set, with the other being unset (not present). If the account is denominated in a currency recognized under ISO-4217, then currency should be set to that currency’s alphabetic code under that standard.
However, if the balance is denominated in a non-ISO currency, e.g. Bitcoin, mileage, or reward points, then currency must be null and non_iso_currency
should be used instead. In this case, Plaid does not guarantee that balances across accounts, and across institutions, refer to the same currency even when they use the same non_iso_currency
values.
Account Ownership
When modeling account ownership, include only the identities that are interesting when understanding a user’s financial situation and capability. For example, joint account ownership between a husband and wife should be modeled as two owner_identity_ids. Business account ownership should be modeled as a single business owner (use BusinessIdentity
), which then has owner_identity_ids
related to it, representing the beneficial owners (those with at least a 25% stake). Identification of business-owned depository accounts is critical for funds transfer use cases (e.g. payments), e.g. in the US, ACH transfers are required to distinguish B2B transactions from individual or B2C transactions.
Interested non-ownership identities should be included when doing so would further illustrate the user’s situation. For example, when the user is a trustee of an account, their identity should be included in non_owner_identity_ids
. Inclusion of personally identifying information should always be balanced against visibility and consent concerns. Identity information not necessary for the currently authorized user to transact against the account should be limited, and those identities should be modeled using BasicIdentity e.g. when the trustor on an account is transacting, identifying information about the trustee need not be extensive. Conversely, if the trustee were viewing the account, their entry in non_owner_identity_ids
can be more complete, and the trustor’s entry can be more limited.
Plaid’s account ownership model is intended to support compliance with ownership guidelines set forth in the FDIC Publication, "Your Insured Deposits" and in the US Treasury FinCEN publication, "FIN-2018-G001" (Anti-Money Laundering Guidance document).
Ownership structure of an account.
individual
joint
association
trust
Was this helpful?
Account Status
Report accounts until they are closed, and continue reporting closed accounts until 90 days after closure.
active
inactive
frozen
locked
flagged
restricted
closed
Was this helpful?
Suspended Access
There are multiple statuses listed here which, at first glance, seem to describe nearly identical conditions. Although frozen, flagged, and locked all describe conditions where the account’s assets cannot be accessed until they are released, the reasons for suspension differ,
frozen
describes a condition in connection to legal action: use frozen to indicate than an account’s assets may be subject to seizureflagged
describes a condition where account activity is suspicious, or non-compliant with the customer agreement: use flagged to indicate that the account may be at risk of closurelocked
describes a condition applied proactively to protect the account holder: use locked to indicate that assets are restricted to protect against loss
Account Type and Subtype
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.
id
last_activity_at
date-time
ownership_type
individual
, joint
, association
, trust
owner_identity_ids
non_owner_identity_ids
status
active
, inactive
, frozen
, locked
, flagged
, restricted
, closed
type
depository
, loan
, investment
subtype
cash management
, cd
, checking
, savings
, money market
, health
, prepaid
, gic
, auto
, commercial
, construction
, consumer
, credit card
, home equity
, mortgage
, overdraft
, line of credit
, student
, 401a
, 401k
, 403B
, 457b
, 529
, brokerage
, esa
, ira
, isa
, lira
, other
, rif
, rsp
, pension
, profit-sharing
, roth ira
, roth 401k
, sep ira
, simple ira
, sipp
, stock plan
, tsp
, tfsa
, custodial
, variable annuity
name
official_name
display_mask
opening_date
date
current_balance
^-?(\d*)(?:\.\d{1,2})?$
available_balance
^-?(\d*)(?:\.\d{1,2})?$
tax_advantaged
non_iso_currency
1{2 "id": "R13oiR6lC5jNC5jK",3 "last_activity_at": "2020-04-21T12:45:00+00:00",4 "ownership_type": "individual",5 "owner_identity_ids": null,6 "non_owner_identity_ids": [7 "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"8 ],9 "status": "active",10 "type": "depository",11 "subtype": "checking",12 "name": "Vacation Money",13 "official_name": "Pro Checking",14 "display_mask": "9833",15 "opening_date": "2018-01-31",16 "current_balance": "850.55",17 "available_balance": "149.45",18 "tax_advantaged": true,19 "currency": "USD",20 "non_iso_currency": null21}
Was this helpful?
DepositoryAccount
List of all accounts for which this user is an owner or interested non-owner.
interest_rate
^\d*(\.\d{1,4})?$
transfer_codes
ach
account_number
routing_number
wire_routing_number
supports_debit
supports_credit
eft
account_number
institution_number
branch_number
supports_debit
supports_credit
iban
account_number
bank_code
country_code
location_code
branch_code
supports_debit
supports_credit
payment_card
card_number
expiry_month
expiry_year
security_code
supports_debit
supports_credit
acats
account_number
receiving_member _identity
organization
name
structure
sole
, partnership
, llc
, corp
mcc
^\d{4}$
owner_identity_ids
tax_identifier
tax_authority
tax_payer_id
country
subdivision
person
first_name
middle_name
last_name
date_of_birth
date
tax_identifier
tax_authority
tax_payer_id
country
subdivision
email
mailing_address
lines
1
city
region
country
postal_code
phone
id
name
dtcc_clearing_ids
supports_debit
supports_credit
maturity_date
date
statements
statement_id
open_date
date
close_date
date
balance
^-?(\d*)(?:\.\d{1,2})?$
document_url
id
last_activity_at
date-time
ownership_type
individual
, joint
, association
, trust
owner_identity_ids
non_owner_identity_ids
status
active
, inactive
, frozen
, locked
, flagged
, restricted
, closed
type
depository
, loan
, investment
subtype
cash management
, cd
, checking
, savings
, money market
, health
, prepaid
, gic
, auto
, commercial
, construction
, consumer
, credit card
, home equity
, mortgage
, overdraft
, line of credit
, student
, 401a
, 401k
, 403B
, 457b
, 529
, brokerage
, esa
, ira
, isa
, lira
, other
, rif
, rsp
, pension
, profit-sharing
, roth ira
, roth 401k
, sep ira
, simple ira
, sipp
, stock plan
, tsp
, tfsa
, custodial
, variable annuity
name
official_name
display_mask
opening_date
date
current_balance
^-?(\d*)(?:\.\d{1,2})?$
available_balance
^-?(\d*)(?:\.\d{1,2})?$
tax_advantaged
non_iso_currency
1{2 "interest_rate": "0.0199",3 "transfer_codes": {4 "ach": {5 "account_number": "string",6 "routing_number": "031176110",7 "wire_routing_number": "string",8 "supports_debit": true,9 "supports_credit": true10 },11 "eft": {12 "account_number": "string",13 "institution_number": "004",14 "branch_number": "1320",15 "supports_debit": true,16 "supports_credit": true17 },18 "iban": {19 "account_number": "string",20 "bank_code": "NORD",21 "country_code": "FR",22 "location_code": "ZZ",23 "branch_code": "80A",24 "supports_debit": true,25 "supports_credit": true26 },27 "payment_card": {28 "card_number": "string",29 "expiry_month": "01",30 "expiry_year": "2021",31 "security_code": "363",32 "supports_debit": true,33 "supports_credit": true34 },35 "acats": {36 "account_number": "string",37 "receiving_member_identity": {38 "organization": {39 "name": "Doe Business, Inc.",40 "structure": "sole",41 "mcc": "5542",42 "owner_identity_ids": [43 "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"44 ],45 "tax_identifier": {46 "tax_authority": "IRS",47 "tax_payer_id": "string"48 }49 },50 "person": {51 "first_name": "Jane",52 "middle_name": "Joan",53 "last_name": "Doe",54 "date_of_birth": "1987-01-31",55 "tax_identifier": {56 "tax_authority": "IRS",57 "tax_payer_id": "string"58 }59 },60 "email": "jane@plaid.com",61 "mailing_address": {62 "lines": [63 "413 Leeward Way",64 "Apt 3A"65 ],66 "city": "San Francisco",67 "region": "US-CA",68 "country": "US",69 "postal_code": "94106",70 "phone": "+1 415 555 1212"71 },72 "id": "d7f1b8b9-0006-4135-91c0-b5532045a314",73 "name": "Jane Doe"74 },75 "dtcc_clearing_ids": [76 "string"77 ],78 "supports_debit": true,79 "supports_credit": true80 }81 },82 "maturity_date": "2018-08-28",83 "statements": [84 {85 "statement_id": "string",86 "open_date": "2018-08-28",87 "close_date": "2018-08-28",88 "balance": "100.95",89 "document_url": "string"90 }91 ],92 "id": "R13oiR6lC5jNC5jK",93 "last_activity_at": "2020-04-21T12:45:00+00:00",94 "ownership_type": "individual",95 "owner_identity_ids": [96 "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"97 ],98 "non_owner_identity_ids": null,99 "status": "active",100 "type": "depository",101 "subtype": "checking",102 "name": "Vacation Money",103 "official_name": "Pro Checking",104 "display_mask": "9833",105 "opening_date": "2018-01-31",106 "current_balance": "850.55",107 "available_balance": "149.45",108 "tax_advantaged": true,109 "currency": "USD",110 "non_iso_currency": null111}
Was this helpful?
DepositoryAccountStatement
Represents primary account statement details.
statement_id
open_date
date
close_date
date
balance
^-?(\d*)(?:\.\d{1,2})?$
document_url
1{2 "statement_id": "string",3 "open_date": "2018-08-28",4 "close_date": "2018-08-28",5 "balance": "100.95",6 "document_url": "string"7}
Was this helpful?
TransferCodeMap
Mapping between an account and various payment networks.
ach
account_number
routing_number
wire_routing_number
supports_debit
supports_credit
eft
account_number
institution_number
branch_number
supports_debit
supports_credit
iban
account_number
bank_code
country_code
location_code
branch_code
supports_debit
supports_credit
payment_card
card_number
expiry_month
expiry_year
security_code
supports_debit
supports_credit
acats
account_number
receiving_member _identity
organization
name
structure
sole
, partnership
, llc
, corp
mcc
^\d{4}$
owner_identity_ids
tax_identifier
tax_authority
tax_payer_id
country
subdivision
person
first_name
middle_name
last_name
date_of_birth
date
tax_identifier
tax_authority
tax_payer_id
country
subdivision
email
mailing_address
lines
1
city
region
country
postal_code
phone
id
name
dtcc_clearing_ids
supports_debit
supports_credit
1{2 "ach": {3 "account_number": "string",4 "routing_number": "031176110",5 "wire_routing_number": "string",6 "supports_debit": true,7 "supports_credit": true8 },9 "eft": {10 "account_number": "string",11 "institution_number": "004",12 "branch_number": "1320",13 "supports_debit": true,14 "supports_credit": true15 },16 "iban": {17 "account_number": "string",18 "bank_code": "NORD",19 "country_code": "FR",20 "location_code": "ZZ",21 "branch_code": "80A",22 "supports_debit": true,23 "supports_credit": true24 },25 "payment_card": {26 "card_number": "string",27 "expiry_month": "01",28 "expiry_year": "2021",29 "security_code": "363",30 "supports_debit": true,31 "supports_credit": true32 },33 "acats": {34 "account_number": "string",35 "receiving_member_identity": {36 "organization": {37 "name": "Doe Business, Inc.",38 "structure": "sole",39 "mcc": "5542",40 "owner_identity_ids": [41 "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"42 ],43 "tax_identifier": {44 "tax_authority": "IRS",45 "tax_payer_id": "string"46 }47 },48 "person": {49 "first_name": "Jane",50 "middle_name": "Joan",51 "last_name": "Doe",52 "date_of_birth": "1987-01-31",53 "tax_identifier": {54 "tax_authority": "IRS",55 "tax_payer_id": "string"56 }57 },58 "email": "jane@plaid.com",59 "mailing_address": {60 "lines": [61 "413 Leeward Way",62 "Apt 3A"63 ],64 "city": "San Francisco",65 "region": "US-CA",66 "country": "US",67 "postal_code": "94106",68 "phone": "+1 415 555 1212"69 },70 "id": "d7f1b8b9-0006-4135-91c0-b5532045a314",71 "name": "Jane Doe"72 },73 "dtcc_clearing_ids": [74 "string"75 ],76 "supports_debit": true,77 "supports_credit": true78 }79}
Was this helpful?
DepositoryAccountTransferCode
Base model for depository account transfer identifiers.
supports_debit
supports_credit
1{2 "supports_debit": true,3 "supports_credit": true4}
Was this helpful?
AchTransferCode
Base model for depository account transfer identifiers.
account_number
routing_number
wire_routing_number
supports_debit
supports_credit
1{2 "account_number": "121212454545",3 "routing_number": "031176110",4 "wire_routing_number": "1234-5678-0",5 "supports_debit": true,6 "supports_credit": true7}
Was this helpful?
EftTransferCode
Base model for depository account transfer identifiers.
account_number
institution_number
branch_number
supports_debit
supports_credit
1{2 "account_number": "string",3 "institution_number": "004",4 "branch_number": "1320",5 "supports_debit": true,6 "supports_credit": true7}
Was this helpful?
IbanTransferCode
Base model for depository account transfer identifiers.
account_number
bank_code
country_code
location_code
branch_code
supports_debit
supports_credit
1{2 "account_number": "string",3 "bank_code": "NORD",4 "country_code": "FR",5 "location_code": "ZZ",6 "branch_code": "80A",7 "supports_debit": true,8 "supports_credit": true9}
Was this helpful?
PaymentCardTransferCode
Base model for depository account transfer identifiers.
card_number
expiry_month
expiry_year
security_code
supports_debit
supports_credit
1{2 "card_number": "string",3 "expiry_month": "01",4 "expiry_year": "2021",5 "security_code": "363",6 "supports_debit": true,7 "supports_credit": true8}
Was this helpful?
NotionalAccount
A placeholder entity, capable of indicating only basic facts about an account.
id
accountId
. Do not use a full or masked account number for this value as this increases the risk of revealing Personally Identifiable Information (PII).type
accountType
values.subtype
accountSubtype
values.access_authorized
name
official_name
currency
non_iso_currency
1{2 "id": "R13oiR6lC5jNC5jK",3 "type": "depository",4 "subtype": "checking",5 "name": "Vacation money",6 "official_name": "Pro Checking",7 "currency": "USD",8 "non_iso_currency": null9}
Was this helpful?
InvestmentAccount
List of all accounts for which this user is an owner or interested non-owner.
transfer_codes
ach
account_number
routing_number
wire_routing_number
supports_debit
supports_credit
eft
account_number
institution_number
branch_number
supports_debit
supports_credit
iban
account_number
bank_code
country_code
location_code
branch_code
supports_debit
supports_credit
payment_card
card_number
expiry_month
expiry_year
security_code
supports_debit
supports_credit
acats
account_number
receiving_member _identity
organization
name
structure
sole
, partnership
, llc
, corp
mcc
^\d{4}$
owner_identity_ids
tax_identifier
tax_authority
tax_payer_id
country
subdivision
person
first_name
middle_name
last_name
date_of_birth
date
tax_identifier
tax_authority
tax_payer_id
country
subdivision
email
mailing_address
lines
1
city
region
country
postal_code
phone
id
name
dtcc_clearing_ids
supports_debit
supports_credit
current_balance
^-?(\d*)(?:\.\d{1,2})?$
available_balance
^-?(\d*)(?:\.\d{1,2})?$
margin_balance
^-?(\d*)(?:\.\d{1,2})?$
margin_limit
^-?(\d*)(?:\.\d{1,2})?$
margin_equity
^-?(\d*)(?:\.\d{1,2})?$
maintenance_margin
^-?(\d*)(?:\.\d{1,2})?$
buying_power
^-?(\d*)(?:\.\d{1,2})?$
current_as_of
current_balance
was current.date-time
holdings
security_id
cost_basis
^-?(\d*)(?:\.\d{1,2})?$
quantity
^-?(\d*)(?:\.\d{1,2})?$
lots
id
acquired_at
date
acquired_price
^-?(\d*)(?:\.\d{1,2})?$
quantity
^-?(\d*)(?:\.\d{1,2})?$
non_iso_currency
id
last_activity_at
date-time
ownership_type
individual
, joint
, association
, trust
owner_identity_ids
non_owner_identity_ids
status
active
, inactive
, frozen
, locked
, flagged
, restricted
, closed
type
depository
, loan
, investment
subtype
cash management
, cd
, checking
, savings
, money market
, health
, prepaid
, gic
, auto
, commercial
, construction
, consumer
, credit card
, home equity
, mortgage
, overdraft
, line of credit
, student
, 401a
, 401k
, 403B
, 457b
, 529
, brokerage
, esa
, ira
, isa
, lira
, other
, rif
, rsp
, pension
, profit-sharing
, roth ira
, roth 401k
, sep ira
, simple ira
, sipp
, stock plan
, tsp
, tfsa
, custodial
, variable annuity
name
official_name
display_mask
opening_date
date
tax_advantaged
non_iso_currency
1{2 "transfer_codes": {3 "ach": {4 "account_number": "string",5 "routing_number": "031176110",6 "wire_routing_number": "string",7 "supports_debit": true,8 "supports_credit": true9 },10 "eft": {11 "account_number": "string",12 "institution_number": "004",13 "branch_number": "1320",14 "supports_debit": true,15 "supports_credit": true16 },17 "iban": {18 "account_number": "string",19 "bank_code": "NORD",20 "country_code": "FR",21 "location_code": "ZZ",22 "branch_code": "80A",23 "supports_debit": true,24 "supports_credit": true25 },26 "payment_card": {27 "card_number": "string",28 "expiry_month": "01",29 "expiry_year": "2021",30 "security_code": "363",31 "supports_debit": true,32 "supports_credit": true33 },34 "acats": {35 "account_number": "string",36 "receiving_member_identity": {37 "organization": {38 "name": "Doe Business, Inc.",39 "structure": "sole",40 "mcc": "5542",41 "owner_identity_ids": [42 "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"43 ],44 "tax_identifier": {45 "tax_authority": "IRS",46 "tax_payer_id": "string"47 }48 },49 "person": {50 "first_name": "Jane",51 "middle_name": "Joan",52 "last_name": "Doe",53 "date_of_birth": "1987-01-31",54 "tax_identifier": {55 "tax_authority": "IRS",56 "tax_payer_id": "string"57 }58 },59 "email": "jane@plaid.com",60 "mailing_address": {61 "lines": [62 "413 Leeward Way",63 "Apt 3A"64 ],65 "city": "San Francisco",66 "region": "US-CA",67 "country": "US",68 "postal_code": "94106",69 "phone": "+1 415 555 1212"70 },71 "id": "d7f1b8b9-0006-4135-91c0-b5532045a314",72 "name": "Jane Doe"73 },74 "dtcc_clearing_ids": [75 "string"76 ],77 "supports_debit": true,78 "supports_credit": true79 }80 },81 "current_balance": "850.55",82 "available_balance": "149.45",83 "margin_balance": "100.95",84 "margin_limit": "100.95",85 "margin_equity": "100.95",86 "maintenance_margin": "100.95",87 "buying_power": "100.95",88 "current_as_of": "2018-08-28",89 "holdings": [90 {91 "security_id": "string",92 "cost_basis": "100.95",93 "quantity": "100.95",94 "lots": {95 "id": "string",96 "acquired_at": "2018-08-28",97 "acquired_price": "100.95",98 "quantity": "100.95"99 },100 "currency": "USD",101 "non_iso_currency": null102 }103 ],104 "id": "R13oiR6lC5jNC5jK",105 "last_activity_at": "2020-04-21T12:45:00+00:00",106 "ownership_type": "individual",107 "owner_identity_ids": [108 "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"109 ],110 "non_owner_identity_ids": null,111 "status": "active",112 "type": "investment",113 "subtype": "401k",114 "name": "Vacation Money",115 "official_name": "401k Account",116 "display_mask": "9833",117 "opening_date": "2018-01-31",118 "tax_advantaged": true,119 "currency": "USD",120 "non_iso_currency": null121}
Was this helpful?
AcatsTransferCode
Base model for depository account transfer identifiers.
account_number
receiving_member _identity
organization
name
structure
sole
, partnership
, llc
, corp
mcc
^\d{4}$
owner_identity_ids
tax_identifier
tax_authority
tax_payer_id
country
subdivision
person
first_name
middle_name
last_name
date_of_birth
date
tax_identifier
tax_authority
tax_payer_id
country
subdivision
email
mailing_address
lines
1
city
region
country
postal_code
phone
id
name
dtcc_clearing_ids
supports_debit
supports_credit
1{2 "account_number": "string",3 "receiving_member_identity": {4 "organization": {5 "name": "Doe Business, Inc.",6 "structure": "sole",7 "mcc": "5542",8 "owner_identity_ids": [9 "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"10 ],11 "tax_identifier": {12 "tax_authority": "IRS",13 "tax_payer_id": "string"14 }15 },16 "person": {17 "first_name": "Jane",18 "middle_name": "Joan",19 "last_name": "Doe",20 "date_of_birth": "1987-01-31",21 "tax_identifier": {22 "tax_authority": "IRS",23 "tax_payer_id": "string"24 }25 },26 "email": "jane@plaid.com",27 "mailing_address": {28 "lines": [29 "413 Leeward Way",30 "Apt 3A"31 ],32 "city": "San Francisco",33 "region": "US-CA",34 "country": "US",35 "postal_code": "94106",36 "phone": "+1 415 555 1212"37 },38 "id": "d7f1b8b9-0006-4135-91c0-b5532045a314",39 "name": "Jane Doe"40 },41 "dtcc_clearing_ids": [42 "string"43 ],44 "supports_debit": true,45 "supports_credit": true46}
Was this helpful?
Security
Description of a security (i.e. stocks, bonds, derivatives, etc.)
id
name
symbol
is_cash_equivalent
current_price
^-?(\d*)(?:\.\d{1,2})?$
current_as_of
current_price
was current, in ISO 8601 format.date-time
close_price
^-?(\d*)(?:\.\d{1,2})?$
type
cash
, derivative
, equity
, etf
, fixed income
, loan
, mutual fund
, other
non_iso_currency
1{2 "id": "account_5921",3 "isin": "US17275R1023",4 "name": "CISCO SYSTEMS INC",5 "symbol": "CSCO",6 "is_cash_equivalent": true,7 "current_price": "100.95",8 "current_as_of": "2018-08-28",9 "close_price": "100.95",10 "type": "cash",11 "currency": "USD",12 "non_iso_currency": null13}
Was this helpful?
OptionSecurity
Description of a security (i.e. stocks, bonds, derivatives, etc.)
expiry
date
contract_type
put
, call
option_style
euro
, us
exercise_price
^-?(\d*)(?:\.\d{1,2})?$
underlying_security_id
id
name
symbol
is_cash_equivalent
current_price
^-?(\d*)(?:\.\d{1,2})?$
current_as_of
current_price
was current, in ISO 8601 format.date-time
close_price
^-?(\d*)(?:\.\d{1,2})?$
type
cash
, derivative
, equity
, etf
, fixed income
, loan
, mutual fund
, other
non_iso_currency
1{2 "id": "account_5921",3 "isin": "US17275R1023",4 "name": "CISCO SYSTEMS INC",5 "symbol": "CSCO",6 "is_cash_equivalent": true,7 "current_price": "100.95",8 "current_as_of": "2018-08-28",9 "close_price": "100.95",10 "type": "cash",11 "currency": "USD",12 "non_iso_currency": null13}
Was this helpful?
ContractType
Holding
Instance of a held security.
security_id
cost_basis
^-?(\d*)(?:\.\d{1,2})?$
quantity
^-?(\d*)(?:\.\d{1,2})?$
lots
id
acquired_at
date
acquired_price
^-?(\d*)(?:\.\d{1,2})?$
quantity
^-?(\d*)(?:\.\d{1,2})?$
non_iso_currency
1{2 "security_id": "string",3 "cost_basis": "100.95",4 "quantity": "100.95",5 "lots": {6 "id": "string",7 "acquired_at": "2018-08-28",8 "acquired_price": "100.95",9 "quantity": "100.95"10 },11 "currency": "USD",12 "non_iso_currency": null13}
Was this helpful?
TaxLot
Describes taxable lots of shares within a Holding.
id
acquired_at
date
acquired_price
^-?(\d*)(?:\.\d{1,2})?$
quantity
^-?(\d*)(?:\.\d{1,2})?$
1{2 "id": "string",3 "acquired_at": "2018-08-28",4 "acquired_price": "100.95",5 "quantity": "100.95"6}
Was this helpful?
LoanAccount
List of all accounts for which this user is an owner or interested non-owner.
account_number
reference_number
servicer_identity_id
interest_rate
^\d*(\.\d{1,4})?$
interest_rate_type
fixed
, adjustable
, variable
, other
interest_rate_schedule
start_date
date
end_date
null
if the end date is not known or not fixed.date
interest_rate
^\d*(\.\d{1,4})?$
term_months
0
term_days
0
repayment_status
fully repaid
, current
, grace
, deferment
, forbearance
, past due
, delinquent
, default
, charged off
, cancelled
principal_balance
^-?(\d*)(?:\.\d{1,2})?$
payoff_quote
^-?(\d*)(?:\.\d{1,2})?$
payoff_expiry
payoff_quote
is considered current.date
origination_date
date
origination_principal
^-?(\d*)(?:\.\d{1,2})?$
maturity_date
date
statements
payment_paid_to _principal
^-?(\d*)(?:\.\d{1,2})?$
payment_paid_to _interest
^-?(\d*)(?:\.\d{1,2})?$
open_date
date
close_date
date
balance_due
^-?(\d*)(?:\.\d{1,2})?$
minimum_payment_due
^-?(\d*)(?:\.\d{1,2})?$
payment_due_date
date
payment_received_date
payment_received_amount
exceeded minimum_payment_due
.date
payment_received _amount
^-?(\d*)(?:\.\d{1,2})?$
document_url
id
last_activity_at
date-time
ownership_type
individual
, joint
, association
, trust
owner_identity_ids
non_owner_identity_ids
status
active
, inactive
, frozen
, locked
, flagged
, restricted
, closed
type
depository
, loan
, investment
subtype
cash management
, cd
, checking
, savings
, money market
, health
, prepaid
, gic
, auto
, commercial
, construction
, consumer
, credit card
, home equity
, mortgage
, overdraft
, line of credit
, student
, 401a
, 401k
, 403B
, 457b
, 529
, brokerage
, esa
, ira
, isa
, lira
, other
, rif
, rsp
, pension
, profit-sharing
, roth ira
, roth 401k
, sep ira
, simple ira
, sipp
, stock plan
, tsp
, tfsa
, custodial
, variable annuity
name
official_name
display_mask
opening_date
date
current_balance
^-?(\d*)(?:\.\d{1,2})?$
available_balance
^-?(\d*)(?:\.\d{1,2})?$
tax_advantaged
non_iso_currency
1{2 "type": "loan",3 "account_number": "string",4 "reference_number": "string",5 "servicer_identity_id": "string",6 "interest_rate": "0.0199",7 "interest_rate_type": "fixed",8 "interest_rate_schedule": [9 {10 "start_date": "2018-08-28",11 "end_date": "2018-08-28",12 "interest_rate": "0.0199"13 }14 ],15 "term_months": 0,16 "term_days": 0,17 "repayment_status": "fully repaid",18 "principal_balance": "100.95",19 "payoff_quote": "100.95",20 "payoff_expiry": "2018-08-28",21 "origination_date": "2018-08-28",22 "origination_principal": "100.95",23 "maturity_date": "2018-08-28",24 "statements": [25 {26 "payment_paid_to_principal": "100.95",27 "payment_paid_to_interest": "100.95",28 "open_date": "2018-08-28",29 "close_date": "2018-08-28",30 "balance_due": "100.95",31 "minimum_payment_due": "100.95",32 "payment_due_date": "2018-08-28",33 "payment_received_date": "2018-08-28",34 "payment_received_amount": "100.95",35 "document_url": "string"36 }37 ],38 "id": "R13oiR6lC5jNC5jK",39 "last_activity_at": "2020-04-21T12:45:00+00:00",40 "ownership_type": "individual",41 "owner_identity_ids": [42 "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"43 ],44 "non_owner_identity_ids": null,45 "status": "active",46 "subtype": "consumer",47 "name": "Vacation Money",48 "official_name": "Pro Checking",49 "display_mask": "9833",50 "opening_date": "2018-01-31",51 "current_balance": "850.55",52 "available_balance": "149.45",53 "tax_advantaged": true,54 "currency": "USD",55 "non_iso_currency": null56}
Was this helpful?
LoanStatement
Description of a loan account statement.
payment_paid_to _principal
^-?(\d*)(?:\.\d{1,2})?$
payment_paid_to _interest
^-?(\d*)(?:\.\d{1,2})?$
open_date
date
close_date
date
balance_due
^-?(\d*)(?:\.\d{1,2})?$
minimum_payment_due
^-?(\d*)(?:\.\d{1,2})?$
payment_due_date
date
payment_received_date
payment_received_amount
exceeded minimum_payment_due
.date
payment_received _amount
^-?(\d*)(?:\.\d{1,2})?$
document_url
1{2 "open_date": "2018-08-28",3 "close_date": "2018-08-28",4 "balance_due": "100.95",5 "minimum_payment_due": "100.95",6 "payment_due_date": "2018-08-28",7 "payment_received_date": "2018-08-28",8 "payment_received_amount": "100.95",9 "document_url": "string"10}
Was this helpful?
InterestRateType
Interest rate adjustment schemes.
fixed
adjustable
variable
other
Was this helpful?
InterestRatePeriod
Time-bound description of interest rates and their effective periods.
start_date
date
end_date
null
if the end date is not known or not fixed.date
interest_rate
^\d*(\.\d{1,4})?$
1{2 "start_date": "2018-08-28",3 "end_date": "2018-08-28",4 "interest_rate": "0.0199"5}
Was this helpful?
LoanRepaymentStatus
Loan repayment status.
fully repaid
current
grace
deferment
forbearance
past due
delinquent
default
charged off
cancelled
Was this helpful?
MortgageAccount
List of all accounts for which this user is an owner or interested non-owner.
subtype
cash management
, cd
, checking
, savings
, money market
, health
, prepaid
, gic
, auto
, commercial
, construction
, consumer
, credit card
, home equity
, mortgage
, overdraft
, line of credit
, student
, 401a
, 401k
, 403B
, 457b
, 529
, brokerage
, esa
, ira
, isa
, lira
, other
, rif
, rsp
, pension
, profit-sharing
, roth ira
, roth 401k
, sep ira
, simple ira
, sipp
, stock plan
, tsp
, tfsa
, custodial
, variable annuity
escrow_balance
Fixed-point decimal number, carried up to six decimal places.
^-?(\d*)(?:\.\d{1,2})?$
id
last_activity_at
date-time
ownership_type
individual
, joint
, association
, trust
owner_identity_ids
non_owner_identity_ids
status
active
, inactive
, frozen
, locked
, flagged
, restricted
, closed
type
depository
, loan
, investment
name
official_name
display_mask
opening_date
date
current_balance
^-?(\d*)(?:\.\d{1,2})?$
available_balance
^-?(\d*)(?:\.\d{1,2})?$
tax_advantaged
non_iso_currency
1{2 "subtype": "mortgage",3 "escrow_balance": "100.95",4 "type": "loan",5 "account_number": "string",6 "reference_number": "string",7 "servicer_identity_id": "string",8 "interest_rate": "0.0199",9 "interest_rate_type": "fixed",10 "interest_rate_schedule": [11 {12 "start_date": "2018-08-28",13 "end_date": "2018-08-28",14 "interest_rate": "0.0199"15 }16 ],17 "term_months": 0,18 "term_days": 0,19 "repayment_status": "fully repaid",20 "principal_balance": "100.95",21 "payoff_quote": "100.95",22 "payoff_expiry": "2018-08-28",23 "origination_date": "2018-08-28",24 "origination_principal": "100.95",25 "maturity_date": "2018-08-28",26 "statements": [27 {28 "payment_paid_to_principal": "100.95",29 "payment_paid_to_interest": "100.95",30 "open_date": "2018-08-28",31 "close_date": "2018-08-28",32 "balance_due": "100.95",33 "minimum_payment_due": "100.95",34 "payment_due_date": "2018-08-28",35 "payment_received_date": "2018-08-28",36 "payment_received_amount": "100.95",37 "document_url": "string"38 }39 ],40 "id": "R13oiR6lC5jNC5jK",41 "last_activity_at": "2020-04-21T12:45:00+00:00",42 "ownership_type": "individual",43 "owner_identity_ids": [44 "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"45 ],46 "non_owner_identity_ids": null,47 "status": "active",48