data
Plaid MCP, CLI, and Lua Integration for AI Agents
Plaid integration docs for AI agents: MCP gateway setup, Plaid CLI commands, Lua API reference, credentials, and function schemas.Plaid for agents
Credentials can be configured manually in web or CLI hosts.
Use this integration from Lua code mode, the headless integrations CLI, or the KosmoKrator MCP gateway. The same package metadata powers all three surfaces.
Agent Surfaces
Machine-Readable Metadata
Function Catalog
| Function | Type | Parameters | Description |
|---|---|---|---|
plaid.plaid_asset_report_create | Write write | 0 | The `/asset_report/create` endpoint initiates the process of creating an Asset Report, which can then be retrieved by passing the `asset_report_token` return value to the `/asse... |
plaid.plaid_asset_report_get | Read read | 0 | The `/asset_report/get` endpoint retrieves the Asset Report in JSON format. Before calling `/asset_report/get`, you must first create the Asset Report using `/asset_report/creat... |
plaid.plaid_asset_report_pdf_get | Read read | 0 | The `/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/asset_report/pdf/get`, you must first create the Asset Report using `/asset_repor... |
plaid.plaid_asset_report_refresh | Write write | 0 | An Asset Report is an immutable snapshot of a user's assets. In order to "refresh" an Asset Report you created previously, you can use the `/asset_report/refresh` endpoint to cr... |
plaid.plaid_asset_report_filter | Read read | 0 | By default, an Asset Report will contain all of the accounts on a given Item. In some cases, you may not want the Asset Report to contain all accounts. For example, you might ha... |
plaid.plaid_asset_report_remove | Write write | 0 | The `/item/remove` endpoint allows you to invalidate an `access_token`, meaning you will not be able to create new Asset Reports with it. Removing an Item does not affect any As... |
plaid.plaid_asset_report_audit_copy_create | Write write | 0 | Plaid can provide an Audit Copy of any Asset Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy directly to the GSEs on y... |
plaid.plaid_asset_report_audit_copy_get | Read read | 0 | `/asset_report/audit_copy/get` allows auditors to get a copy of an Asset Report that was previously shared via the `/asset_report/audit_copy/create` endpoint. The caller of `/as... |
plaid.plaid_asset_report_audit_copy_pdf_get | Read read | 0 | The `/asset_report/audit_copy/pdf/get` endpoint retrieves an Asset Report Audit Copy in PDF format. The caller must provide the `audit_copy_token` that was shared via the `/asse... |
plaid.plaid_asset_report_audit_copy_remove | Write write | 0 | The `/asset_report/audit_copy/remove` endpoint allows you to remove an Audit Copy. Removing an Audit Copy invalidates the `audit_copy_token` associated with it, meaning both you... |
plaid.plaid_cra_monitoring_insights_subscribe | Write write | 0 | This endpoint allows you to subscribe to insights for a user's linked CRA Item, which are updated between one and four times per day (best-effort). In the current Cash Flow Upda... |
plaid.plaid_cra_monitoring_insights_unsubscribe | Write write | 0 | This endpoint allows you to unsubscribe from previously subscribed Monitoring Insights. |
plaid.plaid_cra_monitoring_insights_get | Read read | 0 | This endpoint allows you to retrieve a Cash Flow Updates report by passing in the `user_id` referred to in the webhook you received. |
plaid.plaid_credit_audit_copy_token_update | Write write | 0 | The `/credit/audit_copy_token/update` endpoint updates an existing Audit Copy Token by adding the report tokens in the `report_tokens` field to the `audit_copy_token`. If the Au... |
plaid.plaid_cra_partner_insights_get | Read read | 0 | `/cra/partner_insights/get` returns cash flow insights for a specified user. |
plaid.plaid_cra_check_report_income_insights_get | Read read | 0 | 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` or a `USER_CHECK_REPO... |
plaid.plaid_cra_check_report_base_report_get | Read read | 0 | 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 yo... |
plaid.plaid_cra_check_report_pdf_get | Read read | 0 | `/cra/check_report/pdf/get` retrieves the most recent Consumer Report in PDF format. By default, the most recent Base Report (if it exists) for the user will be returned. To req... |
plaid.plaid_cra_check_report_create | Write write | 0 | Use `/cra/check_report/create` to refresh data in an existing report. A Consumer Report will last for 24 hours before expiring; you should call any `/get` endpoints on the repor... |
plaid.plaid_cra_check_report_partner_insights_get | Read read | 0 | This endpoint allows you to retrieve the Partner Insights report for your user. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPOR... |
plaid.plaid_cra_check_report_cashflow_insights_get | Read read | 0 | This endpoint allows you to retrieve the Cashflow Insights report for your user. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPO... |
plaid.plaid_cra_check_report_lend_score_get | Read read | 0 | This endpoint allows you to retrieve the LendScore report for your user. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY... |
plaid.plaid_cra_check_report_network_insights_get | Read read | 0 | This endpoint allows you to retrieve the Network Insights product for your user. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPO... |
plaid.plaid_cra_check_report_verification_get | Read read | 0 | This endpoint allows you to retrieve home lending reports for a user. To obtain a VoA or Employment Refresh report, you need to make sure that `cra_base_report` is included in t... |
plaid.plaid_cra_check_report_verification_pdf_get | Read read | 0 | The `/cra/check_report/verification/pdf/get` endpoint retrieves the most recent Consumer Report in PDF format, specifically formatted for Home Lending verification use cases. Be... |
plaid.plaid_cra_loans_applications_register | Write write | 0 | `/cra/loans/applications/register` registers loan applications and decisions. |
plaid.plaid_cra_loans_register | Write write | 0 | `/cra/loans/register` registers a list of loans to their applicants. |
plaid.plaid_cra_loans_update | Write write | 0 | `/cra/loans/update` updates loan information such as the status and payment history. |
plaid.plaid_cra_loans_unregister | Write write | 0 | `/cra/loans/unregister` indicates the loans have reached a final status and no further updates are expected. |
plaid.plaid_cra_credit_profile_report_get | Read read | 0 | `/cra/credit_profile/report/get` retrieves a credit profile report for a user. |
plaid.plaid_consumer_report_pdf_get | Read read | 0 | Retrieves all existing CRB Bank Income and Base reports for the consumer in PDF format. Response is PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. |
plaid.plaid_oauth_token | Write write | 0 | `/oauth/token` issues an access token and refresh token depending on the `grant_type` provided. This endpoint supports `Content-Type: application/x-www-form-urlencoded` as well ... |
plaid.plaid_oauth_introspect | Read read | 0 | `/oauth/introspect` returns metadata about an access token or refresh token. Note: This endpoint supports `Content-Type: application/x-www-form-urlencoded` as well as JSON. The ... |
plaid.plaid_oauth_revoke | Write write | 0 | `/oauth/revoke` revokes an access or refresh token, preventing any further use. If a refresh token is revoked, all access and refresh tokens derived from it are also revoked, in... |
plaid.plaid_statements_list | Read read | 0 | The `/statements/list` endpoint retrieves a list of all statements associated with an item. |
plaid.plaid_statements_download | Read read | 0 | The `/statements/download` endpoint retrieves a single statement PDF in binary format. The response will contain a `Plaid-Content-Hash` header containing a SHA 256 checksum of t... |
plaid.plaid_statements_refresh | Write write | 0 | `/statements/refresh` initiates an on-demand extraction to fetch the statements for the provided dates. |
plaid.plaid_consent_events_get | Read read | 0 | List a historical log of Item consent events. Consent logs are only available for events occurring on or after November 7, 2024. Extremely recent events (occurring within the pa... |
plaid.plaid_item_activity_list | Read read | 0 | List a historical log of user consent events |
plaid.plaid_item_application_list | Read read | 0 | List a user’s connected applications |
plaid.plaid_item_application_unlink | Read read | 0 | Unlink a user’s connected application. On an unlink request, Plaid will immediately revoke the Application’s access to the User’s data. The User will have to redo the OAut... |
plaid.plaid_item_application_scopes_update | Write write | 0 | Enable consumers to update product access on selected accounts for an application. |
plaid.plaid_application_get | Read read | 0 | Allows financial institutions to retrieve information about Plaid clients for the purpose of building control-tower experiences |
plaid.plaid_item_get | Read read | 0 | Returns information about the status of an Item. |
plaid.plaid_user_account_session_get | Read read | 0 | This endpoint returns user permissioned account data, including identity and Item access tokens, for use with [Plaid Layer](https://plaid.com/docs/layer). Note that end users ar... |
plaid.plaid_user_account_session_event_send | Read read | 0 | This endpoint allows sending client-specific events related to Layer sessions for analytics and tracking purposes. |
plaid.plaid_profile_network_status_get | Read read | 0 | The `/profile/network_status/get` endpoint can be used to check whether Plaid has a matching profile for the user. |
plaid.plaid_network_status_get | Read read | 0 | The `/network/status/get` endpoint can be used to check whether Plaid has a matching profile for the user. This is useful for determining if a user is eligible for a streamlined... |
plaid.plaid_auth_get | Read read | 0 | The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking, savings, and cas... |
plaid.plaid_auth_verify | Read read | 0 | The `/auth/verify` endpoint verifies bank account and routing numbers and (optionally) account owner names against Plaid's database via [Database Auth](https://plaid.com/docs/au... |
plaid.plaid_transactions_get | Read read | 0 | Note: All new implementations are encouraged to use `/transactions/sync` rather than `/transactions/get`. `/transactions/sync` provides the same functionality as `/transactions/... |
plaid.plaid_transactions_refresh | Write write | 0 | `/transactions/refresh` is an optional endpoint that initiates an on-demand extraction to fetch the newest transactions for an Item. The on-demand extraction takes place in addi... |
plaid.plaid_sandbox_transactions_create | Write write | 0 | Use the `/sandbox/transactions/create` endpoint to create new transactions for an existing Item. This endpoint can be used to add up to 10 transactions to any Item at a time. Th... |
plaid.plaid_cashflow_report_refresh | Write write | 0 | `/cashflow_report/refresh` is an endpoint that initiates an on-demand extraction to fetch the newest transactions for an item (given an `item_id`). The item must already have Ca... |
plaid.plaid_cashflow_report_get | Read read | 0 | The `/cashflow_report/get` endpoint retrieves transactions data associated with an item. Transactions data is standardized across financial institutions. Transactions are return... |
plaid.plaid_cashflow_report_transactions_get | Read read | 0 | The `/cashflow_report/transactions/get` endpoint retrieves transactions data associated with an item. Transactions data is standardized across financial institutions. Transactio... |
plaid.plaid_cashflow_report_insights_get | Read read | 0 | The `/cashflow_report/insights/get` endpoint retrieves insights data associated with an item. Insights are only calculated on credit and depository accounts. |
plaid.plaid_transactions_recurring_get | Read read | 0 | The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, s... |
plaid.plaid_transactions_sync | Read read | 0 | The `/transactions/sync` endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For importan... |
plaid.plaid_transactions_enrich | Read read | 0 | The `/transactions/enrich` endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources. |
plaid.plaid_user_transactions_refresh | Write write | 0 | `/user/transactions/refresh` is an optional endpoint that initiates an on-demand extraction to fetch the newest transactions for a User using the Transactions bundle. This bundl... |
plaid.plaid_user_financial_data_refresh | Write write | 0 | `/user/financial_data/refresh` is an optional endpoint that initiates an on-demand extraction to fetch the newest transactions for a User using the Financial Insights bundle. Th... |
plaid.plaid_institutions_get | Read read | 0 | Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. I... |
plaid.plaid_institutions_search | Read read | 0 | Returns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query. Versioning note: API versions 2019-05... |
plaid.plaid_institutions_get_by_id | Read read | 0 | Returns a JSON response containing details on a specified financial institution currently supported by Plaid. Versioning note: API versions 2019-05-29 and earlier allow use of t... |
plaid.plaid_item_remove | Write write | 0 | The `/item/remove` endpoint allows you to remove an Item. Once removed, the `access_token`, as well as any processor tokens or bank account tokens associated with the Item, is n... |
plaid.plaid_item_products_terminate | Read read | 0 | The `/item/products/terminate` endpoint allows you to terminate an Item. Once terminated, the `access_token` associated with the Item is no longer valid, billing for the Item's ... |
plaid.plaid_item_handle_fraud_report | Read read | 0 | Use this endpoint to create a fraud report and terminate the associated Item. The `access_token` associated with the Item will be deactivated and billing for the Item's products... |
plaid.plaid_accounts_get | Read read | 0 | The `/accounts/get` endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts — that is, accounts that a... |
plaid.plaid_categories_get | Read read | 0 | Send a request to the `/categories/get` endpoint to get detailed information on legacy categories returned by Plaid. This endpoint does not require authentication. All implement... |
plaid.plaid_sandbox_processor_token_create | Write write | 0 | Use the `/sandbox/processor_token/create` endpoint to create a valid `processor_token` for an arbitrary institution ID and test credentials. The created `processor_token` corres... |
plaid.plaid_sandbox_public_token_create | Write write | 0 | Use the `/sandbox/public_token/create` endpoint to create a valid `public_token` for an arbitrary institution ID, initial products, and test credentials. The created `public_tok... |
plaid.plaid_sandbox_item_fire_webhook | Write write | 0 | The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Webhook to be... |
plaid.plaid_accounts_balance_get | Read read | 0 | The `/accounts/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints, such as `/accounts/get`, return a balance object, `/acc... |
plaid.plaid_identity_get | Read read | 0 | The `/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addres... |
plaid.plaid_identity_documents_uploads_get | Read read | 0 | Use `/identity/documents/uploads/get` to retrieve identity details when using [Identity Document Upload](https://plaid.com/docs/identity/identity-document-upload/). |
plaid.plaid_identity_match | Read read | 0 | The `/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's fi... |
plaid.plaid_identity_refresh | Write write | 0 | `/identity/refresh` is an optional endpoint for users of the Identity product. It initiates an on-demand extraction to fetch the most up to date Identity information from the Fi... |
plaid.plaid_dashboard_user_get | Read read | 0 | The `/dashboard_user/get` endpoint provides details (such as email address) about a specific Dashboard user based on the `dashboard_user_id` field, which is returned in the `aud... |
plaid.plaid_dashboard_user_list | Read read | 0 | The `/dashboard_user/list` endpoint provides details (such as email address) all Dashboard users associated with your account. This can use used to audit or track the list of re... |
plaid.plaid_identity_verification_create | Write write | 0 | Create a new Identity Verification for the user specified by the `client_user_id` and/or `user_id` field. At least one of these two fields must be provided. The requirements and... |
plaid.plaid_identity_verification_get | Read read | 0 | Retrieve a previously created Identity Verification. |
plaid.plaid_identity_verification_list | Read read | 0 | Filter and list Identity Verifications created by your account |
plaid.plaid_identity_verification_retry | Write write | 0 | Allow a customer to retry their Identity Verification |
plaid.plaid_watchlist_screening_entity_create | Write write | 0 | Create a new entity watchlist screening to check your customer against watchlists defined in the associated entity watchlist program. If your associated program has ongoing scre... |
plaid.plaid_watchlist_screening_entity_get | Read read | 0 | Retrieve an entity watchlist screening. |
plaid.plaid_watchlist_screening_entity_history_list | Read read | 0 | List all changes to the entity watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be returned. |
plaid.plaid_watchlist_screening_entity_hit_list | Read read | 0 | List all hits for the entity watchlist screening. |
plaid.plaid_watchlist_screening_entity_list | Read read | 0 | List all entity screenings. |
plaid.plaid_watchlist_screening_entity_program_get | Read read | 0 | Get an entity watchlist screening program |
plaid.plaid_watchlist_screening_entity_program_list | Read read | 0 | List all entity watchlist screening programs |
plaid.plaid_watchlist_screening_entity_review_create | Write write | 0 | Create a review for an entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid. |
plaid.plaid_watchlist_screening_entity_review_list | Read read | 0 | List all reviews for a particular entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits foun... |
plaid.plaid_watchlist_screening_entity_update | Write write | 0 | Update an entity watchlist screening. |
plaid.plaid_watchlist_screening_individual_create | Write write | 0 | Create a new Watchlist Screening to check your customer against watchlists defined in the associated Watchlist Program. If your associated program has ongoing screening enabled,... |
plaid.plaid_watchlist_screening_individual_get | Read read | 0 | Retrieve a previously created individual watchlist screening |
plaid.plaid_watchlist_screening_individual_history_list | Read read | 0 | List all changes to the individual watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be returned. |
plaid.plaid_watchlist_screening_individual_hit_list | Read read | 0 | List all hits found by Plaid for a particular individual watchlist screening. |
plaid.plaid_watchlist_screening_individual_list | Read read | 0 | List previously created watchlist screenings for individuals |
plaid.plaid_watchlist_screening_individual_program_get | Read read | 0 | Get an individual watchlist screening program |
plaid.plaid_watchlist_screening_individual_program_list | Read read | 0 | List all individual watchlist screening programs |
plaid.plaid_watchlist_screening_individual_review_create | Write write | 0 | Create a review for the individual watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by P... |
plaid.plaid_watchlist_screening_individual_review_list | Read read | 0 | List all reviews for the individual watchlist screening. |
plaid.plaid_watchlist_screening_individual_update | Write write | 0 | Update a specific individual watchlist screening. This endpoint can be used to add additional customer information, correct outdated information, add a reference id, assign the ... |
plaid.plaid_beacon_account_risk_evaluate | Read read | 0 | Use `/beacon/account_risk/v1/evaluate` to get risk insights for a linked account. |
plaid.plaid_beacon_user_create | Write write | 0 | Create and scan a Beacon User against your Beacon Program, according to your program's settings. When you submit a new user to `/beacon/user/create`, several checks are performe... |
plaid.plaid_beacon_user_get | Read read | 0 | Fetch a Beacon User. The Beacon User is returned with all of their associated information and a `status` based on the Beacon Network duplicate record and fraud checks. |
plaid.plaid_beacon_user_review | Read read | 0 | Update the status of a Beacon User. When updating a Beacon User's status via this endpoint, Plaid validates that the status change is consistent with the related state for this ... |
plaid.plaid_beacon_report_create | Write write | 0 | Create a fraud report for a given Beacon User. |
plaid.plaid_beacon_report_list | Read read | 0 | Use the `/beacon/report/list` endpoint to view all Beacon Reports you created for a specific Beacon User. The reports returned by this endpoint are exclusively reports you creat... |
plaid.plaid_beacon_report_syndication_list | Read read | 0 | Use the `/beacon/report_syndication/list` endpoint to view all Beacon Reports that have been syndicated to a specific Beacon User. This endpoint returns Beacon Report Syndicatio... |
plaid.plaid_beacon_report_get | Read read | 0 | Returns a Beacon report for a given Beacon report id. |
plaid.plaid_beacon_report_syndication_get | Read read | 0 | Returns a Beacon Report Syndication for a given Beacon Report Syndication id. |
plaid.plaid_beacon_user_update | Write write | 0 | Update the identity data for a Beacon User in your Beacon Program or add new accounts to the Beacon User. Similar to `/beacon/user/create`, several checks are performed immediat... |
plaid.plaid_beacon_duplicate_get | Read read | 0 | Returns a Beacon Duplicate for a given Beacon Duplicate id. A Beacon Duplicate represents a pair of similar Beacon Users within your organization. Two Beacon User revisions are ... |
plaid.plaid_identity_verification_autofill_create | Write write | 0 | Try to autofill an Identity Verification based of the provided phone number, date of birth and country of residence. |
plaid.plaid_beacon_user_history_list | Read read | 0 | List all changes to the Beacon User in reverse-chronological order. |
plaid.plaid_beacon_user_account_insights_get | Read read | 0 | Get Account Insights for all Accounts linked to this Beacon User. The insights for each account are computed based on the information that was last retrieved from the financial ... |
plaid.plaid_protect_user_insights_get | Read read | 0 | Use this endpoint to get basic information about a user as it relates to their fraud profile with Protect. |
plaid.plaid_protect_report_create | Write write | 0 | Use this endpoint to create a Protect report to document fraud incidents, investigation outcomes, or other risk events. This endpoint allows you to report various types of incid... |
plaid.plaid_protect_compute | Read read | 0 | Use this endpoint to compute a Protect Trust Index score and retrieve fraud attributes. For link-session models, if the Link session is not yet complete, the endpoint returns HT... |
plaid.plaid_protect_event_send | Read read | 0 | Send a new event to enrich user data and optionally get a Trust Index score for the event. |
plaid.plaid_protect_event_get | Read read | 0 | Get information about a user event including Trust Index score and fraud attributes. |
plaid.plaid_business_verification_get | Read read | 0 | Retrieve the current state of a specific business verification. |
plaid.plaid_business_verification_create | Write write | 0 | Create a new business verification to check a business's identity and risk profile. |
plaid.plaid_processor_auth_get | Read read | 0 | The `/processor/auth/get` endpoint returns the bank account and bank identification number (such as the routing number, for US accounts), for a checking, savings, or cash manage... |
plaid.plaid_processor_account_get | Read read | 0 | This endpoint returns the account associated with a given processor token. This endpoint retrieves cached information, rather than extracting fresh information from the institut... |
plaid.plaid_processor_investments_holdings_get | Read read | 0 | This endpoint returns the stock position data of the account associated with a given processor token. |
plaid.plaid_processor_investments_auth_get | Read read | 0 | The `/processor/investments/auth/get` endpoint allows you to retrieve information about the account authorized by a processor token, including account numbers, account owners, h... |
plaid.plaid_processor_investments_transactions_get | Read read | 0 | The `/processor/investments/transactions/get` endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for the investment account associated wi... |
plaid.plaid_processor_transactions_get | Read read | 0 | The `/processor/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with acc... |
plaid.plaid_processor_transactions_sync | Read read | 0 | The `/processor/transactions/sync` endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. Fo... |
plaid.plaid_processor_transactions_refresh | Write write | 0 | `/processor/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a proc... |
plaid.plaid_processor_transactions_recurring_get | Read read | 0 | The `/processor/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s c... |
plaid.plaid_processor_signal_evaluate | Read read | 0 | Use `/processor/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment and additional risk signals. `/processor/signal/evaluate` uses Rulesets th... |
plaid.plaid_processor_signal_decision_report | Write write | 0 | After you call `/processor/signal/evaluate`, Plaid will normally infer the outcome from your Signal Rules. However, if you are not using Signal Rules, if the Signal Rules outcom... |
plaid.plaid_processor_signal_return_report | Read read | 0 | Call the `/processor/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/processor/signal/evaluate` endpoint. Your feedback will be... |
plaid.plaid_processor_signal_prepare | Read read | 0 | When a processor token is not initialized with `signal`, call `/processor/signal/prepare` to opt-in that processor token to the data collection process, which will improve the a... |
plaid.plaid_processor_bank_transfer_create | Write write | 0 | Use the `/processor/bank_transfer/create` endpoint to initiate a new bank transfer as a processor |
plaid.plaid_processor_liabilities_get | Read read | 0 | The `/processor/liabilities/get` endpoint returns various details about a loan or credit account. Liabilities data is available primarily for US financial institutions, with som... |
plaid.plaid_processor_identity_get | Read read | 0 | The `/processor/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, ... |
plaid.plaid_processor_identity_match | Read read | 0 | The `/processor/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account h... |
plaid.plaid_processor_balance_get | Read read | 0 | The `/processor/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints may return a balance object, only `/processor/balance/g... |
plaid.plaid_item_webhook_update | Write write | 0 | The POST `/item/webhook/update` allows you to update the webhook URL associated with an Item. This request triggers a [`WEBHOOK_UPDATE_ACKNOWLEDGED`](https://plaid.com/docs/api/... |
plaid.plaid_item_access_token_invalidate | Write write | 0 | By default, the `access_token` associated with an Item does not expire and should be stored in a persistent, secure manner. You can use the `/item/access_token/invalidate` endpo... |
plaid.plaid_webhook_verification_key_get | Read read | 0 | Plaid signs all outgoing webhooks and provides JSON Web Tokens (JWTs) so that you can verify the authenticity of any incoming webhooks to your application. A message signature i... |
plaid.plaid_liabilities_get | Read read | 0 | The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with s... |
plaid.plaid_payment_initiation_recipient_create | Write write | 0 | Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA) or a non-Eurozone co... |
plaid.plaid_payment_initiation_payment_reverse | Read read | 0 | Reverse a settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded. To refund partially, specify the amount as part of the re... |
plaid.plaid_payment_initiation_recipient_get | Read read | 0 | Get details about a payment recipient you have previously created. |
plaid.plaid_payment_initiation_recipient_list | Read read | 0 | The `/payment_initiation/recipient/list` endpoint list the payment recipients that you have previously created. |
plaid.plaid_payment_initiation_payment_create | Write write | 0 | After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing ord... |
plaid.plaid_create_payment_token | Write write | 0 | The `/payment_initiation/payment/token/create` endpoint has been deprecated. New Plaid customers will be unable to use this endpoint, and existing customers are encouraged to mi... |
plaid.plaid_payment_initiation_consent_create | Write write | 0 | The `/payment_initiation/consent/create` endpoint is used to create a payment consent, which can be used to initiate payments on behalf of the user. Payment consents are created... |
plaid.plaid_payment_initiation_consent_get | Read read | 0 | The `/payment_initiation/consent/get` endpoint can be used to check the status of a payment consent, as well as to receive basic information such as recipient and constraints. |
plaid.plaid_payment_initiation_consent_revoke | Write write | 0 | The `/payment_initiation/consent/revoke` endpoint can be used to revoke the payment consent. Once the consent is revoked, it is not possible to initiate payments using it. |
plaid.plaid_payment_initiation_consent_payment_execute | Read read | 0 | The `/payment_initiation/consent/payment/execute` endpoint can be used to execute payments using payment consent. |
plaid.plaid_sandbox_item_reset_login | Write write | 0 | `/sandbox/item/reset_login/` forces an Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [u... |
plaid.plaid_sandbox_item_application_seed | Write write | 0 | `/sandbox/item/application/seed` creates a test connected application on an existing Permissions Manager Item's login. The seeded application will appear in subsequent calls to ... |
plaid.plaid_sandbox_item_set_verification_status | Write write | 0 | The `/sandbox/item/set_verification_status` endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit ... |
plaid.plaid_sandbox_user_reset_login | Write write | 0 | `/sandbox/user/reset_login/` functions the same as `/sandbox/item/reset_login`, but will modify Items related to a User. This endpoint forces each Item into an `ITEM_LOGIN_REQUI... |
plaid.plaid_item_public_token_exchange | Write write | 0 | Exchange a Link `public_token` for an API `access_token`. Link hands off the `public_token` client-side via the `onSuccess` callback once a user has successfully created an Item... |
plaid.plaid_item_create_public_token | Write write | 0 | Note: As of July 2020, the `/item/public_token/create` endpoint is deprecated. Instead, use `/link/token/create` with an `access_token` to create a Link token for use with [upda... |
plaid.plaid_user_create | Write write | 0 | For Plaid products and flows that use the user object, `/user/create` provides you a single token to access all data associated with the user. You must call this endpoint before... |
plaid.plaid_user_get | Read read | 0 | Get user details using a `user_id`. This endpoint only supports users that were created on the new user API flow, without a `user_token`. For more details, see [New User APIs](h... |
plaid.plaid_user_identity_remove | Write write | 0 | This endpoint allows customers to explicitly purge identity/PII data provided to Plaid for a given user. This is not exposed to customers by default, as it is meant for special ... |
plaid.plaid_user_update | Write write | 0 | This endpoint updates user information for an existing `user_id` or `user_token`. If an existing `user_id` or `user_token` is missing fields required for a given use case (e.g. ... |
plaid.plaid_user_remove | Write write | 0 | `/user/remove` deletes a `user_id` or `user_token` and and associated information, including any Items associated with the user. |
plaid.plaid_user_products_terminate | Read read | 0 | `/user/products/terminate` terminates user-based recurring subscriptions for a given client user. This will remove user-based products (Financial Management, Protect, and CRA pr... |
plaid.plaid_user_items_get | Read read | 0 | Returns Items associated with a `user_id`, along with their corresponding statuses. Plaid associates an Item with a User when it has been successfully connected within a Link se... |
plaid.plaid_user_items_associate | Read read | 0 | Associates Items to the target user. If an Item is already associated to another user, the Item will be disassociated with the existing user and associated to the target user. T... |
plaid.plaid_user_items_remove | Write write | 0 | Removes specific Items associated with a user. It is equivalent to calling `/item/remove` on each Item individually, but supports use cases (such as Plaid Check) where access to... |
plaid.plaid_user_third_party_token_create | Write write | 0 | This endpoint is used to create a third-party user token. This token can be shared with and used by a specified third-party client to access data associated with the user throug... |
plaid.plaid_user_third_party_token_remove | Write write | 0 | This endpoint is used to delete a third-party user token. Once removed, the token can longer be used to access data associated with the user. Any subsequent calls to retrieve in... |
plaid.plaid_credit_sessions_get | Read read | 0 | This endpoint can be used for your end users after they complete the Link flow. This endpoint returns a list of Link sessions that your user completed, where each session includ... |
plaid.plaid_payment_initiation_payment_get | Read read | 0 | The `/payment_initiation/payment/get` endpoint can be used to check the status of a payment, as well as to receive basic information such as recipient and payment amount. In the... |
plaid.plaid_payment_initiation_payment_list | Read read | 0 | The `/payment_initiation/payment/list` endpoint can be used to retrieve all created payments. By default, the 10 most recent payments are returned. You can request more payments... |
plaid.plaid_investments_holdings_get | Read read | 0 | The `/investments/holdings/get` endpoint allows developers to receive user-authorized stock position data for `investment`-type accounts. |
plaid.plaid_investments_transactions_get | Read read | 0 | The `/investments/transactions/get` endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for investment accounts. Transactions are returned... |
plaid.plaid_investments_refresh | Write write | 0 | `/investments/refresh` is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest investment holdings and transaction... |
plaid.plaid_investments_auth_get | Read read | 0 | The `/investments/auth/get` endpoint allows developers to receive user-authorized data to facilitate the transfer of holdings |
plaid.plaid_processor_token_create | Write write | 0 | Used to create a token suitable for sending to one of Plaid's partners to enable integrations. Note that Stripe partnerships use bank account tokens instead; see `/processor/str... |
plaid.plaid_processor_token_permissions_set | Write write | 0 | Used to control a processor's access to products on the given processor token. By default, a processor will have access to all available products on the corresponding item. To r... |
plaid.plaid_processor_token_permissions_get | Read read | 0 | Used to get a processor token's product permissions. The `products` field will be an empty list if the processor can access all available products. |
plaid.plaid_processor_token_webhook_update | Write write | 0 | This endpoint allows you, the processor, to update the webhook URL associated with a processor token. This request triggers a `WEBHOOK_UPDATE_ACKNOWLEDGED` webhook to the newly ... |
plaid.plaid_processor_stripe_bank_account_token_create | Write write | 0 | Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see [Add Stripe to your app](https://plaid... |
plaid.plaid_processor_apex_processor_token_create | Write write | 0 | Used to create a token suitable for sending to Apex to enable Plaid-Apex integrations. |
plaid.plaid_item_import | Write write | 0 | `/item/import` creates an Item via your Plaid Exchange Integration and returns an `access_token`. As part of an `/item/import` request, you will include a User ID (`user_auth.us... |
plaid.plaid_link_token_create | Write write | 0 | The `/link/token/create` endpoint creates a `link_token`, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a `public_token`. F... |
plaid.plaid_link_token_get | Read read | 0 | The `/link/token/get` endpoint gets information about a Link session, including all callbacks fired during the session along with their metadata, including the public token. Thi... |
plaid.plaid_link_oauth_correlation_id_exchange | Write write | 0 | Exchange an OAuth `link_correlation_id` for the corresponding `link_token`. The `link_correlation_id` is only available for `payment_initiation` products and is provided to the ... |
plaid.plaid_session_token_create | Write write | 0 | `/session/token/create` is used to create a Link token for Layer. The returned Link token is used as an parameter when initializing the Link SDK. For more details, see the [Link... |
plaid.plaid_transfer_get | Read read | 0 | The `/transfer/get` endpoint fetches information about the transfer corresponding to the given `transfer_id` or `authorization_id`. One of `transfer_id` or `authorization_id` mu... |
plaid.plaid_transfer_recurring_get | Read read | 0 | The `/transfer/recurring/get` fetches information about the recurring transfer corresponding to the given `recurring_transfer_id`. |
plaid.plaid_bank_transfer_get | Read read | 0 | The `/bank_transfer/get` fetches information about the bank transfer corresponding to the given `bank_transfer_id`. |
plaid.plaid_transfer_authorization_create | Write write | 0 | Use the `/transfer/authorization/create` endpoint to authorize a transfer. This endpoint must be called prior to calling `/transfer/create`. The transfer authorization will expi... |
plaid.plaid_transfer_authorization_cancel | Write write | 0 | Use the `/transfer/authorization/cancel` endpoint to cancel a transfer authorization. A transfer authorization is eligible for cancellation if it has not yet been used to create... |
plaid.plaid_transfer_balance_get | Read read | 0 | (Deprecated) Use the `/transfer/balance/get` endpoint to view a balance held with Plaid. |
plaid.plaid_transfer_capabilities_get | Read read | 0 | Use the `/transfer/capabilities/get` endpoint to determine the RTP eligibility information of an account to be used with Transfer. This endpoint works on all Transfer-capable It... |
plaid.plaid_transfer_configuration_get | Read read | 0 | Use the `/transfer/configuration/get` endpoint to view your transfer product configurations. |
plaid.plaid_transfer_ledger_get | Read read | 0 | Use the `/transfer/ledger/get` endpoint to view a balance on the ledger held with Plaid. |
plaid.plaid_transfer_ledger_distribute | Write write | 0 | Use the `/transfer/ledger/distribute` endpoint to move available balance between ledgers, if you have multiple. If you’re a platform, you can move funds between one of your le... |
plaid.plaid_transfer_ledger_deposit | Write write | 0 | Use the `/transfer/ledger/deposit` endpoint to deposit funds into Plaid Ledger. |
plaid.plaid_transfer_ledger_withdraw | Write write | 0 | Use the `/transfer/ledger/withdraw` endpoint to withdraw funds from a Plaid Ledger balance. |
plaid.plaid_transfer_originator_funding_account_update | Write write | 0 | Use the `/transfer/originator/funding_account/update` endpoint to update the funding account associated with the originator. |
plaid.plaid_transfer_originator_funding_account_create | Write write | 0 | Use the `/transfer/originator/funding_account/create` endpoint to create a new funding account for the originator. |
plaid.plaid_transfer_metrics_get | Read read | 0 | Use the `/transfer/metrics/get` endpoint to view your transfer product usage metrics. In the Sandbox environment, this endpoint returns static placeholder values rather than met... |
plaid.plaid_transfer_create | Write write | 0 | Use the `/transfer/create` endpoint to initiate a new transfer. This endpoint is retryable and idempotent; if a transfer with the provided `transfer_id` has already been created... |
plaid.plaid_transfer_recurring_create | Write write | 0 | Use the `/transfer/recurring/create` endpoint to initiate a new recurring transfer. This capability is not currently supported for Transfer UI or Transfer for Platforms (beta) c... |
plaid.plaid_bank_transfer_create | Write write | 0 | Use the `/bank_transfer/create` endpoint to initiate a new bank transfer. |
plaid.plaid_transfer_list | Read read | 0 | Use the `/transfer/list` endpoint to see a list of all your transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retrieve the de... |
plaid.plaid_transfer_recurring_list | Read read | 0 | Use the `/transfer/recurring/list` endpoint to see a list of all your recurring transfers and their statuses. Results are paginated; use the `count` and `offset` query parameter... |
plaid.plaid_bank_transfer_list | Read read | 0 | Use the `/bank_transfer/list` endpoint to see a list of all your bank transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retri... |
plaid.plaid_transfer_cancel | Write write | 0 | Use the `/transfer/cancel` endpoint to cancel a transfer. A transfer is eligible for cancellation if the `cancellable` property returned by `/transfer/get` is `true`. |
plaid.plaid_transfer_recurring_cancel | Write write | 0 | Use the `/transfer/recurring/cancel` endpoint to cancel a recurring transfer. Scheduled transfer that hasn't been submitted to bank will be cancelled. |
plaid.plaid_bank_transfer_cancel | Write write | 0 | Use the `/bank_transfer/cancel` endpoint to cancel a bank transfer. A transfer is eligible for cancelation if the `cancellable` property returned by `/bank_transfer/get` is `true`. |
plaid.plaid_transfer_event_list | Read read | 0 | Use the `/transfer/event/list` endpoint to get a list of transfer events based on specified filter criteria. |
plaid.plaid_transfer_ledger_event_list | Read read | 0 | Use the `/transfer/ledger/event/list` endpoint to get a list of ledger events for a specific ledger based on specified filter criteria. |
plaid.plaid_bank_transfer_event_list | Read read | 0 | Use the `/bank_transfer/event/list` endpoint to get a list of Plaid-initiated ACH or bank transfer events based on specified filter criteria. When using Auth with micro-deposit ... |
plaid.plaid_transfer_event_sync | Write write | 0 | `/transfer/event/sync` allows you to request up to the next 500 transfer events that happened after a specific `event_id`. Use the `/transfer/event/sync` endpoint to guarantee y... |
plaid.plaid_bank_transfer_event_sync | Write write | 0 | `/bank_transfer/event/sync` allows you to request up to the next 25 Plaid-initiated bank transfer events that happened after a specific `event_id`. When using Auth with micro-de... |
plaid.plaid_transfer_sweep_get | Read read | 0 | The `/transfer/sweep/get` endpoint fetches a sweep corresponding to the given `sweep_id`. |
plaid.plaid_bank_transfer_sweep_get | Read read | 0 | The `/bank_transfer/sweep/get` endpoint fetches information about the sweep corresponding to the given `sweep_id`. |
plaid.plaid_transfer_sweep_list | Read read | 0 | The `/transfer/sweep/list` endpoint fetches sweeps matching the given filters. |
plaid.plaid_bank_transfer_sweep_list | Read read | 0 | The `/bank_transfer/sweep/list` endpoint fetches information about the sweeps matching the given filters. |
plaid.plaid_bank_transfer_balance_get | Read read | 0 | Use the `/bank_transfer/balance/get` endpoint to see the available balance in your bank transfer account. Debit transfers increase this balance once their status is posted. Cred... |
plaid.plaid_bank_transfer_migrate_account | Write write | 0 | As an alternative to adding Items via Link, you can also use the `/bank_transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. Note that... |
plaid.plaid_transfer_migrate_account | Write write | 0 | As an alternative to adding Items via Link, you can also use the `/transfer/migrate_account` endpoint to migrate previously-verified account and routing numbers to Plaid Items. ... |
plaid.plaid_transfer_intent_create | Write write | 0 | Use the `/transfer/intent/create` endpoint to generate a transfer intent object and invoke the Transfer UI. |
plaid.plaid_transfer_intent_get | Read read | 0 | Use the `/transfer/intent/get` endpoint to retrieve more information about a transfer intent. |
plaid.plaid_transfer_repayment_list | Read read | 0 | The `/transfer/repayment/list` endpoint fetches repayments matching the given filters. Repayments are returned in reverse-chronological order (most recent first) starting at the... |
plaid.plaid_transfer_repayment_return_list | Read read | 0 | The `/transfer/repayment/return/list` endpoint retrieves the set of returns that were batched together into the specified repayment. The sum of amounts of returns retrieved by t... |
plaid.plaid_transfer_platform_requirement_submit | Write write | 0 | Use the `/transfer/platform/requirement/submit` endpoint to submit additional onboarding information that is needed by Plaid to approve or decline the originator. See [Requireme... |
plaid.plaid_transfer_originator_create | Write write | 0 | Use the `/transfer/originator/create` endpoint to create a new originator and return an `originator_client_id`. |
plaid.plaid_transfer_questionnaire_create | Write write | 0 | The `/transfer/questionnaire/create` endpoint generates a Plaid-hosted onboarding UI URL. Redirect the originator to this URL to provide their due diligence information and agre... |
plaid.plaid_transfer_diligence_submit | Write write | 0 | Use the `/transfer/diligence/submit` endpoint to submit transfer diligence on behalf of the originator (i.e., the end customer). |
plaid.plaid_transfer_diligence_document_upload | Write write | 0 | Third-party sender customers can use `/transfer/diligence/document/upload` endpoint to upload a document on behalf of its end customer (i.e. originator) to Plaid. You’ll need ... |
plaid.plaid_transfer_originator_get | Read read | 0 | The `/transfer/originator/get` endpoint gets status updates for an originator's onboarding process. This information is also available via the Transfer page on the Plaid dashboard. |
plaid.plaid_transfer_originator_list | Read read | 0 | The `/transfer/originator/list` endpoint gets status updates for all of your originators' onboarding. This information is also available via the Plaid dashboard. |
plaid.plaid_transfer_refund_create | Write write | 0 | Use the `/transfer/refund/create` endpoint to create a refund for a transfer. A transfer can be refunded if the transfer was initiated in the past 180 days. Refunds come out of ... |
plaid.plaid_transfer_refund_get | Read read | 0 | The `/transfer/refund/get` endpoint fetches information about the refund corresponding to the given `refund_id`. |
plaid.plaid_transfer_refund_cancel | Write write | 0 | Use the `/transfer/refund/cancel` endpoint to cancel a refund. A refund is eligible for cancellation if it has not yet been submitted to the payment network. |
plaid.plaid_transfer_platform_originator_create | Write write | 0 | Use the `/transfer/platform/originator/create` endpoint to submit information about the originator you are onboarding, including the originator's agreement to the required legal... |
plaid.plaid_transfer_platform_person_create | Write write | 0 | Use the `/transfer/platform/person/create` endpoint to create a person associated with an originator (e.g. beneficial owner or control person) and optionally submit personal ide... |
plaid.plaid_sandbox_bank_transfer_simulate | Write write | 0 | Use the `/sandbox/bank_transfer/simulate` endpoint to simulate a bank transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when ... |
plaid.plaid_sandbox_transfer_sweep_simulate | Write write | 0 | Use the `/sandbox/transfer/sweep/simulate` endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all transfers with a sweep st... |
plaid.plaid_sandbox_transfer_simulate | Write write | 0 | Use the `/sandbox/transfer/simulate` endpoint to simulate a transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endp... |
plaid.plaid_sandbox_transfer_refund_simulate | Write write | 0 | Use the `/sandbox/transfer/refund/simulate` endpoint to simulate a refund event in the Sandbox environment. Note that while an event will be simulated and will appear when using... |
plaid.plaid_sandbox_transfer_ledger_simulate_available | Write write | 0 | Use the `/sandbox/transfer/ledger/simulate_available` endpoint to simulate converting pending balance to available balance for all originators in the Sandbox environment. |
plaid.plaid_sandbox_transfer_ledger_deposit_simulate | Write write | 0 | Use the `/sandbox/transfer/ledger/deposit/simulate` endpoint to simulate a ledger deposit event in the Sandbox environment. |
plaid.plaid_sandbox_transfer_ledger_withdraw_simulate | Write write | 0 | Use the `/sandbox/transfer/ledger/withdraw/simulate` endpoint to simulate a ledger withdraw event in the Sandbox environment. |
plaid.plaid_sandbox_transfer_repayment_simulate | Write write | 0 | Use the `/sandbox/transfer/repayment/simulate` endpoint to trigger the creation of a repayment. As a side effect of calling this route, a repayment is created that includes all ... |
plaid.plaid_sandbox_transfer_fire_webhook | Write write | 0 | Use the `/sandbox/transfer/fire_webhook` endpoint to manually trigger a `TRANSFER_EVENTS_UPDATE` webhook in the Sandbox environment. |
plaid.plaid_sandbox_transfer_test_clock_create | Write write | 0 | Use the `/sandbox/transfer/test_clock/create` endpoint to create a `test_clock` in the Sandbox environment. A test clock object represents an independent timeline and has a `vir... |
plaid.plaid_sandbox_transfer_test_clock_advance | Write write | 0 | Use the `/sandbox/transfer/test_clock/advance` endpoint to advance a `test_clock` in the Sandbox environment. A test clock object represents an independent timeline and has a `v... |
plaid.plaid_sandbox_transfer_test_clock_get | Read read | 0 | Use the `/sandbox/transfer/test_clock/get` endpoint to get a `test_clock` in the Sandbox environment. |
plaid.plaid_sandbox_transfer_test_clock_list | Read read | 0 | Use the `/sandbox/transfer/test_clock/list` endpoint to see a list of all your test clocks in the Sandbox environment, by ascending `virtual_time`. Results are paginated; use th... |
plaid.plaid_sandbox_payment_profile_reset_login | Write write | 0 | `/sandbox/payment_profile/reset_login/` forces a Payment Profile into a state where the login is no longer valid. This makes it easy to test update mode for Payment Profile in t... |
plaid.plaid_sandbox_payment_simulate | Write write | 0 | Use the `/sandbox/payment/simulate` endpoint to simulate various payment events in the Sandbox environment. This endpoint will trigger the corresponding payment status webhook. |
plaid.plaid_employers_search | Read read | 0 | `/employers/search` allows you the ability to search Plaid’s database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user's employer i... |
plaid.plaid_income_verification_create | Write write | 0 | `/income/verification/create` begins the income verification process by returning an `income_verification_id`. You can then provide the `income_verification_id` to `/link/token/... |
plaid.plaid_income_verification_paystubs_get | Read read | 0 | `/income/verification/paystubs/get` returns the information collected from the paystubs that were used to verify an end user's income. It can be called once the status of the ve... |
plaid.plaid_income_verification_documents_download | Read read | 0 | `/income/verification/documents/download` provides the ability to download the source documents associated with the verification. If Document Income was used, the documents will... |
plaid.plaid_income_verification_taxforms_get | Read read | 0 | `/income/verification/taxforms/get` returns the information collected from forms that were used to verify an end user''s income. It can be called once the status of the verifica... |
plaid.plaid_income_verification_precheck | Read read | 0 | `/income/verification/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is suppo... |
plaid.plaid_employment_verification_get | Read read | 0 | `/employment/verification/get` returns a list of employments through a user payroll that was verified by an end user. This endpoint has been deprecated; new integrations should ... |
plaid.plaid_credit_audit_copy_token_create | Write write | 0 | Plaid can create an Audit Copy token of an Asset Report and/or Income Report to share with a participating Government Sponsored Entity (GSE) if you participate in Fannie Mae's D... |
plaid.plaid_credit_report_audit_copy_remove | Write write | 0 | The `/credit/audit_copy_token/remove` endpoint allows you to remove an Audit Copy. Removing an Audit Copy invalidates the `audit_copy_token` associated with it, meaning both you... |
plaid.plaid_credit_asset_report_freddie_mac_get | Read read | 0 | The `credit/asset_report/freddie_mac/get` endpoint retrieves the Asset Report in Freddie Mac's JSON format. |
plaid.plaid_credit_freddie_mac_reports_get | Read read | 0 | The `credit/asset_report/freddie_mac/get` endpoint retrieves the Verification of Assets and Verification of Employment reports. |
plaid.plaid_credit_bank_employment_get | Read read | 0 | `/credit/bank_employment/get` returns the employment report(s) derived from bank transaction data for a specified user. |
plaid.plaid_credit_bank_income_get | Read read | 0 | `/credit/bank_income/get` returns the bank income report(s) for a specified user. A single report corresponds to all institutions linked in a single Link session. To include mul... |
plaid.plaid_credit_bank_income_pdf_get | Read read | 0 | `/credit/bank_income/pdf/get` returns the most recent bank income report for a specified user in PDF format. A single report corresponds to all institutions linked in a single L... |
plaid.plaid_credit_bank_income_refresh | Write write | 0 | `/credit/bank_income/refresh` is deprecated. The backend implementation was removed (returns an `Unimplemented` error at runtime), and the endpoint is no longer part of the docu... |
plaid.plaid_credit_bank_income_webhook_update | Write write | 0 | `/credit/bank_income/webhook/update` allows you to subscribe or unsubscribe a user for income webhook notifications. By default, all users start out unsubscribed. If a user is s... |
plaid.plaid_credit_payroll_income_parsing_config_update | Write write | 0 | `/credit/payroll_income/parsing_config/update` updates the parsing configuration for a document income verification. |
plaid.plaid_credit_bank_statements_uploads_get | Read read | 0 | `/credit/bank_statements/uploads/get` returns parsed data from bank statements uploaded by users as part of the Document Income flow. If your account is not enabled for Document... |
plaid.plaid_credit_payroll_income_get | Read read | 0 | This endpoint gets payroll income information for a specific user, either as a result of the user connecting to their payroll provider or uploading a pay related document. |
plaid.plaid_credit_payroll_income_risk_signals_get | Read read | 0 | `/credit/payroll_income/risk_signals/get` can be used as part of the Document Income flow to assess a user-uploaded document for signs of potential fraud or tampering. It return... |
plaid.plaid_credit_payroll_income_precheck | Read read | 0 | `/credit/payroll_income/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is sup... |
plaid.plaid_credit_employment_get | Read read | 0 | `/credit/employment/get` returns a list of items with employment information from a user's payroll provider that was verified by an end user. |
plaid.plaid_credit_payroll_income_refresh | Write write | 0 | `/credit/payroll_income/refresh` refreshes a given digital payroll income verification. |
plaid.plaid_credit_relay_create | Write write | 0 | Plaid can share an Asset Report directly with a participating third party on your behalf. The shared Asset Report is the exact same Asset Report originally created in `/asset_re... |
plaid.plaid_credit_relay_get | Read read | 0 | `/credit/relay/get` allows third parties to receive a report that was shared with them, using a `relay_token` that was created by the report owner. |
plaid.plaid_credit_relay_pdf_get | Read read | 0 | `/credit/relay/pdf/get` allows third parties to receive a pdf report that was shared with them, using a `relay_token` that was created by the report owner. The `/credit/relay/pd... |
plaid.plaid_credit_relay_refresh | Write write | 0 | The `/credit/relay/refresh` endpoint allows third parties to refresh a report that was relayed to them, using a `relay_token` that was created by the report owner. A new report ... |
plaid.plaid_credit_relay_remove | Write write | 0 | The `/credit/relay/remove` endpoint allows you to invalidate a `relay_token`. The third party holding the token will no longer be able to access or refresh the reports which the... |
plaid.plaid_sandbox_bank_transfer_fire_webhook | Write write | 0 | Use the `/sandbox/bank_transfer/fire_webhook` endpoint to manually trigger a Bank Transfers webhook in the Sandbox environment. |
plaid.plaid_sandbox_income_fire_webhook | Write write | 0 | Use the `/sandbox/income/fire_webhook` endpoint to manually trigger a Payroll or Document Income webhook in the Sandbox environment. |
plaid.plaid_sandbox_bank_income_fire_webhook | Write write | 0 | Use the `/sandbox/bank_income/fire_webhook` endpoint to manually trigger a Bank Income webhook in the Sandbox environment. |
plaid.plaid_sandbox_cra_cashflow_updates_update | Write write | 0 | Use the `/sandbox/cra/cashflow_updates/update` endpoint to manually trigger an update for Cash Flow Updates (Monitoring) in the Sandbox environment. |
plaid.plaid_sandbox_oauth_select_accounts | Write write | 0 | Save the selected accounts when connecting to the Platypus Oauth institution |
plaid.plaid_signal_evaluate | Read read | 0 | Use `/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment and additional risk signals. Before using `/signal/evaluate`, you must first [create... |
plaid.plaid_signal_schedule | Read read | 0 | Use `/signal/schedule` to schedule a planned ACH transaction. |
plaid.plaid_signal_decision_report | Write write | 0 | After you call `/signal/evaluate`, Plaid will normally infer the outcome from your Signal Rules. However, if you are not using Signal Rules, if the Signal Rules outcome was `REV... |
plaid.plaid_signal_return_report | Read read | 0 | Call the `/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/signal/evaluate` endpoint. Your feedback will be used by the model t... |
plaid.plaid_signal_prepare | Read read | 0 | When an Item is not initialized with `signal`, call `/signal/prepare` to opt-in that Item to the data collection process used to develop a Signal Transaction Score. This should ... |
plaid.plaid_wallet_create | Write write | 0 | Create an e-wallet. The response is the newly created e-wallet object. |
plaid.plaid_wallet_get | Read read | 0 | Fetch an e-wallet. The response includes the current balance. |
plaid.plaid_wallet_list | Read read | 0 | This endpoint lists all e-wallets in descending order of creation. |
plaid.plaid_wallet_transaction_execute | Read read | 0 | Execute a transaction using the specified e-wallet. Specify the e-wallet to debit from, the counterparty to credit to, the idempotency key to prevent duplicate transactions, the... |
plaid.plaid_wallet_transaction_get | Read read | 0 | Fetch a specific e-wallet transaction |
plaid.plaid_wallet_transaction_list | Read read | 0 | This endpoint lists the latest transactions of the specified e-wallet. Transactions are returned in descending order by the `created_at` time. |
plaid.plaid_transactions_enhance | Read read | 0 | The `/beta/transactions/v1/enhance` endpoint enriches raw transaction data provided directly by clients. The product is currently in beta. |
plaid.plaid_transactions_rules_create | Write write | 0 | The `/transactions/rules/v1/create` endpoint creates transaction categorization rules. Rules will be applied on the Item's transactions returned in `/transactions/get` response.... |
plaid.plaid_transactions_rules_list | Read read | 0 | The `/transactions/rules/v1/list` returns a list of transaction rules created for the Item associated with the access token. |
plaid.plaid_transactions_rules_remove | Write write | 0 | The `/transactions/rules/v1/remove` endpoint is used to remove a transaction rule. |
plaid.plaid_transactions_user_insights_get | Read read | 0 | The `/beta/transactions/user_insights/v1/get` gets user insights for clients who have enriched data with `/transactions/enrich`. The product is currently in beta. |
plaid.plaid_beta_ewa_report_v1_get | Read read | 0 | The `/beta/ewa_report/v1/get` endpoint provides an Earned Wage Access (EWA) score that quantifies the delinquency risk associated with a given item. The score is derived from a ... |
plaid.plaid_issues_search | Read read | 0 | Search for an issue associated with one of the following identifiers: `item_id`, `link_session_id` or Link session `request_id`. This endpoint returns a list of `Issue` objects,... |
plaid.plaid_issues_get | Read read | 0 | Retrieve detailed information about a specific `Issue`. This endpoint returns a single `Issue` object. |
plaid.plaid_issues_subscribe | Write write | 0 | Allows a user to subscribe to updates on a specific `Issue` using a POST method. Subscribers will receive webhook notifications when the issue status changes, particularly when ... |
plaid.plaid_payment_profile_create | Write write | 0 | Use `/payment_profile/create` endpoint to create a new payment profile. To initiate the account linking experience, call `/link/token/create` and provide the `payment_profile_to... |
plaid.plaid_payment_profile_get | Read read | 0 | Use `/payment_profile/get` endpoint to get the status of a given Payment Profile. |
plaid.plaid_payment_profile_remove | Write write | 0 | Use the `/payment_profile/remove` endpoint to remove a given Payment Profile. Once it’s removed, it can no longer be used to create transfers. |
plaid.plaid_partner_customer_create | Write write | 0 | The `/partner/customer/create` endpoint is used by reseller partners to create end customers. To create end customers, it should be called in the Production environment only, ev... |
plaid.plaid_partner_customer_get | Read read | 0 | The `/partner/customer/get` endpoint is used by reseller partners to retrieve data about a single end customer. |
plaid.plaid_partner_customer_enable | Write write | 0 | The `/partner/customer/enable` endpoint is used by reseller partners to enable an end customer in the full Production environment. |
plaid.plaid_partner_customer_remove | Write write | 0 | The `/partner/customer/remove` endpoint is used by reseller partners to remove an end customer. Removing an end customer will remove it from view in the Plaid Dashboard and deac... |
plaid.plaid_partner_customer_oauth_institutions_get | Read read | 0 | The `/partner/customer/oauth_institutions/get` endpoint is used by reseller partners to retrieve OAuth-institution registration information about a single end customer. To learn... |
plaid.plaid_beta_partner_customer_v1_create | Write write | 0 | The `/beta/partner/customer/v1/create` endpoint creates a new end customer record. You can provide as much information as you have available. If any required information is miss... |
plaid.plaid_beta_partner_customer_v1_get | Read read | 0 | The `/beta/partner/customer/v1/get` endpoint is used by reseller partners to retrieve data about a single end customer. |
plaid.plaid_beta_partner_customer_v1_update | Write write | 0 | The `/beta/partner/customer/v1/update` endpoint updates an existing end customer record. |
plaid.plaid_beta_partner_customer_v1_enable | Write write | 0 | The `/beta/partner/customer/v1/enable` endpoint is used by reseller partners to enable an end customer in the full Production environment. |
plaid.plaid_link_delivery_create | Write write | 0 | Use the `/link_delivery/create` endpoint to create a Hosted Link session. |
plaid.plaid_link_delivery_get | Read read | 0 | Use the `/link_delivery/get` endpoint to get the status of a Hosted Link session. |
plaid.plaid_fdx_notifications | Read read | 0 | A generic webhook receiver endpoint for FDX Event Notifications |
plaid.plaid_get_recipients | Read read | 0 | Returns a list of Recipients |
plaid.plaid_get_recipient | Read read | 0 | Get a specific recipient |
plaid.plaid_network_insights_report_get | Read read | 0 | This endpoint allows you to retrieve the Network Insights from a list of `access_tokens`. |