Data Dictionary

string

ISO 3166-2 sub-national region identifier.

string

ISO 3166-1 two-character country identifier.

API Object
Copy
1{
2  "coordinates": {
3    "lat": 41.8574,
4    "lon": -71.39862
5  },
6  "city": "New York",
7  "region": "US-NY",
8  "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
Copy
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: and 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).

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

string

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

Possible values: individual, joint, association, trust

required[string]

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

[string]

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

requiredstring

Status of an account.

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

type

requiredstring

Major classification of this account.

Possible values: depository, loan, investment

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.

requiredstring

The account's marketing or brand name.

requiredstring

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

string

The date on which the account was opened.

Format: date

requiredstring

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

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

requiredstring

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

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

boolean

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

string

ISO 4217 currency code.

string

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

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

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

string

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

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

transfer_codes

requiredobject

Mapping between an account and various payment networks.

ach

object

Base model for depository account transfer identifiers.

string

The account number.

string

The ABA routing transit number.

string

The institution's routing number for wire transfer.

boolean

Indicates account may be debited using transfer code.

boolean

Indicates account may be credited using transfer code.

eft

object

Base model for depository account transfer identifiers.

string

The account number.

string

The institution's number assigned by Payments Canada.

string

The branch number corresponding to the account.

boolean

Indicates account may be debited using transfer code.

boolean

Indicates account may be credited using transfer code.

iban

object

Base model for depository account transfer identifiers.

string

The full IBAN.

string

Bank identifier.

string

The country code.

string

Location code for the bank's office.

string

Optionally indicate a specific branch.

boolean

Indicates account may be debited using transfer code.

boolean

Indicates account may be credited using transfer code.

payment_card

object

Base model for depository account transfer identifiers.

string

The payment card number.

string

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

string

Year of card expiration.

string

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

boolean

Indicates account may be debited using transfer code.

boolean

Indicates account may be credited using transfer code.

acats

object

Base model for depository account transfer identifiers.

string

The account number.

object

A lightweight identity container suitable for passing minimal identification.

object

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

name

string

Name of the organization represented.

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}$

[string]

The identities of the organization owner(s).

object

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

string

Name of the tax authority.

string

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

string

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

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.

object

Describes an individual, named person.

string

Legal given name of the personal entity.

string

Middle name, use blank if none.

string

Last name or family name.

string

The date of birth in ISO-8601 format.

Format: date

object

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

string

Name of the tax authority.

string

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

string

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

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.

string

The email address where this entity can be contacted.

object

Description of a street address.

[string]

The lines of the street address.

Min items: 1

city

string

The city of the mailing address.

string

ISO 3166-2 sub-national region identifier.

string

ISO 3166-1 two-character country identifier.

string

The postal code.

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)

[string]

The DTCC institution identifiers for the institution holding the account.

Min items: 1

boolean

Indicates account may be debited using transfer code.

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.

string

The opening date of this statement period.

Format: date

string

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

Format: date

balance

string

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

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

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).

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

string

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

Possible values: individual, joint, association, trust

required[string]

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

[string]

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

requiredstring

Status of an account.

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

type

requiredstring

Major classification of this account.

Possible values: depository, loan, investment

requiredstring

Minor classification of this account.

name

string

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

requiredstring

The account's marketing or brand name.

requiredstring

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

string

The date on which the account was opened.

Format: date

requiredstring

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

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

requiredstring

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

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

boolean

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

string

ISO 4217 currency code.

string

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

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

string

The opening date of this statement period.

Format: date

string

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

Format: date

balance

string

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

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

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
Copy
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

Base model for depository account transfer identifiers.

string

The account number.

string

The ABA routing transit number.

string

The institution's routing number for wire transfer.

boolean

Indicates account may be debited using transfer code.

boolean

Indicates account may be credited using transfer code.

eft

object

Base model for depository account transfer identifiers.

string

The account number.

string

The institution's number assigned by Payments Canada.

string

The branch number corresponding to the account.

boolean

Indicates account may be debited using transfer code.

boolean

Indicates account may be credited using transfer code.

iban

object

Base model for depository account transfer identifiers.

string

The full IBAN.

string

Bank identifier.

string

The country code.

string

Location code for the bank's office.

string

Optionally indicate a specific branch.

boolean

Indicates account may be debited using transfer code.

boolean

Indicates account may be credited using transfer code.

payment_card

object

Base model for depository account transfer identifiers.

string

The payment card number.

string

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

string

Year of card expiration.

string

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

boolean

Indicates account may be debited using transfer code.

boolean

Indicates account may be credited using transfer code.

acats

object

Base model for depository account transfer identifiers.

string

The account number.

object

A lightweight identity container suitable for passing minimal identification.

object

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

name

string

Name of the organization represented.

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}$

[string]

The identities of the organization owner(s).

object

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

string

Name of the tax authority.

string

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

string

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

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.

object

Describes an individual, named person.

string

Legal given name of the personal entity.

string

Middle name, use blank if none.

string

Last name or family name.

string

The date of birth in ISO-8601 format.

Format: date

object

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

string

Name of the tax authority.

string

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

string

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

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.

string

The email address where this entity can be contacted.

object

Description of a street address.

[string]

The lines of the street address.

Min items: 1

city

string

The city of the mailing address.

string

ISO 3166-2 sub-national region identifier.

string

ISO 3166-1 two-character country identifier.

string

The postal code.

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)

[string]

The DTCC institution identifiers for the institution holding the account.

Min items: 1

boolean

Indicates account may be debited using transfer code.

boolean

Indicates account may be credited using transfer code.

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

requiredboolean

Indicates account may be debited using transfer code.

requiredboolean

Indicates account may be credited using transfer code.

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

Was this helpful?

AchTransferCode

Base model for depository account transfer identifiers.

requiredstring

The account number.

requiredstring

The ABA routing transit number.

string

The institution's routing number for wire transfer.

requiredboolean

Indicates account may be debited using transfer code.

requiredboolean

Indicates account may be credited using transfer code.

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

Base model for depository account transfer identifiers.

requiredstring

The account number.

requiredstring

The institution's number assigned by Payments Canada.

requiredstring

The branch number corresponding to the account.

requiredboolean

Indicates account may be debited using transfer code.

requiredboolean

Indicates account may be credited using transfer code.

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

Base model for depository account transfer identifiers.

requiredstring

The full IBAN.

requiredstring

Bank identifier.

requiredstring

The country code.

requiredstring

Location code for the bank's office.

string

Optionally indicate a specific branch.

requiredboolean

Indicates account may be debited using transfer code.

requiredboolean

Indicates account may be credited using transfer code.

API Object
Copy
1{
2  "account_number": "string",
3  "bank_code": "NORD",
4  "country_code": "FR",
5  "location_code": "ZZ",
6  "branch_code": "80A",
7  "supports_debit": true,
8  "supports_credit": true
9}

Was this helpful?

PaymentCardTransferCode

Base model for depository account transfer identifiers.

requiredstring

The payment card number.

requiredstring

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

requiredstring

Year of card expiration.

requiredstring

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

requiredboolean

Indicates account may be debited using transfer code.

requiredboolean

Indicates account may be credited using transfer code.

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

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

requiredstring

The account’s marketing or brand name.

string

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

string

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

API Object
Copy
1{
2  "id": "R13oiR6lC5jNC5jK",
3  "type": "depository",
4  "subtype": "checking",
5  "name": "Vacation money",
6  "official_name": "Pro Checking",
7  "currency": "USD",
8  "non_iso_currency": null
9}

Was this helpful?

InvestmentAccount

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

transfer_codes

object

Mapping between an account and various payment networks.

ach

object

Base model for depository account transfer identifiers.

string

The account number.

string

The ABA routing transit number.

string

The institution's routing number for wire transfer.

boolean

Indicates account may be debited using transfer code.

boolean

Indicates account may be credited using transfer code.

eft

object

Base model for depository account transfer identifiers.

string

The account number.

string

The institution's number assigned by Payments Canada.

string

The branch number corresponding to the account.

boolean

Indicates account may be debited using transfer code.

boolean

Indicates account may be credited using transfer code.

iban

object

Base model for depository account transfer identifiers.

string

The full IBAN.

string

Bank identifier.

string

The country code.

string

Location code for the bank's office.

string

Optionally indicate a specific branch.

boolean

Indicates account may be debited using transfer code.

boolean

Indicates account may be credited using transfer code.

payment_card

object

Base model for depository account transfer identifiers.

string

The payment card number.

string

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

string

Year of card expiration.

string

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

boolean

Indicates account may be debited using transfer code.

boolean

Indicates account may be credited using transfer code.

acats

object

Base model for depository account transfer identifiers.

string

The account number.

object

A lightweight identity container suitable for passing minimal identification.

object

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

name

string

Name of the organization represented.

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}$

[string]

The identities of the organization owner(s).

object

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

string

Name of the tax authority.

string

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

string

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

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.

object

Describes an individual, named person.

string

Legal given name of the personal entity.

string

Middle name, use blank if none.

string

Last name or family name.

string

The date of birth in ISO-8601 format.

Format: date

object

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

string

Name of the tax authority.

string

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

string

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

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.

string

The email address where this entity can be contacted.

object

Description of a street address.

[string]

The lines of the street address.

Min items: 1

city

string

The city of the mailing address.

string

ISO 3166-2 sub-national region identifier.

string

ISO 3166-1 two-character country identifier.

string

The postal code.

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)

[string]

The DTCC institution identifiers for the institution holding the account.

Min items: 1

boolean

Indicates account may be debited using transfer code.

boolean

Indicates account may be credited using transfer code.

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})?$

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

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

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

margin_limit

string

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

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

margin_equity

string

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

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

maintenance_margin

string

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

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

buying_power

string

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

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

current_as_of

string

The time at which current_balance was current.

Format: date-time

holdings

required[object]

Descriptions of held assets in the account.

security_id

string

The identifier of the security referenced by this holding.

cost_basis

string

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

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

string

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

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

lots

object

Describes taxable lots of shares within a Holding.

id

string

The unique and permanent identifier for this lot.

acquired_at

string

The date at which the lot was acquired.

Format: date

acquired_price

string

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

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

string

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

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

string

ISO 4217 currency code.

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).

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

string

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

Possible values: individual, joint, association, trust

required[string]

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

[string]

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

requiredstring

Status of an account.

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

type

requiredstring

Major classification of this account.

Possible values: depository, loan, investment

requiredstring

Minor classification of this account.

name

string

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

requiredstring

The account's marketing or brand name.

requiredstring

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

string

The date on which the account was opened.

Format: date

boolean

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

string

ISO 4217 currency code.

string

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

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

Base model for depository account transfer identifiers.

requiredstring

The account number.

requiredobject

A lightweight identity container suitable for passing minimal identification.

object

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

name

string

Name of the organization represented.

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}$

[string]

The identities of the organization owner(s).

object

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

string

Name of the tax authority.

string

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

string

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

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.

object

Describes an individual, named person.

string

Legal given name of the personal entity.

string

Middle name, use blank if none.

string

Last name or family name.

string

The date of birth in ISO-8601 format.

Format: date

object

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

string

Name of the tax authority.

string

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

string

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

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.

string

The email address where this entity can be contacted.

object

Description of a street address.

[string]

The lines of the street address.

Min items: 1

city

string

The city of the mailing address.

string

ISO 3166-2 sub-national region identifier.

string

ISO 3166-1 two-character country identifier.

string

The postal code.

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)

required[string]

The DTCC institution identifiers for the institution holding the account.

Min items: 1

requiredboolean

Indicates account may be debited using transfer code.

requiredboolean

Indicates account may be credited using transfer code.

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

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

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

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

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

string

ISO 4217 currency code.

string

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

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

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

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

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

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

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

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

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

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

string

ISO 4217 currency code.

string

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

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

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

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

requiredstring

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

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

lots

object

Describes taxable lots of shares within a Holding.

id

string

The unique and permanent identifier for this lot.

acquired_at

string

The date at which the lot was acquired.

Format: date

acquired_price

string

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

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

string

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

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

string

ISO 4217 currency code.

string

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

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

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

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

requiredstring

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

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

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

Was this helpful?

LoanAccount

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

string

The account number for this loan.

reference_number

string

The loan's reference number.

servicer_identity_id

string

Reference to the udentity of the loan servicer.

requiredstring

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

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

payment_paid_to_principal

string

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

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

term_months

integer

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

Minimum: 0

term_days

integer

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

Minimum: 0

repayment_status

requiredstring

The loan's repayment status.

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

principal_balance

requiredstring

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

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

payoff_quote

string

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

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

payoff_expiry

string

The date until which payoff_quote is considered current.

Format: date

origination_date

requiredstring

The loan's date of origination.

Format: date

origination_principal

string

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

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

maturity_date

string

The loan's date of maturity.

Format: date

statements

[object]

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

string

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

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

payment_paid_to_interest

string

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

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

string

The opening date of this statement period.

Format: date

payment_received_amount

string

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

Format: date

balance_due

string

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

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

minimum_payment_due

string

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

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

payment_due_date

string

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

Format: date

payment_received_date

string

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

Format: date

string

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

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

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).

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

string

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

Possible values: individual, joint, association, trust

required[string]

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

[string]

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

requiredstring

Status of an account.

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

type

requiredstring

Major classification of this account.

Possible values: depository, loan, investment

requiredstring

Minor classification of this account.

name

string

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

requiredstring

The account's marketing or brand name.

requiredstring

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

string

The date on which the account was opened.

Format: date

requiredstring

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

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

requiredstring

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

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

boolean

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

string

ISO 4217 currency code.

payment_paid_to_principal

string

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

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

string

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

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

payment_paid_to_interest

string

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

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

requiredstring

The opening date of this statement period.

Format: date

payment_received_amount

requiredstring

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

Format: date

balance_due

requiredstring

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

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

minimum_payment_due

requiredstring

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

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

requiredstring

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

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

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
Copy
1{
2  "open_date": "2018-08-28",
3  "close_date": "2018-08-28",
4  "balance_due": "100.95",
5  "minimum_payment_due": "100.95",
6  "payment_due_date": "2018-08-28",
7  "payment_received_date": "2018-08-28",
8  "payment_received_amount": "100.95",
9  "document_url": "string"
10}

Was this helpful?

InterestRateType

Interest rate adjustment schemes.

fixed

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

requiredstring

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

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

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

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

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).

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

string

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

Possible values: individual, joint, association, trust

required[string]

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

[string]

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

requiredstring

Status of an 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.

requiredstring

The account's marketing or brand name.

requiredstring

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

string

The date on which the account was opened.

Format: date

requiredstring

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

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

requiredstring

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

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

boolean

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

string

ISO 4217 currency code.

string

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

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

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

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

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

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

guarantor_identity

object

A lightweight identity container suitable for passing minimal identification.

object

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

name

string

Name of the organization represented.

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}$

[string]

The identities of the organization owner(s).

object

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

string

Name of the tax authority.

string

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

string

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

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.

object

Describes an individual, named person.

string

Legal given name of the personal entity.

string

Middle name, use blank if none.

string

Last name or family name.

string

The date of birth in ISO-8601 format.

Format: date

object

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

string

Name of the tax authority.

string

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

string

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

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.

string

The email address where this entity can be contacted.

object

Description of a street address.

[string]

The lines of the street address.

Min items: 1

city

string

The city of the mailing address.

string

ISO 3166-2 sub-national region identifier.

string

ISO 3166-1 two-character country identifier.

string

The postal code.

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

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

Minimum: 0

total_payments

integer

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

Minimum: 0

sequence_number

string

The loan's sequence number.

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).

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

string

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

Possible values: individual, joint, association, trust

required[string]

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

[string]

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