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

string

A globally unique identifier (accountId, transactionId, identityId, etc.) which can serve as a stable identifier for the associated entity.

amount

string

Fixed point decimal number, carried up to six decimal places.

natural

integer

A natural number i.e. a non-negative integer.

rate

string

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

iso4217

string

ISO-4217 currency code.

iso8601

string

ISO-8601 formatted date or timestamp.

Format: date

mcc

string

Merchant category code.

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

object

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

lat

number

Latitude coordinate.

lon

number

Longitude coordinate.

city

string

City name.

region

string

Region identifier.

country

string

Country identifier.

API Object
1{
"coordinates": {
  "lat": 41.8574,
  "lon": -71.39862
},
"city": "New York",
"region": "US-NY",
"country": "US"
9}

Was this helpful?

GeoCoordinates

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

lat

requirednumber

Latitude coordinate.

lon

requirednumber

Longitude coordinate.

API Object
1{
2  "lat": 41.8574,
3  "lon": -71.39862
4}

Was this helpful?

Account

Currencies

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

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

Account Ownership

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

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

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

Ownership structure of an account.

individual

Individual account.

joint

Joint account ownership.

association

Ownership by a corporation, partnership, or unincorporated association, including for-profit and not-for-profit organizations.

trust

Revocable or irrevocable trust.

Was this helpful?

Account Status

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

active

Account has current activity and there are no issues outstanding.

inactive

Account has seen no activity for a standard period defined by the institution, and may be subject to fees or at risk of closure.

frozen

Access to and transaction against the account is prohibited due to legal or compliance concerns, e.g. assets subject to OFAC sanctions enforcement, assets subject to a discovery subpoena, etc.

locked

Access to the account is prohibited due to security concerns, e.g. fraudulent activity observed.

flagged

All activity is prohibited due to regulatory or policy requirements, e.g. monthly withdrawals from a savings account in excess of FRB Regulation D.

restricted

Activity on the account is restricted, e.g. withdrawals are subject to a daily limit, until the user meets certain conditions.

closed

The account is closed.

Was this helpful?

Suspended Access

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

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

Account Type and Subtype

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

requiredstring

Permanent account identifier. Do not use a full or masked account number for this value as this increases the risk of revealing Personally Identifiable Information (PII).

last_activity_at

string

Date of most recent change to, or activity on this account, e.g. new transactions, or changes to account metadata. Used to provide hints for optimal scheduling of updates.

Format: date-time

ownership_type

string

Indicates the ownership type of the account, not the relationship the current user has over the account.

Possible values: individual, joint, association, trust

owner_identity_ids

required[string]

References to the identities for the owner(s) of this account.

non_owner_identity_ids

[string]

References to the identities for the non-owner(s) related to this account, e.g. trustees, beneficiaries.

status

requiredstring

Status of this account.

Possible values: active, inactive, frozen, locked, flagged, restricted, closed

type

requiredstring

Major classification of this account.

Possible values: depository, loan, investment

subtype

requiredstring

Minor classification of this account.

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

name

string

The account's user-given name, if the institution supports naming of accounts.

official_name

requiredstring

The account's marketing or brand name.

display_mask

requiredstring

A short alpha-numeric string to assist users in identifying the account, e.g. last four digits of the account number.

opening_date

string

The date on which the account was opened.

Format: date

current_balance

requiredstring

The total balance in the account, typically including pending transactions. See individual account types for specific definitions of this value.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

available_balance

requiredstring

The immediately available balance in the account, typically the amount available to withdraw at the moment.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

tax_advantaged

boolean

Indicates whether some activity on the account - deposits, gains, etc - benefits from tax deferral or exemption, e.g. HSA, IRA, 401(k) accounts.

currency

string

The ISO-4217 currency in which this account’s transactions and balances are denominated.

non_iso_currency

string

If the account is denominated in a non-ISO currency, provide the currency's symbol.

API Object
1{
"id": "R13oiR6lC5jNC5jK",
"last_activity_at": "2020-04-21T12:45:00+00:00",
"ownership_type": "individual",
"owner_identity_ids": null,
"non_owner_identity_ids": [
  "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
],
"status": "active",
"type": "depository",
"subtype": "checking",
"name": "Vacation Money",
"official_name": "Pro Checking",
"display_mask": "9833",
"opening_date": "2018-01-31",
"current_balance": "850.55",
"available_balance": "149.45",
"tax_advantaged": true,
"currency": "USD",
"non_iso_currency": null
21}

Was this helpful?

DepositoryAccount

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

interest_rate

string

The rate at which this account earns interest.

Pattern: ^\d*(\.\d{1,4})?$

transfer_codes

requiredobject

Account identifiers necessary for funds transfers.

ach

object

ACH (US) account identifiers.

account_number

string

The account number.

routing_number

string

The ABA routing transit number.

wire_routing_number

string

The institution's routing number for wire transfer.

supports_debit

boolean

Indicates account may be debited using transfer code.

supports_credit

boolean

Indicates account may be credited using transfer code.

eft

object

EFT (Canada) account identifiers.

account_number

string

The account number.

institution_number

string

The institution's number assigned by Payments Canada.

branch_number

string

The branch number corresponding to the account.

supports_debit

boolean

Indicates account may be debited using transfer code.

supports_credit

boolean

Indicates account may be credited using transfer code.

iban

object

IBAN account identifiers.

account_number

string

The full IBAN.

bank_code

string

Bank identifier.

country_code

string

The country code.

location_code

string

Location code for the bank's office.

branch_code

string

Optionally indicate a specific branch.

supports_debit

boolean

Indicates account may be debited using transfer code.

supports_credit

boolean

Indicates account may be credited using transfer code.

payment_card

object

Payment card account identifiers.

card_number

string

The payment card number.

expiry_month

string

Month of card expiration, as a 2-digit value.

expiry_year

string

Year of card expiration.

security_code

string

CVV, CSC, or other card-not-present verification value.

supports_debit

boolean

Indicates account may be debited using transfer code.

supports_credit

boolean

Indicates account may be credited using transfer code.

acats

object

ACATS account identifiers.

account_number

string

The account number.

receiving_member_identity

object

Identity of the receiving brokerage (including organization).

organization

object

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

name

string

Name of the organization represented.

structure

string

Type of business structure.

Possible values: sole, partnership, llc, corp

mcc

string

The ISO-18245 merchant category code for this business.

Pattern: ^\d{4}$

owner_identity_ids

[string]

The identities of the organization owner(s).

tax_identifier

object

The tax authority ID.

tax_authority

string

Name of the tax authority.

tax_payer_id

string

The tax payer ID, e.g. EIN, TIN, SSN.

country

string

The national jurisdiction of the tax authority in ISO 3166-1 format.

subdivision

string

If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.

person

object

Describes an individual, named person.

first_name

string

Legal given name of the personal entity.

middle_name

string

Middle name, use blank if none.

last_name

string

Last name or family name.

date_of_birth

string

The date of birth in ISO-8601 format.

Format: date

tax_identifier

object

The tax authority ID.

tax_authority

string

Name of the tax authority.

tax_payer_id

string

The tax payer ID, e.g. EIN, TIN, SSN.

country

string

The national jurisdiction of the tax authority in ISO 3166-1 format.

subdivision

string

If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.

email

string

The email address where this entity can be contacted.

mailing_address

object

Description of a street address.

lines

[string]

The lines of the street address.

Min items: 1

city

string

The city of the mailing address.

region

string

The first-level administrative subdivision, e.g., a state, province or district. Use ISO 3166-2 subdivisions (note: not ISO-3166-alpha-2).

country

string

The ISO 3166-alpha-2 country code.

postal_code

string

The postal code.

phone

string

The phone number, formatted using ITU standard E. 123.

id

string

Permanent identity identifier.

name

string

The display name of this entity (insufficient for KYC purposes)

dtcc_clearing_ids

[string]

The DTCC institution identifiers for the institution holding the account.

Min items: 1

supports_debit

boolean

Indicates account may be debited using transfer code.

supports_credit

boolean

Indicates account may be credited using transfer code.

maturity_date

string

The date of maturity for fixed-term instruments, e.g. CDs.

Format: date

statements

[object]

Must describe statement periods for previous two years.

statement_id

string

Globally unique identifier for this statement.

open_date

string

The opening date of this statement period.

Format: date

close_date

string

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

Format: date

balance

string

The balance at the close of the statement period.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

document_url

string

A URL to a downloadable document form of this statement. Implementers should not assume that accessors of this URL are always authorized.

id

requiredstring

Permanent account identifier. Do not use a full or masked account number for this value as this increases the risk of revealing Personally Identifiable Information (PII).

last_activity_at

string

Date of most recent change to, or activity on this account, e.g. new transactions, or changes to account metadata. Used to provide hints for optimal scheduling of updates.

Format: date-time

ownership_type

string

Indicates the ownership type of the account, not the relationship the current user has over the account.

Possible values: individual, joint, association, trust

owner_identity_ids

required[string]

References to the identities for the owner(s) of this account.

non_owner_identity_ids

[string]

References to the identities for the non-owner(s) related to this account, e.g. trustees, beneficiaries.

status

requiredstring

Status of this account.

Possible values: active, inactive, frozen, locked, flagged, restricted, closed

type

requiredstring

Major classification of this account.

Possible values: depository, loan, investment

subtype

requiredstring

Minor classification of this account.

name

string

The account's user-given name, if the institution supports naming of accounts.

official_name

requiredstring

The account's marketing or brand name.

display_mask

requiredstring

A short alpha-numeric string to assist users in identifying the account, e.g. last four digits of the account number.

opening_date

string

The date on which the account was opened.

Format: date

current_balance

requiredstring

The total balance in the account, typically including pending transactions. See individual account types for specific definitions of this value.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

available_balance

requiredstring

The immediately available balance in the account, typically the amount available to withdraw at the moment.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

tax_advantaged

boolean

Indicates whether some activity on the account - deposits, gains, etc - benefits from tax deferral or exemption, e.g. HSA, IRA, 401(k) accounts.

currency

string

The ISO-4217 currency in which this account’s transactions and balances are denominated.

non_iso_currency

string

If the account is denominated in a non-ISO currency, provide the currency's symbol.

API Object
1{
"interest_rate": "0.0199",
"transfer_codes": {
  "ach": {
    "account_number": "string",
    "routing_number": "031176110",
    "wire_routing_number": "string",
    "supports_debit": true,
    "supports_credit": true
  },
  "eft": {
    "account_number": "string",
    "institution_number": "004",
    "branch_number": "1320",
    "supports_debit": true,
    "supports_credit": true
  },
  "iban": {
    "account_number": "string",
    "bank_code": "NORD",
    "country_code": "FR",
    "location_code": "ZZ",
    "branch_code": "80A",
    "supports_debit": true,
    "supports_credit": true
  },
  "payment_card": {
    "card_number": "string",
    "expiry_month": "01",
    "expiry_year": "2021",
    "security_code": "363",
    "supports_debit": true,
    "supports_credit": true
  },
  "acats": {
    "account_number": "string",
    "receiving_member_identity": {
      "organization": {
        "name": "Doe Business, Inc.",
        "structure": "sole",
        "mcc": "5542",
        "owner_identity_ids": [
          "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
        ],
        "tax_identifier": {
          "tax_authority": "IRS",
          "tax_payer_id": "string"
        }
      },
      "person": {
        "first_name": "Jane",
        "middle_name": "Joan",
        "last_name": "Doe",
        "date_of_birth": "1987-01-31",
        "tax_identifier": {
          "tax_authority": "IRS",
          "tax_payer_id": "string"
        }
      },
      "email": "jane@plaid.com",
      "mailing_address": {
        "lines": [
          "413 Leeward Way",
          "Apt 3A"
        ],
        "city": "San Francisco",
        "region": "US-CA",
        "country": "US",
        "postal_code": "94106",
        "phone": "+1 415 555 1212"
      },
      "id": "d7f1b8b9-0006-4135-91c0-b5532045a314",
      "name": "Jane Doe"
    },
    "dtcc_clearing_ids": [
      "string"
    ],
    "supports_debit": true,
    "supports_credit": true
  }
},
"maturity_date": "2018-08-28",
"statements": [
  {
    "statement_id": "string",
    "open_date": "2018-08-28",
    "close_date": "2018-08-28",
    "balance": "100.95",
    "document_url": "string"
  }
],
"id": "R13oiR6lC5jNC5jK",
"last_activity_at": "2020-04-21T12:45:00+00:00",
"ownership_type": "individual",
"owner_identity_ids": [
  "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
],
"non_owner_identity_ids": null,
"status": "active",
"type": "depository",
"subtype": "checking",
"name": "Vacation Money",
"official_name": "Pro Checking",
"display_mask": "9833",
"opening_date": "2018-01-31",
"current_balance": "850.55",
"available_balance": "149.45",
"tax_advantaged": true,
"currency": "USD",
"non_iso_currency": null
111}

Was this helpful?

DepositoryAccountStatement

Represents primary account statement details.

statement_id

requiredstring

Globally unique identifier for this statement.

open_date

string

The opening date of this statement period.

Format: date

close_date

string

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

Format: date

balance

string

The balance at the close of the statement period.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

document_url

string

A URL to a downloadable document form of this statement. Implementers should not assume that accessors of this URL are always authorized.

API Object
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

object

ACH (US) account identifiers.

account_number

string

The account number.

routing_number

string

The ABA routing transit number.

wire_routing_number

string

The institution's routing number for wire transfer.

supports_debit

boolean

Indicates account may be debited using transfer code.

supports_credit

boolean

Indicates account may be credited using transfer code.

eft

object

EFT (Canada) account identifiers.

account_number

string

The account number.

institution_number

string

The institution's number assigned by Payments Canada.

branch_number

string

The branch number corresponding to the account.

supports_debit

boolean

Indicates account may be debited using transfer code.

supports_credit

boolean

Indicates account may be credited using transfer code.

iban

object

IBAN account identifiers.

account_number

string

The full IBAN.

bank_code

string

Bank identifier.

country_code

string

The country code.

location_code

string

Location code for the bank's office.

branch_code

string

Optionally indicate a specific branch.

supports_debit

boolean

Indicates account may be debited using transfer code.

supports_credit

boolean

Indicates account may be credited using transfer code.

payment_card

object

Payment card account identifiers.

card_number

string

The payment card number.

expiry_month

string

Month of card expiration, as a 2-digit value.

expiry_year

string

Year of card expiration.

security_code

string

CVV, CSC, or other card-not-present verification value.

supports_debit

boolean

Indicates account may be debited using transfer code.

supports_credit

boolean

Indicates account may be credited using transfer code.

acats

object

ACATS account identifiers.

account_number

string

The account number.

receiving_member_identity

object

Identity of the receiving brokerage (including organization).

organization

object

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

name

string

Name of the organization represented.

structure

string

Type of business structure.

Possible values: sole, partnership, llc, corp

mcc

string

The ISO-18245 merchant category code for this business.

Pattern: ^\d{4}$

owner_identity_ids

[string]

The identities of the organization owner(s).

tax_identifier

object

The tax authority ID.

tax_authority

string

Name of the tax authority.

tax_payer_id

string

The tax payer ID, e.g. EIN, TIN, SSN.

country

string

The national jurisdiction of the tax authority in ISO 3166-1 format.

subdivision

string

If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.

person

object

Describes an individual, named person.

first_name

string

Legal given name of the personal entity.

middle_name

string

Middle name, use blank if none.

last_name

string

Last name or family name.

date_of_birth

string

The date of birth in ISO-8601 format.

Format: date

tax_identifier

object

The tax authority ID.

tax_authority

string

Name of the tax authority.

tax_payer_id

string

The tax payer ID, e.g. EIN, TIN, SSN.

country

string

The national jurisdiction of the tax authority in ISO 3166-1 format.

subdivision

string

If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.

email

string

The email address where this entity can be contacted.

mailing_address

object

Description of a street address.

lines

[string]

The lines of the street address.

Min items: 1

city

string

The city of the mailing address.

region

string

The first-level administrative subdivision, e.g., a state, province or district. Use ISO 3166-2 subdivisions (note: not ISO-3166-alpha-2).

country

string

The ISO 3166-alpha-2 country code.

postal_code

string

The postal code.

phone

string

The phone number, formatted using ITU standard E. 123.

id

string

Permanent identity identifier.

name

string

The display name of this entity (insufficient for KYC purposes)

dtcc_clearing_ids

[string]

The DTCC institution identifiers for the institution holding the account.

Min items: 1

supports_debit

boolean

Indicates account may be debited using transfer code.

supports_credit

boolean

Indicates account may be credited using transfer code.

API Object
1{
"ach": {
  "account_number": "string",
  "routing_number": "031176110",
  "wire_routing_number": "string",
  "supports_debit": true,
  "supports_credit": true
},
"eft": {
  "account_number": "string",
  "institution_number": "004",
  "branch_number": "1320",
  "supports_debit": true,
  "supports_credit": true
},
"iban": {
  "account_number": "string",
  "bank_code": "NORD",
  "country_code": "FR",
  "location_code": "ZZ",
  "branch_code": "80A",
  "supports_debit": true,
  "supports_credit": true
},
"payment_card": {
  "card_number": "string",
  "expiry_month": "01",
  "expiry_year": "2021",
  "security_code": "363",
  "supports_debit": true,
  "supports_credit": true
},
"acats": {
  "account_number": "string",
  "receiving_member_identity": {
    "organization": {
      "name": "Doe Business, Inc.",
      "structure": "sole",
      "mcc": "5542",
      "owner_identity_ids": [
        "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
      ],
      "tax_identifier": {
        "tax_authority": "IRS",
        "tax_payer_id": "string"
      }
    },
    "person": {
      "first_name": "Jane",
      "middle_name": "Joan",
      "last_name": "Doe",
      "date_of_birth": "1987-01-31",
      "tax_identifier": {
        "tax_authority": "IRS",
        "tax_payer_id": "string"
      }
    },
    "email": "jane@plaid.com",
    "mailing_address": {
      "lines": [
        "413 Leeward Way",
        "Apt 3A"
      ],
      "city": "San Francisco",
      "region": "US-CA",
      "country": "US",
      "postal_code": "94106",
      "phone": "+1 415 555 1212"
    },
    "id": "d7f1b8b9-0006-4135-91c0-b5532045a314",
    "name": "Jane Doe"
  },
  "dtcc_clearing_ids": [
    "string"
  ],
  "supports_debit": true,
  "supports_credit": true
}
79}

Was this helpful?

DepositoryAccountTransferCode

Base model for depository account transfer identifiers.

supports_debit

requiredboolean

Indicates account may be debited using transfer code.

supports_credit

requiredboolean

Indicates account may be credited using transfer code.

API Object
1{
2  "supports_debit": true,
3  "supports_credit": true
4}

Was this helpful?

AchTransferCode

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

account_number

requiredstring

The account number.

routing_number

requiredstring

The ABA routing transit number.

wire_routing_number

string

The institution's routing number for wire transfer.

supports_debit

requiredboolean

Indicates account may be debited using transfer code.

supports_credit

requiredboolean

Indicates account may be credited using transfer code.

API Object
1{
2  "account_number": "121212454545",
3  "routing_number": "031176110",
4  "wire_routing_number": "1234-5678-0",
5  "supports_debit": true,
6  "supports_credit": true
7}

Was this helpful?

EftTransferCode

Identifiers for directing funds transfers in Canada.

account_number

requiredstring

The account number.

institution_number

requiredstring

The institution's number assigned by Payments Canada.

branch_number

requiredstring

The branch number corresponding to the account.

supports_debit

requiredboolean

Indicates account may be debited using transfer code.

supports_credit

requiredboolean

Indicates account may be credited using transfer code.

API Object
1{
2  "account_number": "string",
3  "institution_number": "004",
4  "branch_number": "1320",
5  "supports_debit": true,
6  "supports_credit": true
7}

Was this helpful?

IbanTransferCode

International Bank Account Number for directing international funds transfers.

account_number

requiredstring

The full IBAN.

bank_code

requiredstring

Bank identifier.

country_code

requiredstring

The country code.

location_code

requiredstring

Location code for the bank's office.

branch_code

string

Optionally indicate a specific branch.

supports_debit

requiredboolean

Indicates account may be debited using transfer code.

supports_credit

requiredboolean

Indicates account may be credited using transfer code.

API Object
1{
"account_number": "string",
"bank_code": "NORD",
"country_code": "FR",
"location_code": "ZZ",
"branch_code": "80A",
"supports_debit": true,
"supports_credit": true
9}

Was this helpful?

PaymentCardTransferCode

Identifiers for directing funds to/from payment cards.

card_number

requiredstring

The payment card number.

expiry_month

requiredstring

Month of card expiration, as a 2-digit value.

expiry_year

requiredstring

Year of card expiration.

security_code

requiredstring

CVV, CSC, or other card-not-present verification value.

supports_debit

requiredboolean

Indicates account may be debited using transfer code.

supports_credit

requiredboolean

Indicates account may be credited using transfer code.

API Object
1{
2  "card_number": "string",
3  "expiry_month": "01",
4  "expiry_year": "2021",
5  "security_code": "363",
6  "supports_debit": true,
7  "supports_credit": true
8}

Was this helpful?

NotionalAccount

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

id

requiredstring

Permanent account identifier. Should be an accountId. Do not use a full or masked account number for this value as this increases the risk of revealing Personally Identifiable Information (PII).

type

requiredstring

Major classification of this account. Should be one of the accountType values.

subtype

requiredstring

Minor classification of this account. Should be one of the accountSubtype values.

access_authorized

deprecatedboolean

Indicate that the user has not authorized the account to participate in aggregation. should only be present/true for notional accounts.

name

string

The account’s user-given name, if the institution supports naming of accounts

official_name

requiredstring

The account’s marketing or brand name.

currency

string

The ISO-4217 currency in which this account’s transactions and balances are denominated.

non_iso_currency

string

If the account is denominated in a non-ISO currency, provide the currency’s symbol.

API Object
1{
"id": "R13oiR6lC5jNC5jK",
"type": "depository",
"subtype": "checking",
"name": "Vacation money",
"official_name": "Pro Checking",
"currency": "USD",
"non_iso_currency": null
9}

Was this helpful?

InvestmentAccount

Representation of brokerage accounts.

transfer_codes

object

Account identifiers necessary for portfolio transfers.

ach

object

ACH (US) account identifiers.

account_number

string

The account number.

routing_number

string

The ABA routing transit number.

wire_routing_number

string

The institution's routing number for wire transfer.

supports_debit

boolean

Indicates account may be debited using transfer code.

supports_credit

boolean

Indicates account may be credited using transfer code.

eft

object

EFT (Canada) account identifiers.

account_number

string

The account number.

institution_number

string

The institution's number assigned by Payments Canada.

branch_number

string

The branch number corresponding to the account.

supports_debit

boolean

Indicates account may be debited using transfer code.

supports_credit

boolean

Indicates account may be credited using transfer code.

iban

object

IBAN account identifiers.

account_number

string

The full IBAN.

bank_code

string

Bank identifier.

country_code

string

The country code.

location_code

string

Location code for the bank's office.

branch_code

string

Optionally indicate a specific branch.

supports_debit

boolean

Indicates account may be debited using transfer code.

supports_credit

boolean

Indicates account may be credited using transfer code.

payment_card

object

Payment card account identifiers.

card_number

string

The payment card number.

expiry_month

string

Month of card expiration, as a 2-digit value.

expiry_year

string

Year of card expiration.

security_code

string

CVV, CSC, or other card-not-present verification value.

supports_debit

boolean

Indicates account may be debited using transfer code.

supports_credit

boolean

Indicates account may be credited using transfer code.

acats

object

ACATS account identifiers.

account_number

string

The account number.

receiving_member_identity

object

Identity of the receiving brokerage (including organization).

organization

object

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

name

string

Name of the organization represented.

structure

string

Type of business structure.

Possible values: sole, partnership, llc, corp

mcc

string

The ISO-18245 merchant category code for this business.

Pattern: ^\d{4}$

owner_identity_ids

[string]

The identities of the organization owner(s).

tax_identifier

object

The tax authority ID.

tax_authority

string

Name of the tax authority.

tax_payer_id

string

The tax payer ID, e.g. EIN, TIN, SSN.

country

string

The national jurisdiction of the tax authority in ISO 3166-1 format.

subdivision

string

If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.

person

object

Describes an individual, named person.

first_name

string

Legal given name of the personal entity.

middle_name

string

Middle name, use blank if none.

last_name

string

Last name or family name.

date_of_birth

string

The date of birth in ISO-8601 format.

Format: date

tax_identifier

object

The tax authority ID.

tax_authority

string

Name of the tax authority.

tax_payer_id

string

The tax payer ID, e.g. EIN, TIN, SSN.

country

string

The national jurisdiction of the tax authority in ISO 3166-1 format.

subdivision

string

If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.

email

string

The email address where this entity can be contacted.

mailing_address

object

Description of a street address.

lines

[string]

The lines of the street address.

Min items: 1

city

string

The city of the mailing address.

region

string

The first-level administrative subdivision, e.g., a state, province or district. Use ISO 3166-2 subdivisions (note: not ISO-3166-alpha-2).

country

string

The ISO 3166-alpha-2 country code.

postal_code

string

The postal code.

phone

string

The phone number, formatted using ITU standard E. 123.

id

string

Permanent identity identifier.

name

string

The display name of this entity (insufficient for KYC purposes)

dtcc_clearing_ids

[string]

The DTCC institution identifiers for the institution holding the account.

Min items: 1

supports_debit

boolean

Indicates account may be debited using transfer code.

supports_credit

boolean

Indicates account may be credited using transfer code.

current_balance

requiredstring

The total balance in the account, typically including pending transactions. See individual account types for specific definitions of this value.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

available_balance

requiredstring

The immediately available balance in the account, typically the amount available to withdraw at the moment.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

margin_balance

string

The amount that is on loan. Provide as a negative amount.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

margin_limit

string

The total limit of the margin extended to the account.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

margin_equity

string

The amount of marginable assets owned in the account.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

maintenance_margin

string

The minimum equity needed to hold the positions in the account.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

buying_power

string

Total amount of funds available for making transactions, includes margin.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

current_as_of

string

The time at which current_balance was current.

Format: date-time

holdings

required[object]

Descriptions of held assets in the account.

security_id

string

The identifier of the security referenced by this holding.

cost_basis

string

The total cost of acquiring this holding, inclusive of fees.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

quantity

string

The amount of the security (typically, number of shares) comprising this holding.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

lots

object

The tax lots constituting this holding.

id

string

The unique and permanent identifier for this lot.

acquired_at

string

The date at which the lot was acquired.

Format: date

acquired_price

string

The total price at which this lot was acquired.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

quantity

string

The quantity held in this lot.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

currency

string

The ISO-4217 currency in which this account’s transactions and balances are denominated.

non_iso_currency

string

If the account is denominated in a non-ISO currency, provide the currency's symbol.

id

requiredstring

Permanent account identifier. Do not use a full or masked account number for this value as this increases the risk of revealing Personally Identifiable Information (PII).

last_activity_at

string

Date of most recent change to, or activity on this account, e.g. new transactions, or changes to account metadata. Used to provide hints for optimal scheduling of updates.

Format: date-time

ownership_type

string

Indicates the ownership type of the account, not the relationship the current user has over the account.

Possible values: individual, joint, association, trust

owner_identity_ids

required[string]

References to the identities for the owner(s) of this account.

non_owner_identity_ids

[string]

References to the identities for the non-owner(s) related to this account, e.g. trustees, beneficiaries.

status

requiredstring

Status of this account.

Possible values: active, inactive, frozen, locked, flagged, restricted, closed

type

requiredstring

Major classification of this account.

Possible values: depository, loan, investment

subtype

requiredstring

Minor classification of this account.

name

string

The account's user-given name, if the institution supports naming of accounts.

official_name

requiredstring

The account's marketing or brand name.

display_mask

requiredstring

A short alpha-numeric string to assist users in identifying the account, e.g. last four digits of the account number.

opening_date

string

The date on which the account was opened.

Format: date

tax_advantaged

boolean

Indicates whether some activity on the account - deposits, gains, etc - benefits from tax deferral or exemption, e.g. HSA, IRA, 401(k) accounts.

currency

string

The ISO-4217 currency in which this account’s transactions and balances are denominated.

non_iso_currency

string

If the account is denominated in a non-ISO currency, provide the currency's symbol.

API Object
1{
"transfer_codes": {
  "ach": {
    "account_number": "string",
    "routing_number": "031176110",
    "wire_routing_number": "string",
    "supports_debit": true,
    "supports_credit": true
  },
  "eft": {
    "account_number": "string",
    "institution_number": "004",
    "branch_number": "1320",
    "supports_debit": true,
    "supports_credit": true
  },
  "iban": {
    "account_number": "string",
    "bank_code": "NORD",
    "country_code": "FR",
    "location_code": "ZZ",
    "branch_code": "80A",
    "supports_debit": true,
    "supports_credit": true
  },
  "payment_card": {
    "card_number": "string",
    "expiry_month": "01",
    "expiry_year": "2021",
    "security_code": "363",
    "supports_debit": true,
    "supports_credit": true
  },
  "acats": {
    "account_number": "string",
    "receiving_member_identity": {
      "organization": {
        "name": "Doe Business, Inc.",
        "structure": "sole",
        "mcc": "5542",
        "owner_identity_ids": [
          "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
        ],
        "tax_identifier": {
          "tax_authority": "IRS",
          "tax_payer_id": "string"
        }
      },
      "person": {
        "first_name": "Jane",
        "middle_name": "Joan",
        "last_name": "Doe",
        "date_of_birth": "1987-01-31",
        "tax_identifier": {
          "tax_authority": "IRS",
          "tax_payer_id": "string"
        }
      },
      "email": "jane@plaid.com",
      "mailing_address": {
        "lines": [
          "413 Leeward Way",
          "Apt 3A"
        ],
        "city": "San Francisco",
        "region": "US-CA",
        "country": "US",
        "postal_code": "94106",
        "phone": "+1 415 555 1212"
      },
      "id": "d7f1b8b9-0006-4135-91c0-b5532045a314",
      "name": "Jane Doe"
    },
    "dtcc_clearing_ids": [
      "string"
    ],
    "supports_debit": true,
    "supports_credit": true
  }
},
"current_balance": "850.55",
"available_balance": "149.45",
"margin_balance": "100.95",
"margin_limit": "100.95",
"margin_equity": "100.95",
"maintenance_margin": "100.95",
"buying_power": "100.95",
"current_as_of": "2018-08-28",
"holdings": [
  {
    "security_id": "string",
    "cost_basis": "100.95",
    "quantity": "100.95",
    "lots": {
      "id": "string",
      "acquired_at": "2018-08-28",
      "acquired_price": "100.95",
      "quantity": "100.95"
    },
    "currency": "USD",
    "non_iso_currency": null
  }
],
"id": "R13oiR6lC5jNC5jK",
"last_activity_at": "2020-04-21T12:45:00+00:00",
"ownership_type": "individual",
"owner_identity_ids": [
  "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
],
"non_owner_identity_ids": null,
"status": "active",
"type": "investment",
"subtype": "401k",
"name": "Vacation Money",
"official_name": "401k Account",
"display_mask": "9833",
"opening_date": "2018-01-31",
"tax_advantaged": true,
"currency": "USD",
"non_iso_currency": null
121}

Was this helpful?

AcatsTransferCode

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

account_number

requiredstring

The account number.

receiving_member_identity

requiredobject

Identity of the receiving brokerage (including organization).

organization

object

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

name

string

Name of the organization represented.

structure

string

Type of business structure.

Possible values: sole, partnership, llc, corp

mcc

string

The ISO-18245 merchant category code for this business.

Pattern: ^\d{4}$

owner_identity_ids

[string]

The identities of the organization owner(s).

tax_identifier

object

The tax authority ID.

tax_authority

string

Name of the tax authority.

tax_payer_id

string

The tax payer ID, e.g. EIN, TIN, SSN.

country

string

The national jurisdiction of the tax authority in ISO 3166-1 format.

subdivision

string

If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.

person

object

Describes an individual, named person.

first_name

string

Legal given name of the personal entity.

middle_name

string

Middle name, use blank if none.

last_name

string

Last name or family name.

date_of_birth

string

The date of birth in ISO-8601 format.

Format: date

tax_identifier

object

The tax authority ID.

tax_authority

string

Name of the tax authority.

tax_payer_id

string

The tax payer ID, e.g. EIN, TIN, SSN.

country

string

The national jurisdiction of the tax authority in ISO 3166-1 format.

subdivision

string

If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.

email

string

The email address where this entity can be contacted.

mailing_address

object

Description of a street address.

lines

[string]

The lines of the street address.

Min items: 1

city

string

The city of the mailing address.

region

string

The first-level administrative subdivision, e.g., a state, province or district. Use ISO 3166-2 subdivisions (note: not ISO-3166-alpha-2).

country

string

The ISO 3166-alpha-2 country code.

postal_code

string

The postal code.

phone

string

The phone number, formatted using ITU standard E. 123.

id

string

Permanent identity identifier.

name

string

The display name of this entity (insufficient for KYC purposes)

dtcc_clearing_ids

required[string]

The DTCC institution identifiers for the institution holding the account.

Min items: 1

supports_debit

requiredboolean

Indicates account may be debited using transfer code.

supports_credit

requiredboolean

Indicates account may be credited using transfer code.

API Object
1{
"account_number": "string",
"receiving_member_identity": {
  "organization": {
    "name": "Doe Business, Inc.",
    "structure": "sole",
    "mcc": "5542",
    "owner_identity_ids": [
      "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
    ],
    "tax_identifier": {
      "tax_authority": "IRS",
      "tax_payer_id": "string"
    }
  },
  "person": {
    "first_name": "Jane",
    "middle_name": "Joan",
    "last_name": "Doe",
    "date_of_birth": "1987-01-31",
    "tax_identifier": {
      "tax_authority": "IRS",
      "tax_payer_id": "string"
    }
  },
  "email": "jane@plaid.com",
  "mailing_address": {
    "lines": [
      "413 Leeward Way",
      "Apt 3A"
    ],
    "city": "San Francisco",
    "region": "US-CA",
    "country": "US",
    "postal_code": "94106",
    "phone": "+1 415 555 1212"
  },
  "id": "d7f1b8b9-0006-4135-91c0-b5532045a314",
  "name": "Jane Doe"
},
"dtcc_clearing_ids": [
  "string"
],
"supports_debit": true,
"supports_credit": true
46}

Was this helpful?

Security

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

id

requiredstring

The permanent identifier for this security, across all accounts and holdings. Do not use a full or masked account number for this value as this increases the risk of revealing Personally Identifiable Information (PII).

isin

string

The ISO 6166-compliant ISIN for this security, if available.

name

requiredstring

A descriptive name for the security, suitable for display.

symbol

requiredstring

The security's trading symbol, if applicable. Otherwise, a short, commonly used identifier.

is_cash_equivalent

requiredboolean

Indicates the security is highly-liquid, e.g. a money market account, and should be regarded as cash.

current_price

requiredstring

The instantaneous trading price of the security.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

current_as_of

requiredstring

The time at which current_price was current, in ISO 8601 format.

Format: date-time

close_price

string

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

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

type

requiredstring

The security type. For detailed descriptions of available types, see Plaid API security types.

Possible values: cash, derivative, equity, etf, fixed income, loan, mutual fund, other

currency

string

The ISO 4217 currency in which this account’s transactions and balances are denominated.

non_iso_currency

string

If the account is denominated in a non-ISO currency, provide the currency's symbol.

API Object
1{
"id": "account_5921",
"isin": "US17275R1023",
"name": "CISCO SYSTEMS INC",
"symbol": "CSCO",
"is_cash_equivalent": true,
"current_price": "100.95",
"current_as_of": "2018-08-28",
"close_price": "100.95",
"type": "cash",
"currency": "USD",
"non_iso_currency": null
13}

Was this helpful?

OptionSecurity

Representation of a Security with type of derivative.

expiry

requiredstring

The contract expiration date.

Format: date

contract_type

requiredstring

The type of option.

Possible values: put, call

option_style

string

The style of option (US or European)

Possible values: euro, us

exercise_price

string

The price at which the contract owner may transact.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

underlying_security_id

requiredstring

Reference to the security underlying this contract.

id

requiredstring

isin

string

The ISO 6166-compliant ISIN for this security, if available.

name

requiredstring

A descriptive name for the security, suitable for display.

symbol

requiredstring

The security's trading symbol, if applicable. Otherwise, a short, commonly used identifier.

is_cash_equivalent

requiredboolean

Indicates the security is highly-liquid, e.g. a money market account, and should be regarded as cash.

current_price

requiredstring

The instantaneous trading price of the security.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

current_as_of

requiredstring

The time at which current_price was current, in ISO 8601 format.

Format: date-time

close_price

string

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

type

requiredstring

The security type. For detailed descriptions of available types, see Plaid API security types.

Possible values: cash, derivative, equity, etf, fixed income, loan, mutual fund, other

currency

string

The ISO 4217 currency in which this account’s transactions and balances are denominated.

non_iso_currency

string

If the account is denominated in a non-ISO currency, provide the currency's symbol.

API Object
1{
"id": "account_5921",
"isin": "US17275R1023",
"name": "CISCO SYSTEMS INC",
"symbol": "CSCO",
"is_cash_equivalent": true,
"current_price": "100.95",
"current_as_of": "2018-08-28",
"close_price": "100.95",
"type": "cash",
"currency": "USD",
"non_iso_currency": null
13}

Was this helpful?

ContractType

Describes available contract type

put

A put option

call

A call option

Was this helpful?

Holding

Instance of a held security.

security_id

requiredstring

The identifier of the security referenced by this holding.

cost_basis

string

The total cost of acquiring this holding, inclusive of fees.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

quantity

requiredstring

The amount of the security (typically, number of shares) comprising this holding.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

lots

object

The tax lots constituting this holding.

id

string

The unique and permanent identifier for this lot.

acquired_at

string

The date at which the lot was acquired.

Format: date

acquired_price

string

The total price at which this lot was acquired.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

quantity

string

The quantity held in this lot.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

currency

string

The ISO-4217 currency in which this account’s transactions and balances are denominated.

non_iso_currency

string

If the account is denominated in a non-ISO currency, provide the currency's symbol.

API Object
1{
"security_id": "string",
"cost_basis": "100.95",
"quantity": "100.95",
"lots": {
  "id": "string",
  "acquired_at": "2018-08-28",
  "acquired_price": "100.95",
  "quantity": "100.95"
},
"currency": "USD",
"non_iso_currency": null
13}

Was this helpful?

TaxLot

Describes taxable lots of shares within a Holding.

id

requiredstring

The unique and permanent identifier for this lot.

acquired_at

requiredstring

The date at which the lot was acquired.

Format: date

acquired_price

requiredstring

The total price at which this lot was acquired.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

quantity

requiredstring

The quantity held in this lot.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

API Object
1{
2  "id": "string",
3  "acquired_at": "2018-08-28",
4  "acquired_price": "100.95",
5  "quantity": "100.95"
6}

Was this helpful?

LoanAccount

Representation of short and long-term debt.

account_number

string

The account number for this loan.

reference_number

string

The loan's reference number.

servicer_identity_id

string

Reference to the identity of the loan servicer.

interest_rate

requiredstring

The current interest rate for this loan.

Pattern: ^\d*(\.\d{1,4})?$

interest_rate_type

requiredstring

The interest rate adjustment scheme for this loan.

Possible values: fixed, adjustable, variable, other

interest_rate_schedule

[object]

A history of effective rates on this loan. For adjustable rate loans, include dates of future adjustments. Do not use to describe fixed-rate loans.

start_date

string

The date this rate became, or becomes, effective.

Format: date

end_date

string

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

Format: date

interest_rate

string

The effective rate during the period described.

Pattern: ^\d*(\.\d{1,4})?$

term_months

integer

The full length of the loan's term, in months.

Minimum: 0

term_days

integer

The full length of the loan's term, in days.

Minimum: 0

repayment_status

requiredstring

The loan's repayment status.

Possible values: fully repaid, current, grace, deferment, forbearance, past due, delinquent, default, charged off, cancelled

principal_balance

requiredstring

The loan's remaining principal.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

payoff_quote

string

The instantaneous payoff quote.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

payoff_expiry

string

The date until which payoff_quote is considered current.

Format: date

origination_date

requiredstring

The loan's date of origination.

Format: date

origination_principal

string

The original principal balance.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

maturity_date

string

The loan's date of maturity.

Format: date

statements

[object]

Must describe statement periods for the account's entire history.

payment_paid_to_principal

string

The amount of the payment paid to principal.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

payment_paid_to_interest

string

The amount of the payment paid to interest.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

open_date

string

The opening date of this statement period.

Format: date

close_date

string

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

Format: date

balance_due

string

The statement balance.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

minimum_payment_due

string

The minimum payment due on this statement. If the statement is paid, this should be 0.00.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

payment_due_date

string

The date payment is, or was, due for this statement.

Format: date

payment_received_date

string

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

Format: date

payment_received_amount

string

The sum of all payments received during the period.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

document_url

string

A URL to a downloadable document form of this statement. Implementers should not assume that accessors of this URL are always authorized.

id

requiredstring

Permanent account identifier. Do not use a full or masked account number for this value as this increases the risk of revealing Personally Identifiable Information (PII).

last_activity_at

string

Date of most recent change to, or activity on this account, e.g. new transactions, or changes to account metadata. Used to provide hints for optimal scheduling of updates.

Format: date-time

ownership_type

string

Indicates the ownership type of the account, not the relationship the current user has over the account.

Possible values: individual, joint, association, trust

owner_identity_ids

required[string]

References to the identities for the owner(s) of this account.

non_owner_identity_ids

[string]

References to the identities for the non-owner(s) related to this account, e.g. trustees, beneficiaries.

status

requiredstring

Status of this account.

Possible values: active, inactive, frozen, locked, flagged, restricted, closed

type

requiredstring

Major classification of this account.

Possible values: depository, loan, investment

subtype

requiredstring

Minor classification of this account.

name

string

The account's user-given name, if the institution supports naming of accounts.

official_name

requiredstring

The account's marketing or brand name.

display_mask

requiredstring

A short alpha-numeric string to assist users in identifying the account, e.g. last four digits of the account number.

opening_date

string

The date on which the account was opened.

Format: date

current_balance

requiredstring

The total balance in the account, typically including pending transactions. See individual account types for specific definitions of this value.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

available_balance

requiredstring

The immediately available balance in the account, typically the amount available to withdraw at the moment.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

tax_advantaged

boolean

Indicates whether some activity on the account - deposits, gains, etc - benefits from tax deferral or exemption, e.g. HSA, IRA, 401(k) accounts.

currency

string

The ISO-4217 currency in which this account’s transactions and balances are denominated.

non_iso_currency

string

If the account is denominated in a non-ISO currency, provide the currency's symbol.

API Object
1{
"type": "loan",
"account_number": "string",
"reference_number": "string",
"servicer_identity_id": "string",
"interest_rate": "0.0199",
"interest_rate_type": "fixed",
"interest_rate_schedule": [
  {
    "start_date": "2018-08-28",
    "end_date": "2018-08-28",
    "interest_rate": "0.0199"
  }
],
"term_months": 0,
"term_days": 0,
"repayment_status": "fully repaid",
"principal_balance": "100.95",
"payoff_quote": "100.95",
"payoff_expiry": "2018-08-28",
"origination_date": "2018-08-28",
"origination_principal": "100.95",
"maturity_date": "2018-08-28",
"statements": [
  {
    "payment_paid_to_principal": "100.95",
    "payment_paid_to_interest": "100.95",
    "open_date": "2018-08-28",
    "close_date": "2018-08-28",
    "balance_due": "100.95",
    "minimum_payment_due": "100.95",
    "payment_due_date": "2018-08-28",
    "payment_received_date": "2018-08-28",
    "payment_received_amount": "100.95",
    "document_url": "string"
  }
],
"id": "R13oiR6lC5jNC5jK",
"last_activity_at": "2020-04-21T12:45:00+00:00",
"ownership_type": "individual",
"owner_identity_ids": [
  "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
],
"non_owner_identity_ids": null,
"status": "active",
"subtype": "consumer",
"name": "Vacation Money",
"official_name": "Pro Checking",
"display_mask": "9833",
"opening_date": "2018-01-31",
"current_balance": "850.55",
"available_balance": "149.45",
"tax_advantaged": true,
"currency": "USD",
"non_iso_currency": null
56}

Was this helpful?

LoanStatement

Description of a loan account statement.

payment_paid_to_principal

string

The amount of the payment paid to principal.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

payment_paid_to_interest

string

The amount of the payment paid to interest.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

open_date

requiredstring

The opening date of this statement period.

Format: date

close_date

requiredstring

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

Format: date

balance_due

requiredstring

The statement balance.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

minimum_payment_due

requiredstring

The minimum payment due on this statement. If the statement is paid, this should be 0.00.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

payment_due_date

requiredstring

The date payment is, or was, due for this statement.

Format: date

payment_received_date

requiredstring

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

Format: date

payment_received_amount

requiredstring

The sum of all payments received during the period.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

document_url

string

A URL to a downloadable document form of this statement. Implementers should not assume that accessors of this URL are always authorized.

API Object
1{
"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"
10}

Was this helpful?

InterestRateType

Interest rate adjustment schemes.

fixed

string

fixed rate.

adjustable

string

Adjustable rate.

variable

string

Variable rate.

other

string

All other rate adjustment schemes.

Was this helpful?

InterestRatePeriod

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

start_date

requiredstring

The date this rate became, or becomes, effective.

Format: date

end_date

requiredstring

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

Format: date

interest_rate

requiredstring

The effective rate during the period described.

Pattern: ^\d*(\.\d{1,4})?$

API Object
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

string

The loan is fully repaid.

current

string

The loan is current and the borrow is in good standing with respect to this loan.

grace

string

Loan payments have not begun, and interest is not accruing.

deferment

string

Loan payments are reduced or suspended, and interest is not accruing.

forbearance

string

Loan payments are reduced or suspended, but deferred interest is accruing.

past due

string

The borrower is past due, but can return the account to current.

delinquent

string

The borrower is severely past due and the institution may begin Dunning.

default

string

The borrower has defaulted and the institution may be pursuing other remedies.

charged off

string

The borrower has defaulted and the institution has completed actions in connection with the default.

cancelled

string

The lender has cancelled this loan (use also for forgiven or discharged loans).

Was this helpful?

MortgageAccount

Representation of a home mortgage loan.

subtype

requiredstring

Minor classification of this account.

escrow_balance

string

The total amount held in escrow for this loan, if applicable.
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

id

requiredstring

Permanent account identifier. Do not use a full or masked account number for this value as this increases the risk of revealing Personally Identifiable Information (PII).

last_activity_at

string

Date of most recent change to, or activity on this account, e.g. new transactions, or changes to account metadata. Used to provide hints for optimal scheduling of updates.

Format: date-time

ownership_type

string

Indicates the ownership type of the account, not the relationship the current user has over the account.

Possible values: individual, joint, association, trust

owner_identity_ids

required[string]

References to the identities for the owner(s) of this account.

non_owner_identity_ids

[string]

References to the identities for the non-owner(s) related to this account, e.g. trustees, beneficiaries.

status

requiredstring

Status of this account.

Possible values: active, inactive, frozen, locked, flagged, restricted, closed

type

requiredstring

Major classification of this account.

Possible values: depository, loan, investment

name

string

The account's user-given name, if the institution supports naming of accounts.

official_name

requiredstring

The account's marketing or brand name.

display_mask

requiredstring

A short alpha-numeric string to assist users in identifying the account, e.g. last four digits of the account number.

opening_date

string

The date on which the account was opened.

Format: date

current_balance

requiredstring

The total balance in the account, typically including pending transactions. See individual account types for specific definitions of this value.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

available_balance

requiredstring

The immediately available balance in the account, typically the amount available to withdraw at the moment.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

tax_advantaged

boolean

Indicates whether some activity on the account - deposits, gains, etc - benefits from tax deferral or exemption, e.g. HSA, IRA, 401(k) accounts.

currency

string

The ISO-4217 currency in which this account’s transactions and balances are denominated.

non_iso_currency

string

If the account is denominated in a non-ISO currency, provide the currency's symbol.

API Object
1{
"subtype": "mortgage",
"escrow_balance": "100.95",
"type": "loan",
"account_number": "string",
"reference_number": "string",
"servicer_identity_id": "string",
"interest_rate": "0.0199",
"interest_rate_type": "fixed",
"interest_rate_schedule": [
  {
    "start_date": "2018-08-28",
    "end_date": "2018-08-28",
    "interest_rate": "0.0199"
  }
],
"term_months": 0,
"term_days": 0,
"repayment_status": "fully repaid",
"principal_balance": "100.95",
"payoff_quote": "100.95",
"payoff_expiry": "2018-08-28",
"origination_date": "2018-08-28",
"origination_principal": "100.95",
"maturity_date": "2018-08-28",
"statements": [
  {
    "payment_paid_to_principal": "100.95",
    "payment_paid_to_interest": "100.95",
    "open_date": "2018-08-28",
    "close_date": "2018-08-28",
    "balance_due": "100.95",
    "minimum_payment_due": "100.95",
    "payment_due_date": "2018-08-28",
    "payment_received_date": "2018-08-28",
    "payment_received_amount": "100.95",
    "document_url": "string"
  }
],
"id": "R13oiR6lC5jNC5jK",
"last_activity_at": "2020-04-21T12:45:00+00:00",
"ownership_type": "individual",
"owner_identity_ids": [
  "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
],
"non_owner_identity_ids": null,
"status": "active",
"name": "Vacation Money",
"official_name": "Pro Checking",
"display_mask": "9833",
"opening_date": "2018-01-31",
"current_balance": "850.55",
"available_balance": "149.45",
"tax_advantaged": true,
"currency": "USD",
"non_iso_currency": null
57}

Was this helpful?

StudentLoanAccount

Representational of a loan account that is specific to student loans

subtype

requiredstring

Minor classification of this account.

disbursement_schedule

[object]

The schedule for disbursement of funds.

disbursement_date

string

The date of disbursement.

Format: date

amount

string

The amount disbursed.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

guarantor_identity

object

The company or agency guaranteeing the loan.

organization

object

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

name

string

Name of the organization represented.

structure

string

Type of business structure.

Possible values: sole, partnership, llc, corp

mcc

string

The ISO-18245 merchant category code for this business.

Pattern: ^\d{4}$

owner_identity_ids

[string]

The identities of the organization owner(s).

tax_identifier

object

The tax authority ID.

tax_authority

string

Name of the tax authority.

tax_payer_id

string

The tax payer ID, e.g. EIN, TIN, SSN.

country

string

The national jurisdiction of the tax authority in ISO 3166-1 format.

subdivision

string

If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.

person

object

Describes an individual, named person.

first_name

string

Legal given name of the personal entity.

middle_name

string

Middle name, use blank if none.

last_name

string

Last name or family name.

date_of_birth

string

The date of birth in ISO-8601 format.

Format: date

tax_identifier

object

The tax authority ID.

tax_authority

string

Name of the tax authority.

tax_payer_id

string

The tax payer ID, e.g. EIN, TIN, SSN.

country

string

The national jurisdiction of the tax authority in ISO 3166-1 format.

subdivision

string

If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.

email

string

The email address where this entity can be contacted.

mailing_address

object

Description of a street address.

lines

[string]

The lines of the street address.

Min items: 1

city

string

The city of the mailing address.

region

string

The first-level administrative subdivision, e.g., a state, province or district. Use ISO 3166-2 subdivisions (note: not ISO-3166-alpha-2).

country

string

The ISO 3166-alpha-2 country code.

postal_code

string

The postal code.

phone

string

The phone number, formatted using ITU standard E. 123.

id

string

Permanent identity identifier.

name

string

The display name of this entity (insufficient for KYC purposes)

pslf_eligibility

object

Description of the loan's eligibility for public service forgiveness.

eligible

boolean

Indicates the loan's eligibility for PSLF.

qualifying_payments

integer

The number of payments made which qualify under PSLF.

Minimum: 0

total_payments

integer

Total payments required for forgiveness.

Minimum: 0

sequence_number

string

The loan's sequence number.

id

requiredstring

Permanent account identifier. Do not use a full or masked account number for this value as this increases the risk of revealing Personally Identifiable Information (PII).

last_activity_at

string

Date of most recent change to, or activity on this account, e.g. new transactions, or changes to account metadata. Used to provide hints for optimal scheduling of updates.

Format: date-time

ownership_type

string

Indicates the ownership type of the account, not the relationship the current user has over the account.

Possible values: individual, joint, association, trust

owner_identity_ids

required[string]

References to the identities for the owner(s) of this account.

non_owner_identity_ids

[string]

References to the identities for the non-owner(s) related to this account, e.g. trustees, beneficiaries.

status

requiredstring

Status of this account.

Possible values: active, inactive, frozen, locked, flagged, restricted, closed

type

requiredstring

Major classification of this account.

Possible values: depository, loan, investment

name

string

The account's user-given name, if the institution supports naming of accounts.

official_name

requiredstring

The account's marketing or brand name.

display_mask

requiredstring

A short alpha-numeric string to assist users in identifying the account, e.g. last four digits of the account number.

opening_date

string

The date on which the account was opened.

Format: date

current_balance

requiredstring

The total balance in the account, typically including pending transactions. See individual account types for specific definitions of this value.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

available_balance

requiredstring

The immediately available balance in the account, typically the amount available to withdraw at the moment.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

tax_advantaged

boolean

Indicates whether some activity on the account - deposits, gains, etc - benefits from tax deferral or exemption, e.g. HSA, IRA, 401(k) accounts.

currency

string

The ISO-4217 currency in which this account’s transactions and balances are denominated.

non_iso_currency

string

If the account is denominated in a non-ISO currency, provide the currency's symbol.

API Object
1{
"subtype": "student",
"disbursement_schedule": [
  {
    "disbursement_date": "2018-08-28",
    "amount": "100.95"
  }
],
"guarantor_identity": {
  "organization": {
    "name": "Doe Business, Inc.",
    "structure": "sole",
    "mcc": "5542",
    "owner_identity_ids": [
      "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
    ],
    "tax_identifier": {
      "tax_authority": "IRS",
      "tax_payer_id": "string"
    }
  },
  "person": {
    "first_name": "Jane",
    "middle_name": "Joan",
    "last_name": "Doe",
    "date_of_birth": "1987-01-31",
    "tax_identifier": {
      "tax_authority": "IRS",
      "tax_payer_id": "string"
    }
  },
  "email": "jane@plaid.com",
  "mailing_address": {
    "lines": [
      "413 Leeward Way",
      "Apt 3A"
    ],
    "city": "San Francisco",
    "region": "US-CA",
    "country": "US",
    "postal_code": "94106",
    "phone": "+1 415 555 1212"
  },
  "id": "d7f1b8b9-0006-4135-91c0-b5532045a314",
  "name": "Jane Doe"
},
"pslf_eligibility": {
  "eligible": true,
  "qualifying_payments": 0,
  "total_payments": 0
},
"sequence_number": "string",
"type": "loan",
"account_number": "string",
"reference_number": "string",
"servicer_identity_id": "string",
"interest_rate": "0.0199",
"interest_rate_type": "fixed",
"interest_rate_schedule": [
  {
    "start_date": "2018-08-28",
    "end_date": "2018-08-28",
    "interest_rate": "0.0199"
  }
],
"term_months": 0,
"term_days": 0,
"repayment_status": "fully repaid",
"principal_balance": "100.95",
"payoff_quote": "100.95",
"payoff_expiry": "2018-08-28",
"origination_date": "2018-08-28",
"origination_principal": "100.95",
"maturity_date": "2018-08-28",
"statements": [
  {
    "payment_paid_to_principal": "100.95",
    "payment_paid_to_interest": "100.95",
    "open_date": "2018-08-28",
    "close_date": "2018-08-28",
    "balance_due": "100.95",
    "minimum_payment_due": "100.95",
    "payment_due_date": "2018-08-28",
    "payment_received_date": "2018-08-28",
    "payment_received_amount": "100.95",
    "document_url": "string"
  }
],
"id": "R13oiR6lC5jNC5jK",
"last_activity_at": "2020-04-21T12:45:00+00:00",
"ownership_type": "individual",
"owner_identity_ids": [
  "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
],
"non_owner_identity_ids": null,
"status": "active",
"name": "Vacation Money",
"official_name": "Pro Checking",
"display_mask": "9833",
"opening_date": "2018-01-31",
"current_balance": "850.55",
"available_balance": "149.45",
"tax_advantaged": true,
"currency": "USD",
"non_iso_currency": null
106}

Was this helpful?

Disbursement

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

disbursement_date

requiredstring

The date of disbursement.

Format: date

amount

requiredstring

The amount disbursed.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

API Object
1{
2  "disbursement_date": "2018-08-28",
3  "amount": "100.95"
4}

Was this helpful?

PslfEligibility

Student loan PSLF eligibility status information.

eligible

requiredboolean

Indicates the loan's eligibility for PSLF.

qualifying_payments

integer

The number of payments made which qualify under PSLF.

Minimum: 0

total_payments

integer

Total payments required for forgiveness.

Minimum: 0

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

Was this helpful?

CreditCardAccount

Representation of  credit card.

type

requiredstring

Major classification of this account.

Possible values: depository, loan, investment

subtype

requiredstring

Minor classification of this account.

current_balance

requiredstring

The total balance in the account, typically including pending transactions. See individual account types for specific definitions of this value.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

available_balance

requiredstring

The immediately available balance in the account, typically the amount available to withdraw at the moment.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

reward_balance

string

The balance of any rewards associated with this account.
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

credit_limit

requiredstring

The total credit limit for this account. If card has no limit, use null.
Fixed-point decimal number, carried up to six decimal places.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

spender_identity_ids

[string]

References to the Identities for non-owner authorized spenders.

interest_rates

[object]

Effective interest rates for different balances associated with this card.

start_date

string

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

Format: date

end_date

string

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

Format: date

type

string

The type of balance subject to this rate.

Possible values: purchase, cash advance, balance transfer

interest_rate

string

The APR covering this balance.

Pattern: ^\d*(\.\d{1,4})?$

subject_balance

string

The current balance subject to this rate, following the definition of current_balance.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

interest_charged

string

The amount within the subject_balance that was generated by this interest rate.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

statements

[object]

Must describe statement periods for previous two years.

open_date

string

The opening date of this statement period.

Format: date

close_date

string

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

Format: date

balance_due

string

The statement balance.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

minimum_payment_due

string

The minimum payment due on this statement. If the statement is paid, this should be 0.00.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

payment_due_date

string

The date payment is, or was, due for this statement.

Format: date

payment_received_date

string

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

Format: date

payment_received_amount

string

The sum of all payments received during the period.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

document_url

string

A URL to a downloadable document form of this statement. Implementers should not assume that accessors of this URL are always authorized.

reward_currency

string

The ISO-4217 currency in which this account's reward balances are denominated

reward_non_iso_currency

string

If the account's reward balance is denominated in a non-ISO currency, provide the currency's symbol

art_asset_url

string

URL reference to an image of the payment card face.

id

requiredstring

Permanent account identifier. Do not use a full or masked account number for this value as this increases the risk of revealing Personally Identifiable Information (PII).

last_activity_at

string

Date of most recent change to, or activity on this account, e.g. new transactions, or changes to account metadata. Used to provide hints for optimal scheduling of updates.

Format: date-time

ownership_type

string

Indicates the ownership type of the account, not the relationship the current user has over the account.

Possible values: individual, joint, association, trust

owner_identity_ids

required[string]

References to the identities for the owner(s) of this account.

non_owner_identity_ids

[string]

References to the identities for the non-owner(s) related to this account, e.g. trustees, beneficiaries.

status

requiredstring

Status of this account.

Possible values: active, inactive, frozen, locked, flagged, restricted, closed

name

string

The account's user-given name, if the institution supports naming of accounts.

official_name

requiredstring

The account's marketing or brand name.

display_mask

requiredstring

A short alpha-numeric string to assist users in identifying the account, e.g. last four digits of the account number.

opening_date

string

The date on which the account was opened.

Format: date

tax_advantaged

boolean

Indicates whether some activity on the account - deposits, gains, etc - benefits from tax deferral or exemption, e.g. HSA, IRA, 401(k) accounts.

currency

string

The ISO-4217 currency in which this account’s transactions and balances are denominated.

non_iso_currency

string

If the account is denominated in a non-ISO currency, provide the currency's symbol.

API Object
1{
"type": "loan",
"subtype": "credit card",
"current_balance": "850.55",
"available_balance": "149.45",
"reward_balance": "100.95",
"credit_limit": "1000",
"spender_identity_ids": [
  "string"
],
"interest_rates": [
  {
    "start_date": "2018-08-28",
    "end_date": "2018-08-28",
    "type": "purchase",
    "interest_rate": "0.0199",
    "subject_balance": "100.95",
    "interest_charged": "100.95"
  }
],
"statements": [
  {
    "open_date": "2018-08-28",
    "close_date": "2018-08-28",
    "balance_due": "100.95",
    "minimum_payment_due": "100.95",
    "payment_due_date": "2018-08-28",
    "payment_received_date": "2018-08-28",
    "payment_received_amount": "100.95",
    "document_url": "string"
  }
],
"reward_currency": "USD",
"reward_non_iso_currency": null,
"art_asset_url": "string",
"id": "R13oiR6lC5jNC5jK",
"last_activity_at": "2020-04-21T12:45:00+00:00",
"ownership_type": "individual",
"owner_identity_ids": [
  "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
],
"non_owner_identity_ids": null,
"status": "active",
"name": "Vacation Money",
"official_name": "Pro Checking",
"display_mask": "9833",
"opening_date": "2018-01-31",
"tax_advantaged": true,
"currency": "USD",
"non_iso_currency": null
51}

Was this helpful?

CreditCardStatement

Description of a credit card account statement.

open_date

requiredstring

The opening date of this statement period.

Format: date

close_date

requiredstring

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

Format: date

balance_due

requiredstring

The statement balance.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

minimum_payment_due

requiredstring

The minimum payment due on this statement. If the statement is paid, this should be 0.00.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

payment_due_date

requiredstring

The date payment is, or was, due for this statement.

Format: date

payment_received_date

requiredstring

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

Format: date

payment_received_amount

requiredstring

The sum of all payments received during the period.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

document_url

string

A URL to a downloadable document form of this statement. Implementers should not assume that accessors of this URL are always authorized.

API Object
1{
"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"
10}

Was this helpful?

CreditCardInterestRate

Description of a credit card interest rate.

start_date

requiredstring

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

Format: date

end_date

requiredstring

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

Format: date

type

requiredstring

The type of balance subject to this rate.

Possible values: purchase, cash advance, balance transfer

interest_rate

requiredstring

The APR covering this balance.

Pattern: ^\d*(\.\d{1,4})?$

subject_balance

requiredstring

The current balance subject to this rate, following the definition of current_balance.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

interest_charged

requiredstring

The amount within the subject_balance that was generated by this interest rate.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

API Object
1{
2  "start_date": "2018-08-28",
3  "end_date": "2018-08-28",
4  "type": "purchase",
5  "interest_rate": "0.0199",
6  "subject_balance": "100.95",
7  "interest_charged": "100.95"
8}

Was this helpful?

CreditCardInterestRateType

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

purchase

string

Purchases.

cash advance

string

Cash advances.

balance transfer

string

Balance transfers (not payments).

Was this helpful?

Identity

BasicIdentity

A lightweight identity container suitable for passing minimal identification.

id

requiredstring

Permanent identity identifier.

name

requiredstring

The display name of this entity (insufficient for KYC purposes)

email

string

The email address where this entity can be contacted.

API Object
1{
2  "id": "d7f1b8b9-0006-4135-91c0-b5532045a314",
3  "name": "Jane Doe",
4  "email": "jane@plaid.com"
5}

Was this helpful?

FullIdentity

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

organization

object

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

name

string

Name of the organization represented.

structure

string

Type of business structure.

Possible values: sole, partnership, llc, corp

mcc

string

The ISO-18245 merchant category code for this business.

Pattern: ^\d{4}$

owner_identity_ids

[string]

The identities of the organization owner(s).

tax_identifier

object

The tax authority ID.

tax_authority

string

Name of the tax authority.

tax_payer_id

string

The tax payer ID, e.g. EIN, TIN, SSN.

country

string

The national jurisdiction of the tax authority in ISO 3166-1 format.

subdivision

string

If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.

person

object

Describes an individual, named person.

first_name

string

Legal given name of the personal entity.

middle_name

string

Middle name, use blank if none.

last_name

string

Last name or family name.

date_of_birth

string

The date of birth in ISO-8601 format.

Format: date

tax_identifier

object

The tax authority ID.

tax_authority

string

Name of the tax authority.

tax_payer_id

string

The tax payer ID, e.g. EIN, TIN, SSN.

country

string

The national jurisdiction of the tax authority in ISO 3166-1 format.

subdivision

string

If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.

email

requiredstring

The email address where this entity can be contacted.

mailing_address

object

Description of a street address.

lines

[string]

The lines of the street address.

Min items: 1

city

string

The city of the mailing address.

region

string

The first-level administrative subdivision, e.g., a state, province or district. Use ISO 3166-2 subdivisions (note: not ISO-3166-alpha-2).

country

string

The ISO 3166-alpha-2 country code.

postal_code

string

The postal code.

phone

string

The phone number, formatted using ITU standard E. 123.

id

requiredstring

Permanent identity identifier.

name

requiredstring

The display name of this entity (insufficient for KYC purposes)

API Object
1{
"organization": {
  "name": "Doe Business, Inc.",
  "structure": "sole",
  "mcc": "5542",
  "owner_identity_ids": [
    "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
  ],
  "tax_identifier": {
    "tax_authority": "IRS",
    "tax_payer_id": "string"
  }
},
"person": {
  "first_name": "Jane",
  "middle_name": "Joan",
  "last_name": "Doe",
  "date_of_birth": "1987-01-31",
  "tax_identifier": {
    "tax_authority": "IRS",
    "tax_payer_id": "string"
  }
},
"email": "jane@plaid.com",
"mailing_address": {
  "lines": [
    "413 Leeward Way",
    "Apt 3A"
  ],
  "city": "San Francisco",
  "region": "US-CA",
  "country": "US",
  "postal_code": "94106",
  "phone": "+1 415 555 1212"
},
"id": "d7f1b8b9-0006-4135-91c0-b5532045a314",
"name": "Jane Doe"
38}

Was this helpful?

MailingAddress

Description of a street address.

lines

required[string]

The lines of the street address.

Min items: 1

city

requiredstring

The city of the mailing address.

region

string

The first-level administrative subdivision, e.g., a state, province or district. Use ISO 3166-2 subdivisions (note: not ISO-3166-alpha-2).

country

requiredstring

The ISO 3166-alpha-2 country code.

postal_code

string

The postal code.

phone

string

The phone number, formatted using ITU standard E. 123.

API Object
1{
"lines": [
  "413 Leeward Way",
  "Apt 3A"
],
"city": "San Francisco",
"region": "US-CA",
"country": "US",
"postal_code": "94106",
"phone": "+1 415 555 1212"
11}

Was this helpful?

PersonalEntity

Describes an individual, named person.

first_name

requiredstring

Legal given name of the personal entity.

middle_name

requiredstring

Middle name, use blank if none.

last_name

requiredstring

Last name or family name.

date_of_birth

string

The date of birth in ISO-8601 format.

Format: date

tax_identifier

object

The tax authority ID.

tax_authority

string

Name of the tax authority.

tax_payer_id

string

The tax payer ID, e.g. EIN, TIN, SSN.

country

string

The national jurisdiction of the tax authority in ISO 3166-1 format.

subdivision

string

If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.

API Object
1{
"first_name": "Jane",
"middle_name": "Joan",
"last_name": "Doe",
"date_of_birth": "1987-01-31",
"tax_identifier": {
  "tax_authority": "IRS",
  "tax_payer_id": "string"
}
10}

Was this helpful?

OrganizationalEntity

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

name

requiredstring

Name of the organization represented.

structure

string

Type of business structure.

Possible values: sole, partnership, llc, corp

mcc

string

The ISO-18245 merchant category code for this business.

Pattern: ^\d{4}$

owner_identity_ids

[string]

The identities of the organization owner(s).

tax_identifier

object

The tax authority ID.

tax_authority

string

Name of the tax authority.

tax_payer_id

string

The tax payer ID, e.g. EIN, TIN, SSN.

country

string

The national jurisdiction of the tax authority in ISO 3166-1 format.

subdivision

string

If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.

API Object
1{
"name": "Doe Business, Inc.",
"structure": "sole",
"mcc": 5542,
"owner_identity_ids": [
  "6gXfjEcgqcjTVnUgbTwDF3DTeiQ"
],
"tax_identifier": {
  "tax_authority": "IRS",
  "tax_payer_id": "string",
  "country": "US"
}
13}

Was this helpful?

USBusinessStructure

Enumeration of business structures in the U.S.

sole

string

Sole proprietorship.

partnership

string

Partnership, e.g. limited partnership, general partnership.

llc

string

Limited liability company.

corp

string

C-corp, S-corp, not-for-profit, etc.

Was this helpful?

TaxIdentifier

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

tax_authority

requiredstring

Name of the tax authority.

tax_payer_id

requiredstring

The tax payer ID, e.g. EIN, TIN, SSN.

country

requiredstring

The national jurisdiction of the tax authority in ISO 3166-1 format.

subdivision

string

If the tax authority is subnational, the ISO 3166-2 subdivision of the authority's jurisdiction. This is usually a state, province, or department.

API Object
1{
2  "tax_authority": "IRS",
3  "tax_payer_id": "string",
4  "country": "US",
5  "subdivision": ""
6}

Was this helpful?

Transaction

BaseTransaction

Base properties for all transactions.

id

requiredstring

Permanent, unique transaction identifier. Must survive changes to pending status or amount.

account_id

requiredstring

References to the account that this transaction is posting against.

description

requiredstring

Description of the transaction.
Nullable: true

memo

string

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_balance

string

The balance of the account after this transaction posts.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

transacted_at

requiredstring

The date/time when the transaction was authorized, in the time zone local to the transaction or to the customer.

Format: date-time

settled_at

requiredstring

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

Format: date-time

spender_identity_id

string

Reference to the identity of the authorized spender who conducted this transaction.

merchant_identity_id

string

Reference to the identity of the merchant related to this transaction.

geolocation

object

Geographic location where this transaction occurs.

coordinates

object

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

lat

number

Latitude coordinate.

lon

number

Longitude coordinate.

city

string

City name.

region

string

Region identifier.

country

string

Country identifier.

reward_currency

string

The ISO 4217 currency in which this transaction's reward contribution is denominated. example: USD

reward_non_iso_currency

string

If the reward contribution is denominated in a non-ISO currency, provide the currency's symbol.

currency

string

The ISO 4217 currency in which this transaction is denominated. One of either the currency or non_iso_currency fields is required.

non_iso_currency

string

If the transaction is denominated in a non-ISO currency, provide the currency's symbol.

API Object
1{
"id": "6AOU0jwFQw3sMZJ",
"account_id": 100273,
"description": "Finance Charge",
"memo": "Check #318",
"category": [
  "electronics",
  "desktop",
  "accessories"
],
"tags": [
  "electronics",
  "accessories"
],
"ending_balance": "100.95",
"transacted_at": "2019-08-22T14:15:22Z",
"settled_at": "2019-08-25T08:15:42Z",
"spender_identity_id": "uid_1234",
"merchant_identity_id": "amazon_880",
"geolocation": {
  "coordinates": {
    "lat": 40.7128,
    "lon": 74.006
  },
  "city": "New York",
  "region": "US-NY",
  "country": "US"
},
"reward_non_iso_currency": null,
"currency": "USD",
"non_iso_currency": null
32}

Was this helpful?

DepositoryOrCreditTransaction

Describes a transaction against a depository or credit card account.

type

string

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

Possible values: transfer, cash, fee, purchase, interest, deposit

pending

requiredboolean

Indicates that this transaction has not posted.

amount

requiredstring

The amount of the transaction. Use a positive amount for transactions where money is flowing out of the account, and a negative amount for those where money flows into the account.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

fee_amount

string

The amount of fees associated with this transaction.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

reward_amount

string

The amount of rewards associated with this transaction.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

reward_rate

string

The effective rate of reward for this transaction.

Pattern: ^\d*(\.\d{1,4})?$

transfer_account_id

string

If this transaction is an internal transfer type, references the account_id associated with this transaction.

method

string

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

Possible values: card present, card not present, check, eft

id

requiredstring

Permanent, unique transaction identifier. Must survive changes to pending status or amount.

account_id

requiredstring

References to the account that this transaction is posting against.

description

requiredstring

Description of the transaction.
Nullable: true

memo

string

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_balance

string

The balance of the account after this transaction posts.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

transacted_at

requiredstring

The date/time when the transaction was authorized, in the time zone local to the transaction or to the customer.

Format: date-time

settled_at

requiredstring

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

Format: date-time

spender_identity_id

string

Reference to the identity of the authorized spender who conducted this transaction.

merchant_identity_id

string

Reference to the identity of the merchant related to this transaction.

geolocation

object

Geographic location where this transaction occurs.

coordinates

object

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

lat

number

Latitude coordinate.

lon

number

Longitude coordinate.

city

string

City name.

region

string

Region identifier.

country

string

Country identifier.

reward_currency

string

The ISO 4217 currency in which this transaction's reward contribution is denominated. example: USD

reward_non_iso_currency

string

If the reward contribution is denominated in a non-ISO currency, provide the currency's symbol.

currency

string

The ISO 4217 currency in which this transaction is denominated. One of either the currency or non_iso_currency fields is required.

non_iso_currency

string

If the transaction is denominated in a non-ISO currency, provide the currency's symbol.

API Object
1{
"type": "purchase",
"pending": false,
"amount": "100.95",
"fee_amount": "0",
"reward_amount": "2.01",
"reward_rate": "0.0199",
"transfer_account_id": null,
"method": "card present",
"id": "6AOU0jwFQw3sMZJ",
"account_id": "account1234",
"description": "Finance Charge",
"memo": "Check #318",
"category": [
  "grocery",
  "meat"
],
"tags": [
  "grocery"
],
"ending_balance": "100.95",
"transacted_at": "2019-08-24T14:15:22Z",
"settled_at": "2019-08-25T08:45:03Z",
"spender_identity_id": "uid_1234",
"merchant_identity_id": "target",
"geolocation": {
  "coordinates": {
    "lat": 40.7128,
    "lon": 74.006
  },
  "city": "New York",
  "region": "US-NY",
  "country": "US"
},
"reward_currency": "USD",
"reward_non_iso_currency": null,
"currency": "USD",
"non_iso_currency": null
39}

Was this helpful?

DepositoryOrCreditTransactionType

Classification of DepositoryOrCreditTransaction by purpose as an enum.

transfer

string

A transfer between accounts, or balance transfer (for credit cards).

cash

string

Cash withdrawal, or cash advance (for credit cards) including check drafts.

fee

string

Finance charges, or fees associated with account management, e.g. ATM fees, overdraft charges, etc.

purchase

string

Ordinary purchase activity, subject to the purchase APR (for credit cards).

interest

string

Interest earned, not finance charges on carried balance (use fee).

deposit

string

Cash or electronic deposit from an external account, not a transfer; or a payment (for credit cards).

Was this helpful?

DepositoryOrCreditTransactionMethod

Classification of DepositoryOrCreditTransaction by method.

card present

string

Transaction was conducted by a physical payment card interaction (e.g. swipe, chip-and-sign, contactless).

card not present

string

Card was not physically present for transaction (e.g. online or phone order).

check

string

Check drafted against account.

eft

string

Electronic funds transfer.

Was this helpful?

InvestmentTransaction

Describes a transaction in an investment account.

amount

requiredstring

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

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

type

requiredstring

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

Possible values: buy, sell, cash, fee, transfer, purchase, interest, deposit

security_id

requiredstring

Reference to the security that the transaction is posting for.

quantity

requiredstring

The quantity of the security involved in this transaction.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

price

requiredstring

The price of the security at which the transaction occured.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

fees

string

The total combined fees associated with this transaction.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

status

requiredstring

Status of an InvestmentTransaction. pending: The trade is in progress, or transfer is pending. settled: The transaction has completed. cancelled: The transaction was cancelled, or represents the cancelled portion of a previous order.

Possible values: pending, settled, cancelled

cancel_transaction_id

string

If the status is cancelled, but this transaction represents the unfulfilled portion of a partially filled order, provide the transaction_id of the transaction representing the filled portion.

id

requiredstring

Permanent, unique transaction identifier. Must survive changes to pending status or amount.

account_id

requiredstring

References to the account that this transaction is posting against.

description

requiredstring

Description of the transaction.
Nullable: true

memo

string

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_balance

string

The balance of the account after this transaction posts.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

transacted_at

requiredstring

The date/time when the transaction was authorized, in the time zone local to the transaction or to the customer.

Format: date-time

settled_at

requiredstring

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

Format: date-time

spender_identity_id

string

Reference to the identity of the authorized spender who conducted this transaction.

merchant_identity_id

string

Reference to the identity of the merchant related to this transaction.

geolocation

object

Geographic location where this transaction occurs.

coordinates

object

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

lat

number

Latitude coordinate.

lon

number

Longitude coordinate.

city

string

City name.

region

string

Region identifier.

country

string

Country identifier.

reward_currency

string

The ISO 4217 currency in which this transaction's reward contribution is denominated. example: USD

reward_non_iso_currency

string

If the reward contribution is denominated in a non-ISO currency, provide the currency's symbol.

currency

string

The ISO 4217 currency in which this transaction is denominated. One of either the currency or non_iso_currency fields is required.

non_iso_currency

string

If the transaction is denominated in a non-ISO currency, provide the currency's symbol.

API Object
1{
"value": {
  "amount": "100.95",
  "type": "buy",
  "security_id": "string",
  "quantity": "100.95",
  "price": "100.95",
  "fees": "100.95",
  "status": "settled",
  "cancel_transaction_id": "string",
  "id": "6AOU0jwFQw3sMZJ",
  "account_id": "account_1234",
  "description": "Finance Charge",
  "memo": "Check #318",
  "category": [
    "electronics",
    "desktop",
    "accessories"
  ],
  "tags": [
    "electronics",
    "desktop"
  ],
  "ending_balance": "100.95",
  "transacted_at": "2019-08-24T14:15:22Z",
  "settled_at": "2019-08-25T08:15:42Z",
  "spender_identity_id": "uid_1234",
  "merchant_identity_id": null,
  "geolocation": {
    "coordinates": {
      "lat": 40.7128,
      "lon": 74.006
    },
    "city": "New York",
    "region": "US-NY",
    "country": "US"
  },
  "reward_currency": "USD",
  "reward_non_iso_currency": null,
  "currency": "USD",
  "non_iso_currency": null
},
"description": "Classification of `InvestmentTransaction` by purpose."
44}

Was this helpful?

InvestmentTransactionType

Classification of InvestmentTransaction by purpose.

buy

string

Activity increasing the quantity of a holding.

cash

string

Activity modifying the account’s cash position.

fee

string

Fees on the account, e.g. commission, bookkeeping, options-related charges.

sell

string

Activity decreasing the quantity of a holding.

transfer

string

Activity which modifies a position, outside of buying/selling activity e.g., options exercise, portfolio transfer.

purchase

string

Ordinary purchase activity, subject to the purchase APR (for credit cards).

interest

string

Interest earned, not finance charges on carried balance (use fee).

deposit

string

Cash or electronic deposit from an external account, not a transfer; or a payment (for credit cards).

Was this helpful?

InvestmentTransactionStatus

Status of an InvestmentTransaction.

pending

string

The trade is in progress, or transfer is pending.

settled

string

The transaction has completed.

cancelled

string

The transaction was cancelled, or represents the cancelled portion of a previous order.

Was this helpful?

LoanTransaction

Describes a transaction in a loan account.

amount

requiredstring

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

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

type

string

Classification of LoanTransaction by purpose or effect. payment: The transaction describes a payment on the loan. principal: The transaction advances or reduces the principal. interest: The transaction advances or reduces interest. adjustment: The transaction adjusts the loan’s balances, unrelated to a loan payment.

Possible values: pending, settled, cancelled

principal_amount

requiredstring

The amount affecting the principal balance.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

interest_amount

requiredstring

The amount affecting the interest balance.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

escrow_amount

string

The amount affecting the escrow account (mortgages only, required.)

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

id

requiredstring

Permanent, unique transaction identifier. Must survive changes to pending status or amount.

account_id

requiredstring

References to the account that this transaction is posting against.

description

requiredstring

Description of the transaction.
Nullable: true

memo

string

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_balance

string

The balance of the account after this transaction posts.

Pattern: ^-?(\d*)(?:\.\d{1,2})?$

transacted_at

requiredstring

The date/time when the transaction was authorized, in the time zone local to the transaction or to the customer.

Format: date-time

settled_at

requiredstring

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

Format: date-time

spender_identity_id

string

Reference to the identity of the authorized spender who conducted this transaction.

merchant_identity_id

string

Reference to the identity of the merchant related to this transaction.

geolocation

object

Geographic location where this transaction occurs.

coordinates

object

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

lat

number

Latitude coordinate.

lon

number

Longitude coordinate.

city

string

City name.

region

string

Region identifier.

country

string

Country identifier.

reward_currency

string

The ISO 4217 currency in which this transaction's reward contribution is denominated. example: USD

reward_non_iso_currency

string

If the reward contribution is denominated in a non-ISO currency, provide the currency's symbol.

currency

string

The ISO 4217 currency in which this transaction is denominated. One of either the currency or non_iso_currency fields is required.

non_iso_currency

string

If the transaction is denominated in a non-ISO currency, provide the currency's symbol.

API Object
1{
"amount": "100.95",
"type": "payment",
"principal_amount": "100.95",
"interest_amount": "2.95",
"escrow_amount": "1.95",
"id": "6AOU0jwFQw3sMZJ",
"account_id": "account1234",
"description": "Finance Charge",
"memo": "Check #318",
"category": [
  "electronics",
  "desktop",
  "accessories"
],
"tags": [
  "electronics",
  "desktop"
],
"ending_balance": "100.95",
"transacted_at": "2019-08-24T14:15:22Z",
"settled_at": "2019-08-25T08:15:42Z",
"spender_identity_id": "uid_1234",
"merchant_identity_id": "apex_rentals_091",
"geolocation": {
  "coordinates": {
    "lat": 40.7128,
    "lon": 74.006
  },
  "city": "New York",
  "region": "US-NY",
  "country": "US"
},
"reward_currency": "USD",
"reward_non_iso_currency": null,
"currency": "USD",
"non_iso_currency": null
38}

Was this helpful?

LoanTransactionType

Classification of LoanTransaction by purpose or effect.

payment

string

The transaction describes a payment on the loan.

principal

string

The transaction advances or reduces the principal.

interest

string

The transaction advances or reduces interest.

adjustment

string

The transaction adjusts the loan’s balances, unrelated to a loan payment.

Was this helpful?

Acquisition

PlaidProductDataType

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

ACCOUNT_BALANCE

string

Balance for each of the user's accounts. Used in various Plaid products, such as Auth.

ACCOUNT_TRANSACTIONS

string

Historical and current transactions for each of the user's accounts. Used in the Plaid Transactions product.

ACCOUNT_USER_INFO

string

User's personally identifying information, including account and routing numbers. Used in the Plaid Identity product.

Was this helpful?

PlaidProduct

Plaid products that a PlaidApplication uses.

auth

string

Auth, funds transfer principals.

identity

string

Identity, personally identifying information

transactions

string

Transactions, historical and current.

Was this helpful?

NewAccountApplicant

Describes an application to open a new bank account.

id

string

The ID of this applicant.

identity

string

The FullIdentity of the applicant.

funding_transfer_code

string

The transfer code for the funding account if applicant opts to fund the account on opening.'

funding_amount

string

The amount to transfer into the account upon opening.

Was this helpful?

Application

Describes a Plaid-powered application.

application_id

requiredstring

The application’s unique ID.

name

requiredstring

The name of the application.

logo

string

A URL that links to the application logo image.

application_url

string

A URL that links to the application’s website.

reason_for_access

string

A string provided by the connected app stating why they use their respective enabled products.

API Object
1{
2  "application_id": "123123-123123-application_id",
3  "name": "App Name",
4  "logo": "https://www.plaid.com/logo",
5  "application_url": "https://www.application.com",
6  "reason_for_access": "Need balance"
7}

Was this helpful?

ConnectedApplication

Scope

Scopes

The scopes object

product_access

object

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

statements

boolean

Allow access to statements.

Default: true

identity

boolean

Allow access to the Identity product (name, email, phone, address).

Default: true

auth

boolean

Allow access to account number details.

Default: true

transactions

boolean

Allow access to transaction details.

Default: true

accounts

array

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

Min items: 1

new_accounts

boolean

Allow access to newly opened accounts as they are opened.

Default: true

API Object
1{
"product_access": {
  "identity": false,
  "statement": false,
  "auth": true,
  "transactions": false
},
"accounts": [
  {
    "unique_id": "915ace15f",
    "selected": true
  },
  {
    "unique_id": "1512343cc",
    "selected": true
  }
],
"new_accounts": true
19}

Was this helpful?

RequestedScope

AccountSelectionCardinality

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

enum_values

string

Enum values

Possible values: SINGLE_SELECT, MULTI_SELECT, ALL

Was this helpful?

AccountAccess

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

unique_id

requiredstring

The unique account identifier for this account. This value must match that returned by the data access API for this account. Do not use a full or masked account number for this value as this increases the risk of revealing Personally Identifiable Information (PII).

authorized

boolean

Allow the application to see this account (and associated details, including balance) in the list of accounts.

Default: true

API Object
1{
2  "unique_id": "abc1241f975",
3  "authorized": true
4}

Was this helpful?

AccountFilter

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

depository

Depository subtypes required.

subtypes

string

List of account subtypes.

credit

AccountFilterSubtypes

Credit subtypes required.

subtypes

string

List of account subtypes.

loan

AccountFilterSubtypes

Loan subtypes required.

subtypes

string

List of account subtypes.

investment

AccountFilterSubtypes

Investment subtypes required.

subtypes

string

List of account subtypes.

API Object
1{
2  "depository": {
3    "account_subtypes": [
4      "checking",
5      "savings"
6    ]
7  }
8}

Was this helpful?

AccountFilterSubtypes

A list of account subtypes to be filtered.

subtypes

string

List of account subtypes.

API Object
1[
2  "checking",
3  "savings"
4]

Was this helpful?

ProductAccess

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

statements

boolean

Allow access to statements.

Default: true

identity

boolean

Allow access to the Identity product (name, email, phone, address).

Default: true

auth

boolean

Allow access to account number details.

Default: true

transactions

boolean

Allow access to transaction details.

Default: true

API Object
1{
2  "auth": true,
3  "identity": false,
4  "statements": false,
5  "transactions": false
6}

Was this helpful?

Errors

BasicError

Generic error object.

id

requiredstring

Opaque identifier, expected to be consistent for errors which have the same cause.

message

requiredstring

Brief description of the error, intended for display purposes. Under certain conditions, Plaid may modify or replace the message e.g. in response to suspicious user activity.

API Object
1{
2  "id": "E00001",
3  "message": "string"
4}

Was this helpful?

AuthenticationError

Authentication-specific error object.

reason

requiredstring

Reason code for authentication failures.

Possible values: credentials, configuration, mfa, not permitted, unsupported, other

id

requiredstring

Opaque identifier, expected to be consistent for errors which have the same cause.

message

requiredstring

Brief description of the error, intended for display purposes. Under certain conditions, Plaid may modify or replace the message e.g. in response to suspicious user activity.

API Object
1{
2  "reason": "credentials",
3  "id": "E00001",
4  "message": "The submitted credentials are not valid."
5}

Was this helpful?

InstitutionError

Error schema for planned institution downtime.

retry_at

string

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

Format: date-time

id

requiredstring

Opaque identifier, expected to be consistent for errors which have the same cause.

message

requiredstring

Brief description of the error, intended for display purposes. Under certain conditions, Plaid may modify or replace the message e.g. in response to suspicious user activity.

API Object
1{
2  "retry_at": "2020-10-02T00:15:00.000+0000",
3  "id": "E00001",
4  "message": "string"
5}