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

Required

CraPartnerInsightsGetRequest defines the request schema for /cra/partner_insights/get.

Parameters

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
required, string
The user token associated with the User data is being requested for.

Response

CraPartnerInsightsGetResponse defines the response schema for /cra/partner_insights/get.

Response Properties

report
array[object]
report_id
string
A unique identifier associated with the Partner Insights object.
generated_time
string
The time when the Partner Insights report was generated.
client_report_id
string
Client-generated identifier, which can be used by lenders to track loan applications.
prism
object
The Prism Data insights for the user.
insights
object
The data from the Insights product returned by Prism Data.
version
required, 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
object
The data from the CashScore® product returned by Prism Data.
version
required, integer
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
required, integer
The score returned by Prism Data. Ranges from 1-999, with higher score indicating lower risk.
reason_codes
array[string]
The reasons for an individual having risk according to the cash score.
metadata
object
An object containing metadata about the provided transactions.
max_age
required, integer
Number of days since the oldest transaction.
min_age
required, integer
Number of days since the latest transaction.
min_age_credit
required, integer
Number of days since the latest credit transaction.
min_age_debit
required, integer
Number of days since the latest debit transaction.
max_age_debit
required, integer
Number of days since the oldest debit transaction.
max_age_credit
required, integer
Number of days since the oldest credit transaction.
num_trxn_credit
required, integer
Number of credit transactions.
num_trxn_debit
required, integer
Number of debit transactions.
l1m_credit_value_cnt
required, integer
Number of credit transactions in the last 30 days.
l1m_debit_value_cnt
required, integer
Number of debit transactions in the last 30 days.
error_reason
string
The error returned by Prism for this product.
extend
object
The data from the CashScore® Extend product returned by Prism Data.
model_version
required, string
The version of Prism Data’s CashScore® Extend model used.
score
required, integer
The score returned by Prism Data. Ranges from 1-999, with higher score indicating lower risk.
reason_codes
array[string]
The reasons for an individual having risk according to the CashScore® Extend score.
metadata
object
An object containing metadata about the provided transactions.
max_age
required, integer
Number of days since the oldest transaction.
min_age
required, integer
Number of days since the latest transaction.
min_age_credit
required, integer
Number of days since the latest credit transaction.
min_age_debit
required, integer
Number of days since the latest debit transaction.
max_age_debit
required, integer
Number of days since the oldest debit transaction.
max_age_credit
required, integer
Number of days since the oldest credit transaction.
num_trxn_credit
required, integer
Number of credit transactions.
num_trxn_debit
required, integer
Number of debit transactions.
l1m_credit_value_cnt
required, integer
Number of credit transactions in the last 30 days.
l1m_debit_value_cnt
required, integer
Number of debit transactions in the last 30 days.
error_reason
string
The error returned by Prism for this product.
first_detect
object
The data from the FirstDetect product returned by Prism Data.
version
required, integer
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
required, integer
The score returned by Prism Data. Ranges from 1-999, with higher score indicating lower risk.
reason_codes
array[string]
The reasons for an individual having risk according to the FirstDetect score.
metadata
object
An object containing metadata about the provided transactions.
max_age
required, integer
Number of days since the oldest transaction.
min_age
required, integer
Number of days since the latest transaction.
min_age_credit
required, integer
Number of days since the latest credit transaction.
min_age_debit
required, integer
Number of days since the latest debit transaction.
max_age_debit
required, integer
Number of days since the oldest debit transaction.
max_age_credit
required, integer
Number of days since the oldest credit transaction.
num_trxn_credit
required, integer
Number of credit transactions.
num_trxn_debit
required, integer
Number of debit transactions.
l1m_credit_value_cnt
required, integer
Number of credit transactions in the last 30 days.
l1m_debit_value_cnt
required, integer
Number of debit transactions in the last 30 days.
error_reason
string
The error returned by Prism for this product.
detect
object
The data from the CashScore® Detect product returned by Prism Data.
model_version
required, string
The version of Prism Data’s CashScore® Detect model used.
score
required, integer
The score returned by Prism Data. Ranges from 1-999, with higher score indicating lower risk.
reason_codes
array[string]
The reasons for an individual having risk according to the CashScore® Detect score.
metadata
object
An object containing metadata about the provided transactions.
max_age
required, integer
Number of days since the oldest transaction.
min_age
required, integer
Number of days since the latest transaction.
min_age_credit
required, integer
Number of days since the latest credit transaction.
min_age_debit
required, integer
Number of days since the latest debit transaction.
max_age_debit
required, integer
Number of days since the oldest debit transaction.
max_age_credit
required, integer
Number of days since the oldest credit transaction.
num_trxn_credit
required, integer
Number of credit transactions.
num_trxn_debit
required, integer
Number of debit transactions.
l1m_credit_value_cnt
required, integer
Number of credit transactions in the last 30 days.
l1m_debit_value_cnt
required, integer
Number of debit transactions in the last 30 days.
error_reason
string
The error returned by Prism for this product.
status
required, string
Details on whether the Prism Data attributes succeeded or failed to be generated.
items
array[object]
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
array[object]
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
required, string
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
required, object
An object containing metadata about the extracted account.
start_date
required, string
The date of the earliest extracted transaction, in ISO 8601 format (“yyyy-mm-dd”).
end_date
required, string
The date of the most recent extracted transaction, in ISO 8601 format (“yyyy-mm-dd”).
name
required, string
The name of the account
official_name
required, string
The official name of the bank account.
subtype
required, string
Valid account subtypes for depository accounts. For a list containing descriptions of each subtype, see Account schemas.
type
required, string
The account type. This will always be depository.
owners
required, array[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
required, array[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
required, array[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.
emails
required, array[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.
addresses
required, array[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.
request_id
required, string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.