The Check Income Insights Report for an end user.

The unique identifier associated with the Check Income Insights Report.

The time when the Check Income Insights Report was generated.

The number of days requested by the customer for the Check Income Insights Report.

Client-generated identifier, which can be used by lenders to track loan applications.

The list of Items in the report along with the associated metadata about the Item.

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

The Item’s accounts that have bank income data.

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

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.

An object containing metadata about the extracted account.

The date of the earliest extracted transaction, in ISO 8601 format (“yyyy-mm-dd”).

The date of the most recent extracted transaction, in ISO 8601 format (“yyyy-mm-dd”).

The name of the bank account.

The official name of the bank account.

Valid account subtypes for depository accounts. For a list containing descriptions of each subtype, see Account schemas.

The account type. This will always be depository.

Data returned by the financial institution about the account owner or owners. Identity information is optional, so field may return an empty array.

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.

The income sources for this Item. Each entry in the array is a single income source.

The account ID with which this income source is associated.

A unique identifier for an income source. If the report is regenerated and a new report_id is created, the new report will have a new set of income_source_ids.

The most common name or original description for the underlying income transactions.

The income category. BANK_INTEREST: Interest earned from a bank account. BENEFIT_OTHER: Government benefits other than retirement, unemployment, child support, or disability. Currently used only in the UK, to represent benefits such as Cost of Living Payments. CASH: Deprecated and used only for existing legacy implementations. Has been replaced by CASH_DEPOSIT and TRANSFER_FROM_APPLICATION. CASH_DEPOSIT: A cash or check deposit. CHILD_SUPPORT: Child support payments received. GIG_ECONOMY: Income earned as a gig economy worker, e.g. driving for Uber, Lyft, Postmates, DoorDash, etc. LONG_TERM_DISABILITY: Disability payments, including Social Security disability benefits. OTHER: Income that could not be categorized as any other income category. MILITARY: Veterans benefits. Income earned as salary for serving in the military (e.g. through DFAS) will be classified as SALARY rather than MILITARY. RENTAL: Income earned from a rental property. Income may be identified as rental when the payment is received through a rental platform, e.g. Airbnb; rent paid directly by the tenant to the property owner (e.g. via cash, check, or ACH) will typically not be classified as rental income. RETIREMENT: Payments from private retirement systems, pensions, and government retirement programs, including Social Security retirement benefits. SALARY: Payment from an employer to an earner or other form of permanent employment. TAX_REFUND: A tax refund. TRANSFER_FROM_APPLICATION: Deposits from a money transfer app, such as Venmo, Cash App, or Zelle. UNEMPLOYMENT: Unemployment benefits. In the UK, includes certain low-income benefits such as the Universal Credit.

Minimum of all dates within the specific income sources in the user’s bank account for days requested by the client. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

Maximum of all dates within the specific income sources in the user’s bank account for days requested by the client. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

The income pay frequency.

Total amount of earnings in the user’s bank account for the specific income source for days requested by the client.

The ISO 4217 currency code of the amount or balance.

The unofficial currency code associated with the amount or 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.

Number of transactions for the income source within the start and end date.

The expected date of the end user’s next paycheck for the income source. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

An estimate of the average gross monthly income based on the historical net amount and income category for the income source(s).

The average monthly net income amount estimated based on the historical data for the income source(s).

The predicted average monthly net income amount for the income source(s).

The prediction interval(s) for the forecasted average monthly income.

The lower bound of the predicted attribute for the given probability.

The upper bound of the predicted attribute for the given probability.

The probability of the actual value of the attribute falling within the upper and lower bound. This is a percentage represented as a value between 0 and 1.

The object containing employer data.

The name of the employer.

Total amount of earnings for the income source(s) of the user for the month in the summary. This can contain multiple amounts, with each amount denominated in one unique currency.

The start date of the period covered in this monthly summary. This date will be the first day of the month, unless the month being covered is a partial month because it is the first month included in the summary and the date range being requested does not begin with the first day of the month. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

The end date of the period included in this monthly summary. This date will be the last day of the month, unless the month being covered is a partial month because it is the last month included in the summary and the date range being requested does not end with the last day of the month. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

The time when this Item’s data was last retrieved from the financial institution.

The unique identifier of the institution associated with the Item.

The name of the institution associated with the Item.

Summary for income across all income sources and items (max history of 730 days).

Total amount of earnings across all the income sources in the end user’s Items for the days requested by the client. This can contain multiple amounts, with each amount denominated in one unique currency.

Value of amount with up to 2 decimal places.

The ISO 4217 currency code of the amount or balance.

The unofficial currency code associated with the amount or 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.

The earliest date within the days requested in which all income sources identified by Plaid appear in a user’s account. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

The latest date in which all income sources identified by Plaid appear in the user’s account. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

Number of income sources per end user.

Number of income categories per end user.

Number of income transactions per end user.

An estimate of the average gross monthly income based on the historical net amount and income category for the income source(s). The average monthly income is calculated based on the lifetime of the income stream, rather than the entire historical period included in the scope of the report.

Value of amount with up to 2 decimal places.

The ISO 4217 currency code of the amount or balance.

The unofficial currency code associated with the amount or 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.

The average monthly income amount estimated based on the historical data for the income source(s). The average monthly income is calculated based on the lifetime of the income stream, rather than the entire historical period included in the scope of the report.

Value of amount with up to 2 decimal places.

The ISO 4217 currency code of the amount or balance.

The unofficial currency code associated with the amount or 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.

The predicted average monthly income amount for the income source(s).

Value of amount with up to 2 decimal places.

The ISO 4217 currency code of the amount or balance.

The unofficial currency code associated with the amount or 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.

An estimate of the annual gross income for the income source, calculated by multiplying the historical_average_monthly_gross_income by 12.

Value of amount with up to 2 decimal places.

The ISO 4217 currency code of the amount or balance.

The unofficial currency code associated with the amount or 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.

An estimate of the annual net income for the income source, calculated by multiplying the historical_average_monthly_income by 12.

Value of amount with up to 2 decimal places.

The ISO 4217 currency code of the amount or balance.

The unofficial currency code associated with the amount or 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.

The predicted average annual income amount for the income source(s).

Value of amount with up to 2 decimal places.

The ISO 4217 currency code of the amount or balance.

The unofficial currency code associated with the amount or 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.

Total amount of earnings for the income source(s) of the user for the month in the summary. This can contain multiple amounts, with each amount denominated in one unique currency.

Value of amount with up to 2 decimal places.

The ISO 4217 currency code of the amount or balance.

The unofficial currency code associated with the amount or 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.

The start date of the period covered in this monthly summary. This date will be the first day of the month, unless the month being covered is a partial month because it is the first month included in the summary and the date range being requested does not begin with the first day of the month. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

The end date of the period included in this monthly summary. This date will be the last day of the month, unless the month being covered is a partial month because it is the last month included in the summary and the date range being requested does not end with the last day of the month. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

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

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, credit card purchases are positive; credit card payment, direct deposits, and refunds are negative.

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

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

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

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

The ISO 4217 currency code of the amount or balance.

The unofficial currency code associated with the amount or 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.

The type of bonus that this transaction represents, if it is a bonus. BONUS_INCLUDED: Bonus is included in this transaction along with the normal pay BONUS_ONLY: This transaction is a standalone bonus

If data from the report was unable to be retrieved, the warnings object will contain information about the error that caused the data to be incomplete.

The warning type which will always be BANK_INCOME_WARNING.

The warning code identifies a specific kind of warning. IDENTITY_UNAVAILABLE: Unable to extract identity for the Item TRANSACTIONS_UNAVAILABLE: Unable to extract transactions for the Item REPORT_DELETED: Report deleted due to customer or consumer request DATA_UNAVAILABLE: No relevant data was found for the Item

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 broad categorization of the error. Safe for programmatic use.

We use standard HTTP response codes for success and failure notifications, and our errors are further classified by error_type. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. Error fields will be null if no error has occurred.

A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.

A user-friendly representation of the error code. null if the error is not related to user action. This may change over time and is not safe for programmatic use.

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

If the Income Insights generation was successful but a subset of data could not be retrieved, this array will contain information about the errors causing information to be missing

The warning type, which will always be CHECK_REPORT_WARNING

The warning code identifies a specific kind of warning. IDENTITY_UNAVAILABLE: Account-owner information is not available. TRANSACTIONS_UNAVAILABLE: Transactions information associated with Credit and Depository accounts are unavailable. USER_FRAUD_ALERT: The user has placed a fraud alert on their Plaid Check consumer report due to suspected fraud. Please note that when a fraud alert is in place, the recipient of the consumer report has an obligation to verify the consumer’s identity.

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.