Plaid Check

string

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.

string

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.

consumer_report_permissible_purpose

requiredstring

The user token associated with the User data is being requested for.

webhook

requiredstring

The destination URL to which webhooks will be sent

days_requested

requiredinteger

The number of days of data to request for the report. Default value is 365; maximum is 731; minimum is 180. If a value lower than 180 is provided, a minimum of 180 days of history will be requested.

Maximum: 731

days_required

integer

The minimum number of days of data required for the report to be successfully generated.

requiredstring

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).
ACCOUNT_REVIEW_NON_CREDIT: For a legitimate business need of the information to review a non-credit account provided primarily for personal, family, or household purposes to determine whether the consumer continues to meet the terms of the account pursuant to FCRA Section 604(a)(3)(F)(2).
EMPLOYMENT: For employment purposes pursuant to FCRA 604(a)(3)(B), including hiring, retention and promotion purposes.
EXTENSION_OF_CREDIT: In connection with a credit transaction initiated by and involving the consumer pursuant to FCRA Section 604(a)(3)(A).
LEGITIMATE_BUSINESS_NEED_TENANT_SCREENING: For a legitimate business need in connection with a business transaction initiated by the consumer primarily for personal, family, or household purposes in connection with a property rental assessment pursuant to FCRA Section 604(a)(3)(F)(i).
LEGITIMATE_BUSINESS_NEED_OTHER: For a legitimate business need in connection with a business transaction made primarily for personal, family, or household initiated by the consumer pursuant to FCRA Section 604(a)(3)(F)(i).
WRITTEN_INSTRUCTION_PREQUALIFICATION: In accordance with the written instructions of the consumer pursuant to FCRA Section 604(a)(2), to evaluate an application’s profile to make an offer to the consumer.
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.

Possible values: ACCOUNT_REVIEW_CREDIT, ACCOUNT_REVIEW_NON_CREDIT, EMPLOYMENT, EXTENSION_OF_CREDIT, LEGITIMATE_BUSINESS_NEED_TENANT_SCREENING, LEGITIMATE_BUSINESS_NEED_OTHER, WRITTEN_INSTRUCTION_PREQUALIFICATION, WRITTEN_INSTRUCTION_OTHER

/cra/check_report/create
Select Language
1try {
2  const response = await client.craCheckReportCreate({
3    user_token: 'user-environment-1234567-abcd-abcd-1234-1234567890ab',
4    webhook: 'https://sample-web-hook.com',
5    days_requested: 365,
6    consumer_report_permissible_purpose: 'LEGITIMATE_BUSINESS_NEED_OTHER',
7  });
8} catch (error) {
9  // handle error
10}

cra/check_report/create

Response fields and example

string

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

API Object
1{
2  "request_id": "LhQf0THi8SH1yJm"
3}

Was this helpful?

Retrieve a Base Report

This endpoint allows you to retrieve the Base Report for your user, allowing you to receive comprehensive bank account and cash flow data. You should call this endpoint after you've received a CHECK_REPORT_READY webhook, either after the Link session for the user or after calling /cra/check_report/create. If the most recent consumer report for the user doesn't have sufficient data to generate the base report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling /cra/check_report/create.

cra/check_report/base_report/get

Request fields

string

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.

string

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.

string

The user token associated with the User data is being requested for.

/cra/check_report/base_report/get
Select Language
1try {
2  const response = await client.craCheckReportBaseReportGet({
3    user_token: 'user-environment-1234567-abcd-abcd-1234-1234567890ab',
4  });
5} catch (error) {
6  // handle error
7}

cra/check_report/base_report/get

Response fields and example

object

An object representing a Base Report

string

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

date_generated

string

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

Format: date-time

days_requested

number

The number of days of transaction history requested.

client_report_id

nullablestring

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

[object]

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

string

The full financial institution name associated with the Item.

string

The id of the financial institution associated with the Item.

date_last_updated

string

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

Format: date-time

string

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

accounts

[object]

Data about each of the accounts open on the Item.

string

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

object

Base Report information about an account's balances

available

nullablenumber

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.

Format: double

current

nullablenumber

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.

Format: double

limit

nullablenumber

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.

Format: double

nullablestring

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

average_monthly_balances

nullablestring

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

nullablestring

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.

Format: date-time

average_balance

nullablenumber

The average historical balance for the entire report

Format: double

[object]

The average historical balance of each calendar month

string

The start date of this time period. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

string

The end date of this time period. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

average_balance

object

This contains an amount, denominated in the currency specified by either iso_currency_code or unofficial_currency_code

number

Value of amount with up to 2 decimal places.

nullablestring

The ISO 4217 currency code of the amount or balance.

most_recent_thirty_day_average_balance

nullablestring

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.

nullablenumber

The average historical balance from the most recent 30 days

Format: double

consumer_disputes

[object]

The information about previously submitted valid dispute statements by the consumer

consumer_dispute_id

string

A unique identifier (UUID) of the consumer dispute that can be used for troubleshooting

dispute_field_create_date

string

Date of the disputed field (e.g. transaction date), in an ISO 8601 format (YYYY-MM-DD)

Format: date

category

string

Type of data being disputed by the consumer

Possible values: TRANSACTION, BALANCE, IDENTITY, OTHER

statement

string

Text content of dispute

mask

nullablestring

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.

object

Base Report metadata about the extracted account.

nullablestring

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

Format: date

nullablestring

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

Format: date

name

string

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

official_name

nullablestring

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

type

string

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.

Possible values: investment, credit, depository, loan, brokerage, other

subtype

nullablestring

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

Possible values: 401a, 401k, 403B, 457b, 529, auto, brokerage, business, cash isa, cash management, cd, checking, commercial, construction, consumer, credit card, crypto exchange, ebt, education savings account, fixed annuity, gic, health reimbursement arrangement, home equity, hsa, isa, ira, keogh, lif, life insurance, line of credit, lira, loan, lrif, lrsp, money market, mortgage, mutual fund, non-custodial wallet, non-taxable brokerage account, other, other insurance, other annuity, overdraft, paypal, payroll, pension, prepaid, prif, profit sharing plan, rdsp, resp, retirement, rlif, roth, roth 401k, rrif, rrsp, sarsep, savings, sep ira, simple ira, sipp, stock plan, student, thrift savings plan, tfsa, trust, ugma, utma, variable annuity

days_available

number

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. Only returned by Base Report endpoints.

transactions

[object]

Transaction history associated with the account. Only returned by Base Report endpoints. Transaction history returned by endpoints such as /transactions/get or /investments/transactions/get will be returned in the top-level transactions field instead.

string

The ID of the account in which this transaction occurred.

number

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.

Format: double

nullablestring

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

nullablestring

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.

original_description

nullablestring

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

credit_category

nullableobject

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.

string

A high level category that communicates the broad category of the transaction.

detailed

string

A granular category conveying the transaction's intent. This field can also be used as a unique identifier for the category.

check_number

nullablestring

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

date

string

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

Format: date

date_transacted

nullablestring

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

location

object

A representation of where a transaction took place

address

nullablestring

The street address where the transaction occurred.

city

nullablestring

The city where the transaction occurred.

nullablestring

The region or state where the transaction occurred. In API versions 2018-05-22 and earlier, this field is called state.

nullablestring

The postal code where the transaction occurred. In API versions 2018-05-22 and earlier, this field is called zip.

nullablestring

The ISO 3166-1 alpha-2 country code where the transaction occurred.

lat

nullablenumber

The latitude where the transaction occurred.

Format: double

lon

nullablenumber

The longitude where the transaction occurred.

Format: double

store_number

nullablestring

The merchant defined store number where the transaction occurred.

merchant_name

nullablestring

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

boolean

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

nullablestring

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

transaction_id

string

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

owners

[object]

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.

names

[string]

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

[object]

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

string

The phone number.

boolean

When true, identifies the phone number as the primary number on an account.

type

string

The type of phone number.

Possible values: home, work, office, mobile, mobile1, other

emails

[object]

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

string

The email address.

boolean

When true, identifies the email address as the primary email on an account.

type

string

The type of email account as described by the financial institution.

Possible values: primary, secondary, other

addresses

[object]

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

object

Data about the components comprising an address.

city

nullablestring

The full city name

nullablestring

The region or state. In API versions 2018-05-22 and earlier, this field is called state. Example: "NC"

street

string

The full street address Example: "564 Main Street, APT 15"

nullablestring

The postal code. In API versions 2018-05-22 and earlier, this field is called zip.

nullablestring

The ISO 3166-1 alpha-2 country code

oldest_transaction_date

boolean

When true, identifies the address as the primary address on an account.

ownership_type

nullablestring

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.

Possible values: null, individual, joint, association, trust

account_insights

object

Calculated insights derived from transaction-level data.

nullablestring

Date of the earliest transaction in the base report for the account.

Format: date

most_recent_transaction_date

nullablestring

Date of the most recent transaction in the base report for the account.

Format: date

days_available

integer

Number of days days available in the base report for the account.

average_days_between_transactions

number

Average number of days between sequential transactions

longest_gap_between_transactions

deprecated[object]

Deprecated; use longest_gaps_between_transactions instead. Longest gap between sequential transactions

string

The start date of this time period. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

Format: date

longest_gaps_between_transactions

string

The end date of this time period. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

Format: date

days

nullableinteger

Largest number of days between sequential transactions for this time period.

[object]

Customers must transition from longest_gap_between_transactions by January 31st 2025. Longest gap between sequential transactions in a time period. This array can include multiple time periods.

string

The start date of this time period. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

Format: date

string

The end date of this time period. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

Format: date

days

nullableinteger

Largest number of days between sequential transactions for this time period.

number_of_inflows

[object]

The number of debits into the account. This array will be empty for non-depository accounts.

string

The start date of this time period. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

Format: date

string

The end date of this time period. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

Format: date

count

integer

The number of credits or debits out of the account for this time period.

average_inflow_amount

deprecated[object]

Deprecated; use average_inflow_amounts instead. Average amount of debit transactions into the account. This array will be empty for non-depository accounts. This field only takes into account USD transactions from the account.

string

The start date of this time period. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

Format: date

string

The end date of this time period. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

Format: date

object

This contains an amount, denominated in the currency specified by either iso_currency_code or unofficial_currency_code

number

Value of amount with up to 2 decimal places.

nullablestring

The ISO 4217 currency code of the amount or balance.

nullablestring

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.

average_inflow_amounts

[object]

Customers must transition from average_inflow_amount by January 31st 2025. 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.

string

The start date of this time period. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

Format: date

string

The end date of this time period. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

Format: date

object

This contains an amount, denominated in the currency specified by either iso_currency_code or unofficial_currency_code

number

Value of amount with up to 2 decimal places.

nullablestring

The ISO 4217 currency code of the amount or balance.

nullablestring

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_outflows

[object]

The number of outflows from the account. This array will be empty for non-depository accounts.

string

The start date of this time period. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

Format: date

string

The end date of this time period. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

Format: date

count

integer

The number of credits or debits out of the account for this time period.

average_outflow_amount

deprecated[object]

Deprecated; use average_outflow_amounts instead. Average amount of transactions out of the account. This array will be empty for non-depository accounts. This field only takes into account USD transactions from the account.

string

The start date of this time period. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

Format: date

string

The end date of this time period. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

Format: date

object

This contains an amount, denominated in the currency specified by either iso_currency_code or unofficial_currency_code

number

Value of amount with up to 2 decimal places.

nullablestring

The ISO 4217 currency code of the amount or balance.

average_outflow_amounts

nullablestring

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.

[object]

Customers must transition from average_outflow_amount by January 31st 2025. 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.

string

The start date of this time period. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

Format: date

string

The end date of this time period. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

Format: date

object

This contains an amount, denominated in the currency specified by either iso_currency_code or unofficial_currency_code

number

Value of amount with up to 2 decimal places.

nullablestring

The ISO 4217 currency code of the amount or balance.

number_of_days_no_transactions

nullablestring

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.

integer

Number of days with no transactions

attributes

object

Calculated attributes derived from transaction-level data.

nsf_overdraft_transactions_count

integer

The number of NSF and overdraft fee transactions in the time range for the report in the given account.

is_primary_account

nullableboolean

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

nullablenumber

Value ranging from 0-1. The higher the score, the more confident we are of the account being the primary account.

total_inflow_amount

nullableobject

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.

number

Value of amount with up to 2 decimal places.

nullablestring

The ISO 4217 currency code of the amount or balance.

total_inflow_amount_30d

nullablestring

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.

nullableobject

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.

number

Value of amount with up to 2 decimal places.

nullablestring

The ISO 4217 currency code of the amount or balance.

total_inflow_amount_60d

nullablestring

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.

nullableobject

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.

number

Value of amount with up to 2 decimal places.

nullablestring

The ISO 4217 currency code of the amount or balance.

total_inflow_amount_90d

nullablestring

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.

nullableobject

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.

number

Value of amount with up to 2 decimal places.

nullablestring

The ISO 4217 currency code of the amount or balance.

nullablestring

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

nullableobject

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.

number

Value of amount with up to 2 decimal places.

nullablestring

The ISO 4217 currency code of the amount or balance.

total_outflow_amount_30d

nullablestring

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.

nullableobject

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.

number

Value of amount with up to 2 decimal places.

nullablestring

The ISO 4217 currency code of the amount or balance.

total_outflow_amount_60d

nullablestring

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.

nullableobject

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.

number

Value of amount with up to 2 decimal places.

nullablestring

The ISO 4217 currency code of the amount or balance.

total_outflow_amount_90d

nullablestring

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.

nullableobject

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.

number

Value of amount with up to 2 decimal places.

nullablestring

The ISO 4217 currency code of the amount or balance.

nullablestring

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.

warnings

[object]

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

warning_type

string

The warning type, which will always be BASE_REPORT_WARNING

warning_code

string

The warning code identifies a specific kind of warning. OWNERS_UNAVAILABLE indicates that account-owner information is not available. TRANSACTIONS_UNAVAILABLE indicates that transactions information associated with Credit and Depository accounts are unavailable. USER_FRAUD_ALERT indicates that the User has placed a fraud alert on their Plaid Check consumer report due to suspected fraud.

Possible values: OWNERS_UNAVAILABLE, TRANSACTIONS_UNAVAILABLE, USER_FRAUD_ALERT

cause

nullableobject

Errors are identified by error_code and categorized by error_type. Use these in preference to HTTP status codes to identify and handle specific errors. HTTP status codes are set and provide the broadest categorization of errors: 4xx codes are for developer- or user-related errors, and 5xx codes are for Plaid-related errors, and the status will be 2xx in non-error cases. An Item with a non-null error object will only be part of an API response when calling /item/get to view Item status. Otherwise, error fields will be null if no error has occurred; if an error has occurred, an error code will be returned instead.

error_type

string

A broad categorization of the error. Safe for programmatic use.

Possible values: INVALID_REQUEST, INVALID_RESULT, INVALID_INPUT, INSTITUTION_ERROR, RATE_LIMIT_EXCEEDED, API_ERROR, ITEM_ERROR, ASSET_REPORT_ERROR, RECAPTCHA_ERROR, OAUTH_ERROR, PAYMENT_ERROR, BANK_TRANSFER_ERROR, INCOME_VERIFICATION_ERROR, MICRODEPOSITS_ERROR, SANDBOX_ERROR, PARTNER_ERROR, TRANSACTIONS_ERROR, TRANSACTION_ERROR, TRANSFER_ERROR

error_code

string

The particular error code. Safe for programmatic use.

error_code_reason

nullablestring

The specific reason for the error code. Currently, reasons are only supported OAuth-based item errors; null will be returned otherwise. Safe for programmatic use.
Possible values: OAUTH_INVALID_TOKEN: The user’s OAuth connection to this institution has been invalidated.
OAUTH_CONSENT_EXPIRED: The user's access consent for this OAuth connection to this institution has expired.
OAUTH_REVOKED_TOKEN: The user’s OAuth connection to this institution is invalid because the user revoked their connection.

error_message

string

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

display_message

nullablestring

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.

string

A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.

causes

array

In this product, a request can pertain to more than one Item. If an error is returned for such a request, causes will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified.
causes will only be provided for the error_type ASSET_REPORT_ERROR. causes will also not be populated inside an error nested within a warning object.

nullableinteger

The HTTP status code associated with the error. This will only be returned in the response body when the error information is provided via a webhook.

documentation_url

string

The URL of a Plaid documentation page with more information about the error

suggested_action

nullablestring

Suggested steps for resolving the error

string

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

string

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

API Object
1{
"report": {
  "date_generated": "2024-07-16T01:52:42.912331716Z",
  "days_requested": 365,
  "items": [
    {
      "accounts": [
        {
          "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",
          "account_insights": {
            "average_days_between_transactions": 0.15,
            "average_inflow_amount": [
              {
                "end_date": "2024-07-31",
                "start_date": "2024-07-01",
                "total_amount": {
                  "amount": -1077.93,
                  "iso_currency_code": "USD",
                  "unofficial_currency_code": null
                }
              }
            ],
            "average_inflow_amounts": [
              {
                "end_date": "2024-07-31",
                "start_date": "2024-07-01",
                "total_amount": {
                  "amount": -1077.93,
                  "iso_currency_code": "USD",
                  "unofficial_currency_code": null
                }
              },
              {
                "end_date": "2024-08-31",
                "start_date": "2024-08-01",
                "total_amount": {
                  "amount": -1076.93,
                  "iso_currency_code": "USD",
                  "unofficial_currency_code": null
                }
              }
            ],
            "average_outflow_amount": [
              {
                "end_date": "2024-07-31",
                "start_date": "2024-07-01",
                "total_amount": {
                  "amount": 34.95,
                  "iso_currency_code": "USD",
                  "unofficial_currency_code": null
                }
              }
            ],
            "average_outflow_amounts": [
              {
                "end_date": "2024-07-31",
                "start_date": "2024-07-01",
                "total_amount": {
                  "amount": 34.95,
                  "iso_currency_code": "USD",
                  "unofficial_currency_code": null
                }
              },
              {
                "end_date": "2024-08-31",
                "start_date": "2024-08-01",
                "total_amount": {
                  "amount": 0,
                  "iso_currency_code": "USD",
                  "unofficial_currency_code": null
                }
              }
            ],
            "days_available": 365,
            "longest_gap_between_transactions": [
              {
                "days": 1,
                "end_date": "2024-07-31",
                "start_date": "2024-07-01"
              }
            ],
            "longest_gaps_between_transactions": [
              {
                "days": 1,
                "end_date": "2024-07-31",
                "start_date": "2024-07-01"
              },
              {
                "days": 2,
                "end_date": "2024-08-31",
                "start_date": "2024-08-01"
              }
            ],
            "most_recent_transaction_date": "2024-07-16",
            "number_of_days_no_transactions": 0,
            "number_of_inflows": [
              {
                "count": 1,
                "end_date": "2024-07-31",
                "start_date": "2024-07-01"
              }
            ],
            "number_of_outflows": [
              {
                "count": 27,
                "end_date": "2024-07-31",
                "start_date": "2024-07-01"
              }
            ],
            "oldest_transaction_date": "2024-07-12"
          },
          "balances": {
            "available": 5000,
            "average_balance": 4956.12,
            "average_monthly_balances": [
              {
                "average_balance": {
                  "amount": 4956.12,
                  "iso_currency_code": "USD",
                  "unofficial_currency_code": null
                },
                "end_date": "2024-07-31",
                "start_date": "2024-07-01"
              }
            ],
            "current": 5000,
            "iso_currency_code": "USD",
            "limit": null,
            "most_recent_thirty_day_average_balance": 4956.125,
            "unofficial_currency_code": null
          },
          "consumer_disputes": [],
          "days_available": 365,
          "mask": "1208",
          "metadata": {
            "start_date": "2024-01-01",
            "end_date": "2024-07-16"
          },
          "name": "Checking",
          "official_name": "Plaid checking",
          "owners": [
            {
              "addresses": [
                {
                  "data": {
                    "city": "Malakoff",
                    "country": "US",
                    "postal_code": "14236",
                    "region": "NY",
                    "street": "2992 Cameron Road"
                  },
                  "primary": true
                },
                {
                  "data": {
                    "city": "San Matias",
                    "country": "US",
                    "postal_code": "93405-2255",
                    "region": "CA",
                    "street": "2493 Leisure Lane"
                  },
                  "primary": false
                }
              ],
              "emails": [
                {
                  "data": "accountholder0@example.com",
                  "primary": true,
                  "type": "primary"
                },
                {
                  "data": "accountholder1@example.com",
                  "primary": false,
                  "type": "secondary"
                },
                {
                  "data": "extraordinarily.long.email.username.123456@reallylonghostname.com",
                  "primary": false,
                  "type": "other"
                }
              ],
              "names": [
                "Alberta Bobbeth Charleson"
              ],
              "phone_numbers": [
                {
                  "data": "+1 111-555-3333",
                  "primary": false,
                  "type": "home"
                },
                {
                  "data": "+1 111-555-4444",
                  "primary": false,
                  "type": "work"
                },
                {
                  "data": "+1 111-555-5555",
                  "primary": false,
                  "type": "mobile"
                }
              ]
            }
          ],
          "ownership_type": null,
          "subtype": "checking",
          "transactions": [
            {
              "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",
              "account_owner": null,
              "amount": 37.07,
              "check_number": null,
              "credit_category": {
                "detailed": "GENERAL_MERCHANDISE_ONLINE_MARKETPLACES",
                "primary": "GENERAL_MERCHANDISE"
              },
              "date": "2024-07-12",
              "date_posted": "2024-07-12T00:00:00Z",
              "date_transacted": "2024-07-12",
              "iso_currency_code": "USD",
              "location": {
                "address": null,
                "city": null,
                "country": null,
                "lat": null,
                "lon": null,
                "postal_code": null,
                "region": null,
                "state": null,
                "store_number": null,
                "zip": null
              },
              "merchant_name": "Amazon",
              "original_description": "AMZN Mktp US*11111111 Amzn.com/bill WA AM",
              "pending": false,
              "transaction_id": "XA7ZLy8rXzt7D3j9B6LMIgv5VxyQkAhbKjzmp",
              "unofficial_currency_code": null
            },
            {
              "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",
              "account_owner": null,
              "amount": 51.61,
              "check_number": null,
              "credit_category": {
                "detailed": "DINING_DINING",
                "primary": "DINING"
              },
              "date": "2024-07-12",
              "date_posted": "2024-07-12T00:00:00Z",
              "date_transacted": "2024-07-12",
              "iso_currency_code": "USD",
              "location": {
                "address": null,
                "city": null,
                "country": null,
                "lat": null,
                "lon": null,
                "postal_code": null,
                "region": null,
                "state": null,
                "store_number": null,
                "zip": null
              },
              "merchant_name": "Domino's",
              "original_description": "DOMINO's XXXX 111-222-3333",
              "pending": false,
              "transaction_id": "VEPeMbWqRluPVZLQX4MDUkKRw41Ljzf9gyLBW",
              "unofficial_currency_code": null
            },
            {
              "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",
              "account_owner": null,
              "amount": 7.55,
              "check_number": null,
              "credit_category": {
                "detailed": "GENERAL_MERCHANDISE_FURNITURE_AND_HARDWARE",
                "primary": "GENERAL_MERCHANDISE"
              },
              "date": "2024-07-12",
              "date_posted": "2024-07-12T00:00:00Z",
              "date_transacted": "2024-07-12",
              "iso_currency_code": "USD",
              "location": {
                "address": null,
                "city": "Chicago",
                "country": null,
                "lat": null,
                "lon": null,
                "postal_code": null,
                "region": null,
                "state": null,
                "store_number": null,
                "zip": null
              },
              "merchant_name": "IKEA",
              "original_description": "IKEA CHICAGO",
              "pending": false,
              "transaction_id": "6GQZARgvroCAE1eW5wpQT7w3oB6nvzi8DKMBa",
              "unofficial_currency_code": null
            },
            {
              "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",
              "account_owner": null,
              "amount": 12.87,
              "check_number": null,
              "credit_category": {
                "detailed": "GENERAL_MERCHANDISE_SPORTING_GOODS",
                "primary": "GENERAL_MERCHANDISE"
              },
              "date": "2024-07-12",
              "date_posted": "2024-07-12T00:00:00Z",
              "date_transacted": "2024-07-12",
              "iso_currency_code": "USD",
              "location": {
                "address": null,
                "city": "Redlands",
                "country": null,
                "lat": null,
                "lon": null,
                "postal_code": null,
                "region": "CA",
                "state": "CA",
                "store_number": null,
                "zip": null
              },
              "merchant_name": "Nike",
              "original_description": "NIKE REDLANDS CA",
              "pending": false,
              "transaction_id": "DkbmlP8BZxibzADqNplKTeL8aZJVQ1c3WR95z",
              "unofficial_currency_code": null
            },
            {
              "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",
              "account_owner": null,
              "amount": 44.21,
              "check_number": null,
              "credit_category": {
                "detailed": "DINING_DINING",
                "primary": "DINING"
              },
              "date": "2024-07-12",
              "date_posted": "2024-07-12T00:00:00Z",
              "date_transacted": "2024-07-12",
              "iso_currency_code": "USD",
              "location": {
                "address": null,
                "city": null,
                "country": null,
                "lat": null,
                "lon": null,
                "postal_code": null,
                "region": null,
                "state": null,
                "store_number": null,
                "zip": null
              },
              "merchant_name": null,
              "original_description": "POKE BROS * POKE BRO IL",
              "pending": false,
              "transaction_id": "RpdN7W8GmRSdjZB9Jm7ATj4M86vdnktapkrgL",
              "unofficial_currency_code": null
            },
            {
              "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",
              "account_owner": null,
              "amount": 36.82,
              "check_number": null,
              "credit_category": {
                "detailed": "GENERAL_MERCHANDISE_DISCOUNT_STORES",
                "primary": "GENERAL_MERCHANDISE"
              },
              "date": "2024-07-13",
              "date_posted": "2024-07-13T00:00:00Z",
              "date_transacted": "2024-07-13",
              "iso_currency_code": "USD",
              "location": {
                "address": null,
                "city": null,
                "country": null,
                "lat": null,
                "lon": null,
                "postal_code": null,
                "region": null,
                "state": null,
                "store_number": null,
                "zip": null
              },
              "merchant_name": "Family Dollar",
              "original_description": "FAMILY DOLLAR",
              "pending": false,
              "transaction_id": "5AeQWvo5KLtAD9wNL68PTdAgPE7VNWf5Kye1G",
              "unofficial_currency_code": null
            },
            {
              "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",
              "account_owner": null,
              "amount": 13.27,
              "check_number": null,
              "credit_category": {
                "detailed": "FOOD_RETAIL_GROCERIES",
                "primary": "FOOD_RETAIL"
              },
              "date": "2024-07-13",
              "date_posted": "2024-07-13T00:00:00Z",
              "date_transacted": "2024-07-13",
              "iso_currency_code": "USD",
              "location": {
                "address": null,
                "city": null,
                "country": null,
                "lat": null,
                "lon": null,
                "postal_code": null,
                "region": null,
                "state": null,
                "store_number": null,
                "zip": null
              },
              "merchant_name": "Instacart",
              "original_description": "INSTACART HTTPSINSTACAR CA",
              "pending": false,
              "transaction_id": "Jjlr3MEVg1HlKbdkZj39ij5a7eg9MqtB6MWDo",
              "unofficial_currency_code": null
            },
            {
              "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",
              "account_owner": null,
              "amount": 36.03,
              "check_number": null,
              "credit_category": {
                "detailed": "DINING_DINING",
                "primary": "DINING"
              },
              "date": "2024-07-13",
              "date_posted": "2024-07-13T00:00:00Z",
              "date_transacted": "2024-07-13",
              "iso_currency_code": "USD",
              "location": {
                "address": null,
                "city": null,
                "country": null,
                "lat": null,
                "lon": null,
                "postal_code": null,
                "region": null,
                "state": null,
                "store_number": null,
                "zip": null
              },
              "merchant_name": null,
              "original_description": "POKE BROS * POKE BRO IL",
              "pending": false,
              "transaction_id": "kN9KV7yAZJUMPn93KDXqsG9MrpjlyLUL6Dgl8",
              "unofficial_currency_code": null
            },
            {
              "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",
              "account_owner": null,
              "amount": 54.74,
              "check_number": null,
              "credit_category": {
                "detailed": "FOOD_RETAIL_GROCERIES",
                "primary": "FOOD_RETAIL"
              },
              "date": "2024-07-13",
              "date_posted": "2024-07-13T00:00:00Z",
              "date_transacted": "2024-07-13",
              "iso_currency_code": "USD",
              "location": {
                "address": null,
                "city": "Whittier",
                "country": null,
                "lat": null,
                "lon": null,
                "postal_code": null,
                "region": "CA",
                "state": "CA",
                "store_number": null,
                "zip": null
              },
              "merchant_name": "Smart & Final",
              "original_description": "POS SMART AND FINAL 111 WHITTIER CA",
              "pending": false,
              "transaction_id": "lPvrweZAMqHDar43vwWKs547kLZVEzfpogGVJ",
              "unofficial_currency_code": null
            },
            {
              "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",
              "account_owner": null,
              "amount": 37.5,
              "check_number": null,
              "credit_category": {
                "detailed": "DINING_DINING",
                "primary": "DINING"
              },
              "date": "2024-07-13",
              "date_posted": "2024-07-13T00:00:00Z",
              "date_transacted": "2024-07-13",
              "iso_currency_code": "USD",
              "location": {
                "address": "1627 N 24th St",
                "city": "Phoenix",
                "country": null,
                "lat": null,
                "lon": null,
                "postal_code": "85008",
                "region": "AZ",
                "state": "AZ",
                "store_number": null,
                "zip": "85008"
              },
              "merchant_name": "Taqueria El Guerrerense",
              "original_description": "TAQUERIA EL GUERRERO PHOENIX AZ",
              "pending": false,
              "transaction_id": "wka74WKqngiyJ3pj7dl5SbpLGQBZqyCPZRDbP",
              "unofficial_currency_code": null
            },
            {
              "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",
              "account_owner": null,
              "amount": 41.42,
              "check_number": null,
              "credit_category": {
                "detailed": "GENERAL_MERCHANDISE_ONLINE_MARKETPLACES",
                "primary": "GENERAL_MERCHANDISE"
              },
              "date": "2024-07-14",
              "date_posted": "2024-07-14T00:00:00Z",
              "date_transacted": "2024-07-14",
              "iso_currency_code": "USD",
              "location": {
                "address": null,
                "city": null,
                "country": null,
                "lat": null,
                "lon": null,
                "postal_code": null,
                "region": null,
                "state": null,
                "store_number": null,
                "zip": null
              },
              "merchant_name": "Amazon",
              "original_description": "AMZN Mktp US*11111111 Amzn.com/bill WA AM",
              "pending": false,
              "transaction_id": "BBGnV4RkerHjn8WVavGyiJbQ95VNDaC4M56bJ",
              "unofficial_currency_code": null
            },
            {
              "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",
              "account_owner": null,
              "amount": -1077.93,
              "check_number": null,
              "credit_category": {
                "detailed": "INCOME_OTHER",
                "primary": "INCOME"
              },
              "date": "2024-07-14",
              "date_posted": "2024-07-14T00:00:00Z",
              "date_transacted": "2024-07-14",
              "iso_currency_code": "USD",
              "location": {
                "address": null,
                "city": null,
                "country": null,
                "lat": null,
                "lon": null,
                "postal_code": null,
                "region": null,
                "state": null,
                "store_number": null,
                "zip": null
              },
              "merchant_name": "Lyft",
              "original_description": "LYFT TRANSFER",
              "pending": false,
              "transaction_id": "3Ej78yKJlQu1Abw7xzo4U4JR6pmwzntZlbKDK",
              "unofficial_currency_code": null
            },
            {
              "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",
              "account_owner": null,
              "amount": 47.17,
              "check_number": null,
              "credit_category": {
                "detailed": "FOOD_RETAIL_GROCERIES",
                "primary": "FOOD_RETAIL"
              },
              "date": "2024-07-14",
              "date_posted": "2024-07-14T00:00:00Z",
              "date_transacted": "2024-07-14",
              "iso_currency_code": "USD",
              "location": {
                "address": null,
                "city": "Whittier",
                "country": null,
                "lat": null,
                "lon": null,
                "postal_code": null,
                "region": "CA",
                "state": "CA",
                "store_number": null,
                "zip": null
              },
              "merchant_name": "Smart & Final",
              "original_description": "POS SMART AND FINAL 111 WHITTIER CA",
              "pending": false,
              "transaction_id": "rMzaBpJw8jSZRJQBabKdteQBwd5EaWc7J9qem",
              "unofficial_currency_code": null
            },
            {
              "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",
              "account_owner": null,
              "amount": 12.37,
              "check_number": null,
              "credit_category": {
                "detailed": "FOOD_RETAIL_GROCERIES",
                "primary": "FOOD_RETAIL"
              },
              "date": "2024-07-14",
              "date_posted": "2024-07-14T00:00:00Z",
              "date_transacted": "2024-07-14",
              "iso_currency_code": "USD",
              "location": {
                "address": null,
                "city": "Whittier",
                "country": null,
                "lat": null,
                "lon": null,
                "postal_code": null,
                "region": "CA",
                "state": "CA",
                "store_number": null,
                "zip": null
              },
              "merchant_name": "Smart & Final",
              "original_description": "POS SMART AND FINAL 111 WHITTIER CA",
              "pending": false,
              "transaction_id": "zWPZjkmzynTyel89ZjExS59DV6WAaZflNBJ56",
              "unofficial_currency_code": null
            },
            {
              "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",
              "account_owner": null,
              "amount": 44.18,
              "check_number": null,
              "credit_category": {
                "detailed": "FOOD_RETAIL_GROCERIES",
                "primary": "FOOD_RETAIL"
              },
              "date": "2024-07-14",
              "date_posted": "2024-07-14T00:00:00Z",
              "date_transacted": "2024-07-14",
              "iso_currency_code": "USD",
              "location": {
                "address": null,
                "city": "Portland",
                "country": null,
                "lat": null,
                "lon": null,
                "postal_code": null,
                "region": "OR",
                "state": "OR",
                "store_number": "1111",
                "zip": null
              },
              "merchant_name": "Safeway",
              "original_description": "SAFEWAY #1111 PORTLAND OR            111111",
              "pending": false,
              "transaction_id": "K7qzx1nP8ptqgwaRMbxyI86XrqADMluRpkWx5",
              "unofficial_currency_code": null
            },
            {
              "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",
              "account_owner": null,
              "amount": 45.37,
              "check_number": null,
              "credit_category": {
                "detailed": "DINING_DINING",
                "primary": "DINING"
              },
              "date": "2024-07-14",
              "date_posted": "2024-07-14T00:00:00Z",
              "date_transacted": "2024-07-14",
              "iso_currency_code": "USD",
              "location": {
                "address": null,
                "city": null,
                "country": null,
                "lat": null,
                "lon": null,
                "postal_code": null,
                "region": null,
                "state": null,
                "store_number": null,
                "zip": null
              },
              "merchant_name": "Uber Eats",
              "original_description": "UBER EATS",
              "pending": false,
              "transaction_id": "qZrdzLRAgNHo5peMdD9xIzELl3a1NvcgrPAzL",
              "unofficial_currency_code": null
            },
            {
              "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",
              "account_owner": null,
              "amount": 15.22,
              "check_number": null,
              "credit_category": {
                "detailed": "GENERAL_MERCHANDISE_ONLINE_MARKETPLACES",
                "primary": "GENERAL_MERCHANDISE"
              },
              "date": "2024-07-15",
              "date_posted": "2024-07-15T00:00:00Z",
              "date_transacted": "2024-07-15",
              "iso_currency_code": "USD",
              "location": {
                "address": null,
                "city": null,
                "country": null,
                "lat": null,
                "lon": null,
                "postal_code": null,
                "region": null,
                "state": null,
                "store_number": null,
                "zip": null
              },
              "merchant_name": "Amazon",
              "original_description": "AMZN Mktp US*11111111 Amzn.com/bill WA AM",
              "pending": false,
              "transaction_id": "NZzx4oRPkAHzyRekpG4PTZkWnBPqEyiy6pB1M",
              "unofficial_currency_code": null
            },
            {
              "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",
              "account_owner": null,
              "amount": 26.33,
              "check_number": null,
              "credit_category": {
                "detailed": "DINING_DINING",
                "primary": "DINING"
              },
              "date": "2024-07-15",
              "date_posted": "2024-07-15T00:00:00Z",
              "date_transacted": "2024-07-15",
              "iso_currency_code": "USD",
              "location": {
                "address": null,
                "city": null,
                "country": null,
                "lat": null,
                "lon": null,
                "postal_code": null,
                "region": null,
                "state": null,
                "store_number": null,
                "zip": null
              },
              "merchant_name": "Domino's",
              "original_description": "DOMINO's XXXX 111-222-3333",
              "pending": false,
              "transaction_id": "x84eNArKbESz8Woden6LT3nvyogeJXc64Pp35",
              "unofficial_currency_code": null
            },
            {
              "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",
              "account_owner": null,
              "amount": 39.8,
              "check_number": null,
              "credit_category": {
                "detailed": "GENERAL_MERCHANDISE_DISCOUNT_STORES",
                "primary": "GENERAL_MERCHANDISE"
              },
              "date": "2024-07-15",
              "date_posted": "2024-07-15T00:00:00Z",
              "date_transacted": "2024-07-15",
              "iso_currency_code": "USD",
              "location": {
                "address": null,
                "city": null,
                "country": null,
                "lat": null,
                "lon": null,
                "postal_code": null,
                "region": null,
                "state": null,
                "store_number": null,
                "zip": null
              },
              "merchant_name": "Family Dollar",
              "original_description": "FAMILY DOLLAR",
              "pending": false,
              "transaction_id": "dzWnyxwZ4GHlZPGgrNyxiMG7qd5jDgCJEz5jL",
              "unofficial_currency_code": null
            },
            {
              "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",
              "account_owner": null,
              "amount": 45.06,
              "check_number": null,
              "credit_category": {
                "detailed": "FOOD_RETAIL_GROCERIES",
                "primary": "FOOD_RETAIL"
              },
              "date": "2024-07-15",
              "date_posted": "2024-07-15T00:00:00Z",
              "date_transacted": "2024-07-15",
              "iso_currency_code": "USD",
              "location": {
                "address": null,
                "city": null,
                "country": null,
                "lat": null,
                "lon": null,
                "postal_code": null,
                "region": null,
                "state": null,
                "store_number": null,
                "zip": null
              },
              "merchant_name": "Instacart",
              "original_description": "INSTACART HTTPSINSTACAR CA",
              "pending": false,
              "transaction_id": "4W7eE9rZqMToDArbPeLNIREoKpdgBMcJbVNQD",
              "unofficial_currency_code": null
            },
            {
              "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",
              "account_owner": null,
              "amount": 34.91,
              "check_number": null,
              "credit_category": {
                "detailed": "FOOD_RETAIL_GROCERIES",
                "primary": "FOOD_RETAIL"
              },
              "date": "2024-07-15",
              "date_posted": "2024-07-15T00:00:00Z",
              "date_transacted": "2024-07-15",
              "iso_currency_code": "USD",
              "location": {
                "address": null,
                "city": "Whittier",
                "country": null,
                "lat": null,
                "lon": null,
                "postal_code": null,
                "region": "CA",
                "state": "CA",
                "store_number": null,
                "zip": null
              },
              "merchant_name": "Smart & Final",
              "original_description": "POS SMART AND FINAL 111 WHITTIER CA",
              "pending": false,
              "transaction_id": "j4yqDjb7QwS7woGzqrgDIEG1NaQVZwf6Wmz3D",
              "unofficial_currency_code": null
            },
            {
              "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",
              "account_owner": null,
              "amount": 49.78,
              "check_number": null,
              "credit_category": {
                "detailed": "FOOD_RETAIL_GROCERIES",
                "primary": "FOOD_RETAIL"
              },
              "date": "2024-07-15",
              "date_posted": "2024-07-15T00:00:00Z",
              "date_transacted": "2024-07-15",
              "iso_currency_code": "USD",
              "location": {
                "address": null,
                "city": "Portland",
                "country": null,
                "lat": null,
                "lon": null,
                "postal_code": null,
                "region": "OR",
                "state": "OR",
                "store_number": "1111",
                "zip": null
              },
              "merchant_name": "Safeway",
              "original_description": "SAFEWAY #1111 PORTLAND OR            111111",
              "pending": false,
              "transaction_id": "aqgWnze7xoHd6DQwLPnzT5dgPKjB1NfZ5JlBy",
              "unofficial_currency_code": null
            },
            {
              "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",
              "account_owner": null,
              "amount": 54.24,
              "check_number": null,
              "credit_category": {
                "detailed": "FOOD_RETAIL_GROCERIES",
                "primary": "FOOD_RETAIL"
              },
              "date": "2024-07-15",
              "date_posted": "2024-07-15T00:00:00Z",
              "date_transacted": "2024-07-15",
              "iso_currency_code": "USD",
              "location": {
                "address": null,
                "city": "Portland",
                "country": null,
                "lat": null,
                "lon": null,
                "postal_code": null,
                "region": "OR",
                "state": "OR",
                "store_number": "1111",
                "zip": null
              },
              "merchant_name": "Safeway",
              "original_description": "SAFEWAY #1111 PORTLAND OR            111111",
              "pending": false,
              "transaction_id": "P13aP8b7nmS3WQoxg1PMsdvMK679RNfo65B4G",
              "unofficial_currency_code": null
            },
            {
              "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",
              "account_owner": null,
              "amount": 41.79,
              "check_number": null,
              "credit_category": {
                "detailed": "GENERAL_MERCHANDISE_ONLINE_MARKETPLACES",
                "primary": "GENERAL_MERCHANDISE"
              },
              "date": "2024-07-16",
              "date_posted": "2024-07-16T00:00:00Z",
              "date_transacted": "2024-07-16",
              "iso_currency_code": "USD",
              "location": {
                "address": null,
                "city": null,
                "country": null,
                "lat": null,
                "lon": null,
                "postal_code": null,
                "region": null,
                "state": null,
                "store_number": null,
                "zip": null
              },
              "merchant_name": "Amazon",
              "original_description": "AMZN Mktp US*11111111 Amzn.com/bill WA AM",
              "pending": false,
              "transaction_id": "7nZMG6pXz8SADylMqzx7TraE4qjJm7udJyAGm",
              "unofficial_currency_code": null
            },
            {
              "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",
              "account_owner": null,
              "amount": 33.86,
              "check_number": null,
              "credit_category": {
                "detailed": "FOOD_RETAIL_GROCERIES",
                "primary": "FOOD_RETAIL"
              },
              "date": "2024-07-16",
              "date_posted": "2024-07-16T00:00:00Z",
              "date_transacted": "2024-07-16",
              "iso_currency_code": "USD",
              "location": {
                "address": null,
                "city": null,
                "country": null,
                "lat": null,
                "lon": null,
                "postal_code": null,
                "region": null,
                "state": null,
                "store_number": null,
                "zip": null
              },
              "merchant_name": "Instacart",
              "original_description": "INSTACART HTTPSINSTACAR CA",
              "pending": false,
              "transaction_id": "MQr3ap7PWEIrQG7bLdaNsxyBV7g1KqCL6pwoy",
              "unofficial_currency_code": null
            },
            {
              "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",
              "account_owner": null,
              "amount": 27.08,
              "check_number": null,
              "credit_category": {
                "detailed": "DINING_DINING",
                "primary": "DINING"
              },
              "date": "2024-07-16",
              "date_posted": "2024-07-16T00:00:00Z",
              "date_transacted": "2024-07-16",
              "iso_currency_code": "USD",
              "location": {
                "address": null,
                "city": null,
                "country": null,
                "lat": null,
                "lon": null,
                "postal_code": null,
                "region": null,
                "state": null,
                "store_number": null,
                "zip": null
              },
              "merchant_name": null,
              "original_description": "POKE BROS * POKE BRO IL",
              "pending": false,
              "transaction_id": "eBAk9dvwNbHPZpr8W69dU3rekJz47Kcr9BRwl",
              "unofficial_currency_code": null
            },
            {
              "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",
              "account_owner": null,
              "amount": 25.94,
              "check_number": null,
              "credit_category": {
                "detailed": "GENERAL_MERCHANDISE_FURNITURE_AND_HARDWARE",
                "primary": "GENERAL_MERCHANDISE"
              },
              "date": "2024-07-16",
              "date_posted": "2024-07-16T00:00:00Z",
              "date_transacted": "2024-07-16",
              "iso_currency_code": "USD",
              "location": {
                "address": null,
                "city": null,
                "country": null,
                "lat": null,
                "lon": null,
                "postal_code": null,
                "region": null,
                "state": null,
                "store_number": null,
                "zip": null
              },
              "merchant_name": "The Home Depot",
              "original_description": "THE HOME DEPOT",
              "pending": false,
              "transaction_id": "QLx4jEJZb9SxRm7aWbjAio3LrgZ5vPswm64dE",
              "unofficial_currency_code": null
            },
            {
              "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",
              "account_owner": null,
              "amount": 27.57,
              "check_number": null,
              "credit_category": {
                "detailed": "GENERAL_MERCHANDISE_OTHER_GENERAL_MERCHANDISE",
                "primary": "GENERAL_MERCHANDISE"
              },
              "date": "2024-07-16",
              "date_posted": "2024-07-16T00:00:00Z",
              "date_transacted": "2024-07-16",
              "iso_currency_code": "USD",
              "location": {
                "address": null,
                "city": null,
                "country": null,
                "lat": null,
                "lon": null,
                "postal_code": null,
                "region": null,
                "state": null,
                "store_number": null,
                "zip": null
              },
              "merchant_name": null,
              "original_description": "The Press Club",
              "pending": false,
              "transaction_id": "ZnQ1ovqBldSQ6GzRbroAHLdQP68BrKceqmAjX",
              "unofficial_currency_code": null
            }
          ],
          "type": "depository"
        }
      ],
      "date_last_updated": "2024-07-16T01:52:42.912331716Z",
      "institution_id": "ins_109512",
      "institution_name": "Houndstooth Bank",
      "item_id": "NZzx4oRPkAHzyRekpG4PTZkDNkQW93tWnyGeA"
    }
  ],
  "report_id": "f3bb434f-1c9b-4ef2-b76c-3d1fd08156ec"
},
"warnings": [],
"request_id": "FibfL8t3s71KJnj"
1089}

Was this helpful?

Retrieve cash flow information from your user's banks

This endpoint allows you to retrieve the Income Insights report for your user. You should call this endpoint after you've received a CHECK_REPORT_READY webhook, either after the Link session for the user or after calling /cra/check_report/create. If the most recent consumer report for the user doesn’t have sufficient data to generate the base report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling /cra/check_report/create.

cra/check_report/income_insights/get

Request fields

string

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.

string

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.

string

The user token associated with the User data is being requested for.

/cra/check_report/income_insights/get
Select Language
1try {
2  const response = await client.craCheckReportIncomeInsightsGet({
3    user_token: 'user-environment-1234567-abcd-abcd-1234-1234567890ab',
4  });
5} catch (error) {
6  // handle error
7}

cra/check_report/income_insights/get

Response fields and example

object

The Check Income Insights Report for an end user.

string

The unique identifier associated with the Check Income Insights Report.

generated_time

string

The time when the Check Income Insights Report was generated.

Format: date-time

days_requested

integer

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

[object]

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

string

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

bank_income_accounts

[object]

The Item's accounts that have bank income data.

string

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.

mask

nullablestring

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.

object

An object containing metadata about the extracted account.

nullablestring

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

Format: date

nullablestring

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

Format: date

name

string

The name of the bank account.

official_name

nullablestring

The official name of the bank account.

subtype

string

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

Possible values: checking, savings, hsa, cd, money market, paypal, prepaid, cash management, ebt, all

type

string

The account type. This will always be depository.

Possible values: depository

owners

[object]

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

names

[string]

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

[object]

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

string

The phone number.

boolean

When true, identifies the phone number as the primary number on an account.

type

string

The type of phone number.

Possible values: home, work, office, mobile, mobile1, other

emails

[object]

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

string

The email address.

boolean

When true, identifies the email address as the primary email on an account.

type

string

The type of email account as described by the financial institution.

Possible values: primary, secondary, other

addresses

[object]

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

object

Data about the components comprising an address.

city

nullablestring

The full city name

nullablestring

The region or state. In API versions 2018-05-22 and earlier, this field is called state. Example: "NC"

street

string

The full street address Example: "564 Main Street, APT 15"

nullablestring

The postal code. In API versions 2018-05-22 and earlier, this field is called zip.

nullablestring

The ISO 3166-1 alpha-2 country code

boolean

When true, identifies the address as the primary address on an account.

bank_income_sources

[object]

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

string

The account ID with which this income source is associated.

income_source_id

string

A unique identifier for an income source.

income_description

string

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

income_category

string

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.

Possible values: SALARY, UNEMPLOYMENT, CASH, GIG_ECONOMY, RENTAL, CHILD_SUPPORT, MILITARY, RETIREMENT, LONG_TERM_DISABILITY, BANK_INTEREST, CASH_DEPOSIT, TRANSFER_FROM_APPLICATION, TAX_REFUND, BENEFIT_OTHER, OTHER

string

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

Format: date

string

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

Format: date

pay_frequency

string

The income pay frequency.

Possible values: WEEKLY, BIWEEKLY, SEMI_MONTHLY, MONTHLY, DAILY, UNKNOWN

number

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

nullablestring

The ISO 4217 currency code of the amount or balance.

historical_average_monthly_gross_income

nullablestring

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.

transaction_count

integer

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

next_payment_date

nullablestring

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

Format: date

nullablenumber

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

historical_average_monthly_income

nullablenumber

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

forecasted_average_monthly_income

nullablenumber

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

forecasted_average_monthly_income_prediction_intervals

[object]

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

lower_bound

nullablenumber

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

upper_bound

nullablenumber

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

probability

nullablenumber

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.

employer

object

The object containing employer data.

name

nullablestring

The name of the employer.

historical_summary

[object]

total_amounts

[object]

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.

number

Value of amount with up to 2 decimal places.

nullablestring

The ISO 4217 currency code of the amount or balance.

nullablestring

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.

string

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

Format: date

string

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

Format: date

transactions

[object]

transaction_id

string

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

number

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.

date

string

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

Format: date

name

string

The merchant name or transaction description.

original_description

nullablestring

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

pending

boolean

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

check_number

nullablestring

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

nullablestring

The ISO 4217 currency code of the amount or balance.

nullablestring

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.

bonus_type

nullablestring

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

Possible values: BONUS_INCLUDED, BONUS_ONLY, null

last_updated_time

string

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

Format: date-time

string

The unique identifier of the institution associated with the Item.

string

The name of the institution associated with the Item.

bank_income_summary

object

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

total_amounts

[object]

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.

number

Value of amount with up to 2 decimal places.

nullablestring

The ISO 4217 currency code of the amount or balance.

nullablestring

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.

string

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

Format: date

income_categories_count

string

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

Format: date

income_sources_count

integer

Number of income sources per end user.

integer

Number of income categories per end user.

income_transactions_count

integer

Number of income transactions per end user.

historical_average_monthly_gross_income

[object]

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

number

Value of amount with up to 2 decimal places.

nullablestring

The ISO 4217 currency code of the amount or balance.

historical_average_monthly_income

nullablestring

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.

[object]

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

number

Value of amount with up to 2 decimal places.

nullablestring

The ISO 4217 currency code of the amount or balance.

forecasted_average_monthly_income

nullablestring

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.

[object]

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

number

Value of amount with up to 2 decimal places.

nullablestring

The ISO 4217 currency code of the amount or balance.

historical_annual_gross_income

nullablestring

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.

[object]

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

number

Value of amount with up to 2 decimal places.

nullablestring

The ISO 4217 currency code of the amount or balance.

historical_annual_income

nullablestring

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.

[object]

The annual income amount estimated based on the historical data for the income source(s).

number

Value of amount with up to 2 decimal places.

nullablestring

The ISO 4217 currency code of the amount or balance.

forecasted_annual_income

nullablestring

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.

[object]

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

number

Value of amount with up to 2 decimal places.

nullablestring

The ISO 4217 currency code of the amount or balance.

nullablestring

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.

historical_summary

[object]

total_amounts

[object]

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.

number

Value of amount with up to 2 decimal places.

nullablestring

The ISO 4217 currency code of the amount or balance.

nullablestring

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.

string

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

Format: date

string

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

Format: date

transactions

[object]

transaction_id

string

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

number

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.

date

string

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

Format: date

name

string

The merchant name or transaction description.

original_description

nullablestring

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

pending

boolean

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

check_number

nullablestring

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

nullablestring

The ISO 4217 currency code of the amount or balance.

nullablestring

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.

bonus_type

nullablestring

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

Possible values: BONUS_INCLUDED, BONUS_ONLY, null

warnings

[object]

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.

warning_type

string

The warning type which will always be BANK_INCOME_WARNING.

Possible values: BANK_INCOME_WARNING

warning_code

string

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

Possible values: IDENTITY_UNAVAILABLE, TRANSACTIONS_UNAVAILABLE, REPORT_DELETED, DATA_UNAVAILABLE

cause

object

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.

error_type

string

A broad categorization of the error. Safe for programmatic use.

Possible values: INTERNAL_SERVER_ERROR, INSUFFICIENT_CREDENTIALS, ITEM_LOCKED, USER_SETUP_REQUIRED, COUNTRY_NOT_SUPPORTED, INSTITUTION_DOWN, INSTITUTION_NO_LONGER_SUPPORTED, INSTITUTION_NOT_RESPONDING, INVALID_CREDENTIALS, INVALID_MFA, INVALID_SEND_METHOD, ITEM_LOGIN_REQUIRED, MFA_NOT_SUPPORTED, NO_ACCOUNTS, ITEM_NOT_SUPPORTED, ACCESS_NOT_GRANTED

error_code

string

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.

error_message

string

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

display_message

string

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.

string

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

API Object
1{
"request_id": "LhQf0THi8SH1yJm",
"report": {
  "report_id": "bbfc5174-5433-4648-8d93-9fec6a0c0966",
  "generated_time": "2022-01-31T22:47:53Z",
  "days_requested": 365,
  "items": [
    {
      "item_id": "AZMP7JrGXgtPd3AQMeg7hwMKgk5E8qU1V5ME7",
      "last_updated_time": "2022-01-31T22:47:53Z",
      "institution_id": "ins_0",
      "institution_name": "Plaid Bank",
      "bank_income_accounts": [
        {
          "account_id": "1qKRXQjk8xUWDJojNwPXTj8gEmR48piqRNye8",
          "mask": "8888",
          "metadata": {
            "start_date": "2024-01-01",
            "end_date": "2024-07-16"
          },
          "name": "Plaid Checking Account",
          "official_name": "Plaid Checking Account",
          "type": "depository",
          "subtype": "checking",
          "owners": [
            {
              "addresses": [
                {
                  "data": {
                    "city": "Malakoff",
                    "country": "US",
                    "postal_code": "14236",
                    "region": "NY",
                    "street": "2992 Cameron Road"
                  },
                  "primary": true
                },
                {
                  "data": {
                    "city": "San Matias",
                    "country": "US",
                    "postal_code": "93405-2255",
                    "region": "CA",
                    "street": "2493 Leisure Lane"
                  },
                  "primary": false
                }
              ],
              "emails": [
                {
                  "data": "accountholder0@example.com",
                  "primary": true,
                  "type": "primary"
                },
                {
                  "data": "accountholder1@example.com",
                  "primary": false,
                  "type": "secondary"
                },
                {
                  "data": "extraordinarily.long.email.username.123456@reallylonghostname.com",
                  "primary": false,
                  "type": "other"
                }
              ],
              "names": [
                "Alberta Bobbeth Charleson"
              ],
              "phone_numbers": [
                {
                  "data": "+1 111-555-3333",
                  "primary": false,
                  "type": "home"
                },
                {
                  "data": "+1 111-555-4444",
                  "primary": false,
                  "type": "work"
                },
                {
                  "data": "+1 111-555-5555",
                  "primary": false,
                  "type": "mobile"
                }
              ]
            }
          ]
        }
      ],
      "bank_income_sources": [
        {
          "account_id": "1qKRXQjk8xUWDJojNwPXTj8gEmR48piqRNye8",
          "income_source_id": "f17efbdd-caab-4278-8ece-963511cd3d51",
          "income_description": "PLAID_INC_DIRECT_DEP_PPD",
          "income_category": "SALARY",
          "start_date": "2021-11-15",
          "end_date": "2022-01-15",
          "pay_frequency": "MONTHLY",
          "total_amount": 300,
          "iso_currency_code": "USD",
          "unofficial_currency_code": null,
          "transaction_count": 1,
          "next_payment_date": "2022-12-15",
          "historical_average_monthly_gross_income": 390,
          "historical_average_monthly_income": 300,
          "forecasted_average_monthly_income": 300,
          "forecasted_average_monthly_income_prediction_intervals": [
            {
              "lower_bound": 200,
              "upper_bound": 400,
              "probability": 0.8
            }
          ],
          "employer": {
            "name": "Plaid Inc"
          },
          "historical_summary": [
            {
              "start_date": "2021-11-02",
              "end_date": "2021-11-30",
              "total_amounts": [
                {
                  "amount": 100,
                  "iso_currency_code": "USD",
                  "unofficial_currency_code": null
                }
              ],
              "transactions": [
                {
                  "transaction_id": "aH5klwqG3B19OMT7D6F24Syv8pdnJXmtZoKQ5",
                  "amount": 100,
                  "bonus_type": null,
                  "date": "2021-11-15",
                  "name": "PLAID_INC_DIRECT_DEP_PPD",
                  "original_description": "PLAID_INC_DIRECT_DEP_PPD 123A",
                  "pending": false,
                  "check_number": null,
                  "iso_currency_code": "USD",
                  "unofficial_currency_code": null
                }
              ]
            },
            {
              "start_date": "2021-12-01",
              "end_date": "2021-12-31",
              "total_amounts": [
                {
                  "amount": 100,
                  "iso_currency_code": "USD",
                  "unofficial_currency_code": null
                }
              ],
              "transactions": [
                {
                  "transaction_id": "mN3rQ5iH8BC41T6UjKL9oD2vWJpZqXFomGwY1",
                  "amount": 100,
                  "bonus_type": null,
                  "date": "2021-12-15",
                  "name": "PLAID_INC_DIRECT_DEP_PPD",
                  "original_description": "PLAID_INC_DIRECT_DEP_PPD 123B",
                  "pending": false,
                  "check_number": null,
                  "iso_currency_code": "USD",
                  "unofficial_currency_code": null
                }
              ]
            },
            {
              "start_date": "2022-01-01",
              "end_date": "2022-01-31",
              "total_amounts": [
                {
                  "amount": 100,
                  "iso_currency_code": "USD",
                  "unofficial_currency_code": null
                }
              ],
              "transactions": [
                {
                  "transaction_id": "zK9lDoR8uBH51PNQ3W4T6Mjy2VFXpGtJwsL4",
                  "amount": 100,
                  "bonus_type": null,
                  "date": "2022-01-31",
                  "name": "PLAID_INC_DIRECT_DEP_PPD",
                  "original_description": "PLAID_INC_DIRECT_DEP_PPD 123C",
                  "pending": false,
                  "check_number": null,
                  "iso_currency_code": "USD",
                  "unofficial_currency_code": null
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "bank_income_summary": {
    "total_amounts": [
      {
        "amount": 300,
        "iso_currency_code": "USD",
        "unofficial_currency_code": null
      }
    ],
    "start_date": "2021-11-15",
    "end_date": "2022-01-15",
    "income_sources_count": 1,
    "income_categories_count": 1,
    "income_transactions_count": 1,
    "historical_average_monthly_gross_income": [
      {
        "amount": 390,
        "iso_currency_code": "USD",
        "unofficial_currency_code": null
      }
    ],
    "historical_average_monthly_income": [
      {
        "amount": 300,
        "iso_currency_code": "USD",
        "unofficial_currency_code": null
      }
    ],
    "forecasted_average_monthly_income": [
      {
        "amount": 300,
        "iso_currency_code": "USD",
        "unofficial_currency_code": null
      }
    ],
    "historical_annual_gross_income": [
      {
        "amount": 4680,
        "iso_currency_code": "USD",
        "unofficial_currency_code": null
      }
    ],
    "historical_annual_income": [
      {
        "amount": 3600,
        "iso_currency_code": "USD",
        "unofficial_currency_code": null
      }
    ],
    "forecasted_annual_income": [
      {
        "amount": 3600,
        "iso_currency_code": "USD",
        "unofficial_currency_code": null
      }
    ],
    "historical_summary": [
      {
        "start_date": "2021-11-02",
        "end_date": "2021-11-30",
        "total_amounts": [
          {
            "amount": 100,
            "iso_currency_code": "USD",
            "unofficial_currency_code": null
          }
        ],
        "transactions": [
          {
            "transaction_id": "aH5klwqG3B19OMT7D6F24Syv8pdnJXmtZoKQ5",
            "amount": 100,
            "bonus_type": null,
            "date": "2021-11-15",
            "name": "PLAID_INC_DIRECT_DEP_PPD",
            "original_description": "PLAID_INC_DIRECT_DEP_PPD 123A",
            "pending": false,
            "check_number": null,
            "iso_currency_code": "USD",
            "unofficial_currency_code": null
          }
        ]
      },
      {
        "start_date": "2021-12-01",
        "end_date": "2021-12-31",
        "total_amounts": [
          {
            "amount": 100,
            "iso_currency_code": "USD",
            "unofficial_currency_code": null
          }
        ],
        "transactions": [
          {
            "transaction_id": "mN3rQ5iH8BC41T6UjKL9oD2vWJpZqXFomGwY1",
            "amount": 100,
            "bonus_type": null,
            "date": "2021-12-15",
            "name": "PLAID_INC_DIRECT_DEP_PPD",
            "original_description": "PLAID_INC_DIRECT_DEP_PPD 123B",
            "pending": false,
            "check_number": null,
            "iso_currency_code": "USD",
            "unofficial_currency_code": null
          }
        ]
      },
      {
        "start_date": "2022-01-01",
        "end_date": "2022-01-31",
        "total_amounts": [
          {
            "amount": 100,
            "iso_currency_code": "USD",
            "unofficial_currency_code": null
          }
        ],
        "transactions": [
          {
            "transaction_id": "zK9lDoR8uBH51PNQ3W4T6Mjy2VFXpGtJwsL4",
            "amount": 100,
            "bonus_type": null,
            "date": "2022-01-31",
            "name": "PLAID_INC_DIRECT_DEP_PPD",
            "original_description": "PLAID_INC_DIRECT_DEP_PPD 123C",
            "pending": false,
            "check_number": null,
            "iso_currency_code": "USD",
            "unofficial_currency_code": null
          }
        ]
      }
    ],
    "warnings": []
  }
}
333}

Was this helpful?

Retrieve network attributes for the user

This endpoint allows you to retrieve the Network Insights product for your user. You should call this endpoint after you've received the CHECK_REPORT_READY webhook, either after the Link session for the user or after calling /cra/check_report/create. If the most recent consumer report for the user doesn’t have sufficient data to generate the report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling /cra/check_report/create.
If you did not initialize Link with the cra_network_attributes product or have generated a report using /cra/check_report/create, we will generate the attributes when you call this endpoint.

cra/check_report/network_insights/get

Request fields

string

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.

string

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.

string

The user token associated with the User data is being requested for.

/cra/check_report/network_insights/get
Select Language
1try {
2  const response = await client.craCheckReportNetworkInsightsGet({
3    user_token: 'user-environment-1234567-abcd-abcd-1234-1234567890ab',
4  });
5} catch (error) {
6  // handle error
7}

cra/check_report/network_insights/get

Response fields and example

object

Contains data for the CRA Network Attributes Report.

string

The unique identifier associated with the Network Attributes report object.

generated_time

string

The time when the Network Attributes Report was generated.

Format: date-time

network_attributes

object

A map of network attributes, where the key is a string, and the value is a float, int, or boolean.

[object]

The Items the end user connected in Link.

string

The ID for the institution the user linked.

string

The name of the institution the user linked.

string

The identifier for the Item.

string

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

API Object
1{
"request_id": "LhQf0THi8SH1yJm",
"report": {
  "report_id": "ee093cb0-e3f2-42d1-9dbc-8d8408964194",
  "generated_time": "2022-01-31T22:47:53Z",
  "network_attributes": {
    "plaid_conn_user_lifetime__lending_count": 5,
    "plaid_conn_user_lifetime__personal_lending_flag": true,
    "plaid_conn_user_lifetime__cash_advance_primary_count": 0
  },
  "items": [
    {
      "institution_id": "ins_0",
      "institution_name": "Plaid Bank",
      "item_id": "AZMP7JrGXgtPd3AQMeg7hwMKgk5E8qU1V5ME7"
    }
  ]
}
19}

Was this helpful?

Retrieve cash flow insights from partners

This endpoint allows you to retrieve the Partner Insights report for your user. You should call this endpoint after you've received the CHECK_REPORT_READY webhook, either after the Link session for the user or after calling /cra/check_report/create. If the most recent consumer report for the user doesn’t have sufficient data to generate the base report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling /cra/check_report/create.
If you did not initialize Link with the credit_partner_insights product or have generated a report using /cra/check_report/create, we will call our partners to generate the insights when you call this endpoint. In this case, you may optionally provide parameters under options to configure which insights you want to receive.

cra/check_report/partner_insights/get

Request fields

string

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.

string

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.

string

The user token associated with the User data is being requested for.

options

object

Defines configuration options to generate Partner Insights

prism_products

[string]

The specific Prism Data products to return. If none are passed in, then all products will be returned.

Possible values: insights, scores

prism_versions

object

The versions of Prism products to evaluate

firstdetect

string

The version of Prism FirstDetect. If not specified, will default to v3.

Possible values: 3, null

cashscore

string

The version of Prism CashScore. If not specified, will default to v3.

Possible values: 3, null

insights

string

The version of Prism Insights. If not specified, will default to v3.

Possible values: 3, null

/cra/check_report/partner_insights/get
Select Language
1try {
2  const response = await client.craCheckReportPartnerInsightsGet({
3    user_token: 'user-environment-1234567-abcd-abcd-1234-1234567890ab',
4  });
5} catch (error) {
6  // handle error
7}

cra/check_report/partner_insights/get

Response fields and example

object

The Partner Insights report of the bank data for an end user.

string

A unique identifier associated with the Partner Insights object.

generated_time

string

The time when the Partner Insights report was generated.

Format: date-time

prism

object

The Prism Data insights for the user.

insights

nullableobject

The data from the Insights product returned by Prism Data.

version

integer

The version of Prism Data's insights model used.

result

object

The Insights Result object is a map of cash flow attributes, where the key is a string, and the value is a float or string.

error_reason

string

The error returned by Prism for this product.

cash_score

nullableobject

The data from the CashScore® product returned by Prism Data.

version

deprecatedinteger

The version of Prism Data's cash score model used. This field is deprecated in favor of model_version.

model_version

string

The version of Prism Data's cash score model used.

score

integer

The score returned by Prism Data. Ranges from 1-999, with higher score indicating lower risk.

reason_codes

[string]

The reasons for an individual having risk according to the cash score.

object

An object containing metadata about the provided transactions.

max_age

nullableinteger

Number of days since the oldest transaction.

min_age

nullableinteger

Number of days since the latest transaction.

min_age_credit

nullableinteger

Number of days since the latest credit transaction.

min_age_debit

nullableinteger

Number of days since the latest debit transaction.

max_age_debit

nullableinteger

Number of days since the oldest debit transaction.

max_age_credit

nullableinteger

Number of days since the oldest credit transaction.

num_trxn_credit

nullableinteger

Number of credit transactions.

num_trxn_debit

nullableinteger

Number of debit transactions.

l1m_credit_value_cnt

nullableinteger

Number of credit transactions in the last 30 days.

l1m_debit_value_cnt

nullableinteger

Number of debit transactions in the last 30 days.

error_reason

string

The error returned by Prism for this product.

first_detect

nullableobject

The data from the FirstDetect product returned by Prism Data.

version

deprecatedinteger

The version of Prism Data's FirstDetect model used. This field is deprecated in favor of model_version.

model_version

string

The version of Prism Data's FirstDetect model used.

score

integer

The score returned by Prism Data. Ranges from 1-999, with higher score indicating lower risk.

reason_codes

[string]

The reasons for an individual having risk according to the FirstDetect score.

object

An object containing metadata about the provided transactions.

max_age

nullableinteger

Number of days since the oldest transaction.

min_age

nullableinteger

Number of days since the latest transaction.

min_age_credit

nullableinteger

Number of days since the latest credit transaction.

min_age_debit

nullableinteger

Number of days since the latest debit transaction.

max_age_debit

nullableinteger

Number of days since the oldest debit transaction.

max_age_credit

nullableinteger

Number of days since the oldest credit transaction.

num_trxn_credit

nullableinteger

Number of credit transactions.

num_trxn_debit

nullableinteger

Number of debit transactions.

l1m_credit_value_cnt

nullableinteger

Number of credit transactions in the last 30 days.

l1m_debit_value_cnt

nullableinteger

Number of debit transactions in the last 30 days.

error_reason

string

The error returned by Prism for this product.

string

Details on whether the Prism Data attributes succeeded or failed to be generated.

[object]

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

string

The ID for the institution that the user linked.

string

The name of the institution the user linked.

string

The identifier for the item.

accounts

[object]

A list of accounts in the item

string

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.

mask

nullablestring

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.

object

An object containing metadata about the extracted account.

nullablestring

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

Format: date

nullablestring

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

Format: date

name

string

The name of the account

official_name

nullablestring

The official name of the bank account.

subtype

string

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

Possible values: checking, savings, hsa, cd, money market, paypal, prepaid, cash management, ebt, all

type

string

The account type. This will always be depository.

Possible values: depository

owners

[object]

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

names

[string]

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

[object]

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

string

The phone number.

boolean

When true, identifies the phone number as the primary number on an account.

type

string

The type of phone number.

Possible values: home, work, office, mobile, mobile1, other

emails

[object]

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

string

The email address.

boolean

When true, identifies the email address as the primary email on an account.

type

string

The type of email account as described by the financial institution.

Possible values: primary, secondary, other

addresses

[object]

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

object

Data about the components comprising an address.

city

nullablestring

The full city name

nullablestring

The region or state. In API versions 2018-05-22 and earlier, this field is called state. Example: "NC"

street

string

The full street address Example: "564 Main Street, APT 15"

nullablestring

The postal code. In API versions 2018-05-22 and earlier, this field is called zip.

nullablestring

The ISO 3166-1 alpha-2 country code

boolean

When true, identifies the address as the primary address on an account.

string

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

API Object
1{
"request_id": "LhQf0THi8SH1yJm",
"report": {
  "report_id": "vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D",
  "generated_time": "2022-01-31T22:47:53Z",
  "items": [
    {
      "institution_id": "ins_109508",
      "institution_name": "Plaid Bank",
      "item_id": "Ed6bjNrDLJfGvZWwnkQlfxwoNz54B5C97ejBr",
      "accounts": [
        {
          "account_id": "1qKRXQjk8xUWDJojNwPXTj8gEmR48piqRNye8",
          "mask": "8888",
          "metadata": {
            "start_date": "2022-01-01",
            "end_date": "2022-01-31"
          },
          "name": "Plaid Checking Account",
          "official_name": "Plaid Checking Account",
          "type": "depository",
          "subtype": "checking",
          "owners": [
            {
              "addresses": [
                {
                  "data": {
                    "city": "Malakoff",
                    "country": "US",
                    "postal_code": "14236",
                    "region": "NY",
                    "street": "2992 Cameron Road"
                  },
                  "primary": true
                },
                {
                  "data": {
                    "city": "San Matias",
                    "country": "US",
                    "postal_code": "93405-2255",
                    "region": "CA",
                    "street": "2493 Leisure Lane"
                  },
                  "primary": false
                }
              ],
              "emails": [
                {
                  "data": "accountholder0@example.com",
                  "primary": true,
                  "type": "primary"
                },
                {
                  "data": "accountholder1@example.com",
                  "primary": false,
                  "type": "secondary"
                },
                {
                  "data": "extraordinarily.long.email.username.123456@reallylonghostname.com",
                  "primary": false,
                  "type": "other"
                }
              ],
              "names": [
                "Alberta Bobbeth Charleson"
              ],
              "phone_numbers": [
                {
                  "data": "+1 111-555-3333",
                  "primary": false,
                  "type": "home"
                },
                {
                  "data": "+1 111-555-4444",
                  "primary": false,
                  "type": "work"
                },
                {
                  "data": "+1 111-555-5555",
                  "primary": false,
                  "type": "mobile"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "prism": {
    "insights": {
      "version": 3,
      "result": {
        "l6m_cumbal_acc": 1
      }
    },
    "cash_score": {
      "version": 3,
      "score": 900,
      "reason_codes": [
        "CASHFLOW_D11"
      ],
      "metadata": {
        "max_age": 20,
        "min_age": 1,
        "min_age_credit": 0,
        "min_age_debit": 1,
        "max_age_debit": 20,
        "max_age_credit": 0,
        "num_trxn_credit": 0,
        "num_trxn_debit": 40,
        "l1m_credit_value_cnt": 0,
        "l1m_debit_value_cnt": 40
      }
    },
    "first_detect": {
      "version": 3,
      "score": 900,
      "reason_codes": [
        "CASHFLOW_D11"
      ],
      "metadata": {
        "max_age": 20,
        "min_age": 1,
        "min_age_credit": 0,
        "min_age_debit": 1,
        "max_age_debit": 20,
        "max_age_credit": 0,
        "num_trxn_credit": 0,
        "num_trxn_debit": 40,
        "l1m_credit_value_cnt": 0,
        "l1m_debit_value_cnt": 40
      }
    },
    "status": "SUCCESS"
  }
}
138}

Was this helpful?

Retrieve Consumer Reports as a PDF

/cra/check_report/pdf/get retrieves the most recent Consumer Report in PDF format. By default, the most recent Base Report (if it exists) for the user will be returned. To request that the most recent Income Insights report be included in the PDF as well, use the add-ons field.

cra/check_report/pdf/get

Request fields

string

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.

string

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.

string

The user token associated with the User data is being requested for.

add_ons

[string]

Use this field to include other reports in the PDF.

Possible values: cra_income_insights

/cra/check_report/pdf/get
Select Language
1try {
2  const response = await client.craCheckReportPDFGet({
3    user_token: 'user-environment-1234567-abcd-abcd-1234-1234567890ab',
4  });
5  const pdf = response.buffer.toString('base64');
6} catch (error) {
7  // handle error
8}

Retrieve a Monitoring Insights Report

This endpoint allows you to retrieve a Monitoring Insights report by passing in the user_token referred to in the webhook you received.

cra/monitoring_insights/get

Request fields

string

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.

string

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.

consumer_report_permissible_purpose

requiredstring

The user token associated with the User data is being requested for.

requiredstring

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.

Possible values: ACCOUNT_REVIEW_CREDIT, WRITTEN_INSTRUCTION_OTHER

/cra/monitoring_insights/get
Select Language
1try {
2  const response = await client.craMonitoringInsightsGet({
3    user_token: 'user-environment-1234567-abcd-abcd-1234-1234567890ab',
4    consumer_report_permissible_purpose: 'EXTENSION_OF_CREDIT',
5  });
6} catch (error) {
7  // handle error
8}

cra/monitoring_insights/get

Response fields and example

string

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

[object]

An array of Monitoring Insights Items associated with the user.

date_generated

string

The date and time when the specific insights were generated (per-item), in ISO 8601 format (e.g. "2018-04-12T03:32:11Z").

Format: date-time

string

The item_id of the Item associated with the insights

forecasted_monthly_income

object

An object with details of the Monitoring Insights Item's status.

status_code

string

Enum for the status of the Item's insights

Possible values: AVAILABLE, FAILED, PENDING, ITEM_NOT_SUPPORTED, ITEM_LOGIN_REQUIRED

reason

nullablestring

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

nullableobject

An object representing the Monitoring Insights for the given Item

income

object

An object representing the income subcategory of the report

total_monthly_income

object

Details about about the total monthly income

baseline_amount

number

The aggregated income for the 30 days prior to subscription date

current_amount

number

The aggregated income of the last 30 days

income_sources_counts

object

Details about the number of income sources

baseline_count

number

The number of income sources detected at the subscription date

current_count

number

The number of income sources currently detected

object

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

number

The forecasted monthly income at the time of subscription

current_amount

number

The current forecasted monthly income

historical_annual_income

object

An object representing the historical annual income amount.

baseline_amount

number

The historical annual income at the time of subscription

current_amount

number

The current historical annual income

income_sources

[object]

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

income_source_id

string

A unique identifier for an income source

income_description

string

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

income_category

string

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.

Possible values: SALARY, UNEMPLOYMENT, CASH, GIG_ECONOMY, RENTAL, CHILD_SUPPORT, MILITARY, RETIREMENT, LONG_TERM_DISABILITY, BANK_INTEREST, CASH_DEPOSIT, TRANSFER_FROM_APPLICATION, TAX_REFUND, BENEFIT_OTHER, OTHER

last_transaction_date

string

The last detected transaction date for this income source

Format: date

loans

object

An object representing the loan exposure subcategory of the report

loan_payments_counts

object

Details regarding the number of loan payments

baseline_count

number

The number of loan payments made in the 30 days before the subscription date

current_count

number

The current number of loan payments made in the last 30 days

loan_disbursements_count

number

The number of loan disbursements detected in the last 30 days

loan_payment_merchants_counts

object

Details regarding the number of unique loan payment merchants

baseline_count

number

The number of unique loan payment merchants detected in the 30 days before the subscription date

current_count

number

The current number of unique loan payment merchants detected in the last 30 days

API Object
1{
"items": [
  {
    "date_generated": "2023-03-30T18:27:37Z",
    "item_id": "AZMP7JrGXgtPd3AQMeg7hwMKgk5E8qU1V5ME7",
    "status": {
      "status_code": "AVAILABLE"
    },
    "insights": {
      "income": {
        "income_sources": [
          {
            "income_source_id": "f17efbdd-caab-4278-8ece-963511cd3d51",
            "income_description": "“PLAID_INC_DIRECT_DEP_PPD”",
            "income_category": "SALARY",
            "last_transaction_date": "2023-03-30"
          }
        ],
        "forecasted_monthly_income": {
          "baseline_amount": 10000,
          "current_amount": 12000
        },
        "total_monthly_income": {
          "baseline_amount": 10770.93,
          "current_amount": 20000.31
        },
        "historical_annual_income": {
          "baseline_amount": 120000,
          "current_amount": 144000
        },
        "income_sources_counts": {
          "baseline_count": 1,
          "current_count": 1
        }
      },
      "loans": {
        "loan_payments_counts": {
          "baseline_count": 1,
          "current_count": 1
        },
        "loan_payment_merchants_counts": {
          "baseline_count": 1,
          "current_count": 1
        },
        "loan_disbursements_count": 1
      }
    }
  }
],
"request_id": "m8MDnv9okwxFNBV"
51}

Was this helpful?

Subscribe to Monitoring Insights

This endpoint allows you to subscribe to insights for a user's linked CRA items, which are updated every 14 days.

cra/monitoring_insights/subscribe

Request fields

string

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.

string

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.

requiredstring

The user token associated with the User data is being requested for.

webhook

requiredstring

URL to which Plaid will send Monitoring Insights webhooks, for example when the requested Monitoring Insights is ready.

/cra/monitoring_insights/subscribe
Select Language
1try {
2  const response = await client.craMonitoringInsightsSubscribe({
3    user_token: 'user-environment-1234567-abcd-abcd-1234-1234567890ab',
4    webhook: 'https://example.com/webhook',
5  });
6} catch (error) {
7  // handle error
8}

cra/monitoring_insights/subscribe

Response fields and example

string

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

subscription_id

string

A unique identifier for the subscription.

API Object
1{
2  "subscription_id": "f17efbdd-caab-4278-8ece-963511cd3d51",
3  "request_id": "GVzMdiDd8DDAQK4"
4}

Was this helpful?

Unsubscribe from Monitoring Insights

This endpoint allows you to unsubscribe from previously subscribed Monitoring Insights.

cra/monitoring_insights/unsubscribe

Request fields

string

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.

string

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.

subscription_id

requiredstring

A unique identifier for the subscription.

/cra/monitoring_insights/unsubscribe
Select Language
1try {
2  const response = await client.craMonitoringInsightsUnsubscribe({
3    subscription_id: '"f17efbdd-caab-4278-8ece-963511cd3d51"',
4  });
5} catch (error) {
6  // handle error
7}

cra/monitoring_insights/unsubscribe

Response fields and example

string

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

API Object
1{
2  "request_id": "GVzMdiDd8DDAQK4"
3}

Was this helpful?

Fired when the Check Report are ready to be retrieved. Once this webhook has fired, the report will be available to retrieve for 24 hours.

webhook_type

string

CHECK_REPORT

webhook_code

string

CHECK_REPORT_READY

user_id

string

The user_id corresponding to the user the webhook has fired for.

environment

string

The Plaid environment the webhook was sent from

Possible values: sandbox, production

API Object
1{
2  "webhook_type": "CHECK_REPORT",
3  "webhook_code": "CHECK_REPORT_READY",
4  "user_id": "wz666MBjYWTp2PDzzggYhM6oWWmBb",
5  "environment": "production"
6}

Was this helpful?

Fired when a Check Report has failed to generate

webhook_type

string

CHECK_REPORT

webhook_code

string

CHECK_REPORT_FAILED

user_id

string

The user_id corresponding to the user the webhook has fired for.

environment

string

The Plaid environment the webhook was sent from

Possible values: sandbox, production

API Object
1{
2  "webhook_type": "CHECK_REPORT",
3  "webhook_code": "CHECK_REPORT_FAILED",
4  "user_id": "wz666MBjYWTp2PDzzggYhM6oWWmBb",
5  "environment": "production"
6}

Was this helpful?

For each user enabled for Cash Flow Updates, this webhook will fire every 14 days with information on the status of the update. Upon receiving the webhook, call /cra/monitoring_insights/get to retrieve the updated insights.

webhook_type

string

CRA_MONITORING

webhook_code

string

INSIGHTS_UPDATED