> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Plaid

> How to set up the Plaid connector, plus the actions and events that are available.

![Plaid](https://stackone-logos.com/api/plaid/filled/svg)

Previewv4.0.0[See changelog](https://docs.stackone.com/connectors/plaid/changelog.md)

[51 actions](#actions) · [27 events](#events) · 2 auth methods

Payments
Accounting

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 — Sandbox · Connector Profile](https://docs.stackone.com/connectors/plaid/guides/connector-profile/oauth-2-0-sandbox.md)
>
> Sandbox-only auto-mint flow. StackOne calls /sandbox/public\_token/create and /item/public\_token/exchange behind the scen...

> [card] [OAuth 2.0 — Production · Connector Profile](https://docs.stackone.com/connectors/plaid/guides/connector-profile/oauth-2-0-production.md)
>
> Production auth flow. Run Plaid Link in your own app to authenticate the end user with their bank, capture the resulting...

Optionally, configure receiving Events for Plaid into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/plaid/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 — Sandbox · Link Account](https://docs.stackone.com/connectors/plaid/guides/link-account/oauth-2-0-sandbox.md)

> [card] [OAuth 2.0 — Production · Link Account](https://docs.stackone.com/connectors/plaid/guides/link-account/oauth-2-0-production.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

assets

auth

balance

enrich

identity

income\_verification

investments

liabilities

signal

statements

transactions

transfer

No scopes found

51 actions

ActionDescriptionRequired scopes

Get Accounts`plaid_get_accounts`

Retrieve all financial accounts (checking, savings, credit, loan, investment) linked to an Item via POST /accounts/get

Get Account Balance`plaid_get_account_balance`

Fetch real-time balance data directly from the financial institution for all or specific accounts via POST /accounts/bal...

`balance`

Create Asset Report`plaid_create_asset_report`

Create an Asset Report for the linked Item, providing a point-in-time snapshot of account balances, transactions, and id...

`assets`

Get Asset Report`plaid_get_asset_report`

Retrieve a completed Asset Report containing account balances, transaction history, and identity data via POST /asset\_re...

`assets`

Get Asset Report PDF`plaid_get_asset_report_pdf`

Download a completed Asset Report as a formatted PDF document (binary response, application/pdf) for sharing with lender...

`assets`

Refresh Asset Report`plaid_refresh_asset_report`

Create a refreshed copy of an existing Asset Report with updated data from the financial institutions via POST /asset\_re...

`assets`

Filter Asset Report`plaid_filter_asset_report`

Create a filtered copy of an Asset Report with specified accounts excluded via POST /asset\_report/filter

`assets`

Remove Asset Report`plaid_remove_asset_report`

Permanently delete an Asset Report and invalidate its token via POST /asset\_report/remove

`assets`

Get Auth`plaid_get_auth`

Retrieve bank account numbers and routing numbers needed to initiate ACH, EFT, BACS, and wire transfers via POST /auth/g...

`auth`

Enrich Transactions`plaid_enrich_transactions`

Enrich your own (non-Plaid-sourced) transactions with merchant info, categorization, and counterparty data via POST /tra...

`enrich`

Get Identity`plaid_get_identity`

Retrieve personal identity information (name, email, phone, address) for account holders directly from the financial ins...

`identity`

Get Bank Income`plaid_get_bank_income`

Retrieve completed Bank Income reports (income streams identified from bank deposits) for a user via POST /credit/bank\_i...

`income_verification`

Get Bank Income PDF`plaid_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

`income_verification`

Get Credit Sessions`plaid_get_credit_sessions`

List the user's Income / Consumer-Report Link sessions and their final statuses via POST /credit/sessions/get

`income_verification`

Get Institutions`plaid_get_institutions`

Retrieve a paginated list of all Plaid-supported financial institutions with filtering by country, products, and routing...

Get Institution By ID`plaid_get_institution_by_id`

Retrieve detailed metadata for a single financial institution by its Plaid institution\_id via POST /institutions/get\_by\_...

Search Institutions`plaid_search_institutions`

Search Plaid's institution directory by name or query string with optional product and country filters via POST /institu...

Get Investment Holdings`plaid_get_investment_holdings`

Retrieve current investment portfolio holdings including stocks, bonds, mutual funds, and ETFs for linked brokerage and...

`investments`

Get Investment Transactions`plaid_get_investment_transactions`

Retrieve investment transactions (buys, sells, dividends, fees, transfers) within a specified date range for linked brok...

`investments`

Get Item`plaid_get_item`

Retrieve metadata and health status for a linked financial institution Item via POST /item/get

Remove Item`plaid_remove_item`

Permanently remove a linked Item, invalidating its access\_token and ending all associated billing via POST /item/remove

Update Item Webhook`plaid_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`plaid_get_liabilities`

Retrieve detailed liabilities data for credit cards, student loans, and mortgages associated with an Item via POST /liab...

`liabilities`

Create Link Token`plaid_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`plaid_get_link_token`

Retrieve metadata and configuration details for a previously created link\_token via POST /link/token/get

Evaluate Signal`plaid_evaluate_signal`

Score the ACH return risk of a proposed debit transaction and apply Dashboard rulesets via POST /signal/evaluate

`signal`

Prepare Signal`plaid_prepare_signal`

Pre-warm Plaid's risk model for an Item so the next /signal/evaluate completes faster via POST /signal/prepare

`signal`

Report Signal Decision`plaid_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 /...

`signal`

Report Signal Return`plaid_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...

`signal`

List Statements`plaid_list_statements`

Retrieve a list of available bank statements for all accounts linked to an Item via POST /statements/list

`statements`

Download Statement`plaid_download_statement`

Download a single bank statement PDF by its statement ID via POST /statements/download

`statements`

Refresh Statements`plaid_refresh_statements`

Trigger on-demand extraction of bank statements for a specified date range via POST /statements/refresh

`statements`

Sync Transactions`plaid_sync_transactions`

Get incremental transaction updates using Plaid's recommended cursor-based sync approach, returning added, modified, and...

`transactions`

Get Transactions`plaid_get_transactions`

Fetch historical transaction data within a specified date range with pagination and optional enrichment fields via POST...

`transactions`

Get Recurring Transactions`plaid_get_recurring_transactions`

Fetch Plaid-detected recurring transaction patterns (subscriptions, income deposits, bills) for accounts associated with...

`transactions`

Refresh Transactions`plaid_refresh_transactions`

Trigger an on-demand refresh of transaction data for an Item, bypassing the normal automatic update schedule, via POST /...

`transactions`

Create Transfer Authorization`plaid_create_transfer_authorization`

Authorize a money movement before creating a transfer, returning a Plaid risk decision (approved, declined, user\_action\_...

`transfer`

Create Transfer`plaid_create_transfer`

Initiate a money movement using a previously-approved authorization, returning the transfer\_id and initial status (pendi...

`transfer`

Get Transfer`plaid_get_transfer`

Retrieve the current state and metadata of a single transfer by transfer\_id via POST /transfer/get

`transfer`

List Transfers`plaid_list_transfers`

List transfers with optional filters by date range, account, status, or originator via POST /transfer/list

`transfer`

Cancel Transfer`plaid_cancel_transfer`

Cancel a transfer that has not yet posted to the bank network via POST /transfer/cancel

`transfer`

Cancel Transfer Authorization`plaid_cancel_transfer_authorization`

Cancel an unused transfer authorization before it expires via POST /transfer/authorization/cancel

`transfer`

List Transfer Events`plaid_list_transfer_events`

List historical lifecycle events across transfers with date and status filters via POST /transfer/event/list

`transfer`

Sync Transfer Events`plaid_sync_transfer_events`

Incrementally pull transfer lifecycle events using a monotonically-increasing event\_id cursor via POST /transfer/event/s...

`transfer`

Create Transfer Refund`plaid_create_transfer_refund`

Refund some or all of a posted/settled transfer back to the user's bank via POST /transfer/refund/create

`transfer`

Get Transfer Refund`plaid_get_transfer_refund`

Retrieve refund details and current status by refund\_id via POST /transfer/refund/get

`transfer`

Cancel Transfer Refund`plaid_cancel_transfer_refund`

Cancel a pending refund before it posts to the network via POST /transfer/refund/cancel

`transfer`

Get Transfer Capabilities`plaid_get_transfer_capabilities`

Determine RTP eligibility and other transfer capabilities for a Plaid Item via POST /transfer/capabilities/get

`transfer`

Create User`plaid_create_user`

Create a Plaid User and return its user\_id, for binding to a production connection's Plaid User ID field

Get User`plaid_get_user`

Retrieve a Plaid User's identity and metadata by user\_id via POST /user/get

Update User`plaid_update_user`

Update the identity details stored against a Plaid User via POST /user/update

## Events

Tags

Select all
|
Clear

Auth

Identity

Income

Investments

Items

Liabilities

Statements

Transactions

No tags found

27 events

EventDescriptionTags

Transactions Sync Updates Available`plaid_webhook_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`plaid_webhook_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`plaid_webhook_transactions_historical_update`

Processes Plaid TRANSACTIONS.HISTORICAL\_UPDATE webhooks, fired when the full transaction history is ready (legacy Get Tr...

Transactions

Transactions Default Update`plaid_webhook_transactions_default_update`

Processes Plaid TRANSACTIONS.DEFAULT\_UPDATE webhooks, fired when new transactions are available (legacy Get Transactions...

Transactions

Transactions Removed`plaid_webhook_transactions_transactions_removed`

Processes Plaid TRANSACTIONS.TRANSACTIONS\_REMOVED webhooks, fired when transactions were removed from the Item (legacy G...

Transactions

Recurring Transactions Update`plaid_webhook_transactions_recurring_transactions_update`

Processes Plaid TRANSACTIONS.RECURRING\_TRANSACTIONS\_UPDATE webhooks, fired when recurring transaction streams changed.

Transactions

Auth Default Update`plaid_webhook_auth_default_update`

Processes Plaid AUTH.DEFAULT\_UPDATE webhooks, fired when account or routing numbers were added or changed.

Auth

Auth Automatically Verified`plaid_webhook_auth_automatically_verified`

Processes Plaid AUTH.AUTOMATICALLY\_VERIFIED webhooks, fired when an account was verified through automated micro-deposit...

Auth

Auth Verification Expired`plaid_webhook_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`plaid_webhook_auth_sms_microdeposits_verification`

Processes Plaid AUTH.SMS\_MICRODEPOSITS\_VERIFICATION webhooks, fired when a Same-Day micro-deposit account finished SMS v...

Auth

Auth Product Permissions Required`plaid_webhook_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`plaid_webhook_identity_default_update`

Processes Plaid IDENTITY.DEFAULT\_UPDATE webhooks, fired when account holder identity data changed.

Identity

Identity Product Permissions Required`plaid_webhook_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`plaid_webhook_holdings_default_update`

Processes Plaid HOLDINGS.DEFAULT\_UPDATE webhooks, fired when investment holdings were added or changed.

Investments

Investments Transactions Default Update`plaid_webhook_investments_transactions_default_update`

Processes Plaid INVESTMENTS\_TRANSACTIONS.DEFAULT\_UPDATE webhooks, fired when new or canceled investment transactions are...

Investments

Investments Transactions Historical Update`plaid_webhook_investments_transactions_historical_update`

Processes Plaid INVESTMENTS\_TRANSACTIONS.HISTORICAL\_UPDATE webhooks, fired when historical investment transactions are r...

Investments

Liabilities Default Update`plaid_webhook_liabilities_default_update`

Processes Plaid LIABILITIES.DEFAULT\_UPDATE webhooks, fired when liabilities data was added or changed.

Liabilities

Income Product Ready`plaid_webhook_income_product_ready`

Processes Plaid INCOME.PRODUCT\_READY webhooks, fired when Plaid finished calculating income for the Item.

Income

Statements Refresh Complete`plaid_webhook_statements_statements_refresh_complete`

Processes Plaid STATEMENTS.STATEMENTS\_REFRESH\_COMPLETE webhooks, fired when a Refresh Statements request finished.

Statements

Item Error`plaid_webhook_item_error`

Processes Plaid ITEM.ERROR webhooks, fired when the Item entered an error state, such as ITEM\_LOGIN\_REQUIRED.

Items

Item Login Repaired`plaid_webhook_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`plaid_webhook_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`plaid_webhook_item_pending_expiration`

Processes Plaid ITEM.PENDING\_EXPIRATION webhooks, fired when the Item's consent expires soon.

Items

Item Pending Disconnect`plaid_webhook_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`plaid_webhook_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`plaid_webhook_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`plaid_webhook_item_webhook_update_acknowledged`

Processes Plaid ITEM.WEBHOOK\_UPDATE\_ACKNOWLEDGED webhooks, fired when the Item's webhook URL was changed.

Items


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.