Plaid

Plaid Plaid API

The Plaid API from Plaid — 256 operation(s) for plaid.

GitHub OpenAPI

Operations 265

Showing the first 250 of 265. The full set is in the contract, and via get_provider_operations.

POST /accounts/get Plaid Retrieve accounts #
POST /accounts/balance/get Plaid Retrieve real-time balance data #
POST /item/application/list Plaid List a user’s connected applications #
POST /item/application/scopes/update Plaid Update the scopes of access for a particular application #
POST /application/get Retrieve information about a Plaid application #
POST /asset_report/create Plaid Create an Asset Report #
POST /asset_report/get Plaid Retrieve an Asset Report #
POST /asset_report/pdf/get Plaid Retrieve a PDF Asset Report #
POST /asset_report/refresh Plaid Refresh an Asset Report #
POST /asset_report/filter Plaid Filter Asset Report #
POST /asset_report/remove Plaid Delete an Asset Report #
POST /asset_report/audit_copy/create Plaid Create Asset Report Audit Copy #
POST /asset_report/audit_copy/get Plaid Retrieve an Asset Report Audit Copy #
POST /asset_report/audit_copy/remove Plaid Remove Asset Report Audit Copy #
POST /credit/asset_report/freddie_mac/get Plaid Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint. #
POST /auth/get Plaid Retrieve auth data #
POST /processor/auth/get Plaid Retrieve Auth data #
POST /investments/auth/get Plaid Get data needed to authorize an investments transfer #
POST /processor/bank_transfer/create Plaid Create a bank transfer as a processor #
POST /bank_transfer/get Plaid Retrieve a bank transfer #
POST /bank_transfer/create Plaid Create a bank transfer #
POST /bank_transfer/list Plaid List bank transfers #
POST /bank_transfer/cancel Plaid Cancel a bank transfer #
POST /bank_transfer/event/list Plaid List bank transfer events #
POST /bank_transfer/event/sync Plaid Sync bank transfer events #
POST /bank_transfer/sweep/get Plaid Retrieve a sweep #
POST /bank_transfer/sweep/list Plaid List sweeps #
POST /bank_transfer/balance/get Plaid Get balance of your Bank Transfer account #
POST /bank_transfer/migrate_account Plaid Migrate account into Bank Transfers #
POST /sandbox/bank_transfer/simulate Plaid Simulate a bank transfer event in Sandbox #
POST /sandbox/bank_transfer/fire_webhook Plaid Manually fire a Bank Transfer webhook #
POST /beacon/account_risk/v1/evaluate Plaid Evaluate risk of a bank account #
POST /beacon/user/create Plaid Create a Beacon User #
POST /beacon/user/get Plaid Get a Beacon User #
POST /beacon/user/review Plaid Review a Beacon User #
POST /beacon/report/create Plaid Create a Beacon Report #
POST /beacon/report/list Plaid List Beacon Reports for a Beacon User #
POST /beacon/report_syndication/list Plaid List Beacon Report Syndications for a Beacon User #
POST /beacon/report/get Plaid Get a Beacon Report #
POST /beacon/report_syndication/get Plaid Get a Beacon Report Syndication #
POST /beacon/user/update Plaid Update the identity data of a Beacon User #
POST /beacon/duplicate/get Plaid Get a Beacon Duplicate #
POST /beacon/user/history/list Plaid List a Beacon User's history #
POST /beta/credit/v1/bank_employment/get Plaid Retrieve information from the bank accounts used for employment verification #
POST /beta/transactions/v1/enhance Plaid enhance locally-held transaction data #
POST /beta/transactions/rules/v1/create Plaid Create transaction category rule #
POST /beta/transactions/rules/v1/list Plaid Return a list of rules created for the Item associated with the access token. #
POST /beta/transactions/rules/v1/remove Plaid Remove transaction rule #
POST /beta/transactions/user_insights/v1/get Plaid Obtain user insights based on transactions sent through /transactions/enrich #
POST /categories/get Plaid Get categories #
POST /cra/base_report/get Plaid Retrieve a Base Report #
POST /cra/base_report/create Plaid Create a Base Report #
POST /cra/bank_income/get Plaid Retrieve information from the bank accounts used for income verification #
POST /cra/bank_income/create Plaid Create a CRA report for income verification #
POST /cra/partner_insights/get Plaid Retrieve cash flow insights from the bank accounts used for income verification #
POST /cra/loans/applications/register Plaid Register loan applications and decisions. #
POST /cra/loans/register Plaid Register a list of loans to their applicants. #
POST /cra/loans/update Plaid Updates loan data. #
POST /cra/loans/unregister Plaid Unregister a list of loans. #
POST /credit/audit_copy_token/update Plaid Update an Audit Copy Token #
POST /credit/sessions/get Plaid Retrieve Link sessions for your user #
POST /credit/audit_copy_token/create Plaid Create Asset or Income Report Audit Copy Token #
POST /credit/audit_copy_token/remove Plaid Remove an Audit Copy token #
POST /credit/freddie_mac/reports/get Plaid Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available. Only Freddie Mac #
POST /credit/bank_income/get Plaid Retrieve information from the bank accounts used for income verification #
POST /credit/bank_income/pdf/get Plaid Retrieve information from the bank accounts used for income verification in PDF format #
POST /credit/bank_income/refresh Plaid Refresh a user's bank income information #
POST /credit/bank_income/webhook/update Plaid Subscribe and unsubscribe to proactive notifications for a user's income profile #
POST /credit/payroll_income/parsing_config/update Plaid Update the parsing configuration for a document income verification #
POST /credit/bank_statements/uploads/get Plaid Retrieve data for a user's uploaded bank statements #
POST /credit/payroll_income/get Plaid Retrieve a user's payroll information #
POST /credit/payroll_income/risk_signals/get Plaid Retrieve fraud insights for a user's manually uploaded document(s). #
POST /credit/payroll_income/precheck Plaid Check income verification eligibility and optimize conversion #
POST /credit/employment/get Plaid Retrieve a summary of an individual's employment information #
POST /credit/payroll_income/refresh Plaid Refresh a digital payroll income verification #
POST /credit/relay/create Plaid Create a relay token to share an Asset Report with a partner client #
POST /credit/relay/get Plaid Retrieve the reports associated with a relay token that was shared with you #
POST /credit/relay/pdf/get Plaid Retrieve the pdf reports associated with a relay token that was shared with you (beta) #
POST /credit/relay/refresh Plaid Refresh a report of a relay token #
POST /credit/relay/remove Plaid Remove relay token #
POST /dashboard_user/get Plaid Retrieve a dashboard user #
POST /dashboard_user/list Plaid List dashboard users #
POST /deposit_switch/create Plaid Create a deposit switch #
POST /deposit_switch/token/create Plaid Create a deposit switch token #
POST /deposit_switch/get Plaid Retrieve a deposit switch #
POST /deposit_switch/alt/create Create a deposit switch without using Plaid Exchange #
POST /employers/search Plaid Search employer database #
POST /fdx/notifications Plaid Webhook receiver for fdx notifications #
POST /identity/get Plaid Retrieve identity data #
POST /identity/documents/uploads/get Plaid Returns uploaded document identity #
POST /identity/match Plaid Retrieve identity match score #
POST /identity/refresh Plaid Refresh identity data #
POST /processor/identity/get Plaid Retrieve Identity data #
POST /processor/identity/match Plaid Retrieve identity match score #
POST /identity_verification/create Plaid Create a new Identity Verification #
POST /identity_verification/get Plaid Retrieve Identity Verification #
POST /identity_verification/list Plaid List Identity Verifications #
POST /identity_verification/retry Plaid Retry an Identity Verification #
POST /identity_verification/autofill/create Plaid Create autofill for an Identity Verification #
POST /income/verification/create Plaid (Deprecated) Create an income verification instance #
POST /income/verification/paystubs/get Plaid (Deprecated) Retrieve information from the paystubs used for income verification #
POST /income/verification/documents/download Plaid (Deprecated) Download the original documents used for income verification #
POST /income/verification/taxforms/get Plaid (Deprecated) Retrieve information from the tax documents used for income verification #
POST /income/verification/precheck Plaid (Deprecated) Check digital income verification eligibility and optimize conversion #
POST /sandbox/income/fire_webhook Plaid Manually fire an Income webhook #
POST /institutions/get Plaid Get details of all supported institutions #
POST /institutions/search Plaid Search institutions #
POST /institutions/get_by_id Plaid Get details of an institution #
POST /investments/holdings/get Plaid Get Investment holdings #
POST /investments/transactions/get Plaid Get investment transactions #
POST /investments/refresh Plaid Refresh investment data #
POST /item/activity/list Plaid List a historical log of user consent events #
POST /item/get Plaid Retrieve an Item #
POST /item/remove Plaid Remove an Item #
POST /sandbox/item/fire_webhook Plaid Fire a test webhook #
POST /item/webhook/update Plaid Update Webhook URL #
POST /item/access_token/invalidate Plaid Invalidate access_token #
POST /sandbox/item/reset_login Plaid Force a Sandbox Item into an error state #
POST /sandbox/item/set_verification_status Plaid Set verification status for Sandbox account #
POST /item/public_token/exchange Plaid Exchange public token for an access token #
POST /item/public_token/create Plaid Create public token #
POST /item/import Plaid Import Item #
POST /processor/liabilities/get Plaid Retrieve Liabilities data #
POST /liabilities/get Plaid Retrieve Liabilities data #
POST /link/profile/eligibility/check Plaid Check profile eligibility #
POST /link/token/create Plaid Create Link Token #
POST /link/token/get Plaid Get Link Token #
POST /link/oauth/correlation_id/exchange Plaid Exchange the Link Correlation Id for a Link Token #
POST /link_delivery/create Plaid Create Hosted Link session #
POST /link_delivery/get Plaid Get Hosted Link session #
POST /consumer_report/pdf/get Plaid Retrieve a PDF Reports #
POST /statements/list Plaid Retrieve a list of all statements associated with an item. #
POST /statements/download Plaid Retrieve a single statement. #
POST /statements/refresh Plaid Refresh statements data. #
POST /profile/get Plaid Retrieve a Profile #
POST /transactions/get Plaid Get transaction data #
POST /transactions/refresh Plaid Refresh transaction data #
POST /transactions/recurring/get Plaid Fetch recurring transaction streams #
POST /transactions/sync Plaid Get incremental transaction updates on an Item #
POST /transactions/enrich Plaid Enrich locally-held transaction data #
POST /sandbox/processor_token/create Plaid Create a test Item and processor token #
POST /sandbox/public_token/create Plaid Create a test Item #
POST /watchlist_screening/entity/create Plaid Create a watchlist screening for an entity #
POST /watchlist_screening/entity/get Plaid Get an entity screening #
POST /watchlist_screening/entity/history/list Plaid List history for entity watchlist screenings #
POST /watchlist_screening/entity/hit/list Plaid List hits for entity watchlist screenings #
POST /watchlist_screening/entity/list Plaid List entity watchlist screenings #
POST /watchlist_screening/entity/program/get Plaid Get entity watchlist screening program #
POST /watchlist_screening/entity/program/list Plaid List entity watchlist screening programs #
POST /watchlist_screening/entity/review/create Plaid Create a review for an entity watchlist screening #
POST /watchlist_screening/entity/review/list Plaid List reviews for entity watchlist screenings #
POST /watchlist_screening/entity/update Plaid Update an entity screening #
POST /watchlist_screening/individual/create Plaid Create a watchlist screening for a person #
POST /watchlist_screening/individual/get Plaid Retrieve an individual watchlist screening #
POST /watchlist_screening/individual/history/list Plaid List history for individual watchlist screenings #
POST /watchlist_screening/individual/hit/list Plaid List hits for individual watchlist screening #
POST /watchlist_screening/individual/list Plaid List Individual Watchlist Screenings #
POST /watchlist_screening/individual/program/get Plaid Get individual watchlist screening program #
POST /watchlist_screening/individual/program/list Plaid List individual watchlist screening programs #
POST /watchlist_screening/individual/review/create Plaid Create a review for an individual watchlist screening #
POST /watchlist_screening/individual/review/list Plaid List reviews for individual watchlist screenings #
POST /watchlist_screening/individual/update Plaid Update individual watchlist screening #
POST /processor/account/get Plaid Retrieve the account associated with a processor token #
POST /processor/transactions/get Plaid Get transaction data #
POST /processor/transactions/sync Plaid Get incremental transaction updates on a processor token #
POST /processor/transactions/refresh Plaid Refresh transaction data #
POST /processor/transactions/recurring/get Plaid Fetch recurring transaction streams #
POST /processor/signal/evaluate Plaid Evaluate a planned ACH transaction #
POST /processor/signal/decision/report Plaid Report whether you initiated an ACH transaction #
POST /processor/signal/return/report Plaid Report a return for an ACH transaction #
POST /processor/signal/prepare Plaid Opt-in a processor token to Signal #
POST /processor/balance/get Plaid Retrieve Balance data #
POST /webhook_verification_key/get Plaid Get webhook verification key #
POST /payment_initiation/recipient/create Plaid Create payment recipient #
POST /payment_initiation/payment/reverse Plaid Reverse an existing payment #
POST /payment_initiation/recipient/get Plaid Get payment recipient #
POST /payment_initiation/recipient/list Plaid List payment recipients #
POST /payment_initiation/payment/create Plaid Create a payment #
POST /payment_initiation/payment/token/create Plaid Create payment token #
POST /payment_initiation/consent/create Plaid Create payment consent #
POST /payment_initiation/consent/get Plaid Get payment consent #
POST /payment_initiation/consent/revoke Plaid Revoke payment consent #
POST /payment_initiation/consent/payment/execute Plaid Execute a single payment using consent #
POST /user/create Plaid Create user #
POST /user/update Plaid Update user information #
POST /payment_initiation/payment/get Plaid Get payment details #
POST /payment_initiation/payment/list Plaid List payments #
POST /processor/token/create Plaid Create processor token #
POST /processor/token/permissions/set Plaid Control a processor's access to products #
POST /processor/token/permissions/get Plaid Get a processor token's product permissions #
POST /processor/token/webhook/update Plaid Update a processor token's webhook URL #
POST /processor/stripe/bank_account_token/create Plaid Create Stripe bank account token #
POST /processor/apex/processor_token/create Plaid Create Apex bank account token #
POST /transfer/get Plaid Retrieve a transfer #
POST /transfer/recurring/get Plaid Retrieve a recurring transfer #
POST /transfer/authorization/create Plaid Create a transfer authorization #
POST /transfer/authorization/cancel Plaid Cancel a transfer authorization #
POST /transfer/balance/get (Deprecated) Retrieve a balance held with Plaid #
POST /transfer/capabilities/get Plaid Get RTP eligibility information of a transfer #
POST /transfer/configuration/get Plaid Get transfer product configuration #
POST /transfer/ledger/get Retrieve Plaid Ledger balance #
POST /transfer/ledger/distribute Plaid Move available balance between the ledgers of the platform and one of its originators #
POST /transfer/ledger/deposit Deposit funds into a Plaid Ledger balance #
POST /transfer/ledger/withdraw Withdraw funds from a Plaid Ledger balance #
POST /transfer/originator/funding_account/update Plaid Update the funding account associated with the originator #
POST /transfer/metrics/get Plaid Get transfer product usage metrics #
POST /transfer/create Plaid Create a transfer #
POST /transfer/recurring/create Plaid Create a recurring transfer #
POST /transfer/list Plaid List transfers #
POST /transfer/recurring/list Plaid List recurring transfers #
POST /transfer/cancel Plaid Cancel a transfer #
POST /transfer/recurring/cancel Plaid Cancel a recurring transfer. #
POST /transfer/event/list Plaid List transfer events #
POST /transfer/event/sync Plaid Sync transfer events #
POST /transfer/sweep/get Plaid Retrieve a sweep #
POST /transfer/sweep/list Plaid List sweeps #
POST /transfer/migrate_account Plaid Migrate account into Transfers #
POST /transfer/intent/create Plaid Create a transfer intent object to invoke the Transfer UI #
POST /transfer/intent/get Plaid Retrieve more information about a transfer intent #
POST /transfer/repayment/list Plaid Lists historical repayments #
POST /transfer/repayment/return/list Plaid List the returns included in a repayment #
POST /transfer/originator/create Plaid Create a new originator #
POST /transfer/questionnaire/create Generate a Plaid-hosted onboarding UI URL. #
POST /transfer/diligence/submit Plaid Submit transfer diligence on behalf of the originator #
POST /transfer/diligence/document/upload Plaid Upload transfer diligence document on behalf of the originator #
POST /transfer/originator/get Plaid Get status of an originator's onboarding #
POST /transfer/originator/list Plaid Get status of all originators' onboarding #
POST /transfer/refund/create Plaid Create a refund #
POST /transfer/refund/get Plaid Retrieve a refund #
POST /transfer/refund/cancel Plaid Cancel a refund #
POST /sandbox/transfer/sweep/simulate Plaid Simulate creating a sweep #
POST /sandbox/transfer/simulate Plaid Simulate a transfer event in Sandbox #
POST /sandbox/transfer/refund/simulate Plaid Simulate a refund event in Sandbox #
POST /sandbox/transfer/ledger/simulate_available Plaid Simulate converting pending balance to available balance #
POST /sandbox/transfer/ledger/deposit/simulate Plaid Simulate a ledger deposit event in Sandbox #
POST /sandbox/transfer/ledger/withdraw/simulate Plaid Simulate a ledger withdraw event in Sandbox #
POST /sandbox/transfer/repayment/simulate Plaid Trigger the creation of a repayment #
POST /sandbox/transfer/fire_webhook Plaid Manually fire a Transfer webhook #
POST /sandbox/transfer/test_clock/create Plaid Create a test clock #
POST /sandbox/transfer/test_clock/advance Plaid Advance a test clock #
POST /sandbox/transfer/test_clock/get Plaid Get a test clock #
POST /sandbox/transfer/test_clock/list Plaid List test clocks #
POST /sandbox/payment_profile/reset_login Plaid Reset the login of a Payment Profile #
POST /employment/verification/get Plaid (Deprecated) Retrieve a summary of an individual's employment information #
POST /sandbox/bank_income/fire_webhook Plaid Manually fire a bank income webhook in sandbox #
POST /sandbox/oauth/select_accounts Plaid Save the selected accounts when connecting to the Platypus Oauth institution #
POST /signal/evaluate Plaid Evaluate a planned ACH transaction #
POST /signal/decision/report Plaid Report whether you initiated an ACH transaction #
POST /signal/return/report Plaid Report a return for an ACH transaction #

Documentation

📖
Documentation
https://plaid.com/docs/auth/
📖
Documentation
https://plaid.com/docs/balance/
📖
Documentation
https://plaid.com/docs/identity/
📖
Documentation
https://plaid.com/docs/identity-verification/
📖
Documentation
https://plaid.com/docs/monitor/
📖
Documentation
https://plaid.com/docs/beacon/
📖
Documentation
https://plaid.com/docs/signal/
📖
Documentation
https://plaid.com/docs/transfer/
📖
Documentation
https://plaid.com/docs/transactions/
📖
Documentation
https://plaid.com/docs/investments/
📖
Documentation
https://plaid.com/docs/liabilities/
📖
Documentation
https://plaid.com/docs/assets/
📖
Documentation
https://plaid.com/docs/income/
📖
Documentation
https://plaid.com/docs/check/
📖
Documentation
https://plaid.com/docs/statements/
📖
Documentation
https://plaid.com/docs/payment-initiation/
📖
Documentation
https://plaid.com/docs/api/products/virtual-accounts/
📖
Documentation
https://plaid.com/docs/api/institutions/
📖
Documentation
https://plaid.com/docs/api/items/
📖
Documentation
https://plaid.com/docs/link/
📖
Documentation
https://plaid.com/docs/api/processor-partners/
📖
Documentation
https://plaid.com/docs/api/partner/
📖
Documentation
https://plaid.com/docs/sandbox/
📖
Documentation
https://plaid.com/docs/
📖
Documentation
https://plaid.com/docs/api/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/plaid/refs/heads/main/openapi/plaid-plaid-api-openapi.yml

Other Resources

🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/plaid/refs/heads/main/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/plaid-plaid-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

plaid-plaid-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Plaid API
  version: 2020-09-14_1.517.0
  contact:
    name: Plaid Developer Team
    url: https://plaid.com
  termsOfService: https://plaid.com/legal/
  description: 'Operations tagged Plaid across 68 of this provider''s published API definitions: plaid-accounts--openapi-original.yml, plaid-accounts--openapi.yml, plaid-application--openapi-original.yml, plaid-asset-report--openapi-original.yml, plaid-asset-report--openapi.yml, plaid-auth--openapi-original.yml, plaid-auth--openapi.yml, plaid-bank-transfer--openapi-original.yml, plaid-bank-transfer--openapi.yml, plaid-beacon--openapi-original.yml, plaid-beacon--openapi.yml, plaid-beta--openapi-original.yml, plaid-categories--openapi-original.yml, plaid-categories--openapi.yml, plaid-cra--openapi-original.yml, plaid-cra--openapi.yml, plaid-credit--openapi-original.yml, plaid-credit--openapi.yml, plaid-dashboard-user--openapi-original.yml, plaid-deposit-switch--openapi-original.yml, plaid-deposit-switch--openapi.yml, plaid-employers--openapi-original.yml, plaid-employers--openapi.yml, plaid-fdx--openapi-original.yml, plaid-fdx--openapi.yml, plaid-identity--openapi-original.yml, plaid-identity--openapi.yml, plaid-identity-verification--openapi-original.yml, plaid-identity-verification--openapi.yml, plaid-income--openapi-original.yml, plaid-income--openapi.yml, plaid-institutions--openapi-original.yml, plaid-institutions--openapi.yml, plaid-investments--openapi-original.yml, plaid-investments--openapi.yml, plaid-item--openapi-original.yml, plaid-item--openapi.yml, plaid-liabilities--openapi-original.yml, plaid-liabilities--openapi.yml, plaid-link--openapi-original.yml, plaid-link--openapi.yml, plaid-link-delivery--openapi-original.yml, plaid-link-delivery--openapi.yml, plaid-openapi-original.yml, plaid-partner--openapi-original.yml, plaid-partner--openapi.yml, plaid-payment-initiation--openapi-original.yml, plaid-payment-initiation--openapi.yml, plaid-payment-profile--openapi-original.yml, plaid-payment-profile--openapi.yml, plaid-processor--openapi-original.yml, plaid-processor--openapi.yml, plaid-profile--openapi-original.yml, plaid-sandbox--openapi-original.yml, plaid-sandbox--openapi.yml, plaid-signal--openapi-original.yml, plaid-signal--openapi.yml, plaid-statements--openapi-original.yml, plaid-statements--openapi.yml, plaid-transactions--openapi-original.yml, plaid-transactions--openapi.yml, plaid-transfer--openapi-original.yml, plaid-transfer--openapi.yml, plaid-user--openapi-original.yml, plaid-wallet--openapi-original.yml, plaid-wallet--openapi.yml, plaid-watchlist-screening--openapi-original.yml, plaid-watchlist-screening--openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- description: Production
  url: https://production.plaid.com
- description: Development
  url: https://development.plaid.com
- description: Sandbox
  url: https://sandbox.plaid.com
security:
- clientId: []
  secret: []
  plaidVersion: []
tags:
- name: Plaid
paths:
  /accounts/get:
    x-plaid-business-unit-context: BUSINESS_UNIT_PLAID
    post:
      tags:
      - Plaid
      summary: Plaid Retrieve accounts
      externalDocs:
        url: /api/accounts/#accountsget
      operationId: accountsGet
      description: '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 are not closed and are capable of carrying a balance.

        For items that went through the updated account selection pane, this endpoint only returns accounts that were permissioned by the user when they initially created the Item. If a user creates a new account after the initial link, you can capture this event through the [`NEW_ACCOUNTS_AVAILABLE`](https://plaid.com/docs/api/items/#new_accounts_available) webhook and then use Link''s [update mode](https://plaid.com/docs/link/update-mode/) to request that the user share this new account with you.


        `/accounts/get` is free to use and retrieves cached information, rather than extracting fresh information from the institution. The balance returned will reflect the balance at the time of the last successful Item update. If the Item is enabled for a regularly updating product, such as Transactions, Investments, or Liabilities, the balance will typically update about once a day, as long as the Item is healthy. If the Item is enabled only for products that do not frequently update, such as Auth or Identity, balance data may be much older.


        For realtime balance information, use the paid endpoint `/accounts/balance/get` instead.'
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountsGetResponse'
              examples:
                example-1:
                  value:
                    accounts:
                    - account_id: blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo
                      balances:
                        available: 100
                        current: 110
                        iso_currency_code: USD
                        limit: null
                        unofficial_currency_code: null
                      mask: '0000'
                      name: Plaid Checking
                      official_name: Plaid Gold Standard 0% Interest Checking
                      persistent_account_id: 8cfb8beb89b774ee43b090625f0d61d0814322b43bff984eaf60386e
                      subtype: checking
                      type: depository
                    - account_id: 6PdjjRP6LmugpBy5NgQvUqpRXMWxzktg3rwrk
                      balances:
                        available: null
                        current: 23631.9805
                        iso_currency_code: USD
                        limit: null
                        unofficial_currency_code: null
                      mask: '6666'
                      name: Plaid 401k
                      official_name: null
                      subtype: 401k
                      type: investment
                    - account_id: XMBvvyMGQ1UoLbKByoMqH3nXMj84ALSdE5B58
                      balances:
                        available: null
                        current: 65262
                        iso_currency_code: USD
                        limit: null
                        unofficial_currency_code: null
                      mask: '7777'
                      name: Plaid Student Loan
                      official_name: null
                      subtype: student
                      type: loan
                    item:
                      available_products:
                      - balance
                      - identity
                      - payment_initiation
                      - transactions
                      billed_products:
                      - assets
                      - auth
                      consent_expiration_time: null
                      error: null
                      institution_id: ins_117650
                      item_id: DWVAAPWq4RHGlEaNyGKRTAnPLaEmo8Cvq7na6
                      update_type: background
                      webhook: https://www.genericwebhookurl.com/webhook
                    request_id: bkVE1BHWMAZ9Rnr
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlaidError'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountsGetRequest'
            examples:
              example-1:
                value:
                  client_id: string
                  secret: string
                  access_token: string
                  options:
                    account_ids:
                    - string
    servers:
    - description: Production
      url: https://production.plaid.com
    - description: Development
      url: https://development.plaid.com
    - description: Sandbox
      url: https://sandbox.plaid.com
  /accounts/balance/get:
    x-plaid-business-unit-context: BUSINESS_UNIT_PLAID
    post:
      tags:
      - Plaid
      summary: Plaid Retrieve real-time balance data
      externalDocs:
        url: /api/products/balance/#accountsbalanceget
      operationId: accountsBalanceGet
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountsGetResponse'
              examples:
                example-1:
                  value:
                    accounts:
                    - account_id: BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp
                      balances:
                        available: 100
                        current: 110
                        iso_currency_code: USD
                        limit: null
                        unofficial_currency_code: null
                      mask: '0000'
                      name: Plaid Checking
                      official_name: Plaid Gold Standard 0% Interest Checking
                      persistent_account_id: 8cfb8beb89b774ee43b090625f0d61d0814322b43bff984eaf60386e
                      subtype: checking
                      type: depository
                    - account_id: dVzbVMLjrxTnLjX4G66XUp5GLklm4oiZy88yK
                      balances:
                        available: null
                        current: 410
                        iso_currency_code: USD
                        limit: 2000
                        unofficial_currency_code: null
                      mask: '3333'
                      name: Plaid Credit Card
                      official_name: Plaid Diamond 12.5% APR Interest Credit Card
                      subtype: credit card
                      type: credit
                    - account_id: Pp1Vpkl9w8sajvK6oEEKtr7vZxBnGpf7LxxLE
                      balances:
                        available: null
                        current: 65262
                        iso_currency_code: USD
                        limit: null
                        unofficial_currency_code: null
                      mask: '7777'
                      name: Plaid Student Loan
                      official_name: null
                      subtype: student
                      type: loan
                    item:
                      available_products:
                      - balance
                      - identity
                      - investments
                      billed_products:
                      - assets
                      - auth
                      - liabilities
                      - transactions
                      consent_expiration_time: null
                      error: null
                      institution_id: ins_3
                      item_id: eVBnVMp7zdTJLkRNr33Rs6zr7KNJqBFL9DrE6
                      update_type: background
                      webhook: https://www.genericwebhookurl.com/webhook
                    request_id: qk5Bxes3gDfv4F2
      description: 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, only `/accounts/balance/get` forces the available and current balance fields to be refreshed rather than cached. This endpoint can be used for existing Items that were added via any of Plaid’s other products. This endpoint can be used as long as Link has been initialized with any other product, `balance` itself is not a product that can be used to initialize Link. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountsBalanceGetRequest'
            examples:
              example-1:
                value:
                  access_token: string
                  secret: string
                  client_id: string
                  options:
                    account_ids:
                    - string
    servers:
    - description: Production
      url: https://production.plaid.com
    - description: Development
      url: https://development.plaid.com
    - description: Sandbox
      url: https://sandbox.plaid.com
  /item/application/list:
    x-plaid-business-unit-context: BUSINESS_UNIT_PLAID
    post:
      tags:
      - Plaid
      summary: Plaid List a user’s connected applications
      operationId: itemApplicationList
      description: List a user’s connected applications
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemApplicationListResponse'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlaidError'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ItemApplicationListRequest'
    servers:
    - description: Production
      url: https://production.plaid.com
    - description: Development
      url: https://development.plaid.com
    - description: Sandbox
      url: https://sandbox.plaid.com
  /item/application/unlink:
    x-plaid-business-unit-context: BUSINESS_UNIT_PLAID
    post:
      tags:
      - Plaid
      summary: Plaid Unlink a user’s connected application
      externalDocs:
        url: none
      operationId: itemApplicationUnlink
      description: '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 OAuth authentication process in order to restore functionality.


        This endpoint only removes ongoing data access permissions, therefore the User will need to reach out to the Application itself in order to disable and delete their account and delete any data that the Application already received (if the Application does not do so by default).


        This endpoint should be called in real time as the User is unlinking an Application, and should not be batched in order to ensure that the change is reflected as soon as possible.'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemApplicationUnlinkResponse'
              examples:
                example-1:
                  value:
                    request_id: m8MDnv9okwxFNBV
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlaidError'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ItemApplicationUnlinkRequest'
    servers:
    - description: Production
      url: https://production.plaid.com
    - description: Development
      url: https://development.plaid.com
    - description: Sandbox
      url: https://sandbox.plaid.com
  /item/application/scopes/update:
    x-plaid-business-unit-context: BUSINESS_UNIT_PLAID
    post:
      tags:
      - Plaid
      summary: Plaid Update the scopes of access for a particular application
      operationId: itemApplicationScopesUpdate
      description: Enable consumers to update product access on selected accounts for an application.
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemApplicationScopesUpdateResponse'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlaidError'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ItemApplicationScopesUpdateRequest'
    servers:
    - description: Production
      url: https://production.plaid.com
    - description: Development
      url: https://development.plaid.com
    - description: Sandbox
      url: https://sandbox.plaid.com
  /application/get:
    x-plaid-business-unit-context: BUSINESS_UNIT_PLAID
    post:
      tags:
      - Plaid
      summary: Retrieve information about a Plaid application
      operationId: applicationGet
      description: Allows financial institutions to retrieve information about Plaid clients for the purpose of building control-tower experiences
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationGetResponse'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlaidError'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationGetRequest'
        description: ''
    servers:
    - description: Production
      url: https://production.plaid.com
    - description: Development
      url: https://development.plaid.com
    - description: Sandbox
      url: https://sandbox.plaid.com
  /asset_report/create:
    x-plaid-business-unit-context: BUSINESS_UNIT_PLAID
    post:
      tags:
      - Plaid
      summary: Plaid Create an Asset Report
      externalDocs:
        url: /api/products/assets/#asset_reportcreate
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssetReportCreateResponse'
              examples:
                example-1:
                  value:
                    asset_report_token: assets-sandbox-6f12f5bb-22dd-4855-b918-f47ec439198a
                    asset_report_id: 1f414183-220c-44f5-b0c8-bc0e6d4053bb
                    request_id: Iam3b
      operationId: assetReportCreate
      description: '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 `/asset_report/get` or `/asset_report/pdf/get` endpoints.


        The Asset Report takes some time to be created and is not available immediately after calling `/asset_report/create`. The exact amount of time to create the report will vary depending on how many days of history are requested and will typically range from a few seconds to about one minute. When the Asset Report is ready to be retrieved using `/asset_report/get` or `/asset_report/pdf/get`, Plaid will fire a `PRODUCT_READY` webhook. For full details of the webhook schema, see [Asset Report webhooks](https://plaid.com/docs/api/products/assets/#webhooks).


        The `/asset_report/create` endpoint creates an Asset Report at a moment in time. Asset Reports are immutable. To get an updated Asset Report, use the `/asset_report/refresh` endpoint.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssetReportCreateRequest'
    servers:
    - description: Production
      url: https://production.plaid.com
    - description: Development
      url: https://development.plaid.com
    - description: Sandbox
      url: https://sandbox.plaid.com
  /asset_report/get:
    x-plaid-business-unit-context: BUSINESS_UNIT_PLAID
    post:
      tags:
      - Plaid
      summary: Plaid Retrieve an Asset Report
      externalDocs:
        url: /api/products/assets/#asset_reportget
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssetReportGetResponse'
              examples:
                example-1:
                  value:
                    report:
                      asset_report_id: 028e8404-a013-4a45-ac9e-002482f9cafc
                      client_report_id: client_report_id_1221
                      date_generated: '2023-03-30T18:27:37Z'
                      days_requested: 5
                      items:
                      - accounts:
                        - account_id: 1qKRXQjk8xUWDJojNwPXTj8gEmR48piqRNye8
                          balances:
                            available: 43200
                            current: 43200
                            limit: null
                            margin_loan_amount: null
                            iso_currency_code: USD
                            unofficial_currency_code: null
                          days_available: 5
                          historical_balances:
                          - current: 49050
                            date: '2023-03-29'
                            iso_currency_code: USD
                            unofficial_currency_code: null
                          - current: 49050
                            date: '2023-03-28'
                            iso_currency_code: USD
                            unofficial_currency_code: null
                          - current: 49050
                            date: '2023-03-27'
                            iso_currency_code: USD
                            unofficial_currency_code: null
                          - current: 49050
                            date: '2023-03-26'
                            iso_currency_code: USD
                            unofficial_currency_code: null
                          - current: 49050
                            date: '2023-03-25'
                            iso_currency_code: USD
                            unofficial_currency_code: null
                          mask: '4444'
                          name: Plaid Money Market
                          official_name: Plaid Platinum Standard 1.85% Interest Money Market
                          owners:
                          - addresses:
                            - data:
                                city: Malakoff
                                country: US
                                region: NY
                                street: 2992 Cameron Road
                                postal_code: '14236'
                              primary: true
                            - data:
                                city: San Matias
                                country: US
                                region: CA
                                street: 2493 Leisure Lane
                                postal_code: 93405-2255
                              primary: false
                            emails:
                            - data: accountholder0@example.com
                              primary: true
                              type: primary
                            - data: accountholder1@example.com
                              primary: false
                              type: secondary
                            - data: extraordinarily.long.email.username.123456@reallylonghostname.com
                              primary: false
                              type: other
                            names:
                            - Alberta Bobbeth Charleson
                            phone_numbers:
                            - data: '1112223333'
                              primary: false
                              type: home
                            - data: '1112224444'
                              primary: false
                              type: work
                            - data: '1112225555'
                              primary: false
                              type: mobile
                          ownership_type: null
                          subtype: money market
                          transactions:
                          - account_id: 1qKRXQjk8xUWDJojNwPXTj8gEmR48piqRNye8
                            amount: 5850
                            date: '2023-03-30'
                            iso_currency_code: USD
                            original_description: ACH Electronic CreditGUSTO PAY 123456
                            pending: false
                            transaction_id: gGQgjoeyqBF89PND6K14Sow1wddZBmtLomJ78
                            unofficial_currency_code: null
                          type: depository
                        - account_id: eG7pNLjknrFpWvP7Dkbdf3Pq6GVBPKTaQJK5v
                          balances:
                            available: 100
                            current: 110
                            limit: null
                            margin_loan_amount: null
                            iso_currency_code: USD
                            unofficial_currency_code: null
                          days_available: 5
                          historical_balances:
                          - current: 110
                            date: '2023-03-29'
                            iso_currency_code: USD
                            unofficial_currency_code: null
                          - current: -390
                            date: '2023-03-28'
                            iso_currency_code: USD
                            unofficial_currency_code: null
                          - current: -373.67
                            date: '2023-03-27'
                            iso_currency_code: USD
                            unofficial_currency_code: null
                          - current: -284.27
                            date: '2023-03-26'
                            iso_currency_code: USD
                            unofficial_currency_code: null
                          - current: -284.27
                            date: '2023-03-25'
                            iso_currency_code: USD
                            unofficial_currency_code: null
                          mask: '0000'
                          name: Plaid Checking
                          official_name: Plaid Gold Standard 0% Interest Checking
                          owners:
                          - addresses:
                            - data:
                                city: Malakoff
                                country: US
                                region: NY
                                street: 2992 Cameron Road
                                postal_code: '14236'
                              primary: true
                            - data:
                                city: San Matias
                                country: US
                                region: CA
                                street: 2493 Leisure Lane
                                postal_code: 93405-2255
                              primary: false
                            emails:
                            - data: accountholder0@example.com
                              primary: true
                              type: primary
                            - data: accountholder1@example.com
                              primary: false
                              type: secondary
                            - data: extraordinarily.long.email.username.123456@reallylonghostname.com
                              primary: false
                              type: other
                            names:
                            - Alberta Bobbeth Charleson
                            phone_numbers:
                            - data: '1112223333'
                              primary: false
                              type: home
                            - data: '1112224444'
                              primary: false
                              type: work
                            - data: '1112225555'
                              primary: false
                              type: mobile
                          ownership_type: null
                          subtype: checking
                          transactions:
                          - account_id: eG7pNLjknrFpWvP7Dkbdf3Pq6GVBPKTaQJK5v
                            amount: 89.4
                            date: '2023-03-27'
                            iso_currency_code: USD
                            original_description: SparkFun
                            pending: false
                            transaction_id: 4zBRq1Qem4uAPnoyKjJNTRQpQddM4ztlo1PLD
                            unofficial_currency_code: null
                          - account_id: eG7pNLjknrFpWvP7Dkbdf3Pq6GVBPKTaQJK5v
                            amount: 12
                            date: '2023-03-28'
                            iso_currency_code: USD
                            original_description: 'McDonalds #3322'
                            pending: false
                            transaction_id: dkjL41PnbKsPral79jpxhMWdW55gkPfBkWpRL
                            unofficial_currency_code: null
                          - account_id: eG7pNLjknrFpWvP7Dkbdf3Pq6GVBPKTaQJK5v
                            amount: 4.33
                            date: '2023-03-28'
                            iso_currency_code: USD
                            original_description: Starbucks
                            pending: false
                            transaction_id: a84ZxQaWDAtDL3dRgmazT57K7jjN3WFkNWMDy
                            unofficial_currency_code: null
                          - account_id: eG7pNLjknrFpWvP7Dkbdf3Pq6GVBPKTaQJK5v
                            amount: -500
                            date: '2023-03-29'
                            iso_currency_code: USD
                            original_description: United Airlines **** REFUND ****
                            pending: false
                            transaction_id: xG9jbv3eMoFWepzB7wQLT3LoLggX5Duy1Gbe5
                            unofficial_currency_code: null
                          type: depository
                        date_last_updated: '2023-03-30T18:25:26Z'
                        institution_id: ins_109508
                        institution_name: First Platypus Bank
                        item_id: AZMP7JrGXgtPd3AQMeg7hwMKgk5E8qU1V5ME7
                      user:
                        client_user_id: uid_40332
                        email: abcharleston@example.com
                        first_name: Anna
                        last_name: Charleston
                        middle_name: B
                        phone_number: 1-415-867-5309
                        ssn: 111-22-1234
                    request_id: GVzMdiDd8DDAQK4
                    warnings: []
      operationId: assetReportGet
      description: '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/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved.


        By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call `/asset_report/get` endpoint with `include_insights` set to `true`.


        For latency-sensitive applications, you can optionally call `/asset_report/create` with `options.add_ons` set to `["fast_assets"]`. This will cause Plaid to create two versions of the Asset Report: one with only current and available balance and identity information, and then later on the complete Asset Report. You will receive separate webhooks for each version of the Asset R

# --- truncated at 32 KB (1947 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/plaid/refs/heads/main/openapi/plaid-plaid-api-openapi.yml