--- title: "Retrieve cash flow insights from the bank accounts used for income verification" method: POST path: "/cra/partner_insights/get" tags: ["plaid"] --- # Retrieve cash flow insights from the bank accounts used for income verification `POST /cra/partner_insights/get` `/cra/partner_insights/get` returns cash flow insights for a specified user. ## Request body - CraPartnerInsightsGetRequest — CraPartnerInsightsGetRequest defines the request schema for `/cra/partner_insights/get`. - `client_id` 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. - `secret` 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. - `user_token` string, required — The user token associated with the user for which data is being requested. This field is used only by customers with pre-existing integrations that already use the `user_token` field. All other customers should use the `user_id` instead. For more details, see [New User APIs](https://plaid.com/docs/api/users/user-apis). - `user_tier` 'free' | 'paid' | 'null', nullable — The tier of the user. ## Response `200` OK - CraPartnerInsightsGetResponse — CraPartnerInsightsGetResponse defines the response schema for `/cra/partner_insights/get`. - `report` CraPartnerInsights[] - `report_id` string — A unique identifier associated with the Partner Insights object. - `generated_time` string, date-time — The time when the Partner Insights report was generated. - `client_report_id` string, nullable — Client-generated identifier, which can be used by lenders to track loan applications. - `fico` CraPartnerInsightsFicoResults, nullable — The calculated UltraFICO® scores returned as part of the Partner Insights report. - `lender_application_id` string, required — Client-generated identifier that uniquely identifies the FICO Application across FICO systems. - `ultrafico_score_results` CraPartnerInsightsUltraFicoScoreResult[], required — UltraFICO® scoring results, one per provided UltraFICO scoring request. - `request_correlation_id` string — Client-generated identifier that can be used to correlate scoring requests with their scoring results. - `fico_scoring_request_id` string — FICO-provided identifier that uniquely identifies this score generation request. - `ultrafico_score` CraPartnerInsightsUltraFicoScore, nullable — The calculated UltraFICO® score. - `ultrafico_score_version` '1.0', required — The version of the UltraFICO® score. - `score` integer, required — Numeric value of the UltraFICO® score. - `negative_reason_codes` string[] — Negative reason codes associated with the score (reasons the score moved downward), in priority order. May contain up to 4 items. - `positive_reason_codes` string[] — Positive reason codes associated with the score (reasons the score moved upward), in priority order. May contain up to 4 items. - `reason_code_1` string, nullable — Deprecated. Use `negative_reason_codes` instead. The first reason code associated with the score. - `reason_code_2` string, nullable — Deprecated. Use `negative_reason_codes` instead. The second reason code associated with the score. - `reason_code_3` string, nullable — Deprecated. Use `negative_reason_codes` instead. The third reason code associated with the score. - `reason_code_4` string, nullable — Deprecated. Use `negative_reason_codes` instead. The fourth reason code associated with the score. - `positive_reason_code_1` string, nullable — Deprecated. Use `positive_reason_codes` instead. The first positive reason code associated with the score. - `positive_reason_code_2` string, nullable — Deprecated. Use `positive_reason_codes` instead. The second positive reason code associated with the score. - `positive_reason_code_3` string, nullable — Deprecated. Use `positive_reason_codes` instead. The third positive reason code associated with the score. - `positive_reason_code_4` string, nullable — Deprecated. Use `positive_reason_codes` instead. The fourth positive reason code associated with the score. - `did_inquiries_adversely_affect_score` boolean, nullable — Whether inquiries adversely affected the score but were not represented in one of the four reason codes. Sometimes referred to as the FACTA Flag. - `error_reason` string — Human-readable description of why the UltraFICO® score could not be computed. - `exclusion_code` string, nullable — FICO exclusion code indicating why an UltraFICO® score could not be computed due to consumer-data conditions (e.g. insufficient account history). `null` when the exclusion code is not set; "0" when a score was produced. - `report_characteristics` CraPartnerInsightsFicoReportCharacteristics, nullable — Report characteristics returned by FICO describing the banking data used to generate the UltraFICO® score. - `num_accounts` integer, nullable — Total number of accounts included in the report. Limited to checking, savings, and money market accounts. - `avg_daily_balance_over_1_month` number, double, nullable — Average daily balance over the past 1 month. - `avg_daily_balance_over_3_months` number, double, nullable — Average daily balance over the past 3 months. - `avg_daily_balance_over_6_months` number, double, nullable — Average daily balance over the past 6 months. - `avg_daily_balance_over_12_months` number, double, nullable — Average daily balance over the past 12 months. - `days_since_earliest_tx` integer, nullable — Number of days since the earliest transaction in the report. - `days_since_most_recent_negative_ending_balance` integer, nullable — Number of days since the most recent day with a negative ending balance. - `days_since_most_recent_insufficient_funds_fee_debit_tx` integer, nullable — Number of days since the most recent insufficient funds fee debit transaction. - `tot_number_days_with_negative_balance_over_1_month` integer, nullable — Total number of days with a negative balance over the past 1 month. - `tot_number_days_with_negative_balance_over_3_months` integer, nullable — Total number of days with a negative balance over the past 3 months. - `tot_number_days_with_negative_balance_over_6_months` integer, nullable — Total number of days with a negative balance over the past 6 months. - `tot_number_days_with_negative_balance_over_12_months` integer, nullable — Total number of days with a negative balance over the past 12 months. - `days_since_most_recent_tx` integer, nullable — Number of days since the most recent transaction. - `days_with_tx_over_1_month` integer, nullable — Number of days with at least one transaction over the past 1 month. - `days_with_tx_over_3_months` integer, nullable — Number of days with at least one transaction over the past 3 months. - `days_with_tx_over_6_months` integer, nullable — Number of days with at least one transaction over the past 6 months. - `days_with_tx_over_12_months` integer, nullable — Number of days with at least one transaction over the past 12 months. - `tot_current_balances` number, double, nullable — Sum of current balances across all accounts in the report. - `num_checking_accounts` integer, nullable — Number of checking accounts included in the report. - `num_money_market_accounts` integer, nullable — Number of money market accounts included in the report. - `num_savings_accounts` integer, nullable — Number of savings accounts included in the report. - `prism` CraPartnerInsightsPrism, nullable — The Prism Data insights for the user. - `insights` PrismInsights, nullable — The data from the Insights product returned by Prism Data. - `version` integer, required — The version of Prism Data's insights model used. This field is deprecated in favor of `model_version`. - `model_version` string — The version of Prism Data's insights model used. - `result` PrismInsightsResult — 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. For a full list of attributes, contact your account manager. The attributes may vary depending on the Prism version used. - `error_reason` string — The error returned by Prism for this product. - `cash_score` PrismCashScore, nullable — The data from the CashScore® product returned by Prism Data. - `version` integer, required — 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, nullable, required — 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. - `metadata` PrismCashScoreMetadata — An object containing metadata about the provided transactions. - `max_age` integer, nullable, required — Number of days since the oldest transaction. - `min_age` integer, nullable, required — Number of days since the latest transaction. - `min_age_credit` integer, nullable, required — Number of days since the latest credit transaction. - `min_age_debit` integer, nullable, required — Number of days since the latest debit transaction. - `max_age_debit` integer, nullable, required — Number of days since the oldest debit transaction. - `max_age_credit` integer, nullable, required — Number of days since the oldest credit transaction. - `num_trxn_credit` integer, nullable, required — Number of credit transactions. - `num_trxn_debit` integer, nullable, required — Number of debit transactions. - `l1m_credit_value_cnt` integer, nullable, required — Number of credit transactions in the last 30 days. - `l1m_debit_value_cnt` integer, nullable, required — Number of debit transactions in the last 30 days. - `error_reason` string — The error returned by Prism for this product. - `extend` PrismExtend, nullable — The data from the CashScore® Extend product returned by Prism Data. - `model_version` string, required — The version of Prism Data's CashScore® Extend model used. - `score` integer, nullable, required — 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 CashScore® Extend score. - `metadata` PrismCashScoreMetadata — An object containing metadata about the provided transactions. - `max_age` integer, nullable, required — Number of days since the oldest transaction. - `min_age` integer, nullable, required — Number of days since the latest transaction. - `min_age_credit` integer, nullable, required — Number of days since the latest credit transaction. - `min_age_debit` integer, nullable, required — Number of days since the latest debit transaction. - `max_age_debit` integer, nullable, required — Number of days since the oldest debit transaction. - `max_age_credit` integer, nullable, required — Number of days since the oldest credit transaction. - `num_trxn_credit` integer, nullable, required — Number of credit transactions. - `num_trxn_debit` integer, nullable, required — Number of debit transactions. - `l1m_credit_value_cnt` integer, nullable, required — Number of credit transactions in the last 30 days. - `l1m_debit_value_cnt` integer, nullable, required — Number of debit transactions in the last 30 days. - `error_reason` string — The error returned by Prism for this product. - `first_detect` PrismFirstDetect, nullable — The data from the FirstDetect product returned by Prism Data. - `version` integer, required — 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, nullable, required — 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. - `metadata` PrismCashScoreMetadata — An object containing metadata about the provided transactions. - `max_age` integer, nullable, required — Number of days since the oldest transaction. - `min_age` integer, nullable, required — Number of days since the latest transaction. - `min_age_credit` integer, nullable, required — Number of days since the latest credit transaction. - `min_age_debit` integer, nullable, required — Number of days since the latest debit transaction. - `max_age_debit` integer, nullable, required — Number of days since the oldest debit transaction. - `max_age_credit` integer, nullable, required — Number of days since the oldest credit transaction. - `num_trxn_credit` integer, nullable, required — Number of credit transactions. - `num_trxn_debit` integer, nullable, required — Number of debit transactions. - `l1m_credit_value_cnt` integer, nullable, required — Number of credit transactions in the last 30 days. - `l1m_debit_value_cnt` integer, nullable, required — Number of debit transactions in the last 30 days. - `error_reason` string — The error returned by Prism for this product. - `detect` PrismDetect, nullable — The data from the CashScore® Detect product returned by Prism Data. - `model_version` string, required — The version of Prism Data's CashScore® Detect model used. - `score` integer, nullable, required — 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 CashScore® Detect score. - `metadata` PrismCashScoreMetadata — An object containing metadata about the provided transactions. - `max_age` integer, nullable, required — Number of days since the oldest transaction. - `min_age` integer, nullable, required — Number of days since the latest transaction. - `min_age_credit` integer, nullable, required — Number of days since the latest credit transaction. - `min_age_debit` integer, nullable, required — Number of days since the latest debit transaction. - `max_age_debit` integer, nullable, required — Number of days since the oldest debit transaction. - `max_age_credit` integer, nullable, required — Number of days since the oldest credit transaction. - `num_trxn_credit` integer, nullable, required — Number of credit transactions. - `num_trxn_debit` integer, nullable, required — Number of debit transactions. - `l1m_credit_value_cnt` integer, nullable, required — Number of credit transactions in the last 30 days. - `l1m_debit_value_cnt` integer, nullable, required — Number of debit transactions in the last 30 days. - `error_reason` string — The error returned by Prism for this product. - `status` string, required — Details on whether the Prism Data attributes succeeded or failed to be generated. - `items` CraPartnerInsightsItem[] — The list of Items used in the report along with the associated metadata about the Item. - `institution_id` string — The ID for the institution that the user linked. - `institution_name` string — The name of the institution the user linked. - `item_id` string — The identifier for the Item. - `accounts` CraPartnerInsightsItemAccount[] — A list of accounts in the Item. - `account_id` 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` string, nullable, required — The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user. - `metadata` CraPartnerInsightsItemAccountMetadata, required — An object containing metadata about the extracted account. - `start_date` string, date, nullable, required — The date of the earliest extracted transaction, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format ("yyyy-mm-dd"). - `end_date` string, date, nullable, required — The date of the most recent extracted transaction, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format ("yyyy-mm-dd"). - `name` string, required — The name of the account - `official_name` string, nullable, required — The official name of the bank account. - `subtype` 'checking' | 'savings' | 'hsa' | 'cd' | 'money market' | 'paypal' | 'prepaid' | 'cash management' | 'ebt' | 'limited purpose checking' | 'all', required — Valid account subtypes for depository accounts. For a list containing descriptions of each subtype, see [Account schemas](https://plaid.com/docs/api/accounts/#StandaloneAccountType-depository). - `type` 'depository', required — The account type. This will always be `depository`. - `owners` Owner[], required — 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[], required — 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` PhoneNumber[], required — 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, required — The phone number. - `primary` boolean, required — When `true`, identifies the phone number as the primary number on an account. - `type` 'home' | 'work' | 'office' | 'mobile' | 'mobile1' | 'other', required — The type of phone number. - `emails` Email[], required — 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, required — The email address. - `primary` boolean, required — When `true`, identifies the email address as the primary email on an account. - `type` 'primary' | 'secondary' | 'other', required — The type of email account as described by the financial institution. - `addresses` Address[], required — 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` AddressData, required — Data about the components comprising an address. - … - `primary` boolean — When `true`, identifies the address as the primary address on an account. - `request_id` string, required — A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. ## Other responses - `default` — Error response --- [API](https://skmtc.net/plaid/apis/the-plaid-api.md) · [All operations](https://skmtc.net/plaid/apis/the-plaid-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/plaid/the-plaid-api/versions/64c4514ea59b/schema)