Getting Started
1
Create or Select a Project
Set up a new project or select an existing one. See Organizations & Projects.
2
Configure the Connector
Enable the connector and create a Connector Profile in your project. See Setup Connector Profile.
Optionally, configure receiving Events for Plaid into StackOne.
OAuth 2.0 — Sandbox · Connector Profile
Sandbox-only auto-mint flow. StackOne calls /sandbox/public_token/create and /item/public_token/exchange behind the scen…
OAuth 2.0 — Production · Connector Profile
Production auth flow. Run Plaid Link in your own app to authenticate the end user with their bank, capture the resulting…
Webhooks setup
3
Link an Account
Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:
OAuth 2.0 — Sandbox · Link Account
OAuth 2.0 — Production · Link Account
4
Use Actions
Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.
Actions
|
No scopes found
51 actions
Action
Description
Required scopes
Get Accounts
Retrieve all financial accounts (checking, savings, credit, loan, investment) linked to an Item via POST /accounts/get
Get Account Balance
Fetch real-time balance data directly from the financial institution for all or specific accounts via POST /accounts/bal…
Create Asset Report
Create an Asset Report for the linked Item, providing a point-in-time snapshot of account balances, transactions, and id…
Get Asset Report
Retrieve a completed Asset Report containing account balances, transaction history, and identity data via POST /asset_re…
Get Asset Report PDF
Download a completed Asset Report as a formatted PDF document (binary response, application/pdf) for sharing with lender…
Refresh Asset Report
Create a refreshed copy of an existing Asset Report with updated data from the financial institutions via POST /asset_re…
Filter Asset Report
Create a filtered copy of an Asset Report with specified accounts excluded via POST /asset_report/filter
Remove Asset Report
Permanently delete an Asset Report and invalidate its token via POST /asset_report/remove
Get Auth
Retrieve bank account numbers and routing numbers needed to initiate ACH, EFT, BACS, and wire transfers via POST /auth/g…
Enrich Transactions
Enrich your own (non-Plaid-sourced) transactions with merchant info, categorization, and counterparty data via POST /tra…
Get Identity
Retrieve personal identity information (name, email, phone, address) for account holders directly from the financial ins…
Get Bank Income
Retrieve completed Bank Income reports (income streams identified from bank deposits) for a user via POST /credit/bank_i…
Get Bank Income PDF
Download a Bank Income report as a formatted PDF document for sharing with lenders via POST /credit/bank_income/pdf/get
Get Credit Sessions
List the user’s Income / Consumer-Report Link sessions and their final statuses via POST /credit/sessions/get
Get Institutions
Retrieve a paginated list of all Plaid-supported financial institutions with filtering by country, products, and routing…
Get Institution By ID
Retrieve detailed metadata for a single financial institution by its Plaid institution_id via POST /institutions/get_by_…
Search Institutions
Search Plaid’s institution directory by name or query string with optional product and country filters via POST /institu…
Get Investment Holdings
Retrieve current investment portfolio holdings including stocks, bonds, mutual funds, and ETFs for linked brokerage and…
Get Investment Transactions
Retrieve investment transactions (buys, sells, dividends, fees, transfers) within a specified date range for linked brok…
Get Item
Retrieve metadata and health status for a linked financial institution Item via POST /item/get
Remove Item
Permanently remove a linked Item, invalidating its access_token and ending all associated billing via POST /item/remove
Update Item Webhook
Update or set the webhook URL for receiving real-time event notifications for an Item via POST /item/webhook/update
Get Liabilities
Retrieve detailed liabilities data for credit cards, student loans, and mortgages associated with an Item via POST /liab…
Create Link Token
Create a link_token to initialize Plaid Link, the client-side UI component for bank account connection, via POST /link/t…
Get Link Token
Retrieve metadata and configuration details for a previously created link_token via POST /link/token/get
Evaluate Signal
Score the ACH return risk of a proposed debit transaction and apply Dashboard rulesets via POST /signal/evaluate
Prepare Signal
Pre-warm Plaid’s risk model for an Item so the next /signal/evaluate completes faster via POST /signal/prepare
Report Signal Decision
Report whether you proceeded with or blocked the ACH debit after a Signal score, used to refine Plaid’s model via POST /…
Report Signal Return
Report a returned ACH transaction back to Plaid with the return code so its risk model can learn via POST /signal/return…
List Statements
Retrieve a list of available bank statements for all accounts linked to an Item via POST /statements/list
Download Statement
Download a single bank statement PDF by its statement ID via POST /statements/download
Refresh Statements
Trigger on-demand extraction of bank statements for a specified date range via POST /statements/refresh
Sync Transactions
Get incremental transaction updates using Plaid’s recommended cursor-based sync approach, returning added, modified, and…
Get Transactions
Fetch historical transaction data within a specified date range with pagination and optional enrichment fields via POST…
Get Recurring Transactions
Fetch Plaid-detected recurring transaction patterns (subscriptions, income deposits, bills) for accounts associated with…
Refresh Transactions
Trigger an on-demand refresh of transaction data for an Item, bypassing the normal automatic update schedule, via POST /…
Create Transfer Authorization
Authorize a money movement before creating a transfer, returning a Plaid risk decision (approved, declined, user_action_…
Create Transfer
Initiate a money movement using a previously-approved authorization, returning the transfer_id and initial status (pendi…
Get Transfer
Retrieve the current state and metadata of a single transfer by transfer_id via POST /transfer/get
List Transfers
List transfers with optional filters by date range, account, status, or originator via POST /transfer/list
Cancel Transfer
Cancel a transfer that has not yet posted to the bank network via POST /transfer/cancel
Cancel Transfer Authorization
Cancel an unused transfer authorization before it expires via POST /transfer/authorization/cancel
List Transfer Events
List historical lifecycle events across transfers with date and status filters via POST /transfer/event/list
Sync Transfer Events
Incrementally pull transfer lifecycle events using a monotonically-increasing event_id cursor via POST /transfer/event/s…
Create Transfer Refund
Refund some or all of a posted/settled transfer back to the user’s bank via POST /transfer/refund/create
Get Transfer Refund
Retrieve refund details and current status by refund_id via POST /transfer/refund/get
Cancel Transfer Refund
Cancel a pending refund before it posts to the network via POST /transfer/refund/cancel
Get Transfer Capabilities
Determine RTP eligibility and other transfer capabilities for a Plaid Item via POST /transfer/capabilities/get
Create User
Create a Plaid User and return its user_id, for binding to a production connection’s Plaid User ID field
Get User
Retrieve a Plaid User’s identity and metadata by user_id via POST /user/get
Update User
Update the identity details stored against a Plaid User via POST /user/update
Events
|
No tags found
27 events
Event
Description
Tags
Transactions Sync Updates Available
Processes Plaid TRANSACTIONS.SYNC_UPDATES_AVAILABLE webhooks, fired when new transaction updates are ready to fetch with…
Transactions
Transactions Initial Update
Processes Plaid TRANSACTIONS.INITIAL_UPDATE webhooks, fired when the first 30 days of transactions are ready (legacy Get…
Transactions
Transactions Historical Update
Processes Plaid TRANSACTIONS.HISTORICAL_UPDATE webhooks, fired when the full transaction history is ready (legacy Get Tr…
Transactions
Transactions Default Update
Processes Plaid TRANSACTIONS.DEFAULT_UPDATE webhooks, fired when new transactions are available (legacy Get Transactions…
Transactions
Transactions Removed
Processes Plaid TRANSACTIONS.TRANSACTIONS_REMOVED webhooks, fired when transactions were removed from the Item (legacy G…
Transactions
Recurring Transactions Update
Processes Plaid TRANSACTIONS.RECURRING_TRANSACTIONS_UPDATE webhooks, fired when recurring transaction streams changed.
Transactions
Auth Default Update
Processes Plaid AUTH.DEFAULT_UPDATE webhooks, fired when account or routing numbers were added or changed.
Auth
Auth Automatically Verified
Processes Plaid AUTH.AUTOMATICALLY_VERIFIED webhooks, fired when an account was verified through automated micro-deposit…
Auth
Auth Verification Expired
Processes Plaid AUTH.VERIFICATION_EXPIRED webhooks, fired when automated micro-deposit verification of an account expire…
Auth
Auth SMS Micro-deposits Verification
Processes Plaid AUTH.SMS_MICRODEPOSITS_VERIFICATION webhooks, fired when a Same-Day micro-deposit account finished SMS v…
Auth
Auth Product Permissions Required
Processes Plaid AUTH.PRODUCT_PERMISSIONS_REQUIRED webhooks, fired when an Auth request hit ACCESS_NOT_GRANTED and the us…
Auth
Identity Default Update
Processes Plaid IDENTITY.DEFAULT_UPDATE webhooks, fired when account holder identity data changed.
Identity
Identity Product Permissions Required
Processes Plaid IDENTITY.PRODUCT_PERMISSIONS_REQUIRED webhooks, fired when an Identity request hit ACCESS_NOT_GRANTED an…
Identity
Holdings Default Update
Processes Plaid HOLDINGS.DEFAULT_UPDATE webhooks, fired when investment holdings were added or changed.
Investments
Investments Transactions Default Update
Processes Plaid INVESTMENTS_TRANSACTIONS.DEFAULT_UPDATE webhooks, fired when new or canceled investment transactions are…
Investments
Investments Transactions Historical Update
Processes Plaid INVESTMENTS_TRANSACTIONS.HISTORICAL_UPDATE webhooks, fired when historical investment transactions are r…
Investments
Liabilities Default Update
Processes Plaid LIABILITIES.DEFAULT_UPDATE webhooks, fired when liabilities data was added or changed.
Liabilities
Income Product Ready
Processes Plaid INCOME.PRODUCT_READY webhooks, fired when Plaid finished calculating income for the Item.
Income
Statements Refresh Complete
Processes Plaid STATEMENTS.STATEMENTS_REFRESH_COMPLETE webhooks, fired when a Refresh Statements request finished.
Statements
Item Error
Processes Plaid ITEM.ERROR webhooks, fired when the Item entered an error state, such as ITEM_LOGIN_REQUIRED.
Items
Item Login Repaired
Processes Plaid ITEM.LOGIN_REPAIRED webhooks, fired when the Item recovered from ITEM_LOGIN_REQUIRED without update mode…
Items
Item New Accounts Available
Processes Plaid ITEM.NEW_ACCOUNTS_AVAILABLE webhooks, fired when new accounts at the institution can be shared through u…
Items
Item Pending Expiration
Processes Plaid ITEM.PENDING_EXPIRATION webhooks, fired when the Item’s consent expires soon.
Items
Item Pending Disconnect
Processes Plaid ITEM.PENDING_DISCONNECT webhooks, fired when the Item will stop working soon and must go through update…
Items
Item User Permission Revoked
Processes Plaid ITEM.USER_PERMISSION_REVOKED webhooks, fired when the end user revoked access to the Item.
Items
Item User Account Revoked
Processes Plaid ITEM.USER_ACCOUNT_REVOKED webhooks, fired when the end user revoked access to one account at the institu…
Items
Item Webhook Update Acknowledged
Processes Plaid ITEM.WEBHOOK_UPDATE_ACKNOWLEDGED webhooks, fired when the Item’s webhook URL was changed.
Items