Data Dictionary

Objects defined in the Plaid Exchange spec

Primitives

Basic types used in other definitions

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.

coordinatesobject
Geographic coordinates in EPSG:4326 WGS84 (lat/long)
latnumber
Latitude coordinate.
lonnumber
Longitude coordinate.
citystring
City name.
regionstring
ISO 3166-2 sub-national region identifier.
countrystring
ISO 3166-1 two-character country identifier.
1
2
3
4
5
6
7
8
9
{
  "coordinates": {
    "lat": 41.8574,
    "lon": -71.39862
  },
  "city": "New York",
  "region": "US",
  "country": "US"
}

GeoCoordinates

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

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

Authentication

UserToken

Embeddable representation of user authorization.

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

Account

Currencies

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

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

Account Ownership

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

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

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

Ownership structure of an account.

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

Account Status

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

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

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

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

Account Type and Subtype

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

BaseAccount

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

idstring
Permanent account identifier.
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, trust
owner_identity_ids[string]
References to the identities for the owner(s) of this account.
non_owner_identity_ids[string]
References to the identities for the non-owner(s) related to this account, e.g. trustees, beneficiaries.
statusstring
Status of an account.
Possible values: active, inactive, frozen, locked, flagged, restricted, closed
typestring
Major classification of this account.
Possible values: depository, loan, investment
subtypestring
Minor classification of this account.
Possible values: cash management, cd, checking, savings, money market, health, prepaid, gic, auto, commercial, construction, consumer, credit card, home equity, mortgage, overdraft, line of credit, student, 401a, 401k, 403B, 457b, 529, brokerage, esa, ira, isa, lira, other, rif, rsp, pension, profit-sharing, roth ira, roth 401k, sep ira, simple ira, sipp, stock plan, tsp, tfsa, custodial, variable annuity
namestring
The account's user-given name, if the institution supports naming of accounts.
official_namestring
The account's marketing or brand name.
display_maskstring
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_balancestring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
available_balancestring
Fixed-point decimal number, carried up to six decimal places.
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
ISO 4217 currency code.
non_iso_currencystring
If the account is denominated in a non-ISO currency, provide the currency's symbol.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
  "id": "R13oiR6lC5jNC5jK",
  "last_activity_at": "2020-04-21T12:45:00+00:00",
  "ownership_type": "individual",
  "owner_identity_ids": [
    "string"
  ],
  "non_owner_identity_ids": [
    "string"
  ],
  "status": "active",
  "type": "depository",
  "subtype": "cash management",
  "name": "Vacation Money",
  "official_name": "Pro Checking",
  "display_mask": "9833",
  "opening_date": "2018-01-31",
  "current_balance": "100.95",
  "available_balance": "100.95",
  "tax_advantaged": true,
  "currency": "USD",
  "non_iso_currency": "string"
}

DepositoryAccount

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

interest_ratestring
Fixed-point representation of a normalized rate, carried up to four decimal places.
Pattern: ^\d*(\.\d{1,4})?$
transfer_codesobject
Mapping between an account and various payment networks.
achobject
Base model for depository account transfer 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
Base model for depository account transfer 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
Base model for depository account transfer 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
Base model for depository account transfer 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
Base model for depository account transfer identifiers.
account_numberstring
The account number.
receiving_member_identityobject
A lightweight identity container suitable for passing minimal identification.
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, corp
mccstring
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
Tax identifiers model an international-compliant identity within a tax authority. Use these to communicate a taxable entity’s identity within a jurisdiction.
tax_authoritystring
Name of the tax authority.
tax_payer_idstring
The tax payer ID, e.g. EIN, TIN, SSN.
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
Tax identifiers model an international-compliant identity within a tax authority. Use these to communicate a taxable entity’s identity within a jurisdiction.
tax_authoritystring
Name of the tax authority.
tax_payer_idstring
The tax payer ID, e.g. EIN, TIN, SSN.
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
ISO 3166-2 sub-national region identifier.
countrystring
ISO 3166-1 two-character country identifier.
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]
The DTCC institution identifiers for the institution holding the account.
Min items: 1
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
Fixed-point decimal number, carried up to six decimal places.
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.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
{
  "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": [
            "string"
          ],
          "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",
          "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": [
    "string"
  ],
  "non_owner_identity_ids": [
    "string"
  ],
  "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": "string"
}

DepositoryAccountStatement

Represents primary account statement details.

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
Fixed-point decimal number, carried up to six decimal places.
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.
1
2
3
4
5
6
7
{
  "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.

achobject
Base model for depository account transfer 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
Base model for depository account transfer 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
Base model for depository account transfer 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
Base model for depository account transfer 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
Base model for depository account transfer identifiers.
account_numberstring
The account number.
receiving_member_identityobject
A lightweight identity container suitable for passing minimal identification.
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, corp
mccstring
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
Tax identifiers model an international-compliant identity within a tax authority. Use these to communicate a taxable entity’s identity within a jurisdiction.
tax_authoritystring
Name of the tax authority.
tax_payer_idstring
The tax payer ID, e.g. EIN, TIN, SSN.
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
Tax identifiers model an international-compliant identity within a tax authority. Use these to communicate a taxable entity’s identity within a jurisdiction.
tax_authoritystring
Name of the tax authority.
tax_payer_idstring
The tax payer ID, e.g. EIN, TIN, SSN.
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
ISO 3166-2 sub-national region identifier.
countrystring
ISO 3166-1 two-character country identifier.
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]
The DTCC institution identifiers for the institution holding the account.
Min items: 1
supports_debitboolean
Indicates account may be debited using transfer code.
supports_creditboolean
Indicates account may be credited using transfer code.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
{
  "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": [
          "string"
        ],
        "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",
        "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.

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

AchTransferCode

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

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.
1
2
3
4
5
6
7
{
  "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.

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.
1
2
3
4
5
6
7
{
  "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.

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.
1
2
3
4
5
6
7
8
9
{
  "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.

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.
1
2
3
4
5
6
7
8
{
  "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.

idstring
permanent account identifier. Should be an accountId.
typestring
major classification of this account. Should be one of the accountType values.
subtypestring
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_namestring
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.
1
2
3
4
5
6
7
8
9
{
  "id": "R13oiR6lC5jNC5jK",
  "type": "depository",
  "subtype": "checking",
  "name": "Vacation money",
  "official_name": "Pro Checking",
  "currency": "USD",
  "non_iso_currency": "BTC"
}

InvestmentAccount

Representation of brokerage accounts.

transfer_codesobject
Mapping between an account and various payment networks.
achobject
Base model for depository account transfer 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
Base model for depository account transfer 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
Base model for depository account transfer 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
Base model for depository account transfer 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
Base model for depository account transfer identifiers.
account_numberstring
The account number.
receiving_member_identityobject
A lightweight identity container suitable for passing minimal identification.
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, corp
mccstring
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
Tax identifiers model an international-compliant identity within a tax authority. Use these to communicate a taxable entity’s identity within a jurisdiction.
tax_authoritystring
Name of the tax authority.
tax_payer_idstring
The tax payer ID, e.g. EIN, TIN, SSN.
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
Tax identifiers model an international-compliant identity within a tax authority. Use these to communicate a taxable entity’s identity within a jurisdiction.
tax_authoritystring
Name of the tax authority.
tax_payer_idstring
The tax payer ID, e.g. EIN, TIN, SSN.
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
ISO 3166-2 sub-national region identifier.
countrystring
ISO 3166-1 two-character country identifier.
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]
The DTCC institution identifiers for the institution holding the account.
Min items: 1
supports_debitboolean
Indicates account may be debited using transfer code.
supports_creditboolean
Indicates account may be credited using transfer code.
current_balancestring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
available_balancestring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
margin_balancestring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
margin_limitstring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
margin_equitystring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
maintenance_marginstring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
buying_powerstring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
current_as_ofstring
The time at which current_balance was current.
Format: date-time
holdings[object]
Descriptions of held assets in the account.
security_idstring
The identifier of the security referenced by this holding.
cost_basisstring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
quantitystring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
lotsobject
Describes taxable lots of shares within a Holding.
idstring
The unique and permanent identifier for this lot.
acquired_atstring
The date at which the lot was acquired.
Format: date
acquired_pricestring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
quantitystring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
currencystring
ISO 4217 currency code.
non_iso_currencystring
If the account is denominated in a non-ISO currency, provide the currency's symbol.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
{
  "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": [
            "string"
          ],
          "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",
          "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": "string"
    }
  ],
  "id": "R13oiR6lC5jNC5jK",
  "last_activity_at": "2020-04-21T12:45:00+00:00",
  "ownership_type": "individual",
  "owner_identity_ids": [
    "string"
  ],
  "non_owner_identity_ids": [
    "string"
  ],
  "status": "active",
  "type": "depository",
  "subtype": "checking",
  "name": "Vacation Money",
  "official_name": "Pro Checking",
  "display_mask": "9833",
  "opening_date": "2018-01-31",
  "tax_advantaged": true,
  "currency": "USD",
  "non_iso_currency": "string"
}

AcatsTransferCode

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

account_numberstring
The account number.
receiving_member_identityobject
A lightweight identity container suitable for passing minimal identification.
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, corp
mccstring
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
Tax identifiers model an international-compliant identity within a tax authority. Use these to communicate a taxable entity’s identity within a jurisdiction.
tax_authoritystring
Name of the tax authority.
tax_payer_idstring
The tax payer ID, e.g. EIN, TIN, SSN.
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
Tax identifiers model an international-compliant identity within a tax authority. Use these to communicate a taxable entity’s identity within a jurisdiction.
tax_authoritystring
Name of the tax authority.
tax_payer_idstring
The tax payer ID, e.g. EIN, TIN, SSN.
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
ISO 3166-2 sub-national region identifier.
countrystring
ISO 3166-1 two-character country identifier.
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]
The DTCC institution identifiers for the institution holding the account.
Min items: 1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
{
  "account_number": "string",
  "receiving_member_identity": {
    "organization": {
      "name": "Doe Business, Inc.",
      "structure": "sole",
      "mcc": "5542",
      "owner_identity_ids": [
        "string"
      ],
      "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",
      "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.)

idstring
The permanent identifier for this security, across all accounts and holdings.
isinstring
The ISO 6166-compliant ISIN for this security, if available.
namestring
A descriptive name for the security, suitable for display.
symbolstring
The security's trading symbol, if applicable. Otherwise, a short, commonly used identifier.
is_cash_equivalentboolean
Indicates the security is highly-liquid, e.g. a money market account, and should be regarded as cash.
current_pricestring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
current_as_ofstring
The time at which current_price was current, in ISO 8601 format.
Format: date-time
close_pricestring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
typestring
The security type. For detailed descriptions of available types, see Plaid API security types.
Possible values: cash, derivative, equity, etf, fixed income, loan, mutual fund, other
currencystring
ISO 4217 currency code.
non_iso_currencystring
If the account is denominated in a non-ISO currency, provide the currency's symbol.
1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "id": "string",
  "isin": "string",
  "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": "string"
}

OptionSecurity

Representation of a Security with type of derivative.

expirystring
The contract expiration date.
Format: date
contract_typestring
The type of option.
Possible values: put, call
option_stylestring
The style of option (US or European)
Possible values: euro, us
exercise_pricestring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
underlying_security_idstring
Reference to the security underlying this contract.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
  "expiry": "2018-08-28",
  "contract_type": "put",
  "option_style": "euro",
  "exercise_price": "100.95",
  "underlying_security_id": "string",
  "id": "string",
  "isin": "string",
  "name": "CISCO SYSTEMS INC",
  "symbol": "CSCO",
  "is_cash_equivalent": true,
  "current_price": "100.95",
  "current_as_of": "2020-10-02T12:45:01Z",
  "close_price": "100.95",
  "type": "mutual fund",
  "currency": "USD",
  "non_iso_currency": "string"
}

ContractType

Describes available contract type

put
A put option
call
A call option

Holding

Instance of a held security.

security_idstring
The identifier of the security referenced by this holding.
cost_basisstring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
quantitystring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
lotsobject
Describes taxable lots of shares within a Holding.
idstring
The unique and permanent identifier for this lot.
acquired_atstring
The date at which the lot was acquired.
Format: date
acquired_pricestring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
quantitystring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
currencystring
ISO 4217 currency code.
non_iso_currencystring
If the account is denominated in a non-ISO currency, provide the currency's symbol.
1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "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": "string"
}

TaxLot

Describes taxable lots of shares within a Holding.

idstring
The unique and permanent identifier for this lot.
acquired_atstring
The date at which the lot was acquired.
Format: date
acquired_pricestring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
quantitystring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
1
2
3
4
5
6
{
  "id": "string",
  "acquired_at": "2018-08-28",
  "acquired_price": "100.95",
  "quantity": "100.95"
}

LoanAccount

Representation of short and long-term debt.

account_numberstring
The account number for this loan.
reference_numberstring
The loan's reference number.
servicer_identity_idstring
Reference to the udentity of the loan servicer.
interest_ratestring
Fixed-point representation of a normalized rate, carried up to four decimal places.
Pattern: ^\d*(\.\d{1,4})?$
interest_rate_typestring
The interest rate adjustment scheme for this loan.
Possible values: fixed, adjustable, variable, other
interest_rate_schedule[object]
A history of effective rates on this loan. For adjustable rate loans, include dates of future adjustments. Do not use to describe fixed-rate loans.
start_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
Fixed-point representation of a normalized rate, carried up to four decimal places.
Pattern: ^\d*(\.\d{1,4})?$
term_monthsinteger
A natural number, i.e. a non-negative integer.
Minimum: 0
term_daysinteger
A natural number, i.e. a non-negative integer.
Minimum: 0
repayment_statusstring
The loan's repayment status.
Possible values: fully repaid, current, grace, deferment, forbearance, past due, delinquent, default, charged off, cancelled
principal_balancestring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
payoff_quotestring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
payoff_expirystring
The date until which payoff_quote is considered current.
Format: date
origination_datestring
The loan's date of origination.
Format: date
origination_principalstring
Fixed-point decimal number, carried up to six decimal places.
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_to_principalstring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
payment_paid_to_intereststring
Fixed-point decimal number, carried up to six decimal places.
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
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
minimum_payment_duestring
Fixed-point decimal number, carried up to six decimal places.
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_received_amountstring
Fixed-point decimal number, carried up to six decimal places.
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.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
{
  "type": "depository",
  "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": [
    "string"
  ],
  "non_owner_identity_ids": [
    "string"
  ],
  "status": "active",
  "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": "string"
}

LoanStatement

Description of a loan account statement.

payment_paid_to_principalstring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
payment_paid_to_intereststring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
1
2
3
4
5
6
7
8
9
10
11
12
{
  "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"
}

InterestRateType

Interest rate adjustment schemes.

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.

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
Fixed-point representation of a normalized rate, carried up to four decimal places.
Pattern: ^\d*(\.\d{1,4})?$
1
2
3
4
5
{
  "start_date": "2018-08-28",
  "end_date": "2018-08-28",
  "interest_rate": "0.0199"
}

LoanRepaymentStatus

Loan repayment status.

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.

subtypestring
escrow_balancestring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
{
  "subtype": "checking",
  "escrow_balance": "100.95",
  "type": "depository",
  "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": [
    "string"
  ],
  "non_owner_identity_ids": [
    "string"
  ],
  "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": "string"
}

StudentLoanAccount

Representational of a loan account that is specific to student loans

subtypestring
disbursement_schedule[object]
The schedule for disbursement of funds.
disbursement_datestring
The date of disbursement.
Format: date
amountstring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
guarantor_identityobject
A lightweight identity container suitable for passing minimal identification.
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, corp
mccstring
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
Tax identifiers model an international-compliant identity within a tax authority. Use these to communicate a taxable entity’s identity within a jurisdiction.
tax_authoritystring
Name of the tax authority.
tax_payer_idstring
The tax payer ID, e.g. EIN, TIN, SSN.
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
Tax identifiers model an international-compliant identity within a tax authority. Use these to communicate a taxable entity’s identity within a jurisdiction.
tax_authoritystring
Name of the tax authority.
tax_payer_idstring
The tax payer ID, e.g. EIN, TIN, SSN.
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
ISO 3166-2 sub-national region identifier.
countrystring
ISO 3166-1 two-character country identifier.
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
Student loan PSLF eligibility status information.
eligibleboolean
Indicates the loan's eligibility for PSLF.
qualifying_paymentsinteger
A natural number, i.e. a non-negative integer.
Minimum: 0
total_paymentsinteger
A natural number, i.e. a non-negative integer.
Minimum: 0
sequence_numberstring
The loan's sequence number.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
{
  "subtype": "checking",
  "disbursement_schedule": [
    {
      "disbursement_date": "2018-08-28",
      "amount": "100.95"
    }
  ],
  "guarantor_identity": {
    "organization": {
      "name": "Doe Business, Inc.",
      "structure": "sole",
      "mcc": "5542",
      "owner_identity_ids": [
        "string"
      ],
      "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",
      "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": "depository",
  "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": [
    "string"
  ],
  "non_owner_identity_ids": [
    "string"
  ],
  "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": "string"
}

Disbursement

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

disbursement_datestring
The date of disbursement.
Format: date
amountstring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
1
2
3
4
{
  "disbursement_date": "2018-08-28",
  "amount": "100.95"
}

PslfEligibility

Student loan PSLF eligibility status information.

eligibleboolean
Indicates the loan's eligibility for PSLF.
qualifying_paymentsinteger
A natural number, i.e. a non-negative integer.
Minimum: 0
total_paymentsinteger
A natural number, i.e. a non-negative integer.
Minimum: 0
1
2
3
4
5
{
  "eligible": true,
  "qualifying_payments": 0,
  "total_payments": 0
}

CreditCardAccount

Representation of
 credit card.

typestring
Major classification of this account.
Possible values: loan
subtypestring
Minor classification of this account.
Possible values: credit card
current_balancestring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
available_balancestring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
reward_balancestring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
credit_limitstring
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 transfer
interest_ratestring
Fixed-point representation of a normalized rate, carried up to four decimal places.
Pattern: ^\d*(\.\d{1,4})?$
subject_balancestring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
interest_chargedstring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
statements[object]
Must describe statement periods for previous two years.
open_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
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
minimum_payment_duestring
Fixed-point decimal number, carried up to six decimal places.
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_received_amountstring
Fixed-point decimal number, carried up to six decimal places.
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
ISO 4217 currency code.
reward_non_iso_currencystring
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.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
{
  "type": "depository",
  "subtype": "checking",
  "current_balance": "850.55",
  "available_balance": "149.45",
  "reward_balance": "100.95",
  "credit_limit": "100.95",
  "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": "BTC",
  "art_asset_url": "string",
  "id": "R13oiR6lC5jNC5jK",
  "last_activity_at": "2020-04-21T12:45:00+00:00",
  "ownership_type": "individual",
  "owner_identity_ids": [
    "string"
  ],
  "non_owner_identity_ids": [
    "string"
  ],
  "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": "string"
}

CreditCardStatement

Description of a credit card account 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
balance_duestring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
minimum_payment_duestring
Fixed-point decimal number, carried up to six decimal places.
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_received_amountstring
Fixed-point decimal number, carried up to six decimal places.
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.
1
2
3
4
5
6
7
8
9
10
{
  "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.

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 transfer
interest_ratestring
Fixed-point representation of a normalized rate, carried up to four decimal places.
Pattern: ^\d*(\.\d{1,4})?$
subject_balancestring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
interest_chargedstring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
1
2
3
4
5
6
7
8
{
  "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.

purchasestring
Purchases.
cash advancestring
Cash advances.
balance transferstring
Balance transfers (not payments).

Identity

BasicIdentity

A lightweight identity container suitable for passing minimal identification.

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

FullIdentity

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

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, corp
mccstring
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
Tax identifiers model an international-compliant identity within a tax authority. Use these to communicate a taxable entity’s identity within a jurisdiction.
tax_authoritystring
Name of the tax authority.
tax_payer_idstring
The tax payer ID, e.g. EIN, TIN, SSN.
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
Tax identifiers model an international-compliant identity within a tax authority. Use these to communicate a taxable entity’s identity within a jurisdiction.
tax_authoritystring
Name of the tax authority.
tax_payer_idstring
The tax payer ID, e.g. EIN, TIN, SSN.
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
ISO 3166-2 sub-national region identifier.
countrystring
ISO 3166-1 two-character country identifier.
postal_codestring
The postal code.
phonestring
The phone number, formatted using ITU standard E. 123.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
{
  "organization": {
    "name": "Doe Business, Inc.",
    "structure": "sole",
    "mcc": "5542",
    "owner_identity_ids": [
      "string"
    ],
    "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",
    "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.

lines[string]
The lines of the street address.
Min items: 1
citystring
The city of the mailing address.
regionstring
ISO 3166-2 sub-national region identifier.
countrystring
ISO 3166-1 two-character country identifier.
postal_codestring
The postal code.
phonestring
The phone number, formatted using ITU standard E. 123.
1

PersonalEntity

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
Tax identifiers model an international-compliant identity within a tax authority. Use these to communicate a taxable entity’s identity within a jurisdiction.
tax_authoritystring
Name of the tax authority.
tax_payer_idstring
The tax payer ID, e.g. EIN, TIN, SSN.
1
2
3
4
5
6
7
8
9
10
{
  "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.

namestring
Name of the organization represented.
structurestring
Type of business structure.
Possible values: sole, partnership, llc, corp
mccstring
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
Tax identifiers model an international-compliant identity within a tax authority. Use these to communicate a taxable entity’s identity within a jurisdiction.
tax_authoritystring
Name of the tax authority.
tax_payer_idstring
The tax payer ID, e.g. EIN, TIN, SSN.
1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "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.

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.

tax_authoritystring
Name of the tax authority.
tax_payer_idstring
The tax payer ID, e.g. EIN, TIN, SSN.
1
2
3
4
5
6
{
  "tax_authority": "IRS",
  "tax_payer_id": "string",
  "country": "US",
  "subdivision": ""
}

Transaction

BaseTransaction

Base properties for all transactions.

idstring
Permanent, unique transaction identifier. Must survive changes to pending status or amount.
account_idstring
References to the account that this transaction is posting against.
descriptionstring
Description of the transaction.
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
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
transacted_atstring
The date/time when the transaction was authorized, in the time zone local to the transaction or to the customer.
Format: date-time
settled_atstring
The date/time when the transaction settled, in the time zone local to the customer. Must be null if the transaction is pending.
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.
coordinatesobject
Geographic coordinates in EPSG:4326 WGS84 (lat/long)
latnumber
Latitude coordinate.
lonnumber
Longitude coordinate.
citystring
City name.
regionstring
ISO 3166-2 sub-national region identifier.
countrystring
ISO 3166-1 two-character country identifier.
reward_currencystring
ISO 4217 currency code.
reward_non_iso_currencystring
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.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
{
  "id": "6AOU0jwFQw3sMZJ",
  "account_id": "string",
  "description": "Finance Charge",
  "memo": "Check #318",
  "category": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "ending_balance": "100.95",
  "transacted_at": "2018-08-28",
  "settled_at": "2018-08-28",
  "spender_identity_id": "string",
  "merchant_identity_id": "string",
  "geolocation": {
    "coordinates": {
      "lat": 0,
      "lon": 0
    },
    "city": "string",
    "region": "US",
    "country": "US"
  },
  "reward_currency": "USD",
  "reward_non_iso_currency": "string",
  "currency": "USD",
  "non_iso_currency": "string"
}

DepositoryOrCreditTransaction

Describes a transaction against a depository or credit card account.

typestring
Classification of DepositoryOrCreditTransaction by purpose as an enum.
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).
pendingboolean
Indicates that this transaction has not posted.
amountstring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
fee_amountstring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
reward_amountstring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
reward_ratestring
Fixed-point representation of a normalized rate, carried up to four decimal places.
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 presentstring
Transaction was conducted by a physcial 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.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
{
  "type": "transfer",
  "pending": true,
  "amount": "100.95",
  "fee_amount": "100.95",
  "reward_amount": "100.95",
  "reward_rate": "0.0199",
  "transfer_account_id": "string",
  "method": "card present",
  "id": "6AOU0jwFQw3sMZJ",
  "account_id": "string",
  "description": "Finance Charge",
  "memo": "Check #318",
  "category": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "ending_balance": "100.95",
  "transacted_at": "2019-08-24T14:15:22Z",
  "settled_at": "2019-08-24T14:15:22Z",
  "spender_identity_id": "string",
  "merchant_identity_id": "string",
  "geolocation": {
    "coordinates": {
      "lat": 0,
      "lon": 0
    },
    "city": "string",
    "region": "US",
    "country": "US"
  },
  "reward_currency": "USD",
  "reward_non_iso_currency": "string",
  "currency": "USD",
  "non_iso_currency": "string"
}

DepositoryOrCreditTransactionType

Classification of DepositoryOrCreditTransaction by purpose as an enum.

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.

card presentstring
Transaction was conducted by a physcial 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.

amountstring
Fixed-point decimal number, carried up to six decimal places.
Pattern: ^-?(\d*)(?:\.\d{1,2})?$
typestring
Classification of InvestmentTransaction by purpose.
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