Plaid Check
API reference for Plaid Check endpoints and webhooks
Endpoints | |
---|---|
/cra/check_report/create | Generate a new Consumer Report for your user with the latest data |
/cra/check_report/base_report/get | Retrieve the base Consumer Report for your user |
/cra/check_report/income_insights/get | Retrieve cash flow insights from your user's banks |
/cra/check_report/partner_insights/get | Retrieve cash flow insights from our partners |
/cra/check_report/pdf/get | Retrieve Consumer Reports in PDF format |
See also | |
---|---|
/link/token/create | Create a token for initializing a Link session with Plaid Check |
/user/create | Create a user ID and token for use with Plaid Check |
/user/update | Update an existing user token to work with Plaid Check, or change user details |
/user/remove | Removes the user and their relevant data |
/user/items/get | Returns Items associated with a user along with their corresponding statuses |
Webhooks | |
---|---|
CHECK_REPORT_READY | A Consumer Report is ready to be retrieved |
CHECK_REPORT_FAILED | Plaid Check failed to create a report |
/cra/check_report/create
Create a Consumer Report
/cra/check_report/create
creates a Consumer Report powered by Plaid Check. Plaid Check automatically starts creating Consumer Report data after the user completes the Link process with a Plaid Check product, so you typically would only call this endpoint if you wish to generate an updated report, some time after the initial report was generated.
client_id
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
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.user_token
webhook
days_requested
1
731
consumer_report _permissible_purpose
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.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
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 error10}
Response fields and example
request_id
1{2 "request_id": "LhQf0THi8SH1yJm"3}
Was this helpful?
/cra/check_report/base_report/get
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
.
client_id
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
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.user_token
1try {2 const response = await client.craCheckReportBaseReportGet({3 user_token: 'user-environment-1234567-abcd-abcd-1234-1234567890ab',4 });5} catch (error) {6 // handle error7}
Response fields and example
report
report_id
date_generated
date-time
days_requested
client_report_id
items
institution_name
institution_id
date_last_updated
date-time
item_id
item_id
of the Item associated with this webhook, warning, or erroraccounts
account_id
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
available
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
.double
current
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
.double
limit
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.double
iso_currency_code
unofficial_currency_code
is non-null.unofficial_currency _code
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_code
s.last_updated_datetime
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.date-time
average_balance
double
average_monthly _balances
start_date
end_date
average_balance
iso_currency_code
or unofficial_currency_code
amount
iso_currency_code
unofficial_currency _code
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.most_recent_thirty _day_average_balance
double
consumer_disputes
consumer_dispute_id
dispute_field_create _date
date
category
TRANSACTION
, BALANCE
, IDENTITY
, OTHER
statement
mask
name
official_name
type
investment:
Investment account. In API versions 2018-05-22 and earlier, this type is called brokerage
instead.credit:
Credit carddepository:
Depository accountloan:
Loan accountother:
Non-specified account typeSee the Account type schema for a full listing of account types and corresponding subtypes.
investment
, credit
, depository
, loan
, brokerage
, other
subtype
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
transactions
/transactions/get
or /investments/transactions/get
will be returned in the top-level transactions
field instead.account_id
amount
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.double
iso_currency_code
null
if unofficial_currency_code
is non-null.unofficial_currency _code
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_code
s.original_description
credit_category
See the
taxonomy csv file
for a full list of credit categories.check_number
date_transacted
location
address
city
region
state
.postal_code
zip
.country
lat
double
lon
double
store_number
merchant_name
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
true
, identifies the transaction as pending or unsettled. Pending transaction details (name, type, amount, category ID) may change before they are settled.account_owner
transaction_id
transaction_id
is case sensitive.owners
owner
object, not in multiple owner objects within the array.names
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
emails
addresses
data
city
region
state
.
Example: "NC"
street
"564 Main Street, APT 15"
postal_code
zip
.country
primary
true
, identifies the address as the primary address on an account.ownership_type
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.null
, individual
, joint
, association
, trust
account_insights
oldest_transaction _date
date
most_recent _transaction_date
date
days_available
average_days_between _transactions
longest_gap_between _transactions
longest_gaps_between_transactions
instead. Longest gap between sequential transactionsstart_date
date
end_date
date
days
longest_gaps_between _transactions
longest_gap_between_transactions
by September 30th 2024. Longest gap between sequential transactions in a time period. This array can include multiple time periods.start_date
date
end_date
date
days
number_of_inflows
start_date
date
end_date
date
count
average_inflow_amount
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.start_date
date
end_date
date
total_amount
iso_currency_code
or unofficial_currency_code
amount
iso_currency_code
unofficial_currency _code
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
average_inflow_amount
by September 30th 2024. Average amount of debit transactions into the account in a time period. This array will be empty for non-depository accounts. This field only takes into account USD transactions from the account.start_date
date
end_date
date
total_amount
iso_currency_code
or unofficial_currency_code
amount
iso_currency_code
unofficial_currency _code
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
start_date
date
end_date
date
count
average_outflow_amount
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.start_date
date
end_date
date
total_amount
iso_currency_code
or unofficial_currency_code
amount
iso_currency_code
unofficial_currency _code
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_outflow _amounts
average_outflow_amount
by September 30th 2024. Average amount of transactions out of the account in a time period. This array will be empty for non-depository accounts. This field only takes into account USD transactions from the account.start_date
date
end_date
date
total_amount
iso_currency_code
or unofficial_currency_code
amount
iso_currency_code
unofficial_currency _code
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_days_no _transactions
warnings
warning_type
BASE_REPORT_WARNING
warning_code
OWNERS_UNAVAILABLE
indicates that account-owner information is not available. TRANSACTIONS_UNAVAILABLE
indicates that transactions information associated with Credit and Depository accounts are unavailable.OWNERS_UNAVAILABLE
, TRANSACTIONS_UNAVAILABLE
cause
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
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
error_code_reason
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
display_message
null
if the error is not related to user action.This may change over time and is not safe for programmatic use.
request_id
causes
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.status
documentation_url
suggested_action
item_id
item_id
of the Item associated with this webhook, warning, or errorrequest_id
1{2 "report": {3 "date_generated": "2024-07-16T01:52:42.912331716Z",4 "days_requested": 365,5 "items": [6 {7 "accounts": [8 {9 "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",10 "account_insights": {11 "average_days_between_transactions": 0.15,12 "average_inflow_amount": [13 {14 "end_date": "2024-07-31",15 "start_date": "2024-07-01",16 "total_amount": {17 "amount": -1077.93,18 "iso_currency_code": "USD",19 "unofficial_currency_code": null20 }21 }22 ],23 "average_inflow_amounts": [24 {25 "end_date": "2024-07-31",26 "start_date": "2024-07-01",27 "total_amount": {28 "amount": -1077.93,29 "iso_currency_code": "USD",30 "unofficial_currency_code": null31 }32 },33 {34 "end_date": "2024-08-31",35 "start_date": "2024-08-01",36 "total_amount": {37 "amount": -1076.93,38 "iso_currency_code": "USD",39 "unofficial_currency_code": null40 }41 }42 ],43 "average_outflow_amount": [44 {45 "end_date": "2024-07-31",46 "start_date": "2024-07-01",47 "total_amount": {48 "amount": 34.95,49 "iso_currency_code": "USD",50 "unofficial_currency_code": null51 }52 }53 ],54 "average_outflow_amounts": [55 {56 "end_date": "2024-07-31",57 "start_date": "2024-07-01",58 "total_amount": {59 "amount": 34.95,60 "iso_currency_code": "USD",61 "unofficial_currency_code": null62 }63 },64 {65 "end_date": "2024-08-31",66 "start_date": "2024-08-01",67 "total_amount": {68 "amount": 0,69 "iso_currency_code": "USD",70 "unofficial_currency_code": null71 }72 }73 ],74 "days_available": 365,75 "longest_gap_between_transactions": [76 {77 "days": 1,78 "end_date": "2024-07-31",79 "start_date": "2024-07-01"80 }81 ],82 "longest_gaps_between_transactions": [83 {84 "days": 1,85 "end_date": "2024-07-31",86 "start_date": "2024-07-01"87 },88 {89 "days": 2,90 "end_date": "2024-08-31",91 "start_date": "2024-08-01"92 }93 ],94 "most_recent_transaction_date": "2024-07-16",95 "number_of_days_no_transactions": 0,96 "number_of_inflows": [97 {98 "count": 1,99 "end_date": "2024-07-31",100 "start_date": "2024-07-01"101 }102 ],103 "number_of_outflows": [104 {105 "count": 27,106 "end_date": "2024-07-31",107 "start_date": "2024-07-01"108 }109 ],110 "oldest_transaction_date": "2024-07-12"111 },112 "balances": {113 "available": 5000,114 "average_balance": 4956.12,115 "average_monthly_balances": [116 {117 "average_balance": {118 "amount": 4956.12,119 "iso_currency_code": "USD",120 "unofficial_currency_code": null121 },122 "end_date": "2024-07-31",123 "start_date": "2024-07-01"124 }125 ],126 "current": 5000,127 "iso_currency_code": "USD",128 "limit": null,129 "most_recent_thirty_day_average_balance": 4956.125,130 "unofficial_currency_code": null131 },132 "consumer_disputes": [],133 "days_available": 365,134 "mask": "1208",135 "name": "Checking",136 "official_name": "Plaid checking",137 "owners": [138 {139 "addresses": [140 {141 "data": {142 "city": "Malakoff",143 "country": "US",144 "postal_code": "14236",145 "region": "NY",146 "street": "2992 Cameron Road"147 },148 "primary": true149 },150 {151 "data": {152 "city": "San Matias",153 "country": "US",154 "postal_code": "93405-2255",155 "region": "CA",156 "street": "2493 Leisure Lane"157 },158 "primary": false159 }160 ],161 "emails": [162 {163 "data": "accountholder0@example.com",164 "primary": true,165 "type": "primary"166 },167 {168 "data": "accountholder1@example.com",169 "primary": false,170 "type": "secondary"171 },172 {173 "data": "extraordinarily.long.email.username.123456@reallylonghostname.com",174 "primary": false,175 "type": "other"176 }177 ],178 "names": [179 "Alberta Bobbeth Charleson"180 ],181 "phone_numbers": [182 {183 "data": "+1 111-555-3333",184 "primary": false,185 "type": "home"186 },187 {188 "data": "+1 111-555-4444",189 "primary": false,190 "type": "work"191 },192 {193 "data": "+1 111-555-5555",194 "primary": false,195 "type": "mobile"196 }197 ]198 }199 ],200 "ownership_type": null,201 "subtype": "checking",202 "transactions": [203 {204 "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",205 "account_owner": null,206 "amount": 37.07,207 "check_number": null,208 "credit_category": {209 "detailed": "GENERAL_MERCHANDISE_ONLINE_MARKETPLACES",210 "primary": "GENERAL_MERCHANDISE"211 },212 "date": "2024-07-12",213 "date_posted": "2024-07-12T00:00:00Z",214 "date_transacted": "2024-07-12",215 "iso_currency_code": "USD",216 "location": {217 "address": null,218 "city": null,219 "country": null,220 "lat": null,221 "lon": null,222 "postal_code": null,223 "region": null,224 "state": null,225 "store_number": null,226 "zip": null227 },228 "merchant_name": "Amazon",229 "original_description": "AMZN Mktp US*11111111 Amzn.com/bill WA AM",230 "pending": false,231 "transaction_id": "XA7ZLy8rXzt7D3j9B6LMIgv5VxyQkAhbKjzmp",232 "unofficial_currency_code": null233 },234 {235 "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",236 "account_owner": null,237 "amount": 51.61,238 "check_number": null,239 "credit_category": {240 "detailed": "DINING_DINING",241 "primary": "DINING"242 },243 "date": "2024-07-12",244 "date_posted": "2024-07-12T00:00:00Z",245 "date_transacted": "2024-07-12",246 "iso_currency_code": "USD",247 "location": {248 "address": null,249 "city": null,250 "country": null,251 "lat": null,252 "lon": null,253 "postal_code": null,254 "region": null,255 "state": null,256 "store_number": null,257 "zip": null258 },259 "merchant_name": "Domino's",260 "original_description": "DOMINO's XXXX 111-222-3333",261 "pending": false,262 "transaction_id": "VEPeMbWqRluPVZLQX4MDUkKRw41Ljzf9gyLBW",263 "unofficial_currency_code": null264 },265 {266 "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",267 "account_owner": null,268 "amount": 7.55,269 "check_number": null,270 "credit_category": {271 "detailed": "GENERAL_MERCHANDISE_FURNITURE_AND_HARDWARE",272 "primary": "GENERAL_MERCHANDISE"273 },274 "date": "2024-07-12",275 "date_posted": "2024-07-12T00:00:00Z",276 "date_transacted": "2024-07-12",277 "iso_currency_code": "USD",278 "location": {279 "address": null,280 "city": "Chicago",281 "country": null,282 "lat": null,283 "lon": null,284 "postal_code": null,285 "region": null,286 "state": null,287 "store_number": null,288 "zip": null289 },290 "merchant_name": "IKEA",291 "original_description": "IKEA CHICAGO",292 "pending": false,293 "transaction_id": "6GQZARgvroCAE1eW5wpQT7w3oB6nvzi8DKMBa",294 "unofficial_currency_code": null295 },296 {297 "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",298 "account_owner": null,299 "amount": 12.87,300 "check_number": null,301 "credit_category": {302 "detailed": "GENERAL_MERCHANDISE_SPORTING_GOODS",303 "primary": "GENERAL_MERCHANDISE"304 },305 "date": "2024-07-12",306 "date_posted": "2024-07-12T00:00:00Z",307 "date_transacted": "2024-07-12",308 "iso_currency_code": "USD",309 "location": {310 "address": null,311 "city": "Redlands",312 "country": null,313 "lat": null,314 "lon": null,315 "postal_code": null,316 "region": "CA",317 "state": "CA",318 "store_number": null,319 "zip": null320 },321 "merchant_name": "Nike",322 "original_description": "NIKE REDLANDS CA",323 "pending": false,324 "transaction_id": "DkbmlP8BZxibzADqNplKTeL8aZJVQ1c3WR95z",325 "unofficial_currency_code": null326 },327 {328 "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",329 "account_owner": null,330 "amount": 44.21,331 "check_number": null,332 "credit_category": {333 "detailed": "DINING_DINING",334 "primary": "DINING"335 },336 "date": "2024-07-12",337 "date_posted": "2024-07-12T00:00:00Z",338 "date_transacted": "2024-07-12",339 "iso_currency_code": "USD",340 "location": {341 "address": null,342 "city": null,343 "country": null,344 "lat": null,345 "lon": null,346 "postal_code": null,347 "region": null,348 "state": null,349 "store_number": null,350 "zip": null351 },352 "merchant_name": null,353 "original_description": "POKE BROS * POKE BRO IL",354 "pending": false,355 "transaction_id": "RpdN7W8GmRSdjZB9Jm7ATj4M86vdnktapkrgL",356 "unofficial_currency_code": null357 },358 {359 "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",360 "account_owner": null,361 "amount": 36.82,362 "check_number": null,363 "credit_category": {364 "detailed": "GENERAL_MERCHANDISE_DISCOUNT_STORES",365 "primary": "GENERAL_MERCHANDISE"366 },367 "date": "2024-07-13",368 "date_posted": "2024-07-13T00:00:00Z",369 "date_transacted": "2024-07-13",370 "iso_currency_code": "USD",371 "location": {372 "address": null,373 "city": null,374 "country": null,375 "lat": null,376 "lon": null,377 "postal_code": null,378 "region": null,379 "state": null,380 "store_number": null,381 "zip": null382 },383 "merchant_name": "Family Dollar",384 "original_description": "FAMILY DOLLAR",385 "pending": false,386 "transaction_id": "5AeQWvo5KLtAD9wNL68PTdAgPE7VNWf5Kye1G",387 "unofficial_currency_code": null388 },389 {390 "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",391 "account_owner": null,392 "amount": 13.27,393 "check_number": null,394 "credit_category": {395 "detailed": "FOOD_RETAIL_GROCERIES",396 "primary": "FOOD_RETAIL"397 },398 "date": "2024-07-13",399 "date_posted": "2024-07-13T00:00:00Z",400 "date_transacted": "2024-07-13",401 "iso_currency_code": "USD",402 "location": {403 "address": null,404 "city": null,405 "country": null,406 "lat": null,407 "lon": null,408 "postal_code": null,409 "region": null,410 "state": null,411 "store_number": null,412 "zip": null413 },414 "merchant_name": "Instacart",415 "original_description": "INSTACART HTTPSINSTACAR CA",416 "pending": false,417 "transaction_id": "Jjlr3MEVg1HlKbdkZj39ij5a7eg9MqtB6MWDo",418 "unofficial_currency_code": null419 },420 {421 "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",422 "account_owner": null,423 "amount": 36.03,424 "check_number": null,425 "credit_category": {426 "detailed": "DINING_DINING",427 "primary": "DINING"428 },429 "date": "2024-07-13",430 "date_posted": "2024-07-13T00:00:00Z",431 "date_transacted": "2024-07-13",432 "iso_currency_code": "USD",433 "location": {434 "address": null,435 "city": null,436 "country": null,437 "lat": null,438 "lon": null,439 "postal_code": null,440 "region": null,441 "state": null,442 "store_number": null,443 "zip": null444 },445 "merchant_name": null,446 "original_description": "POKE BROS * POKE BRO IL",447 "pending": false,448 "transaction_id": "kN9KV7yAZJUMPn93KDXqsG9MrpjlyLUL6Dgl8",449 "unofficial_currency_code": null450 },451 {452 "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",453 "account_owner": null,454 "amount": 54.74,455 "check_number": null,456 "credit_category": {457 "detailed": "FOOD_RETAIL_GROCERIES",458 "primary": "FOOD_RETAIL"459 },460 "date": "2024-07-13",461 "date_posted": "2024-07-13T00:00:00Z",462 "date_transacted": "2024-07-13",463 "iso_currency_code": "USD",464 "location": {465 "address": null,466 "city": "Whittier",467 "country": null,468 "lat": null,469 "lon": null,470 "postal_code": null,471 "region": "CA",472 "state": "CA",473 "store_number": null,474 "zip": null475 },476 "merchant_name": "Smart & Final",477 "original_description": "POS SMART AND FINAL 111 WHITTIER CA",478 "pending": false,479 "transaction_id": "lPvrweZAMqHDar43vwWKs547kLZVEzfpogGVJ",480 "unofficial_currency_code": null481 },482 {483 "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",484 "account_owner": null,485 "amount": 37.5,486 "check_number": null,487 "credit_category": {488 "detailed": "DINING_DINING",489 "primary": "DINING"490 },491 "date": "2024-07-13",492 "date_posted": "2024-07-13T00:00:00Z",493 "date_transacted": "2024-07-13",494 "iso_currency_code": "USD",495 "location": {496 "address": "1627 N 24th St",497 "city": "Phoenix",498 "country": null,499 "lat": null,500 "lon": null,501 "postal_code": "85008",502 "region": "AZ",503 "state": "AZ",504 "store_number": null,505 "zip": "85008"506 },507 "merchant_name": "Taqueria El Guerrerense",508 "original_description": "TAQUERIA EL GUERRERO PHOENIX AZ",509 "pending": false,510 "transaction_id": "wka74WKqngiyJ3pj7dl5SbpLGQBZqyCPZRDbP",511 "unofficial_currency_code": null512 },513 {514 "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",515 "account_owner": null,516 "amount": 41.42,517 "check_number": null,518 "credit_category": {519 "detailed": "GENERAL_MERCHANDISE_ONLINE_MARKETPLACES",520 "primary": "GENERAL_MERCHANDISE"521 },522 "date": "2024-07-14",523 "date_posted": "2024-07-14T00:00:00Z",524 "date_transacted": "2024-07-14",525 "iso_currency_code": "USD",526 "location": {527 "address": null,528 "city": null,529 "country": null,530 "lat": null,531 "lon": null,532 "postal_code": null,533 "region": null,534 "state": null,535 "store_number": null,536 "zip": null537 },538 "merchant_name": "Amazon",539 "original_description": "AMZN Mktp US*11111111 Amzn.com/bill WA AM",540 "pending": false,541 "transaction_id": "BBGnV4RkerHjn8WVavGyiJbQ95VNDaC4M56bJ",542 "unofficial_currency_code": null543 },544 {545 "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",546 "account_owner": null,547 "amount": -1077.93,548 "check_number": null,549 "credit_category": {550 "detailed": "INCOME_OTHER",551 "primary": "INCOME"552 },553 "date": "2024-07-14",554 "date_posted": "2024-07-14T00:00:00Z",555 "date_transacted": "2024-07-14",556 "iso_currency_code": "USD",557 "location": {558 "address": null,559 "city": null,560 "country": null,561 "lat": null,562 "lon": null,563 "postal_code": null,564 "region": null,565 "state": null,566 "store_number": null,567 "zip": null568 },569 "merchant_name": "Lyft",570 "original_description": "LYFT TRANSFER",571 "pending": false,572 "transaction_id": "3Ej78yKJlQu1Abw7xzo4U4JR6pmwzntZlbKDK",573 "unofficial_currency_code": null574 },575 {576 "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",577 "account_owner": null,578 "amount": 47.17,579 "check_number": null,580 "credit_category": {581 "detailed": "FOOD_RETAIL_GROCERIES",582 "primary": "FOOD_RETAIL"583 },584 "date": "2024-07-14",585 "date_posted": "2024-07-14T00:00:00Z",586 "date_transacted": "2024-07-14",587 "iso_currency_code": "USD",588 "location": {589 "address": null,590 "city": "Whittier",591 "country": null,592 "lat": null,593 "lon": null,594 "postal_code": null,595 "region": "CA",596 "state": "CA",597 "store_number": null,598 "zip": null599 },600 "merchant_name": "Smart & Final",601 "original_description": "POS SMART AND FINAL 111 WHITTIER CA",602 "pending": false,603 "transaction_id": "rMzaBpJw8jSZRJQBabKdteQBwd5EaWc7J9qem",604 "unofficial_currency_code": null605 },606 {607 "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",608 "account_owner": null,609 "amount": 12.37,610 "check_number": null,611 "credit_category": {612 "detailed": "FOOD_RETAIL_GROCERIES",613 "primary": "FOOD_RETAIL"614 },615 "date": "2024-07-14",616 "date_posted": "2024-07-14T00:00:00Z",617 "date_transacted": "2024-07-14",618 "iso_currency_code": "USD",619 "location": {620 "address": null,621 "city": "Whittier",622 "country": null,623 "lat": null,624 "lon": null,625 "postal_code": null,626 "region": "CA",627 "state": "CA",628 "store_number": null,629 "zip": null630 },631 "merchant_name": "Smart & Final",632 "original_description": "POS SMART AND FINAL 111 WHITTIER CA",633 "pending": false,634 "transaction_id": "zWPZjkmzynTyel89ZjExS59DV6WAaZflNBJ56",635 "unofficial_currency_code": null636 },637 {638 "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",639 "account_owner": null,640 "amount": 44.18,641 "check_number": null,642 "credit_category": {643 "detailed": "FOOD_RETAIL_GROCERIES",644 "primary": "FOOD_RETAIL"645 },646 "date": "2024-07-14",647 "date_posted": "2024-07-14T00:00:00Z",648 "date_transacted": "2024-07-14",649 "iso_currency_code": "USD",650 "location": {651 "address": null,652 "city": "Portland",653 "country": null,654 "lat": null,655 "lon": null,656 "postal_code": null,657 "region": "OR",658 "state": "OR",659 "store_number": "1111",660 "zip": null661 },662 "merchant_name": "Safeway",663 "original_description": "SAFEWAY #1111 PORTLAND OR 111111",664 "pending": false,665 "transaction_id": "K7qzx1nP8ptqgwaRMbxyI86XrqADMluRpkWx5",666 "unofficial_currency_code": null667 },668 {669 "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",670 "account_owner": null,671 "amount": 45.37,672 "check_number": null,673 "credit_category": {674 "detailed": "DINING_DINING",675 "primary": "DINING"676 },677 "date": "2024-07-14",678 "date_posted": "2024-07-14T00:00:00Z",679 "date_transacted": "2024-07-14",680 "iso_currency_code": "USD",681 "location": {682 "address": null,683 "city": null,684 "country": null,685 "lat": null,686 "lon": null,687 "postal_code": null,688 "region": null,689 "state": null,690 "store_number": null,691 "zip": null692 },693 "merchant_name": "Uber Eats",694 "original_description": "UBER EATS",695 "pending": false,696 "transaction_id": "qZrdzLRAgNHo5peMdD9xIzELl3a1NvcgrPAzL",697 "unofficial_currency_code": null698 },699 {700 "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",701 "account_owner": null,702 "amount": 15.22,703 "check_number": null,704 "credit_category": {705 "detailed": "GENERAL_MERCHANDISE_ONLINE_MARKETPLACES",706 "primary": "GENERAL_MERCHANDISE"707 },708 "date": "2024-07-15",709 "date_posted": "2024-07-15T00:00:00Z",710 "date_transacted": "2024-07-15",711 "iso_currency_code": "USD",712 "location": {713 "address": null,714 "city": null,715 "country": null,716 "lat": null,717 "lon": null,718 "postal_code": null,719 "region": null,720 "state": null,721 "store_number": null,722 "zip": null723 },724 "merchant_name": "Amazon",725 "original_description": "AMZN Mktp US*11111111 Amzn.com/bill WA AM",726 "pending": false,727 "transaction_id": "NZzx4oRPkAHzyRekpG4PTZkWnBPqEyiy6pB1M",728 "unofficial_currency_code": null729 },730 {731 "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",732 "account_owner": null,733 "amount": 26.33,734 "check_number": null,735 "credit_category": {736 "detailed": "DINING_DINING",737 "primary": "DINING"738 },739 "date": "2024-07-15",740 "date_posted": "2024-07-15T00:00:00Z",741 "date_transacted": "2024-07-15",742 "iso_currency_code": "USD",743 "location": {744 "address": null,745 "city": null,746 "country": null,747 "lat": null,748 "lon": null,749 "postal_code": null,750 "region": null,751 "state": null,752 "store_number": null,753 "zip": null754 },755 "merchant_name": "Domino's",756 "original_description": "DOMINO's XXXX 111-222-3333",757 "pending": false,758 "transaction_id": "x84eNArKbESz8Woden6LT3nvyogeJXc64Pp35",759 "unofficial_currency_code": null760 },761 {762 "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",763 "account_owner": null,764 "amount": 39.8,765 "check_number": null,766 "credit_category": {767 "detailed": "GENERAL_MERCHANDISE_DISCOUNT_STORES",768 "primary": "GENERAL_MERCHANDISE"769 },770 "date": "2024-07-15",771 "date_posted": "2024-07-15T00:00:00Z",772 "date_transacted": "2024-07-15",773 "iso_currency_code": "USD",774 "location": {775 "address": null,776 "city": null,777 "country": null,778 "lat": null,779 "lon": null,780 "postal_code": null,781 "region": null,782 "state": null,783 "store_number": null,784 "zip": null785 },786 "merchant_name": "Family Dollar",787 "original_description": "FAMILY DOLLAR",788 "pending": false,789 "transaction_id": "dzWnyxwZ4GHlZPGgrNyxiMG7qd5jDgCJEz5jL",790 "unofficial_currency_code": null791 },792 {793 "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",794 "account_owner": null,795 "amount": 45.06,796 "check_number": null,797 "credit_category": {798 "detailed": "FOOD_RETAIL_GROCERIES",799 "primary": "FOOD_RETAIL"800 },801 "date": "2024-07-15",802 "date_posted": "2024-07-15T00:00:00Z",803 "date_transacted": "2024-07-15",804 "iso_currency_code": "USD",805 "location": {806 "address": null,807 "city": null,808 "country": null,809 "lat": null,810 "lon": null,811 "postal_code": null,812 "region": null,813 "state": null,814 "store_number": null,815 "zip": null816 },817 "merchant_name": "Instacart",818 "original_description": "INSTACART HTTPSINSTACAR CA",819 "pending": false,820 "transaction_id": "4W7eE9rZqMToDArbPeLNIREoKpdgBMcJbVNQD",821 "unofficial_currency_code": null822 },823 {824 "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",825 "account_owner": null,826 "amount": 34.91,827 "check_number": null,828 "credit_category": {829 "detailed": "FOOD_RETAIL_GROCERIES",830 "primary": "FOOD_RETAIL"831 },832 "date": "2024-07-15",833 "date_posted": "2024-07-15T00:00:00Z",834 "date_transacted": "2024-07-15",835 "iso_currency_code": "USD",836 "location": {837 "address": null,838 "city": "Whittier",839 "country": null,840 "lat": null,841 "lon": null,842 "postal_code": null,843 "region": "CA",844 "state": "CA",845 "store_number": null,846 "zip": null847 },848 "merchant_name": "Smart & Final",849 "original_description": "POS SMART AND FINAL 111 WHITTIER CA",850 "pending": false,851 "transaction_id": "j4yqDjb7QwS7woGzqrgDIEG1NaQVZwf6Wmz3D",852 "unofficial_currency_code": null853 },854 {855 "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",856 "account_owner": null,857 "amount": 49.78,858 "check_number": null,859 "credit_category": {860 "detailed": "FOOD_RETAIL_GROCERIES",861 "primary": "FOOD_RETAIL"862 },863 "date": "2024-07-15",864 "date_posted": "2024-07-15T00:00:00Z",865 "date_transacted": "2024-07-15",866 "iso_currency_code": "USD",867 "location": {868 "address": null,869 "city": "Portland",870 "country": null,871 "lat": null,872 "lon": null,873 "postal_code": null,874 "region": "OR",875 "state": "OR",876 "store_number": "1111",877 "zip": null878 },879 "merchant_name": "Safeway",880 "original_description": "SAFEWAY #1111 PORTLAND OR 111111",881 "pending": false,882 "transaction_id": "aqgWnze7xoHd6DQwLPnzT5dgPKjB1NfZ5JlBy",883 "unofficial_currency_code": null884 },885 {886 "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",887 "account_owner": null,888 "amount": 54.24,889 "check_number": null,890 "credit_category": {891 "detailed": "FOOD_RETAIL_GROCERIES",892 "primary": "FOOD_RETAIL"893 },894 "date": "2024-07-15",895 "date_posted": "2024-07-15T00:00:00Z",896 "date_transacted": "2024-07-15",897 "iso_currency_code": "USD",898 "location": {899 "address": null,900 "city": "Portland",901 "country": null,902 "lat": null,903 "lon": null,904 "postal_code": null,905 "region": "OR",906 "state": "OR",907 "store_number": "1111",908 "zip": null909 },910 "merchant_name": "Safeway",911 "original_description": "SAFEWAY #1111 PORTLAND OR 111111",912 "pending": false,913 "transaction_id": "P13aP8b7nmS3WQoxg1PMsdvMK679RNfo65B4G",914 "unofficial_currency_code": null915 },916 {917 "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",918 "account_owner": null,919 "amount": 41.79,920 "check_number": null,921 "credit_category": {922 "detailed": "GENERAL_MERCHANDISE_ONLINE_MARKETPLACES",923 "primary": "GENERAL_MERCHANDISE"924 },925 "date": "2024-07-16",926 "date_posted": "2024-07-16T00:00:00Z",927 "date_transacted": "2024-07-16",928 "iso_currency_code": "USD",929 "location": {930 "address": null,931 "city": null,932 "country": null,933 "lat": null,934 "lon": null,935 "postal_code": null,936 "region": null,937 "state": null,938 "store_number": null,939 "zip": null940 },941 "merchant_name": "Amazon",942 "original_description": "AMZN Mktp US*11111111 Amzn.com/bill WA AM",943 "pending": false,944 "transaction_id": "7nZMG6pXz8SADylMqzx7TraE4qjJm7udJyAGm",945 "unofficial_currency_code": null946 },947 {948 "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",949 "account_owner": null,950 "amount": 33.86,951 "check_number": null,952 "credit_category": {953 "detailed": "FOOD_RETAIL_GROCERIES",954 "primary": "FOOD_RETAIL"955 },956 "date": "2024-07-16",957 "date_posted": "2024-07-16T00:00:00Z",958 "date_transacted": "2024-07-16",959 "iso_currency_code": "USD",960 "location": {961 "address": null,962 "city": null,963 "country": null,964 "lat": null,965 "lon": null,966 "postal_code": null,967 "region": null,968 "state": null,969 "store_number": null,970 "zip": null971 },972 "merchant_name": "Instacart",973 "original_description": "INSTACART HTTPSINSTACAR CA",974 "pending": false,975 "transaction_id": "MQr3ap7PWEIrQG7bLdaNsxyBV7g1KqCL6pwoy",976 "unofficial_currency_code": null977 },978 {979 "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",980 "account_owner": null,981 "amount": 27.08,982 "check_number": null,983 "credit_category": {984 "detailed": "DINING_DINING",985 "primary": "DINING"986 },987 "date": "2024-07-16",988 "date_posted": "2024-07-16T00:00:00Z",989 "date_transacted": "2024-07-16",990 "iso_currency_code": "USD",991 "location": {992 "address": null,993 "city": null,994 "country": null,995 "lat": null,996 "lon": null,997 "postal_code": null,998 "region": null,999 "state": null,1000 "store_number": null,1001 "zip": null1002 },1003 "merchant_name": null,1004 "original_description": "POKE BROS * POKE BRO IL",1005 "pending": false,1006 "transaction_id": "eBAk9dvwNbHPZpr8W69dU3rekJz47Kcr9BRwl",1007 "unofficial_currency_code": null1008 },1009 {1010 "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",1011 "account_owner": null,1012 "amount": 25.94,1013 "check_number": null,1014 "credit_category": {1015 "detailed": "GENERAL_MERCHANDISE_FURNITURE_AND_HARDWARE",1016 "primary": "GENERAL_MERCHANDISE"1017 },1018 "date": "2024-07-16",1019 "date_posted": "2024-07-16T00:00:00Z",1020 "date_transacted": "2024-07-16",1021 "iso_currency_code": "USD",1022 "location": {1023 "address": null,1024 "city": null,1025 "country": null,1026 "lat": null,1027 "lon": null,1028 "postal_code": null,1029 "region": null,1030 "state": null,1031 "store_number": null,1032 "zip": null1033 },1034 "merchant_name": "The Home Depot",1035 "original_description": "THE HOME DEPOT",1036 "pending": false,1037 "transaction_id": "QLx4jEJZb9SxRm7aWbjAio3LrgZ5vPswm64dE",1038 "unofficial_currency_code": null1039 },1040 {1041 "account_id": "NZzx4oRPkAHzyRekpG4PTZkoGpNAR4uypaj1E",1042 "account_owner": null,1043 "amount": 27.57,1044 "check_number": null,1045 "credit_category": {1046 "detailed": "GENERAL_MERCHANDISE_OTHER_GENERAL_MERCHANDISE",1047 "primary": "GENERAL_MERCHANDISE"1048 },1049 "date": "2024-07-16",1050 "date_posted": "2024-07-16T00:00:00Z",1051 "date_transacted": "2024-07-16",1052 "iso_currency_code": "USD",1053 "location": {1054 "address": null,1055 "city": null,1056 "country": null,1057 "lat": null,1058 "lon": null,1059 "postal_code": null,1060 "region": null,1061 "state": null,1062 "store_number": null,1063 "zip": null1064 },1065 "merchant_name": null,1066 "original_description": "The Press Club",1067 "pending": false,1068 "transaction_id": "ZnQ1ovqBldSQ6GzRbroAHLdQP68BrKceqmAjX",1069 "unofficial_currency_code": null1070 }1071 ],1072 "type": "depository"1073 }1074 ],1075 "date_last_updated": "2024-07-16T01:52:42.912331716Z",1076 "institution_id": "ins_109512",1077 "institution_name": "Houndstooth Bank",1078 "item_id": "NZzx4oRPkAHzyRekpG4PTZkDNkQW93tWnyGeA"1079 }1080 ],1081 "report_id": "f3bb434f-1c9b-4ef2-b76c-3d1fd08156ec"1082 },1083 "warnings": [],1084 "request_id": "FibfL8t3s71KJnj"1085}
Was this helpful?
/cra/check_report/income_insights/get
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
.
client_id
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
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.user_token
1try {2 const response = await client.craCheckReportIncomeInsightsGet({3 user_token: 'user-environment-1234567-abcd-abcd-1234-1234567890ab',4 });5} catch (error) {6 // handle error7}
Response fields and example
report
report_id
generated_time
date-time
days_requested
items
item_id
item_id
of the Item associated with this webhook, warning, or errorbank_income_accounts
account_id
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
name
official_name
subtype
checking
, savings
, hsa
, cd
, money market
, paypal
, prepaid
, cash management
, ebt
, all
type
depository
.depository
owners
names
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
emails
addresses
data
city
region
state
.
Example: "NC"
street
"564 Main Street, APT 15"
postal_code
zip
.country
primary
true
, identifies the address as the primary address on an account.bank_income_sources
account_id
income_source_id
income_description
income_category
CASH
value has been deprecated and is used only for existing legacy implementations. It has been replaced by the new categories CASH_DEPOSIT
(representing cash or check deposits) and TRANSFER_FROM_APPLICATION
(representing cash transfers originating from apps, such as Zelle or Venmo).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
start_date
date
end_date
date
pay_frequency
WEEKLY
, BIWEEKLY
, SEMI_MONTHLY
, MONTHLY
, DAILY
, UNKNOWN
total_amount
iso_currency_code
unofficial_currency _code
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
next_payment_date
date
historical_average _monthly_gross_income
historical_average _monthly_income
forecasted_average _monthly_income
forecasted_average _monthly_income _prediction_intervals
lower_bound
upper_bound
probability
historical_summary
total_amounts
amount
iso_currency_code
unofficial_currency _code
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.start_date
date
end_date
date
transactions
transaction_id
transaction_id
is case sensitive.amount
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
date
name
original_description
pending
check_number
iso_currency_code
unofficial_currency _code
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
BONUS_INCLUDED
: Bonus is included in this transaction along with the normal pay
BONUS_ONLY
: This transaction is a standalone bonusBONUS_INCLUDED
, BONUS_ONLY
, null
last_updated_time
date-time
institution_id
institution_name
bank_income_summary
total_amounts
amount
iso_currency_code
unofficial_currency _code
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.start_date
date
end_date
date
income_sources_count
income_categories _count
income_transactions _count
historical_average _monthly_gross_income
amount
iso_currency_code
unofficial_currency _code
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_average _monthly_income
amount
iso_currency_code
unofficial_currency _code
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.forecasted_average _monthly_income
amount
iso_currency_code
unofficial_currency _code
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_annual _gross_income
amount
iso_currency_code
unofficial_currency _code
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_annual _income
amount
iso_currency_code
unofficial_currency _code
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.forecasted_annual _income
amount
iso_currency_code
unofficial_currency _code
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
total_amounts
amount
iso_currency_code
unofficial_currency _code
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.start_date
date
end_date
date
transactions
transaction_id
transaction_id
is case sensitive.amount
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
date
name
original_description
pending
check_number
iso_currency_code
unofficial_currency _code
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
BONUS_INCLUDED
: Bonus is included in this transaction along with the normal pay
BONUS_ONLY
: This transaction is a standalone bonusBONUS_INCLUDED
, BONUS_ONLY
, null
warnings
warning_type
BANK_INCOME_WARNING
.BANK_INCOME_WARNING
warning_code
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 ItemIDENTITY_UNAVAILABLE
, TRANSACTIONS_UNAVAILABLE
, REPORT_DELETED
, DATA_UNAVAILABLE
cause
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
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
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
display_message
request_id
1{2 "request_id": "LhQf0THi8SH1yJm",3 "report": {4 "report_id": "bbfc5174-5433-4648-8d93-9fec6a0c0966",5 "generated_time": "2022-01-31T22:47:53Z",6 "days_requested": 365,7 "items": [8 {9 "item_id": "AZMP7JrGXgtPd3AQMeg7hwMKgk5E8qU1V5ME7",10 "last_updated_time": "2022-01-31T22:47:53Z",11 "institution_id": "ins_0",12 "institution_name": "Plaid Bank",13 "bank_income_accounts": [14 {15 "account_id": "1qKRXQjk8xUWDJojNwPXTj8gEmR48piqRNye8",16 "mask": "8888",17 "name": "Plaid Checking Account",18 "official_name": "Plaid Checking Account",19 "type": "depository",20 "subtype": "checking",21 "owners": [22 {23 "addresses": [24 {25 "data": {26 "city": "Malakoff",27 "country": "US",28 "postal_code": "14236",29 "region": "NY",30 "street": "2992 Cameron Road"31 },32 "primary": true33 },34 {35 "data": {36 "city": "San Matias",37 "country": "US",38 "postal_code": "93405-2255",39 "region": "CA",40 "street": "2493 Leisure Lane"41 },42 "primary": false43 }44 ],45 "emails": [46 {47 "data": "accountholder0@example.com",48 "primary": true,49 "type": "primary"50 },51 {52 "data": "accountholder1@example.com",53 "primary": false,54 "type": "secondary"55 },56 {57 "data": "extraordinarily.long.email.username.123456@reallylonghostname.com",58 "primary": false,59 "type": "other"60 }61 ],62 "names": [63 "Alberta Bobbeth Charleson"64 ],65 "phone_numbers": [66 {67 "data": "+1 111-555-3333",68 "primary": false,69 "type": "home"70 },71 {72 "data": "+1 111-555-4444",73 "primary": false,74 "type": "work"75 },76 {77 "data": "+1 111-555-5555",78 "primary": false,79 "type": "mobile"80 }81 ]82 }83 ]84 }85 ],86 "bank_income_sources": [87 {88 "account_id": "1qKRXQjk8xUWDJojNwPXTj8gEmR48piqRNye8",89 "income_source_id": "f17efbdd-caab-4278-8ece-963511cd3d51",90 "income_description": "PLAID_INC_DIRECT_DEP_PPD",91 "income_category": "SALARY",92 "start_date": "2021-11-15",93 "end_date": "2022-01-15",94 "pay_frequency": "MONTHLY",95 "total_amount": 300,96 "iso_currency_code": "USD",97 "unofficial_currency_code": null,98 "transaction_count": 1,99 "next_payment_date": "2022-12-15",100 "historical_average_monthly_gross_income": 390,101 "historical_average_monthly_income": 300,102 "forecasted_average_monthly_income": 300,103 "forecasted_average_monthly_income_prediction_intervals": [104 {105 "lower_bound": 200,106 "upper_bound": 400,107 "probability": 0.8108 }109 ],110 "employer": {111 "name": "Plaid Inc"112 },113 "historical_summary": [114 {115 "start_date": "2021-11-02",116 "end_date": "2021-11-30",117 "total_amounts": [118 {119 "amount": 100,120 "iso_currency_code": "USD",121 "unofficial_currency_code": null122 }123 ],124 "transactions": [125 {126 "transaction_id": "aH5klwqG3B19OMT7D6F24Syv8pdnJXmtZoKQ5",127 "amount": 100,128 "bonus_type": null,129 "date": "2021-11-15",130 "name": "PLAID_INC_DIRECT_DEP_PPD",131 "original_description": "PLAID_INC_DIRECT_DEP_PPD 123A",132 "pending": false,133 "check_number": null,134 "iso_currency_code": "USD",135 "unofficial_currency_code": null136 }137 ]138 },139 {140 "start_date": "2021-12-01",141 "end_date": "2021-12-31",142 "total_amounts": [143 {144 "amount": 100,145 "iso_currency_code": "USD",146 "unofficial_currency_code": null147 }148 ],149 "transactions": [150 {151 "transaction_id": "mN3rQ5iH8BC41T6UjKL9oD2vWJpZqXFomGwY1",152 "amount": 100,153 "bonus_type": null,154 "date": "2021-12-15",155 "name": "PLAID_INC_DIRECT_DEP_PPD",156 "original_description": "PLAID_INC_DIRECT_DEP_PPD 123B",157 "pending": false,158 "check_number": null,159 "iso_currency_code": "USD",160 "unofficial_currency_code": null161 }162 ]163 },164 {165 "start_date": "2022-01-01",166 "end_date": "2022-01-31",167 "total_amounts": [168 {169 "amount": 100,170 "iso_currency_code": "USD",171 "unofficial_currency_code": null172 }173 ],174 "transactions": [175 {176 "transaction_id": "zK9lDoR8uBH51PNQ3W4T6Mjy2VFXpGtJwsL4",177 "amount": 100,178 "bonus_type": null,179 "date": "2022-01-31",180 "name": "PLAID_INC_DIRECT_DEP_PPD",181 "original_description": "PLAID_INC_DIRECT_DEP_PPD 123C",182 "pending": false,183 "check_number": null,184 "iso_currency_code": "USD",185 "unofficial_currency_code": null186 }187 ]188 }189 ]190 }191 ]192 }193 ],194 "bank_income_summary": {195 "total_amounts": [196 {197 "amount": 300,198 "iso_currency_code": "USD",199 "unofficial_currency_code": null200 }201 ],202 "start_date": "2021-11-15",203 "end_date": "2022-01-15",204 "income_sources_count": 1,205 "income_categories_count": 1,206 "income_transactions_count": 1,207 "historical_average_monthly_gross_income": [208 {209 "amount": 390,210 "iso_currency_code": "USD",211 "unofficial_currency_code": null212 }213 ],214 "historical_average_monthly_income": [215 {216 "amount": 300,217 "iso_currency_code": "USD",218 "unofficial_currency_code": null219 }220 ],221 "forecasted_average_monthly_income": [222 {223 "amount": 300,224 "iso_currency_code": "USD",225 "unofficial_currency_code": null226 }227 ],228 "historical_annual_gross_income": [229 {230 "amount": 4680,231 "iso_currency_code": "USD",232 "unofficial_currency_code": null233 }234 ],235 "historical_annual_income": [236 {237 "amount": 3600,238 "iso_currency_code": "USD",239 "unofficial_currency_code": null240 }241 ],242 "forecasted_annual_income": [243 {244 "amount": 3600,245 "iso_currency_code": "USD",246 "unofficial_currency_code": null247 }248 ],249 "historical_summary": [250 {251 "start_date": "2021-11-02",252 "end_date": "2021-11-30",253 "total_amounts": [254 {255 "amount": 100,256 "iso_currency_code": "USD",257 "unofficial_currency_code": null258 }259 ],260 "transactions": [261 {262 "transaction_id": "aH5klwqG3B19OMT7D6F24Syv8pdnJXmtZoKQ5",263 "amount": 100,264 "bonus_type": null,265 "date": "2021-11-15",266 "name": "PLAID_INC_DIRECT_DEP_PPD",267 "original_description": "PLAID_INC_DIRECT_DEP_PPD 123A",268 "pending": false,269 "check_number": null,270 "iso_currency_code": "USD",271 "unofficial_currency_code": null272 }273 ]274 },275 {276 "start_date": "2021-12-01",277 "end_date": "2021-12-31",278 "total_amounts": [279 {280 "amount": 100,281 "iso_currency_code": "USD",282 "unofficial_currency_code": null283 }284 ],285 "transactions": [286 {287 "transaction_id": "mN3rQ5iH8BC41T6UjKL9oD2vWJpZqXFomGwY1",288 "amount": 100,289 "bonus_type": null,290 "date": "2021-12-15",291 "name": "PLAID_INC_DIRECT_DEP_PPD",292 "original_description": "PLAID_INC_DIRECT_DEP_PPD 123B",293 "pending": false,294 "check_number": null,295 "iso_currency_code": "USD",296 "unofficial_currency_code": null297 }298 ]299 },300 {301 "start_date": "2022-01-01",302 "end_date": "2022-01-31",303 "total_amounts": [304 {305 "amount": 100,306 "iso_currency_code": "USD",307 "unofficial_currency_code": null308 }309 ],310 "transactions": [311 {312 "transaction_id": "zK9lDoR8uBH51PNQ3W4T6Mjy2VFXpGtJwsL4",313 "amount": 100,314 "bonus_type": null,315 "date": "2022-01-31",316 "name": "PLAID_INC_DIRECT_DEP_PPD",317 "original_description": "PLAID_INC_DIRECT_DEP_PPD 123C",318 "pending": false,319 "check_number": null,320 "iso_currency_code": "USD",321 "unofficial_currency_code": null322 }323 ]324 }325 ],326 "warnings": []327 }328 }329}
Was this helpful?
/cra/check_report/partner_insights/get
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.
client_id
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
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.user_token
options
prism_products
insights
, scores
1try {2 const response = await client.craCheckReportPartnerInsightsGet({3 user_token: 'user-environment-1234567-abcd-abcd-1234-1234567890ab',4 });5} catch (error) {6 // handle error7}
Response fields and example
report
report_id
generated_time
date-time
prism
cash_score
version
score
reason_codes
metadata
max_age
min_age
min_age_credit
min_age_debit
max_age_debit
max_age_credit
num_trxn_credit
num_trxn_debit
l1m_credit_value_cnt
l1m_debit_value_cnt
first_detect
version
score
reason_codes
metadata
max_age
min_age
min_age_credit
min_age_debit
max_age_debit
max_age_credit
num_trxn_credit
num_trxn_debit
l1m_credit_value_cnt
l1m_debit_value_cnt
status
items
institution_id
institution_name
item_id
accounts
account_id
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
name
official_name
subtype
checking
, savings
, hsa
, cd
, money market
, paypal
, prepaid
, cash management
, ebt
, all
type
depository
.depository
owners
names
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
emails
addresses
data
city
region
state
.
Example: "NC"
street
"564 Main Street, APT 15"
postal_code
zip
.country
primary
true
, identifies the address as the primary address on an account.request_id
1{2 "request_id": "LhQf0THi8SH1yJm",3 "report": {4 "report_id": "vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D",5 "generated_time": "2022-01-31T22:47:53Z",6 "items": [7 {8 "institution_id": "ins_109508",9 "institution_name": "Plaid Bank",10 "item_id": "Ed6bjNrDLJfGvZWwnkQlfxwoNz54B5C97ejBr",11 "accounts": [12 {13 "account_id": "1qKRXQjk8xUWDJojNwPXTj8gEmR48piqRNye8",14 "mask": "8888",15 "name": "Plaid Checking Account",16 "official_name": "Plaid Checking Account",17 "type": "depository",18 "subtype": "checking",19 "owners": [20 {21 "addresses": [22 {23 "data": {24 "city": "Malakoff",25 "country": "US",26 "postal_code": "14236",27 "region": "NY",28 "street": "2992 Cameron Road"29 },30 "primary": true31 },32 {33 "data": {34 "city": "San Matias",35 "country": "US",36 "postal_code": "93405-2255",37 "region": "CA",38 "street": "2493 Leisure Lane"39 },40 "primary": false41 }42 ],43 "emails": [44 {45 "data": "accountholder0@example.com",46 "primary": true,47 "type": "primary"48 },49 {50 "data": "accountholder1@example.com",51 "primary": false,52 "type": "secondary"53 },54 {55 "data": "extraordinarily.long.email.username.123456@reallylonghostname.com",56 "primary": false,57 "type": "other"58 }59 ],60 "names": [61 "Alberta Bobbeth Charleson"62 ],63 "phone_numbers": [64 {65 "data": "+1 111-555-3333",66 "primary": false,67 "type": "home"68 },69 {70 "data": "+1 111-555-4444",71 "primary": false,72 "type": "work"73 },74 {75 "data": "+1 111-555-5555",76 "primary": false,77 "type": "mobile"78 }79 ]80 }81 ]82 }83 ]84 }85 ],86 "prism": {87 "insights": {88 "version": 3,89 "result": {90 "l6m_cumbal_acc": 191 }92 },93 "cash_score": {94 "version": 3,95 "score": 900,96 "reason_codes": [97 "CASHFLOW_D11"98 ],99 "metadata": {100 "max_age": 20,101 "min_age": 1,102 "min_age_credit": 0,103 "min_age_debit": 1,104 "max_age_debit": 20,105 "max_age_credit": 0,106 "num_trxn_credit": 0,107 "num_trxn_debit": 40,108 "l1m_credit_value_cnt": 0,109 "l1m_debit_value_cnt": 40110 }111 },112 "first_detect": {113 "version": 3,114 "score": 900,115 "reason_codes": [116 "CASHFLOW_D11"117 ],118 "metadata": {119 "max_age": 20,120 "min_age": 1,121 "min_age_credit": 0,122 "min_age_debit": 1,123 "max_age_debit": 20,124 "max_age_credit": 0,125 "num_trxn_credit": 0,126 "num_trxn_debit": 40,127 "l1m_credit_value_cnt": 0,128 "l1m_debit_value_cnt": 40129 }130 },131 "status": "SUCCESS"132 }133 }134}
Was this helpful?
/cra/check_report/pdf/get
Retrieve Consumer Reports as a PDF
/cra/check_report/pdf/get
retrieves the most recent Bank Income report (if it exists) followed by the most recent Base Report (if it exists) in PDF format.
client_id
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
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.user_token
add_ons
cra_income_insights
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 error8}
Response
This endpoint returns binary PDF data. View a sample Check Report PDF.
Was this helpful?
Webhooks
When you create a new report, either by creating a Link token with a Plaid Check product, or by calling /cra/check_report/create
, Plaid Check will start generating a report for you. When the report has been created (or the report creation fails), Plaid Check will let you know by sending you either a CHECK_REPORT: CHECK_REPORT_READY
or CHECK_REPORT: CHECK_REPORT_FAILED
webhook.
CHECK_REPORT_READY
Fired when products for the Check Report are ready to be retrieved
webhook_type
CHECK_REPORT
webhook_code
CHECK_REPORT_READY
user_id
user_id
corresponding to the user the webhook has fired for.environment
sandbox
, production
1{2 "webhook_type": "CHECK_REPORT",3 "webhook_code": "CHECK_REPORT_READY",4 "user_id": "wz666MBjYWTp2PDzzggYhM6oWWmBb",5 "environment": "production"6}
Was this helpful?
CHECK_REPORT_FAILED
Fired when a Check Report has failed to generate
webhook_type
CHECK_REPORT
webhook_code
CHECK_REPORT_FAILED
user_id
user_id
corresponding to the user the webhook has fired for.environment
sandbox
, production
1{2 "webhook_type": "CHECK_REPORT",3 "webhook_code": "CHECK_REPORT_FAILED",4 "user_id": "wz666MBjYWTp2PDzzggYhM6oWWmBb",5 "environment": "production"6}