Connect your own Plaid account (Sandbox and/or Production) to link end users' bank accounts and read/act on their financial data from Imperal -- Link tokens, Items, Accounts, Institutions, Transactions (sync + enrich), Auth, Identity, Investments, Liabilities, Assets (reports), Income, Transfer (ACH/RTP/wire), Signal (return-risk scoring), Monitor (watchlist screening), processor tokens, plus Sandbox testing helpers and value-add reports (net worth, spending overview, recurring charges, low-balance alerts, Item health audit). Nothing is hosted or proxied by Imperal beyond the request itself -- your credentials, your Plaid account, your billing.
connect_plaidwriteConnect your own Plaid account by saving your client_id plus a Sandbox and/or Production secret, after checking whichever ones you provide actually work. Find these in Plaid Dashboard > Team Settings > Keys.
disconnect_plaidwriteDisconnect a Plaid account: deletes the saved client_id/secrets. Nothing in Plaid itself is changed; existing Items keep working if you reconnect the same credentials later.
list_connectionsreadList the connected Plaid accounts.
create_link_tokenwriteCreate a Link token so your app can launch Plaid Link for an end user to connect their bank account (or reauthenticate an existing one in update mode, via access_token).
get_link_tokenreadRead a Link token's own metadata (status, products requested) -- useful to confirm what a token was configured for before handing it to a client.
exchange_public_tokenwriteExchange a public_token (returned by Plaid Link after an end user finishes connecting their bank) for a permanent access_token identifying the new Item. Store the access_token yourself -- Plaid never lets you retrieve it again.
get_itemreadRead one Plaid Item in full: institution, available/billed products, and error state.
remove_itemwritePermanently remove a Plaid Item, revoking its access_token. Cannot be undone -- the end user would need to reconnect through Link again.
update_item_webhookwriteChange the webhook URL Plaid sends this Item's events to.
create_public_tokenwriteRe-issue a short-lived public_token for an existing Item, so Link can be launched in update mode from a different client than the one that originally created the Item.
get_accountsreadRead every account (or a specific subset) attached to a Plaid Item -- balances, type, subtype, mask.
get_institutionreadRead one financial institution known to Plaid by its institution_id -- name, logo, supported products, OAuth requirement.
list_institutionsreadList financial institutions known to Plaid, paginated.
search_institutionsreadSearch financial institutions known to Plaid by free-text name, optionally filtered to institutions supporting given products.
sync_transactionsreadFetch new/modified/removed transactions for an Item since a cursor (the recommended way to keep transactions up to date -- pass the returned next_cursor back in on your next call). Leave cursor blank on the very first call to get full history.
get_transactionsreadFetch transactions for an Item within a date range (legacy endpoint -- prefer sync_transactions for ongoing sync, this is fine for a one-off historical pull).
refresh_transactionswriteAsk Plaid to proactively check for new transaction data right now instead of waiting for its normal refresh schedule. Fires a TRANSACTIONS webhook when done.
get_recurring_transactionsreadRead Plaid's own detected recurring transaction streams (subscriptions, regular income/bills) for an Item.
enrich_transactionsreadEnrich your OWN raw transaction data (not from Plaid) with merchant name, logo, category, and payment channel using Plaid's Transactions Enrich product.
get_authreadRead account and routing numbers for an Item's depository accounts -- the core data needed to originate an ACH transfer.
get_identityreadRead the account holder's name, email, phone, and address on file at their bank, for an Item.
match_identityreadCheck how closely a name/phone/email/address you provide matches the account holder's real identity on file (Identity Match) -- useful for fraud/KYC checks before trusting a linked account.
get_holdingsreadRead investment holdings (securities owned, quantity, cost basis) for an Item's investment accounts.
get_investment_transactionsreadRead investment transactions (buys, sells, dividends, fees) for an Item within a date range.
refresh_investmentswriteAsk Plaid to proactively check for new investment data right now instead of waiting for its normal refresh schedule.
get_liabilitiesreadRead liability details (student loans, credit cards, mortgages -- APR, balances, due dates) for an Item.
create_asset_reportwriteCreate an Asset Report -- a point-in-time snapshot of balances/transactions across one or more Items, used for mortgage/loan underwriting.
get_asset_reportreadRead a previously created Asset Report by its token, once Plaid's PRODUCT_READY webhook has fired.
get_asset_report_pdfreadRender a completed Asset Report as a PDF, base64-encoded.
refresh_asset_reportwriteRefresh an existing Asset Report with up-to-date balance/transaction data.
filter_asset_reportwriteCreate a new, filtered copy of an Asset Report with specific accounts excluded -- e.g. to hide accounts irrelevant to a loan application.
remove_asset_reportwritePermanently delete an Asset Report. Cannot be undone.
create_audit_copywriteCreate an auditor-shareable copy of an Asset Report for a named auditing institution (e.g. Fannie Mae).
remove_audit_copywriteRevoke a previously created Asset Report audit copy.
create_income_verificationwriteStart Payroll/Document income verification for an Item.
get_income_verificationreadRead a previously created Payroll/Document income verification's result by its id.
get_bank_incomereadRead a Bank Income estimate derived purely from an Item's own transaction history -- no separate payroll flow needed.
create_transfer_authorizationwriteGet a real-time risk authorization decision BEFORE creating a Transfer -- Plaid requires a fresh authorization_id for every real Transfer.
create_transferwriteCreate a real Transfer (moves real money) using a prior authorization_id.
get_transferreadRead one Transfer in full by its id -- status, amount, and network.
list_transfersreadList Transfers on this Plaid account.
cancel_transferwriteCancel a Transfer while it is still pending.
create_transfer_refundwriteRefund a completed Transfer, fully or partially.
list_transfer_eventsreadList Transfer lifecycle events (posted, settled, failed, returned, swept) -- your source of truth for reconciling Transfer status changes.
evaluate_signalreadGet a real-time ACH return-risk score for a proposed debit BEFORE you initiate it, from Plaid Signal.
report_signal_decisionwriteReport back to Plaid whether you actually initiated an ACH transaction after seeing its Signal score -- improves future score accuracy.
create_watchlist_screeningwriteScreen a person against global watchlists (sanctions, PEP, adverse media) with Plaid Monitor.
get_watchlist_screeningreadRead one watchlist screening's result in full by its id -- match status and any hits found.
list_watchlist_screeningsreadList watchlist screenings created on this connection, most recent first.
review_watchlist_screeningwriteRecord a human review decision (confirmed match / dismissed as false positive) on a watchlist screening's hit.
create_processor_tokenwriteCreate a processor_token for an account, to hand it off to a supported payment processor (e.g. Dwolla, Stripe, Braintree) without exposing your Plaid access_token to them.
create_bank_account_tokenwriteCreate a bank_account_token for an account -- a newer, processor-agnostic alternative to create_processor_token for handing off an Item to a partner.
create_sandbox_public_tokenwriteCreate a fake public_token for a Sandbox test institution, so you can exercise exchange_public_token without going through real Plaid Link.
fire_sandbox_webhookwriteForce a Sandbox Item to fire a specific webhook right now, so you can test your webhook handler without waiting for real data changes.
reset_sandbox_item_loginwriteForce a Sandbox Item into ITEM_LOGIN_REQUIRED, to test your reauthentication (update-mode Link) flow on demand.
set_sandbox_verification_statuswriteSet a Sandbox account's micro-deposit verification status, to test your Auth verification flow's different outcomes on demand.
create_sandbox_transactionswriteInject fake transactions into a Sandbox Item, so downstream transactions/enrichment testing has realistic data to work with.
audit_item_healthreadBuild one aggregated health report across several Plaid Items: which ones need reauthentication (ITEM_LOGIN_REQUIRED), which have pending errors, and their institution names.
get_spending_overviewreadSummarize spending by category for an Item's transactions over a date range -- total spend, top categories, and transaction count.
detect_recurring_chargesreadFlag subscriptions/recurring charges the end user may have forgotten about, using Plaid's own recurring-transaction detection.
get_net_worth_snapshotreadCombine balances across several Items (depository + investments + liabilities) into one net-worth snapshot: assets, liabilities, and the difference.
check_low_balance_riskreadFlag accounts on an Item whose current balance is at or below a threshold -- a quick way to catch overdraft risk before it happens.
list_available_productsreadList every Plaid product this connector supports, with a one-line description of what each does -- a quick reference before calling create_link_token.
Install Plaid and let Webbee use it across your workflow.
Open in panel