Retrieve a Monitoring Insights Report
POST /cra/monitoring_insights/get
This endpoint allows you to retrieve a Monitoring Insights report by passing in the user_token referred to in the webhook you received.
Request Body
Required
CraMonitoringInsightsGetRequest defines the request schema for /cra/monitoring_insights/get
Parameters
client_id
Your Plaid API
client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.
secret
Your Plaid API
secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.
user_token
The user token associated with the User data is being requested for.
user_id
consumer_report_permissible_purpose
Describes the reason you are generating a Consumer Report for this user.
ACCOUNT_REVIEW_CREDIT: In connection with a consumer credit transaction for the review or collection of an account pursuant to FCRA Section 604(a)(3)(A).
WRITTEN_INSTRUCTION_OTHER: In accordance with the written instructions of the consumer pursuant to FCRA Section 604(a)(2), such as when an individual agrees to act as a guarantor or assumes personal liability for a consumer, business, or commercial loan.
Response
CraMonitoringInsightsGetResponse defines the response schema for cra/monitoring_insights/get
Response Properties
request_id
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
user_insights_id
A unique ID identifying a User Monitoring Insights Report. Like all Plaid identifiers, this ID is case sensitive.
items
An array of Monitoring Insights Items associated with the user.
date_generated
The date and time when the specific insights were generated (per-item), in ISO 8601 format (e.g. “2018-04-12T03:32:11Z”).
item_id
The
item_id of the Item associated with the insights
institution_id
The id of the financial institution associated with the Item.
institution_name
The full financial institution name associated with the Item.
status
An object with details of the Monitoring Insights Item’s status.
status_code
Enum for the status of the Item’s insights
reason
A reason for why a Monitoring Insights Report is not available.
This field will only be populated when the
status_code is not AVAILABLE
insights
An object representing the Monitoring Insights for the given Item
income
An object representing the income subcategory of the report
total_monthly_income
Details about about the total monthly income
baseline_amount
The aggregated income for the 30 days prior to subscription date
current_amount
The aggregated income of the last 30 days
income_sources_counts
Details about the number of income sources
baseline_count
The number of income sources detected at the subscription date
current_count
The number of income sources currently detected
forecasted_monthly_income
An object representing the predicted average monthly net income amount. This amount reflects the funds deposited into the account and may not include any withheld income such as taxes or other payroll deductions
baseline_amount
The forecasted monthly income at the time of subscription
current_amount
The current forecasted monthly income
historical_annual_income
An object representing the historical annual income amount.
baseline_amount
The historical annual income at the time of subscription
current_amount
The current historical annual income
income_sources
The income sources for this Item. Each entry in the array is a single income source
income_source_id
A unique identifier for an income source
income_description
The most common name or original description for the underlying income transactions
income_category
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.
last_transaction_date
The last detected transaction date for this income source
loans
An object representing the loan exposure subcategory of the report
loan_payments_counts
Details regarding the number of loan payments
baseline_count
The number of loan payments made in the 30 days before the subscription date
current_count
The current number of loan payments made in the last 30 days
loan_disbursements_count
The number of loan disbursements detected in the last 30 days
loan_payment_merchants_counts
Details regarding the number of unique loan payment merchants
baseline_count
The number of unique loan payment merchants detected in the 30 days before the subscription date
current_count
The current number of unique loan payment merchants detected in the last 30 days
accounts
Data about each of the accounts open on the Item.
account_id
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.
balances
Information about an account’s balances.
available
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.
current
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.
limit
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.
iso_currency_code
The ISO-4217 currency code of the balance. Always null if
unofficial_currency_code is non-null.
unofficial_currency_code
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.
last_updated_datetime
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.
average_balance
The average historical balance for the entire report
average_monthly_balances
The average historical balance of each calendar month
start_date
The start date of this time period.
The date will be returned in an ISO 8601 format (YYYY-MM-DD).
end_date
The end date of this time period.
The date will be returned in an ISO 8601 format (YYYY-MM-DD).
average_balance
This contains an amount, denominated in the currency specified by either
iso_currency_code or unofficial_currency_code
most_recent_thirty_day_average_balance
The average historical balance from the most recent 30 days
consumer_disputes
The information about previously submitted valid dispute statements by the consumer
consumer_dispute_id
(Deprecated) A unique identifier (UUID) of the consumer dispute that can be used for troubleshooting
dispute_field_create_date
Date of the disputed field (e.g. transaction date), in an ISO 8601 format (YYYY-MM-DD)
category
Type of data being disputed by the consumer
statement
Text content of dispute
mask
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.
metadata
Metadata about the extracted account.
start_date
The beginning of the range of the financial institution provided data for the account, in ISO 8601 format (“yyyy-mm-dd”).
end_date
The end of the range of the financial institution provided data for the account, in ISO 8601 format (“yyyy-mm-dd”).
name
The name of the account, either assigned by the user or by the financial institution itself
official_name
The official name of the account as given by the financial institution
type
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.
subtype
See the Account type schema for a full listing of account types and corresponding subtypes.
days_available
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.
transactions
Transaction history associated with the account. Transaction history returned by endpoints such as
/transactions/get or /investments/transactions/get will be returned in the top-level transactions field instead.
account_id
The ID of the account in which this transaction occurred.
amount
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.
iso_currency_code
The ISO-4217 currency code of the transaction. Always
null if unofficial_currency_code is non-null.
unofficial_currency_code
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.
name
The merchant name or transaction description.
Note: This is a legacy field that is not actively maintained. Use
merchant_name instead for the merchant name.
original_description
The string returned by the financial institution to describe the transaction.
credit_category
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.
primary
A high level category that communicates the broad category of the transaction.
detailed
A granular category conveying the transaction’s intent. This field can also be used as a unique identifier for the category.
check_number
The check number of the transaction. This field is only populated for check transactions.
date
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 ).
date_transacted
The date on which the transaction took place, in IS0 8601 format.
location
A representation of where a transaction took place
address
The street address where the transaction occurred.
city
The city where the transaction occurred.
region
The region or state where the transaction occurred. In API versions 2018-05-22 and earlier, this field is called
state.
postal_code
The postal code where the transaction occurred. In API versions 2018-05-22 and earlier, this field is called
zip.
country
The ISO 3166-1 alpha-2 country code where the transaction occurred.
lat
The latitude where the transaction occurred.
lon
The longitude where the transaction occurred.
store_number
The merchant defined store number where the transaction occurred.
merchant_name
The merchant name, as enriched by Plaid from the
name field. 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.
pending
When
true, identifies the transaction as pending or unsettled. Pending transaction details (name, type, amount, category ID) may change before they are settled.
account_owner
The name of the account owner. This field is not typically populated and only relevant when dealing with sub-accounts.
transaction_id
The unique ID of the transaction. Like all Plaid identifiers, the
transaction_id is case sensitive.
transaction_type
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 types.
category
A hierarchical array of the categories to which this transaction belongs. For a full list of categories, see
/categories/get.
category_id
The ID of the category to which this transaction belongs. For a full list of categories, see
/categories/get.
owners
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. This array can also be empty if no owners are found.
names
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.
phone_numbers
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.
data
The phone number.
primary
When
true, identifies the phone number as the primary number on an account.
type
The type of phone number.
emails
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
The email address.
primary
When
true, identifies the email address as the primary email on an account.
type
The type of email account as described by the financial institution.
addresses
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.
data
Data about the components comprising an address.
primary
When
true, identifies the address as the primary address on an account.
ownership_type
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.
historical_balances
Calculated data about the historical balances on the account. Currently not supported by
brokerage or investment accounts.
date
The date of the calculated historical balance, in an ISO 8601 format (YYYY-MM-DD)
current
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.
iso_currency_code
The ISO-4217 currency code of the balance. Always
null if unofficial_currency_code is non-null.
unofficial_currency_code
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.
account_insights
Calculated insights derived from transaction-level data. This field has been deprecated in favor of Base Report attributes aggregated across accounts and will be removed in a future release.
oldest_transaction_date
Date of the earliest transaction for the account.
most_recent_transaction_date
Date of the most recent transaction for the account.
days_available
Number of days days available for the account.
average_days_between_transactions
Average number of days between sequential transactions
longest_gaps_between_transactions
Longest gap between sequential transactions in a time period. This array can include multiple time periods.
start_date
The start date of this time period.
The date will be returned in an ISO 8601 format (YYYY-MM-DD).
end_date
The end date of this time period.
The date will be returned in an ISO 8601 format (YYYY-MM-DD).
days
Largest number of days between sequential transactions for this time period.
number_of_inflows
The number of debits into the account. This array will be empty for non-depository accounts.
start_date
The start date of this time period.
The date will be returned in an ISO 8601 format (YYYY-MM-DD).
end_date
The end date of this time period.
The date will be returned in an ISO 8601 format (YYYY-MM-DD).
count
The number of credits or debits out of the account for this time period.
average_inflow_amounts
Average amount of debit transactions into the account in a time period. This array will be empty for non-depository accounts. This field only takes into account USD transactions from the account.
start_date
The start date of this time period.
The date will be returned in an ISO 8601 format (YYYY-MM-DD).
end_date
The end date of this time period.
The date will be returned in an ISO 8601 format (YYYY-MM-DD).
total_amount
This contains an amount, denominated in the currency specified by either
iso_currency_code or unofficial_currency_code
number_of_outflows
The number of outflows from the account. This array will be empty for non-depository accounts.
start_date
The start date of this time period.
The date will be returned in an ISO 8601 format (YYYY-MM-DD).
end_date
The end date of this time period.
The date will be returned in an ISO 8601 format (YYYY-MM-DD).
count
The number of credits or debits out of the account for this time period.
average_outflow_amounts
Average amount of transactions out of the account in a time period. This array will be empty for non-depository accounts. This field only takes into account USD transactions from the account.
start_date
The start date of this time period.
The date will be returned in an ISO 8601 format (YYYY-MM-DD).
end_date
The end date of this time period.
The date will be returned in an ISO 8601 format (YYYY-MM-DD).
total_amount
This contains an amount, denominated in the currency specified by either
iso_currency_code or unofficial_currency_code
number_of_days_no_transactions
Number of days with no transactions
attributes
Calculated attributes derived from transaction-level data.
is_primary_account
Prediction indicator of whether the account is a primary account. Only one account per account type across the items connected will have a value of true.
primary_account_score
Value ranging from 0-1. The higher the score, the more confident we are of the account being the primary account.
nsf_overdraft_transactions_count
The number of NSF and overdraft fee transactions in the time range for the report in the given account.
nsf_overdraft_transactions_count_30d
The number of NSF and overdraft fee transactions in the last 30 days for a given account.
nsf_overdraft_transactions_count_60d
The number of NSF and overdraft fee transactions in the last 60 days for a given account.
nsf_overdraft_transactions_count_90d
The number of NSF and overdraft fee transactions in the last 90 days for a given account.
total_inflow_amount
Total amount of debit transactions into the account in the time period of the report. This field will be empty for non-depository accounts. This field only takes into account USD transactions from the account.
amount
Value of amount with up to 2 decimal places.
iso_currency_code
The ISO 4217 currency code of the amount or balance.
unofficial_currency_code
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_inflow_amount_30d
Total amount of debit transactions into the account in the last 30 days. This field will be empty for non-depository accounts. This field only takes into account USD transactions from the account.
amount
Value of amount with up to 2 decimal places.
iso_currency_code
The ISO 4217 currency code of the amount or balance.
unofficial_currency_code
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_inflow_amount_60d
Total amount of debit transactions into the account in the last 60 days. This field will be empty for non-depository accounts. This field only takes into account USD transactions from the account.
amount
Value of amount with up to 2 decimal places.
iso_currency_code
The ISO 4217 currency code of the amount or balance.
unofficial_currency_code
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_inflow_amount_90d
Total amount of debit transactions into the account in the last 90 days. This field will be empty for non-depository accounts. This field only takes into account USD transactions from the account.
amount
Value of amount with up to 2 decimal places.
iso_currency_code
The ISO 4217 currency code of the amount or balance.
unofficial_currency_code
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_outflow_amount
Total amount of credit transactions into the account in the time period of the report. This field will be empty for non-depository accounts. This field only takes into account USD transactions from the account.
amount
Value of amount with up to 2 decimal places.
iso_currency_code
The ISO 4217 currency code of the amount or balance.
unofficial_currency_code
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_outflow_amount_30d
Total amount of credit transactions into the account in the last 30 days. This field will be empty for non-depository accounts. This field only takes into account USD transactions from the account.
amount
Value of amount with up to 2 decimal places.
iso_currency_code
The ISO 4217 currency code of the amount or balance.
unofficial_currency_code
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_outflow_amount_60d
Total amount of credit transactions into the account in the last 60 days. This field will be empty for non-depository accounts. This field only takes into account USD transactions from the account.
amount
Value of amount with up to 2 decimal places.
iso_currency_code
The ISO 4217 currency code of the amount or balance.
unofficial_currency_code
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_outflow_amount_90d
Total amount of credit transactions into the account in the last 90 days. This field will be empty for non-depository accounts. This field only takes into account USD transactions from the account.
amount
Value of amount with up to 2 decimal places.
iso_currency_code
The ISO 4217 currency code of the amount or balance.
unofficial_currency_code
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.