An object representing an Asset Report

A unique ID identifying an Asset Report. Like all Plaid identifiers, this ID is case sensitive.

An identifier you determine and submit for the Asset Report.

The date and time when the Asset Report was created, in ISO 8601 format (e.g. “2018-04-12T03:32:11Z”).

The duration of transaction history you requested

The user object allows you to provide additional information about the user to be appended to the Asset Report. All fields are optional. The first_name, last_name, and ssn fields are required if you would like the Report to be eligible for Fannie Mae’s Day 1 Certainty™ program.

An identifier you determine and submit for the user. If using the Credit Dashboard, Customers should pass in the user_token created in /user/create.

The user’s first name. Required for the Fannie Mae Day 1 Certainty™ program.

The user’s middle name

The user’s last name. Required for the Fannie Mae Day 1 Certainty™ program.

The user’s Social Security Number. Required for the Fannie Mae Day 1 Certainty™ program. Format: “ddd-dd-dddd”

The user’s phone number, in E.164 format: +{countrycode}{number}. For example: “+14151234567”. Phone numbers provided in other formats will be parsed on a best-effort basis.

The user’s email address.

Data returned by Plaid about each of the Items included in the Asset Report.

The item_id of the Item associated with this webhook, warning, or error

The full financial institution name associated with the Item.

The id of the financial institution associated with the Item.

The date and time when this Item’s data was last retrieved from the financial institution, in ISO 8601 format.

Data about each of the accounts open on the Item.

Plaid’s unique identifier for the account. This value will not change unless Plaid can’t reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new account_id will be assigned to the account. The account_id can also change if the access_token is deleted and the same credentials that were used to generate that access_token are used to generate a new access_token on a later date. In that case, the new account_id will be different from the old account_id. If an account with a specific account_id disappears instead of changing, the account is likely closed. Closed accounts are not returned by the Plaid API. Like all Plaid identifiers, the account_id is case sensitive.

A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by /accounts/balance/get.

The amount of funds available to be withdrawn from the account, as determined by the financial institution. For credit-type accounts, the available balance typically equals the limit less the current balance, less any pending outflows plus any pending inflows. For depository-type accounts, the available balance typically equals the current balance less any pending outflows plus any pending inflows. For depository-type accounts, the available balance does not include the overdraft limit. For investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier), the available balance is the total cash available to withdraw as presented by the institution. Note that not all institutions calculate the available balance. In the event that available balance is unavailable, Plaid will return an available balance value of null. Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by /accounts/balance/get. If current is null this field is guaranteed not to be null.

The total amount of funds in or owed by the account. For credit-type accounts, a positive balance indicates the amount owed; a negative amount indicates the lender owing the account holder. For loan-type accounts, the current balance is the principal remaining on the loan, except in the case of student loan accounts at Sallie Mae (ins_116944). For Sallie Mae student loans, the account’s balance includes both principal and any outstanding interest. For investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier), the current balance is the total value of assets as presented by the institution. Note that balance information may be cached unless the value was returned by /accounts/balance/get; if the Item is enabled for Transactions, the balance will be at least as recent as the most recent Transaction update. If you require realtime balance information, use the available balance as provided by /accounts/balance/get. When returned by /accounts/balance/get, this field may be null. When this happens, available is guaranteed not to be null.

For credit-type accounts, this represents the credit limit. For depository-type accounts, this represents the pre-arranged overdraft limit, which is common for current (checking) accounts in Europe. In North America, this field is typically only available for credit-type accounts.

The total amount of borrowed funds in the account, as determined by the financial institution. For investment-type accounts, the margin balance is the total value of borrowed assets in the account, as presented by the institution. This is commonly referred to as margin or a loan.

The ISO-4217 currency code of the balance. Always null if unofficial_currency_code is non-null.

The unofficial currency code associated with the balance. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the currency code schema for a full listing of supported unofficial_currency_codes.

Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the oldest acceptable balance when making a request to /accounts/balance/get. This field is only used and expected when the institution is ins_128026 (Capital One) and the Item contains one or more accounts with a non-depository account type, in which case a value must be provided or an INVALID_REQUEST error with the code of INVALID_FIELD will be returned. For Capital One depository accounts as well as all other account types on all other institutions, this field is ignored. See account type schema for a full list of account types. If the balance that is pulled is older than the given timestamp for Items with this field required, an INVALID_REQUEST error with the code of LAST_UPDATED_DATETIME_OUT_OF_RANGE will be returned with the most recent timestamp for the requested account contained in the response.

The last 2-4 alphanumeric characters of an account’s official account number. Note that the mask may be non-unique between an Item’s accounts, and it may also not match the mask that the bank displays to the user.

The name of the account, either assigned by the user or by the financial institution itself

The official name of the account as given by the financial institution

investment: Investment account. In API versions 2018-05-22 and earlier, this type is called brokerage instead. credit: Credit card depository: Depository account loan: Loan account other: Non-specified account type See the Account type schema for a full listing of account types and corresponding subtypes.

See the Account type schema for a full listing of account types and corresponding subtypes.

The current verification status of an Auth Item initiated through Automated or Manual micro-deposits. Returned for Auth Items only. pending_automatic_verification: The Item is pending automatic verification pending_manual_verification: The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the micro-deposit. automatically_verified: The Item has successfully been automatically verified manually_verified: The Item has successfully been manually verified verification_expired: Plaid was unable to automatically verify the deposit within 7 calendar days and will no longer attempt to validate the Item. Users may retry by submitting their information again through Link. verification_failed: The Item failed manual micro-deposit verification because the user exhausted all 3 verification attempts. Users may retry by submitting their information again through Link. database_matched: The Item has successfully been verified using Plaid’s data sources. Note: Database Match is currently a beta feature, please contact your account manager for more information.

A unique and persistent identifier for accounts that can be used to trace multiple instances of the same account across different Items for depository accounts. This is currently an opt-in field and only supported for Chase Items.

The duration of transaction history available within this report for this Item, typically defined as the time since the date of the earliest transaction in that account.

Transaction history associated with the account.

The ID of the account in which this transaction occurred.

The settled value of the transaction, denominated in the transaction’s currency, as stated in iso_currency_code or unofficial_currency_code. Positive values when money moves out of the account; negative values when money moves in. For example, debit card purchases are positive; credit card payments, direct deposits, and refunds are negative.

The ISO-4217 currency code of the transaction. Always null if unofficial_currency_code is non-null.

The unofficial currency code associated with the transaction. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the currency code schema for a full listing of supported unofficial_currency_codes.

The string returned by the financial institution to describe the transaction.

A hierarchical array of the categories to which this transaction belongs. For a full list of categories, see /categories/get. This field will only appear in an Asset Report with Insights.

The ID of the category to which this transaction belongs. For a full list of categories, see /categories/get. This field will only appear in an Asset Report with Insights.

Information describing the intent of the transaction. Most relevant for credit use cases, but not limited to such use cases. See the taxonomy csv file for a full list of credit categories.

The check number of the transaction. This field is only populated for check transactions.

For pending transactions, the date that the transaction occurred; for posted transactions, the date that the transaction posted. Both dates are returned in an ISO 8601 format ( YYYY-MM-DD ).

The date on which the transaction took place, in IS0 8601 format.

A representation of where a transaction took place

The merchant name or transaction description. This is a legacy field that is no longer maintained. For merchant name, use the merchant_name field. For description, use the original_description field. This field will only appear in an Asset Report with Insights.

The merchant name, as enriched by Plaid. This is typically a more human-readable version of the merchant counterparty in the transaction. For some bank transactions (such as checks or account transfers) where there is no meaningful merchant name, this value will be null.

Transaction information specific to inter-bank transfers. If the transaction was not an inter-bank transfer, all fields will be null. If the transactions object was returned by a Transactions endpoint such as /transactions/sync or /transactions/get, the payment_meta key will always appear, but no data elements are guaranteed. If the transactions object was returned by an Assets endpoint such as /asset_report/get/ or /asset_report/pdf/get, this field will only appear in an Asset Report with Insights.

When true, identifies the transaction as pending or unsettled. Pending transaction details (name, type, amount, category ID) may change before they are settled.

The ID of a posted transaction’s associated pending transaction, where applicable.

The name of the account owner. This field is not typically populated and only relevant when dealing with sub-accounts.

The unique ID of the transaction. Like all Plaid identifiers, the transaction_id is case sensitive.

digital: transactions that took place online. place: transactions that were made at a physical location. special: transactions that relate to banks, e.g. fees or deposits. unresolved: transactions that do not fit into the other three types.

A unique identifier for an income source.

A set of fields describing the investments data on an account.

Quantities and values of securities held in the investment account. Map to the securities array for security details.

Details of specific securities held in on the investment account.

Transaction history on the investment account.

Data returned by the financial institution about the account owner or owners.For business accounts, the name reported may be either the name of the individual or the name of the business, depending on the institution. Multiple owners on a single account will be represented in the same owner object, not in multiple owner objects within the array. In API versions 2018-05-22 and earlier, the owners object is not returned, and instead identity information is returned in the top level identity object. For more details, see Plaid API versioning

A list of names associated with the account by the financial institution. In the case of a joint account, Plaid will make a best effort to report the names of all account holders. If an Item contains multiple accounts with different owner names, some institutions will report all names associated with the Item in each account’s names array.

A list of phone numbers associated with the account by the financial institution. May be an empty array if no relevant information is returned from the financial institution.

A list of email addresses associated with the account by the financial institution. May be an empty array if no relevant information is returned from the financial institution.

Data about the various addresses associated with the account by the financial institution. May be an empty array if no relevant information is returned from the financial institution.

How an asset is owned. association: Ownership by a corporation, partnership, or unincorporated association, including for-profit and not-for-profit organizations. individual: Ownership by an individual. joint: Joint ownership by multiple parties. trust: Ownership by a revocable or irrevocable trust.

Calculated data about the historical balances on the account.

The date of the calculated historical balance, in an ISO 8601 format (YYYY-MM-DD)

The total amount of funds in the account, calculated from the current balance in the balance object by subtracting inflows and adding back outflows according to the posted date of each transaction. If the account has any pending transactions, historical balance amounts on or after the date of the earliest pending transaction may differ if retrieved in subsequent Asset Reports as a result of those pending transactions posting.

The ISO-4217 currency code of the balance. Always null if unofficial_currency_code is non-null.

The unofficial currency code associated with the balance. Always null if iso_currency_code is non-null. See the currency code schema for a full listing of supported unofficial_currency_codes.

If the Asset Report generation was successful but identity information cannot be returned, this array will contain information about the errors causing identity information to be missing

The warning type, which will always be ASSET_REPORT_WARNING

The warning code identifies a specific kind of warning. OWNERS_UNAVAILABLE indicates that account-owner information is not available.INVESTMENTS_UNAVAILABLE indicates that Investments specific information is not available. TRANSACTIONS_UNAVAILABLE indicates that transactions information associated with Credit and Depository accounts are unavailable.

An error object and associated item_id used to identify a specific Item and error when a batch operation operating on multiple Items has encountered an error in one of the Items.

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.