naftiko: 1.0.0-alpha2 info: label: Plaid The Plaid API — Plaid description: 'Plaid The Plaid API — Plaid. 265 operations. Lead operation: Plaid Retrieve real-time balance data. Self-contained Naftiko capability covering one Plaid business surface.' tags: - Plaid created: '2026-05-19' modified: '2026-05-19' binds: - namespace: env keys: PLAID_API_KEY: PLAID_API_KEY capability: consumes: - type: http namespace: plaid-plaid baseUri: https://production.plaid.com description: Plaid The Plaid API — Plaid business capability. Self-contained, no shared references. resources: - name: accounts-balance-get path: /accounts/balance/get operations: - name: accountsbalanceget method: POST description: Plaid Retrieve real-time balance data outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: accounts-get path: /accounts/get operations: - name: accountsget method: POST description: Plaid Retrieve accounts outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: application-get path: /application/get operations: - name: applicationget method: POST description: Retrieve information about a Plaid application outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: asset_report-audit_copy-create path: /asset_report/audit_copy/create operations: - name: assetreportauditcopycreate method: POST description: Plaid Create Asset Report Audit Copy outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: asset_report-audit_copy-get path: /asset_report/audit_copy/get operations: - name: assetreportauditcopyget method: POST description: Plaid Retrieve an Asset Report Audit Copy outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: asset_report-audit_copy-remove path: /asset_report/audit_copy/remove operations: - name: assetreportauditcopyremove method: POST description: Plaid Remove Asset Report Audit Copy outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: asset_report-create path: /asset_report/create operations: - name: assetreportcreate method: POST description: Plaid Create an Asset Report outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: asset_report-filter path: /asset_report/filter operations: - name: assetreportfilter method: POST description: Plaid Filter Asset Report outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: asset_report-get path: /asset_report/get operations: - name: assetreportget method: POST description: Plaid Retrieve an Asset Report outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: asset_report-pdf-get path: /asset_report/pdf/get operations: - name: assetreportpdfget method: POST description: Plaid Retrieve a PDF Asset Report outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: asset_report-refresh path: /asset_report/refresh operations: - name: assetreportrefresh method: POST description: Plaid Refresh an Asset Report outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: asset_report-remove path: /asset_report/remove operations: - name: assetreportremove method: POST description: Plaid Delete an Asset Report outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: auth-get path: /auth/get operations: - name: authget method: POST description: Plaid Retrieve auth data outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: bank_transfer-balance-get path: /bank_transfer/balance/get operations: - name: banktransferbalanceget method: POST description: Plaid Get balance of your Bank Transfer account outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: bank_transfer-cancel path: /bank_transfer/cancel operations: - name: banktransfercancel method: POST description: Plaid Cancel a bank transfer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: bank_transfer-create path: /bank_transfer/create operations: - name: banktransfercreate method: POST description: Plaid Create a bank transfer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: bank_transfer-event-list path: /bank_transfer/event/list operations: - name: banktransfereventlist method: POST description: Plaid List bank transfer events outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: bank_transfer-event-sync path: /bank_transfer/event/sync operations: - name: banktransfereventsync method: POST description: Plaid Sync bank transfer events outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: bank_transfer-get path: /bank_transfer/get operations: - name: banktransferget method: POST description: Plaid Retrieve a bank transfer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: bank_transfer-list path: /bank_transfer/list operations: - name: banktransferlist method: POST description: Plaid List bank transfers outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: bank_transfer-migrate_account path: /bank_transfer/migrate_account operations: - name: banktransfermigrateaccount method: POST description: Plaid Migrate account into Bank Transfers outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: bank_transfer-sweep-get path: /bank_transfer/sweep/get operations: - name: banktransfersweepget method: POST description: Plaid Retrieve a sweep outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: bank_transfer-sweep-list path: /bank_transfer/sweep/list operations: - name: banktransfersweeplist method: POST description: Plaid List sweeps outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: beacon-account_risk-v1-evaluate path: /beacon/account_risk/v1/evaluate operations: - name: beaconaccountriskevaluate method: POST description: Plaid Evaluate risk of a bank account outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: beacon-duplicate-get path: /beacon/duplicate/get operations: - name: beaconduplicateget method: POST description: Plaid Get a Beacon Duplicate outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: beacon-report-create path: /beacon/report/create operations: - name: beaconreportcreate method: POST description: Plaid Create a Beacon Report outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: beacon-report-get path: /beacon/report/get operations: - name: beaconreportget method: POST description: Plaid Get a Beacon Report outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: beacon-report-list path: /beacon/report/list operations: - name: beaconreportlist method: POST description: Plaid List Beacon Reports for a Beacon User outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: beacon-report_syndication-get path: /beacon/report_syndication/get operations: - name: beaconreportsyndicationget method: POST description: Plaid Get a Beacon Report Syndication outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: beacon-report_syndication-list path: /beacon/report_syndication/list operations: - name: beaconreportsyndicationlist method: POST description: Plaid List Beacon Report Syndications for a Beacon User outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: beacon-user-create path: /beacon/user/create operations: - name: beaconusercreate method: POST description: Plaid Create a Beacon User outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: beacon-user-get path: /beacon/user/get operations: - name: beaconuserget method: POST description: Plaid Get a Beacon User outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: beacon-user-history-list path: /beacon/user/history/list operations: - name: beaconuserhistorylist method: POST description: Plaid List a Beacon User's history outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: beacon-user-review path: /beacon/user/review operations: - name: beaconuserreview method: POST description: Plaid Review a Beacon User outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: beacon-user-update path: /beacon/user/update operations: - name: beaconuserupdate method: POST description: Plaid Update the identity data of a Beacon User outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: beta-credit-v1-bank_employment-get path: /beta/credit/v1/bank_employment/get operations: - name: creditbankemploymentget method: POST description: Plaid Retrieve information from the bank accounts used for employment verification outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: beta-transactions-rules-v1-create path: /beta/transactions/rules/v1/create operations: - name: transactionsrulescreate method: POST description: Plaid Create transaction category rule outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: beta-transactions-rules-v1-list path: /beta/transactions/rules/v1/list operations: - name: transactionsruleslist method: POST description: Plaid Return a list of rules created for the Item associated with the access token. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: beta-transactions-rules-v1-remove path: /beta/transactions/rules/v1/remove operations: - name: transactionsrulesremove method: POST description: Plaid Remove transaction rule outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: beta-transactions-user_insights-v1-get path: /beta/transactions/user_insights/v1/get operations: - name: transactionsuserinsightsget method: POST description: Plaid Obtain user insights based on transactions sent through /transactions/enrich outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: beta-transactions-v1-enhance path: /beta/transactions/v1/enhance operations: - name: transactionsenhance method: POST description: Plaid enhance locally-held transaction data outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: categories-get path: /categories/get operations: - name: categoriesget method: POST description: Plaid Get categories outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: consumer_report-pdf-get path: /consumer_report/pdf/get operations: - name: consumerreportpdfget method: POST description: Plaid Retrieve a PDF Reports outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: cra-bank_income-create path: /cra/bank_income/create operations: - name: crabankincomecreate method: POST description: Plaid Create a CRA report for income verification outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: cra-bank_income-get path: /cra/bank_income/get operations: - name: crabankincomeget method: POST description: Plaid Retrieve information from the bank accounts used for income verification outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: cra-base_report-create path: /cra/base_report/create operations: - name: basereportcreate method: POST description: Plaid Create a Base Report outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: cra-base_report-get path: /cra/base_report/get operations: - name: basereportget method: POST description: Plaid Retrieve a Base Report outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: cra-loans-applications-register path: /cra/loans/applications/register operations: - name: craloansapplicationsregister method: POST description: Plaid Register loan applications and decisions. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: cra-loans-register path: /cra/loans/register operations: - name: craloansregister method: POST description: Plaid Register a list of loans to their applicants. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: cra-loans-unregister path: /cra/loans/unregister operations: - name: craloansunregister method: POST description: Plaid Unregister a list of loans. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: cra-loans-update path: /cra/loans/update operations: - name: craloansupdate method: POST description: Plaid Updates loan data. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: cra-partner_insights-get path: /cra/partner_insights/get operations: - name: crapartnerinsightsget method: POST description: Plaid Retrieve cash flow insights from the bank accounts used for income verification outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: credit-asset_report-freddie_mac-get path: /credit/asset_report/freddie_mac/get operations: - name: creditassetreportfreddiemacget method: POST description: Plaid Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: credit-audit_copy_token-create path: /credit/audit_copy_token/create operations: - name: creditauditcopytokencreate method: POST description: Plaid Create Asset or Income Report Audit Copy Token outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: credit-audit_copy_token-remove path: /credit/audit_copy_token/remove operations: - name: creditreportauditcopyremove method: POST description: Plaid Remove an Audit Copy token outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: credit-audit_copy_token-update path: /credit/audit_copy_token/update operations: - name: creditauditcopytokenupdate method: POST description: Plaid Update an Audit Copy Token outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: credit-bank_income-get path: /credit/bank_income/get operations: - name: creditbankincomeget method: POST description: Plaid Retrieve information from the bank accounts used for income verification outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: credit-bank_income-pdf-get path: /credit/bank_income/pdf/get operations: - name: creditbankincomepdfget method: POST description: Plaid Retrieve information from the bank accounts used for income verification in PDF format outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: credit-bank_income-refresh path: /credit/bank_income/refresh operations: - name: creditbankincomerefresh method: POST description: Plaid Refresh a user's bank income information outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: credit-bank_income-webhook-update path: /credit/bank_income/webhook/update operations: - name: creditbankincomewebhookupdate method: POST description: Plaid Subscribe and unsubscribe to proactive notifications for a user's income profile outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: credit-bank_statements-uploads-get path: /credit/bank_statements/uploads/get operations: - name: creditbankstatementsuploadsget method: POST description: Plaid Retrieve data for a user's uploaded bank statements outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: credit-employment-get path: /credit/employment/get operations: - name: creditemploymentget method: POST description: Plaid Retrieve a summary of an individual's employment information outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: credit-freddie_mac-reports-get path: /credit/freddie_mac/reports/get operations: - name: creditfreddiemacreportsget method: POST description: 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 can use this endpoint. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: credit-payroll_income-get path: /credit/payroll_income/get operations: - name: creditpayrollincomeget method: POST description: Plaid Retrieve a user's payroll information outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: credit-payroll_income-parsing_config-update path: /credit/payroll_income/parsing_config/update operations: - name: creditpayrollincomeparsingconfigupdate method: POST description: Plaid Update the parsing configuration for a document income verification outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: credit-payroll_income-precheck path: /credit/payroll_income/precheck operations: - name: creditpayrollincomeprecheck method: POST description: Plaid Check income verification eligibility and optimize conversion outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: credit-payroll_income-refresh path: /credit/payroll_income/refresh operations: - name: creditpayrollincomerefresh method: POST description: Plaid Refresh a digital payroll income verification outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: credit-payroll_income-risk_signals-get path: /credit/payroll_income/risk_signals/get operations: - name: creditpayrollincomerisksignalsget method: POST description: Plaid Retrieve fraud insights for a user's manually uploaded document(s). outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: credit-relay-create path: /credit/relay/create operations: - name: creditrelaycreate method: POST description: Plaid Create a relay token to share an Asset Report with a partner client outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: credit-relay-get path: /credit/relay/get operations: - name: creditrelayget method: POST description: Plaid Retrieve the reports associated with a relay token that was shared with you outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: credit-relay-pdf-get path: /credit/relay/pdf/get operations: - name: creditrelaypdfget method: POST description: Plaid Retrieve the pdf reports associated with a relay token that was shared with you (beta) outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: credit-relay-refresh path: /credit/relay/refresh operations: - name: creditrelayrefresh method: POST description: Plaid Refresh a report of a relay token outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: credit-relay-remove path: /credit/relay/remove operations: - name: creditrelayremove method: POST description: Plaid Remove relay token outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: credit-sessions-get path: /credit/sessions/get operations: - name: creditsessionsget method: POST description: Plaid Retrieve Link sessions for your user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: dashboard_user-get path: /dashboard_user/get operations: - name: dashboarduserget method: POST description: Plaid Retrieve a dashboard user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: dashboard_user-list path: /dashboard_user/list operations: - name: dashboarduserlist method: POST description: Plaid List dashboard users outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: deposit_switch-alt-create path: /deposit_switch/alt/create operations: - name: depositswitchaltcreate method: POST description: Create a deposit switch without using Plaid Exchange outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: deposit_switch-create path: /deposit_switch/create operations: - name: depositswitchcreate method: POST description: Plaid Create a deposit switch outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: deposit_switch-get path: /deposit_switch/get operations: - name: depositswitchget method: POST description: Plaid Retrieve a deposit switch outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: deposit_switch-token-create path: /deposit_switch/token/create operations: - name: depositswitchtokencreate method: POST description: Plaid Create a deposit switch token outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: employers-search path: /employers/search operations: - name: employerssearch method: POST description: Plaid Search employer database outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: employment-verification-get path: /employment/verification/get operations: - name: employmentverificationget method: POST description: Plaid (Deprecated) Retrieve a summary of an individual's employment information outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: fdx-notifications path: /fdx/notifications operations: - name: fdxnotifications method: POST description: Plaid Webhook receiver for fdx notifications outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: identity-documents-uploads-get path: /identity/documents/uploads/get operations: - name: identitydocumentsuploadsget method: POST description: Plaid Returns uploaded document identity outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: identity-get path: /identity/get operations: - name: identityget method: POST description: Plaid Retrieve identity data outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: identity-match path: /identity/match operations: - name: identitymatch method: POST description: Plaid Retrieve identity match score outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: identity-refresh path: /identity/refresh operations: - name: identityrefresh method: POST description: Plaid Refresh identity data outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: identity_verification-autofill-create path: /identity_verification/autofill/create operations: - name: identityverificationautofillcreate method: POST description: Plaid Create autofill for an Identity Verification outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: identity_verification-create path: /identity_verification/create operations: - name: identityverificationcreate method: POST description: Plaid Create a new Identity Verification outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: identity_verification-get path: /identity_verification/get operations: - name: identityverificationget method: POST description: Plaid Retrieve Identity Verification outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: identity_verification-list path: /identity_verification/list operations: - name: identityverificationlist method: POST description: Plaid List Identity Verifications outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: identity_verification-retry path: /identity_verification/retry operations: - name: identityverificationretry method: POST description: Plaid Retry an Identity Verification outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: income-verification-create path: /income/verification/create operations: - name: incomeverificationcreate method: POST description: Plaid (Deprecated) Create an income verification instance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: income-verification-documents-download path: /income/verification/documents/download operations: - name: incomeverificationdocumentsdownload method: POST description: Plaid (Deprecated) Download the original documents used for income verification outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: income-verification-paystubs-get path: /income/verification/paystubs/get operations: - name: incomeverificationpaystubsget method: POST description: Plaid (Deprecated) Retrieve information from the paystubs used for income verification outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: income-verification-precheck path: /income/verification/precheck operations: - name: incomeverificationprecheck method: POST description: Plaid (Deprecated) Check digital income verification eligibility and optimize conversion outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: income-verification-taxforms-get path: /income/verification/taxforms/get operations: - name: incomeverificationtaxformsget method: POST description: Plaid (Deprecated) Retrieve information from the tax documents used for income verification outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: institutions-get path: /institutions/get operations: - name: institutionsget method: POST description: Plaid Get details of all supported institutions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: institutions-get_by_id path: /institutions/get_by_id operations: - name: institutionsgetbyid method: POST description: Plaid Get details of an institution outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: institutions-search path: /institutions/search operations: - name: institutionssearch method: POST description: Plaid Search institutions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: investments-auth-get path: /investments/auth/get operations: - name: investmentsauthget method: POST description: Plaid Get data needed to authorize an investments transfer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: investments-holdings-get path: /investments/holdings/get operations: - name: investmentsholdingsget method: POST description: Plaid Get Investment holdings outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: investments-refresh path: /investments/refresh operations: - name: investmentsrefresh method: POST description: Plaid Refresh investment data outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: investments-transactions-get path: /investments/transactions/get operations: - name: investmentstransactionsget method: POST description: Plaid Get investment transactions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: item-access_token-invalidate path: /item/access_token/invalidate operations: - name: itemaccesstokeninvalidate method: POST description: Plaid Invalidate access_token outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: item-activity-list path: /item/activity/list operations: - name: itemactivitylist method: POST description: Plaid List a historical log of user consent events outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: item-application-list path: /item/application/list operations: - name: itemapplicationlist method: POST description: Plaid List a user’s connected applications outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: item-application-scopes-update path: /item/application/scopes/update operations: - name: itemapplicationscopesupdate method: POST description: Plaid Update the scopes of access for a particular application outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: item-application-unlink path: /item/application/unlink operations: - name: itemapplicationunlink method: POST description: Plaid Unlink a user’s connected application outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: item-get path: /item/get operations: - name: itemget method: POST description: Plaid Retrieve an Item outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: item-import path: /item/import operations: - name: itemimport method: POST description: Plaid Import Item outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: item-public_token-create path: /item/public_token/create operations: - name: itemcreatepublictoken method: POST description: Plaid Create public token outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: item-public_token-exchange path: /item/public_token/exchange operations: - name: itempublictokenexchange method: POST description: Plaid Exchange public token for an access token outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: item-remove path: /item/remove operations: - name: itemremove method: POST description: Plaid Remove an Item outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: item-webhook-update path: /item/webhook/update operations: - name: itemwebhookupdate method: POST description: Plaid Update Webhook URL outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: liabilities-get path: /liabilities/get operations: - name: liabilitiesget method: POST description: Plaid Retrieve Liabilities data outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: link-oauth-correlation_id-exchange path: /link/oauth/correlation_id/exchange operations: - name: linkoauthcorrelationidexchange method: POST description: Plaid Exchange the Link Correlation Id for a Link Token outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: link-profile-eligibility-check path: /link/profile/eligibility/check operations: - name: linkprofileeligibilitycheck method: POST description: Plaid Check profile eligibility outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: link-token-create path: /link/token/create operations: - name: linktokencreate method: POST description: Plaid Create Link Token outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: link-token-get path: /link/token/get operations: - name: linktokenget method: POST description: Plaid Get Link Token outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: link_delivery-create path: /link_delivery/create operations: - name: linkdeliverycreate method: POST description: Plaid Create Hosted Link session outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: link_delivery-get path: /link_delivery/get operations: - name: linkdeliveryget method: POST description: Plaid Get Hosted Link session outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: partner-customer-create path: /partner/customer/create operations: - name: partnercustomercreate method: POST description: Creates a new end customer for a Plaid reseller. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: partner-customer-enable path: /partner/customer/enable operations: - name: partnercustomerenable method: POST description: Enables a Plaid reseller's end customer in the Production environment. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: partner-customer-get path: /partner/customer/get operations: - name: partnercustomerget method: POST description: Returns a Plaid reseller's end customer. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: partner-customer-oauth_institutions-get path: /partner/customer/oauth_institutions/get operations: - name: partnercustomeroauthinstitutionsget method: POST description: Plaid Returns OAuth-institution registration information for a given end customer. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: partner-customer-remove path: /partner/customer/remove operations: - name: partnercustomerremove method: POST description: Removes a Plaid reseller's end customer. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: payment_initiation-consent-create path: /payment_initiation/consent/create operations: - name: paymentinitiationconsentcreate method: POST description: Plaid Create payment consent outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: payment_initiation-consent-get path: /payment_initiation/consent/get operations: - name: paymentinitiationconsentget method: POST description: Plaid Get payment consent outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: payment_initiation-consent-payment-execute path: /payment_initiation/consent/payment/execute operations: - name: paymentinitiationconsentpaymentexecute method: POST description: Plaid Execute a single payment using consent outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: payment_initiation-consent-revoke path: /payment_initiation/consent/revoke operations: - name: paymentinitiationconsentrevoke method: POST description: Plaid Revoke payment consent outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: payment_initiation-payment-create path: /payment_initiation/payment/create operations: - name: paymentinitiationpaymentcreate method: POST description: Plaid Create a payment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: payment_initiation-payment-get path: /payment_initiation/payment/get operations: - name: paymentinitiationpaymentget method: POST description: Plaid Get payment details outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: payment_initiation-payment-list path: /payment_initiation/payment/list operations: - name: paymentinitiationpaymentlist method: POST description: Plaid List payments outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: payment_initiation-payment-reverse path: /payment_initiation/payment/reverse operations: - name: paymentinitiationpaymentreverse method: POST description: Plaid Reverse an existing payment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: payment_initiation-payment-token-create path: /payment_initiation/payment/token/create operations: - name: createpaymenttoken method: POST description: Plaid Create payment token outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: payment_initiation-recipient-create path: /payment_initiation/recipient/create operations: - name: paymentinitiationrecipientcreate method: POST description: Plaid Create payment recipient outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: payment_initiation-recipient-get path: /payment_initiation/recipient/get operations: - name: paymentinitiationrecipientget method: POST description: Plaid Get payment recipient outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: payment_initiation-recipient-list path: /payment_initiation/recipient/list operations: - name: paymentinitiationrecipientlist method: POST description: Plaid List payment recipients outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: payment_profile-create path: /payment_profile/create operations: - name: paymentprofilecreate method: POST description: Plaid Create payment profile outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: payment_profile-get path: /payment_profile/get operations: - name: paymentprofileget method: POST description: Plaid Get payment profile outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: payment_profile-remove path: /payment_profile/remove operations: - name: paymentprofileremove method: POST description: Plaid Remove payment profile outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: processor-account-get path: /processor/account/get operations: - name: processoraccountget method: POST description: Plaid Retrieve the account associated with a processor token outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: processor-apex-processor_token-create path: /processor/apex/processor_token/create operations: - name: processorapexprocessortokencreate method: POST description: Plaid Create Apex bank account token outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: processor-auth-get path: /processor/auth/get operations: - name: processorauthget method: POST description: Plaid Retrieve Auth data outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: processor-balance-get path: /processor/balance/get operations: - name: processorbalanceget method: POST description: Plaid Retrieve Balance data outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: processor-bank_transfer-create path: /processor/bank_transfer/create operations: - name: processorbanktransfercreate method: POST description: Plaid Create a bank transfer as a processor outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: processor-identity-get path: /processor/identity/get operations: - name: processoridentityget method: POST description: Plaid Retrieve Identity data outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: processor-identity-match path: /processor/identity/match operations: - name: processoridentitymatch method: POST description: Plaid Retrieve identity match score outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: processor-liabilities-get path: /processor/liabilities/get operations: - name: processorliabilitiesget method: POST description: Plaid Retrieve Liabilities data outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: processor-signal-decision-report path: /processor/signal/decision/report operations: - name: processorsignaldecisionreport method: POST description: Plaid Report whether you initiated an ACH transaction outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: processor-signal-evaluate path: /processor/signal/evaluate operations: - name: processorsignalevaluate method: POST description: Plaid Evaluate a planned ACH transaction outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: processor-signal-prepare path: /processor/signal/prepare operations: - name: processorsignalprepare method: POST description: Plaid Opt-in a processor token to Signal outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: processor-signal-return-report path: /processor/signal/return/report operations: - name: processorsignalreturnreport method: POST description: Plaid Report a return for an ACH transaction outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: processor-stripe-bank_account_token-create path: /processor/stripe/bank_account_token/create operations: - name: processorstripebankaccounttokencreate method: POST description: Plaid Create Stripe bank account token outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: processor-token-create path: /processor/token/create operations: - name: processortokencreate method: POST description: Plaid Create processor token outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: processor-token-permissions-get path: /processor/token/permissions/get operations: - name: processortokenpermissionsget method: POST description: Plaid Get a processor token's product permissions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: processor-token-permissions-set path: /processor/token/permissions/set operations: - name: processortokenpermissionsset method: POST description: Plaid Control a processor's access to products outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: processor-token-webhook-update path: /processor/token/webhook/update operations: - name: processortokenwebhookupdate method: POST description: Plaid Update a processor token's webhook URL outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: processor-transactions-get path: /processor/transactions/get operations: - name: processortransactionsget method: POST description: Plaid Get transaction data outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: processor-transactions-recurring-get path: /processor/transactions/recurring/get operations: - name: processortransactionsrecurringget method: POST description: Plaid Fetch recurring transaction streams outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: processor-transactions-refresh path: /processor/transactions/refresh operations: - name: processortransactionsrefresh method: POST description: Plaid Refresh transaction data outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: processor-transactions-sync path: /processor/transactions/sync operations: - name: processortransactionssync method: POST description: Plaid Get incremental transaction updates on a processor token outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: profile-get path: /profile/get operations: - name: profileget method: POST description: Plaid Retrieve a Profile outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: sandbox-bank_income-fire_webhook path: /sandbox/bank_income/fire_webhook operations: - name: sandboxbankincomefirewebhook method: POST description: Plaid Manually fire a bank income webhook in sandbox outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: sandbox-bank_transfer-fire_webhook path: /sandbox/bank_transfer/fire_webhook operations: - name: sandboxbanktransferfirewebhook method: POST description: Plaid Manually fire a Bank Transfer webhook outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: sandbox-bank_transfer-simulate path: /sandbox/bank_transfer/simulate operations: - name: sandboxbanktransfersimulate method: POST description: Plaid Simulate a bank transfer event in Sandbox outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: sandbox-income-fire_webhook path: /sandbox/income/fire_webhook operations: - name: sandboxincomefirewebhook method: POST description: Plaid Manually fire an Income webhook outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: sandbox-item-fire_webhook path: /sandbox/item/fire_webhook operations: - name: sandboxitemfirewebhook method: POST description: Plaid Fire a test webhook outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: sandbox-item-reset_login path: /sandbox/item/reset_login operations: - name: sandboxitemresetlogin method: POST description: Plaid Force a Sandbox Item into an error state outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: sandbox-item-set_verification_status path: /sandbox/item/set_verification_status operations: - name: sandboxitemsetverificationstatus method: POST description: Plaid Set verification status for Sandbox account outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: sandbox-oauth-select_accounts path: /sandbox/oauth/select_accounts operations: - name: sandboxoauthselectaccounts method: POST description: Plaid Save the selected accounts when connecting to the Platypus Oauth institution outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: sandbox-payment_profile-reset_login path: /sandbox/payment_profile/reset_login operations: - name: sandboxpaymentprofileresetlogin method: POST description: Plaid Reset the login of a Payment Profile outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: sandbox-processor_token-create path: /sandbox/processor_token/create operations: - name: sandboxprocessortokencreate method: POST description: Plaid Create a test Item and processor token outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: sandbox-public_token-create path: /sandbox/public_token/create operations: - name: sandboxpublictokencreate method: POST description: Plaid Create a test Item outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: sandbox-transfer-fire_webhook path: /sandbox/transfer/fire_webhook operations: - name: sandboxtransferfirewebhook method: POST description: Plaid Manually fire a Transfer webhook outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: sandbox-transfer-ledger-deposit-simulate path: /sandbox/transfer/ledger/deposit/simulate operations: - name: sandboxtransferledgerdepositsimulate method: POST description: Plaid Simulate a ledger deposit event in Sandbox outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: sandbox-transfer-ledger-simulate_available path: /sandbox/transfer/ledger/simulate_available operations: - name: sandboxtransferledgersimulateavailable method: POST description: Plaid Simulate converting pending balance to available balance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: sandbox-transfer-ledger-withdraw-simulate path: /sandbox/transfer/ledger/withdraw/simulate operations: - name: sandboxtransferledgerwithdrawsimulate method: POST description: Plaid Simulate a ledger withdraw event in Sandbox outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: sandbox-transfer-refund-simulate path: /sandbox/transfer/refund/simulate operations: - name: sandboxtransferrefundsimulate method: POST description: Plaid Simulate a refund event in Sandbox outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: sandbox-transfer-repayment-simulate path: /sandbox/transfer/repayment/simulate operations: - name: sandboxtransferrepaymentsimulate method: POST description: Plaid Trigger the creation of a repayment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: sandbox-transfer-simulate path: /sandbox/transfer/simulate operations: - name: sandboxtransfersimulate method: POST description: Plaid Simulate a transfer event in Sandbox outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: sandbox-transfer-sweep-simulate path: /sandbox/transfer/sweep/simulate operations: - name: sandboxtransfersweepsimulate method: POST description: Plaid Simulate creating a sweep outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: sandbox-transfer-test_clock-advance path: /sandbox/transfer/test_clock/advance operations: - name: sandboxtransfertestclockadvance method: POST description: Plaid Advance a test clock outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: sandbox-transfer-test_clock-create path: /sandbox/transfer/test_clock/create operations: - name: sandboxtransfertestclockcreate method: POST description: Plaid Create a test clock outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: sandbox-transfer-test_clock-get path: /sandbox/transfer/test_clock/get operations: - name: sandboxtransfertestclockget method: POST description: Plaid Get a test clock outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: sandbox-transfer-test_clock-list path: /sandbox/transfer/test_clock/list operations: - name: sandboxtransfertestclocklist method: POST description: Plaid List test clocks outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: signal-decision-report path: /signal/decision/report operations: - name: signaldecisionreport method: POST description: Plaid Report whether you initiated an ACH transaction outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: signal-evaluate path: /signal/evaluate operations: - name: signalevaluate method: POST description: Plaid Evaluate a planned ACH transaction outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: signal-prepare path: /signal/prepare operations: - name: signalprepare method: POST description: Plaid Opt-in an Item to Signal outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: signal-return-report path: /signal/return/report operations: - name: signalreturnreport method: POST description: Plaid Report a return for an ACH transaction outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: statements-download path: /statements/download operations: - name: statementsdownload method: POST description: Plaid Retrieve a single statement. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: statements-list path: /statements/list operations: - name: statementslist method: POST description: Plaid Retrieve a list of all statements associated with an item. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: statements-refresh path: /statements/refresh operations: - name: statementsrefresh method: POST description: Plaid Refresh statements data. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transactions-enrich path: /transactions/enrich operations: - name: transactionsenrich method: POST description: Plaid Enrich locally-held transaction data outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transactions-get path: /transactions/get operations: - name: transactionsget method: POST description: Plaid Get transaction data outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transactions-recurring-get path: /transactions/recurring/get operations: - name: transactionsrecurringget method: POST description: Plaid Fetch recurring transaction streams outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transactions-refresh path: /transactions/refresh operations: - name: transactionsrefresh method: POST description: Plaid Refresh transaction data outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transactions-sync path: /transactions/sync operations: - name: transactionssync method: POST description: Plaid Get incremental transaction updates on an Item outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-authorization-cancel path: /transfer/authorization/cancel operations: - name: transferauthorizationcancel method: POST description: Plaid Cancel a transfer authorization outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-authorization-create path: /transfer/authorization/create operations: - name: transferauthorizationcreate method: POST description: Plaid Create a transfer authorization outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-balance-get path: /transfer/balance/get operations: - name: transferbalanceget method: POST description: (Deprecated) Retrieve a balance held with Plaid outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-cancel path: /transfer/cancel operations: - name: transfercancel method: POST description: Plaid Cancel a transfer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-capabilities-get path: /transfer/capabilities/get operations: - name: transfercapabilitiesget method: POST description: Plaid Get RTP eligibility information of a transfer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-configuration-get path: /transfer/configuration/get operations: - name: transferconfigurationget method: POST description: Plaid Get transfer product configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-create path: /transfer/create operations: - name: transfercreate method: POST description: Plaid Create a transfer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-diligence-document-upload path: /transfer/diligence/document/upload operations: - name: transferdiligencedocumentupload method: POST description: Plaid Upload transfer diligence document on behalf of the originator outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-diligence-submit path: /transfer/diligence/submit operations: - name: transferdiligencesubmit method: POST description: Plaid Submit transfer diligence on behalf of the originator outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-event-list path: /transfer/event/list operations: - name: transfereventlist method: POST description: Plaid List transfer events outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-event-sync path: /transfer/event/sync operations: - name: transfereventsync method: POST description: Plaid Sync transfer events outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-get path: /transfer/get operations: - name: transferget method: POST description: Plaid Retrieve a transfer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-intent-create path: /transfer/intent/create operations: - name: transferintentcreate method: POST description: Plaid Create a transfer intent object to invoke the Transfer UI outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-intent-get path: /transfer/intent/get operations: - name: transferintentget method: POST description: Plaid Retrieve more information about a transfer intent outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-ledger-deposit path: /transfer/ledger/deposit operations: - name: transferledgerdeposit method: POST description: Deposit funds into a Plaid Ledger balance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-ledger-distribute path: /transfer/ledger/distribute operations: - name: transferledgerdistribute method: POST description: Plaid Move available balance between the ledgers of the platform and one of its originators outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-ledger-get path: /transfer/ledger/get operations: - name: transferledgerget method: POST description: Retrieve Plaid Ledger balance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-ledger-withdraw path: /transfer/ledger/withdraw operations: - name: transferledgerwithdraw method: POST description: Withdraw funds from a Plaid Ledger balance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-list path: /transfer/list operations: - name: transferlist method: POST description: Plaid List transfers outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-metrics-get path: /transfer/metrics/get operations: - name: transfermetricsget method: POST description: Plaid Get transfer product usage metrics outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-migrate_account path: /transfer/migrate_account operations: - name: transfermigrateaccount method: POST description: Plaid Migrate account into Transfers outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-originator-create path: /transfer/originator/create operations: - name: transferoriginatorcreate method: POST description: Plaid Create a new originator outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-originator-funding_account-update path: /transfer/originator/funding_account/update operations: - name: transferoriginatorfundingaccountupdate method: POST description: Plaid Update the funding account associated with the originator outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-originator-get path: /transfer/originator/get operations: - name: transferoriginatorget method: POST description: Plaid Get status of an originator's onboarding outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-originator-list path: /transfer/originator/list operations: - name: transferoriginatorlist method: POST description: Plaid Get status of all originators' onboarding outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-questionnaire-create path: /transfer/questionnaire/create operations: - name: transferquestionnairecreate method: POST description: Generate a Plaid-hosted onboarding UI URL. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-recurring-cancel path: /transfer/recurring/cancel operations: - name: transferrecurringcancel method: POST description: Plaid Cancel a recurring transfer. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-recurring-create path: /transfer/recurring/create operations: - name: transferrecurringcreate method: POST description: Plaid Create a recurring transfer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-recurring-get path: /transfer/recurring/get operations: - name: transferrecurringget method: POST description: Plaid Retrieve a recurring transfer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-recurring-list path: /transfer/recurring/list operations: - name: transferrecurringlist method: POST description: Plaid List recurring transfers outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-refund-cancel path: /transfer/refund/cancel operations: - name: transferrefundcancel method: POST description: Plaid Cancel a refund outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-refund-create path: /transfer/refund/create operations: - name: transferrefundcreate method: POST description: Plaid Create a refund outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-refund-get path: /transfer/refund/get operations: - name: transferrefundget method: POST description: Plaid Retrieve a refund outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-repayment-list path: /transfer/repayment/list operations: - name: transferrepaymentlist method: POST description: Plaid Lists historical repayments outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-repayment-return-list path: /transfer/repayment/return/list operations: - name: transferrepaymentreturnlist method: POST description: Plaid List the returns included in a repayment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-sweep-get path: /transfer/sweep/get operations: - name: transfersweepget method: POST description: Plaid Retrieve a sweep outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: transfer-sweep-list path: /transfer/sweep/list operations: - name: transfersweeplist method: POST description: Plaid List sweeps outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: user-create path: /user/create operations: - name: usercreate method: POST description: Plaid Create user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: user-update path: /user/update operations: - name: userupdate method: POST description: Plaid Update user information outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: wallet-create path: /wallet/create operations: - name: walletcreate method: POST description: Plaid Create an e-wallet outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: wallet-get path: /wallet/get operations: - name: walletget method: POST description: Plaid Fetch an e-wallet outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: wallet-list path: /wallet/list operations: - name: walletlist method: POST description: Plaid Fetch a list of e-wallets outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: wallet-transaction-execute path: /wallet/transaction/execute operations: - name: wallettransactionexecute method: POST description: Plaid Execute a transaction using an e-wallet outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: wallet-transaction-get path: /wallet/transaction/get operations: - name: wallettransactionget method: POST description: Plaid Fetch an e-wallet transaction outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: wallet-transaction-list path: /wallet/transaction/list operations: - name: wallettransactionlist method: POST description: Plaid List e-wallet transactions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: watchlist_screening-entity-create path: /watchlist_screening/entity/create operations: - name: watchlistscreeningentitycreate method: POST description: Plaid Create a watchlist screening for an entity outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: watchlist_screening-entity-get path: /watchlist_screening/entity/get operations: - name: watchlistscreeningentityget method: POST description: Plaid Get an entity screening outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: watchlist_screening-entity-history-list path: /watchlist_screening/entity/history/list operations: - name: watchlistscreeningentityhistorylist method: POST description: Plaid List history for entity watchlist screenings outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: watchlist_screening-entity-hit-list path: /watchlist_screening/entity/hit/list operations: - name: watchlistscreeningentityhitlist method: POST description: Plaid List hits for entity watchlist screenings outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: watchlist_screening-entity-list path: /watchlist_screening/entity/list operations: - name: watchlistscreeningentitylist method: POST description: Plaid List entity watchlist screenings outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: watchlist_screening-entity-program-get path: /watchlist_screening/entity/program/get operations: - name: watchlistscreeningentityprogramget method: POST description: Plaid Get entity watchlist screening program outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: watchlist_screening-entity-program-list path: /watchlist_screening/entity/program/list operations: - name: watchlistscreeningentityprogramlist method: POST description: Plaid List entity watchlist screening programs outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: watchlist_screening-entity-review-create path: /watchlist_screening/entity/review/create operations: - name: watchlistscreeningentityreviewcreate method: POST description: Plaid Create a review for an entity watchlist screening outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: watchlist_screening-entity-review-list path: /watchlist_screening/entity/review/list operations: - name: watchlistscreeningentityreviewlist method: POST description: Plaid List reviews for entity watchlist screenings outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: watchlist_screening-entity-update path: /watchlist_screening/entity/update operations: - name: watchlistscreeningentityupdate method: POST description: Plaid Update an entity screening outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: watchlist_screening-individual-create path: /watchlist_screening/individual/create operations: - name: watchlistscreeningindividualcreate method: POST description: Plaid Create a watchlist screening for a person outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: watchlist_screening-individual-get path: /watchlist_screening/individual/get operations: - name: watchlistscreeningindividualget method: POST description: Plaid Retrieve an individual watchlist screening outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: watchlist_screening-individual-history-list path: /watchlist_screening/individual/history/list operations: - name: watchlistscreeningindividualhistorylist method: POST description: Plaid List history for individual watchlist screenings outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: watchlist_screening-individual-hit-list path: /watchlist_screening/individual/hit/list operations: - name: watchlistscreeningindividualhitlist method: POST description: Plaid List hits for individual watchlist screening outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: watchlist_screening-individual-list path: /watchlist_screening/individual/list operations: - name: watchlistscreeningindividuallist method: POST description: Plaid List Individual Watchlist Screenings outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: watchlist_screening-individual-program-get path: /watchlist_screening/individual/program/get operations: - name: watchlistscreeningindividualprogramget method: POST description: Plaid Get individual watchlist screening program outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: watchlist_screening-individual-program-list path: /watchlist_screening/individual/program/list operations: - name: watchlistscreeningindividualprogramlist method: POST description: Plaid List individual watchlist screening programs outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: watchlist_screening-individual-review-create path: /watchlist_screening/individual/review/create operations: - name: watchlistscreeningindividualreviewcreate method: POST description: Plaid Create a review for an individual watchlist screening outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: watchlist_screening-individual-review-list path: /watchlist_screening/individual/review/list operations: - name: watchlistscreeningindividualreviewlist method: POST description: Plaid List reviews for individual watchlist screenings outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: watchlist_screening-individual-update path: /watchlist_screening/individual/update operations: - name: watchlistscreeningindividualupdate method: POST description: Plaid Update individual watchlist screening outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: webhook_verification_key-get path: /webhook_verification_key/get operations: - name: webhookverificationkeyget method: POST description: Plaid Get webhook verification key outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true authentication: type: apikey key: PLAID-CLIENT-ID value: '{{env.PLAID_API_KEY}}' placement: header exposes: - type: rest namespace: plaid-plaid-rest port: 8080 description: REST adapter for Plaid The Plaid API — Plaid. One Spectral-compliant resource per consumed operation, prefixed with /v1. resources: - path: /v1/accounts/balance/get name: accounts-balance-get description: REST surface for accounts-balance-get. operations: - method: POST name: accountsbalanceget description: Plaid Retrieve real-time balance data call: plaid-plaid.accountsbalanceget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/accounts/get name: accounts-get description: REST surface for accounts-get. operations: - method: POST name: accountsget description: Plaid Retrieve accounts call: plaid-plaid.accountsget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/application/get name: application-get description: REST surface for application-get. operations: - method: POST name: applicationget description: Retrieve information about a Plaid application call: plaid-plaid.applicationget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/asset-report/audit-copy/create name: asset-report-audit-copy-create description: REST surface for asset_report-audit_copy-create. operations: - method: POST name: assetreportauditcopycreate description: Plaid Create Asset Report Audit Copy call: plaid-plaid.assetreportauditcopycreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/asset-report/audit-copy/get name: asset-report-audit-copy-get description: REST surface for asset_report-audit_copy-get. operations: - method: POST name: assetreportauditcopyget description: Plaid Retrieve an Asset Report Audit Copy call: plaid-plaid.assetreportauditcopyget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/asset-report/audit-copy/remove name: asset-report-audit-copy-remove description: REST surface for asset_report-audit_copy-remove. operations: - method: POST name: assetreportauditcopyremove description: Plaid Remove Asset Report Audit Copy call: plaid-plaid.assetreportauditcopyremove with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/asset-report/create name: asset-report-create description: REST surface for asset_report-create. operations: - method: POST name: assetreportcreate description: Plaid Create an Asset Report call: plaid-plaid.assetreportcreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/asset-report/filter name: asset-report-filter description: REST surface for asset_report-filter. operations: - method: POST name: assetreportfilter description: Plaid Filter Asset Report call: plaid-plaid.assetreportfilter with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/asset-report/get name: asset-report-get description: REST surface for asset_report-get. operations: - method: POST name: assetreportget description: Plaid Retrieve an Asset Report call: plaid-plaid.assetreportget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/asset-report/pdf/get name: asset-report-pdf-get description: REST surface for asset_report-pdf-get. operations: - method: POST name: assetreportpdfget description: Plaid Retrieve a PDF Asset Report call: plaid-plaid.assetreportpdfget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/asset-report/refresh name: asset-report-refresh description: REST surface for asset_report-refresh. operations: - method: POST name: assetreportrefresh description: Plaid Refresh an Asset Report call: plaid-plaid.assetreportrefresh with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/asset-report/remove name: asset-report-remove description: REST surface for asset_report-remove. operations: - method: POST name: assetreportremove description: Plaid Delete an Asset Report call: plaid-plaid.assetreportremove with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/auth/get name: auth-get description: REST surface for auth-get. operations: - method: POST name: authget description: Plaid Retrieve auth data call: plaid-plaid.authget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/bank-transfer/balance/get name: bank-transfer-balance-get description: REST surface for bank_transfer-balance-get. operations: - method: POST name: banktransferbalanceget description: Plaid Get balance of your Bank Transfer account call: plaid-plaid.banktransferbalanceget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/bank-transfer/cancel name: bank-transfer-cancel description: REST surface for bank_transfer-cancel. operations: - method: POST name: banktransfercancel description: Plaid Cancel a bank transfer call: plaid-plaid.banktransfercancel with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/bank-transfer/create name: bank-transfer-create description: REST surface for bank_transfer-create. operations: - method: POST name: banktransfercreate description: Plaid Create a bank transfer call: plaid-plaid.banktransfercreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/bank-transfer/event/list name: bank-transfer-event-list description: REST surface for bank_transfer-event-list. operations: - method: POST name: banktransfereventlist description: Plaid List bank transfer events call: plaid-plaid.banktransfereventlist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/bank-transfer/event/sync name: bank-transfer-event-sync description: REST surface for bank_transfer-event-sync. operations: - method: POST name: banktransfereventsync description: Plaid Sync bank transfer events call: plaid-plaid.banktransfereventsync with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/bank-transfer/get name: bank-transfer-get description: REST surface for bank_transfer-get. operations: - method: POST name: banktransferget description: Plaid Retrieve a bank transfer call: plaid-plaid.banktransferget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/bank-transfer/list name: bank-transfer-list description: REST surface for bank_transfer-list. operations: - method: POST name: banktransferlist description: Plaid List bank transfers call: plaid-plaid.banktransferlist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/bank-transfer/migrate-account name: bank-transfer-migrate-account description: REST surface for bank_transfer-migrate_account. operations: - method: POST name: banktransfermigrateaccount description: Plaid Migrate account into Bank Transfers call: plaid-plaid.banktransfermigrateaccount with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/bank-transfer/sweep/get name: bank-transfer-sweep-get description: REST surface for bank_transfer-sweep-get. operations: - method: POST name: banktransfersweepget description: Plaid Retrieve a sweep call: plaid-plaid.banktransfersweepget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/bank-transfer/sweep/list name: bank-transfer-sweep-list description: REST surface for bank_transfer-sweep-list. operations: - method: POST name: banktransfersweeplist description: Plaid List sweeps call: plaid-plaid.banktransfersweeplist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/beacon/account-risk/v1/evaluate name: beacon-account-risk-v1-evaluate description: REST surface for beacon-account_risk-v1-evaluate. operations: - method: POST name: beaconaccountriskevaluate description: Plaid Evaluate risk of a bank account call: plaid-plaid.beaconaccountriskevaluate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/beacon/duplicate/get name: beacon-duplicate-get description: REST surface for beacon-duplicate-get. operations: - method: POST name: beaconduplicateget description: Plaid Get a Beacon Duplicate call: plaid-plaid.beaconduplicateget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/beacon/report/create name: beacon-report-create description: REST surface for beacon-report-create. operations: - method: POST name: beaconreportcreate description: Plaid Create a Beacon Report call: plaid-plaid.beaconreportcreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/beacon/report/get name: beacon-report-get description: REST surface for beacon-report-get. operations: - method: POST name: beaconreportget description: Plaid Get a Beacon Report call: plaid-plaid.beaconreportget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/beacon/report/list name: beacon-report-list description: REST surface for beacon-report-list. operations: - method: POST name: beaconreportlist description: Plaid List Beacon Reports for a Beacon User call: plaid-plaid.beaconreportlist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/beacon/report-syndication/get name: beacon-report-syndication-get description: REST surface for beacon-report_syndication-get. operations: - method: POST name: beaconreportsyndicationget description: Plaid Get a Beacon Report Syndication call: plaid-plaid.beaconreportsyndicationget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/beacon/report-syndication/list name: beacon-report-syndication-list description: REST surface for beacon-report_syndication-list. operations: - method: POST name: beaconreportsyndicationlist description: Plaid List Beacon Report Syndications for a Beacon User call: plaid-plaid.beaconreportsyndicationlist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/beacon/user/create name: beacon-user-create description: REST surface for beacon-user-create. operations: - method: POST name: beaconusercreate description: Plaid Create a Beacon User call: plaid-plaid.beaconusercreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/beacon/user/get name: beacon-user-get description: REST surface for beacon-user-get. operations: - method: POST name: beaconuserget description: Plaid Get a Beacon User call: plaid-plaid.beaconuserget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/beacon/user/history/list name: beacon-user-history-list description: REST surface for beacon-user-history-list. operations: - method: POST name: beaconuserhistorylist description: Plaid List a Beacon User's history call: plaid-plaid.beaconuserhistorylist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/beacon/user/review name: beacon-user-review description: REST surface for beacon-user-review. operations: - method: POST name: beaconuserreview description: Plaid Review a Beacon User call: plaid-plaid.beaconuserreview with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/beacon/user/update name: beacon-user-update description: REST surface for beacon-user-update. operations: - method: POST name: beaconuserupdate description: Plaid Update the identity data of a Beacon User call: plaid-plaid.beaconuserupdate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/beta/credit/v1/bank-employment/get name: beta-credit-v1-bank-employment-get description: REST surface for beta-credit-v1-bank_employment-get. operations: - method: POST name: creditbankemploymentget description: Plaid Retrieve information from the bank accounts used for employment verification call: plaid-plaid.creditbankemploymentget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/beta/transactions/rules/v1/create name: beta-transactions-rules-v1-create description: REST surface for beta-transactions-rules-v1-create. operations: - method: POST name: transactionsrulescreate description: Plaid Create transaction category rule call: plaid-plaid.transactionsrulescreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/beta/transactions/rules/v1/list name: beta-transactions-rules-v1-list description: REST surface for beta-transactions-rules-v1-list. operations: - method: POST name: transactionsruleslist description: Plaid Return a list of rules created for the Item associated with the access token. call: plaid-plaid.transactionsruleslist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/beta/transactions/rules/v1/remove name: beta-transactions-rules-v1-remove description: REST surface for beta-transactions-rules-v1-remove. operations: - method: POST name: transactionsrulesremove description: Plaid Remove transaction rule call: plaid-plaid.transactionsrulesremove with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/beta/transactions/user-insights/v1/get name: beta-transactions-user-insights-v1-get description: REST surface for beta-transactions-user_insights-v1-get. operations: - method: POST name: transactionsuserinsightsget description: Plaid Obtain user insights based on transactions sent through /transactions/enrich call: plaid-plaid.transactionsuserinsightsget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/beta/transactions/v1/enhance name: beta-transactions-v1-enhance description: REST surface for beta-transactions-v1-enhance. operations: - method: POST name: transactionsenhance description: Plaid enhance locally-held transaction data call: plaid-plaid.transactionsenhance with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/categories/get name: categories-get description: REST surface for categories-get. operations: - method: POST name: categoriesget description: Plaid Get categories call: plaid-plaid.categoriesget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/consumer-report/pdf/get name: consumer-report-pdf-get description: REST surface for consumer_report-pdf-get. operations: - method: POST name: consumerreportpdfget description: Plaid Retrieve a PDF Reports call: plaid-plaid.consumerreportpdfget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cra/bank-income/create name: cra-bank-income-create description: REST surface for cra-bank_income-create. operations: - method: POST name: crabankincomecreate description: Plaid Create a CRA report for income verification call: plaid-plaid.crabankincomecreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cra/bank-income/get name: cra-bank-income-get description: REST surface for cra-bank_income-get. operations: - method: POST name: crabankincomeget description: Plaid Retrieve information from the bank accounts used for income verification call: plaid-plaid.crabankincomeget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cra/base-report/create name: cra-base-report-create description: REST surface for cra-base_report-create. operations: - method: POST name: basereportcreate description: Plaid Create a Base Report call: plaid-plaid.basereportcreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cra/base-report/get name: cra-base-report-get description: REST surface for cra-base_report-get. operations: - method: POST name: basereportget description: Plaid Retrieve a Base Report call: plaid-plaid.basereportget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cra/loans/applications/register name: cra-loans-applications-register description: REST surface for cra-loans-applications-register. operations: - method: POST name: craloansapplicationsregister description: Plaid Register loan applications and decisions. call: plaid-plaid.craloansapplicationsregister with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cra/loans/register name: cra-loans-register description: REST surface for cra-loans-register. operations: - method: POST name: craloansregister description: Plaid Register a list of loans to their applicants. call: plaid-plaid.craloansregister with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cra/loans/unregister name: cra-loans-unregister description: REST surface for cra-loans-unregister. operations: - method: POST name: craloansunregister description: Plaid Unregister a list of loans. call: plaid-plaid.craloansunregister with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cra/loans/update name: cra-loans-update description: REST surface for cra-loans-update. operations: - method: POST name: craloansupdate description: Plaid Updates loan data. call: plaid-plaid.craloansupdate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cra/partner-insights/get name: cra-partner-insights-get description: REST surface for cra-partner_insights-get. operations: - method: POST name: crapartnerinsightsget description: Plaid Retrieve cash flow insights from the bank accounts used for income verification call: plaid-plaid.crapartnerinsightsget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/credit/asset-report/freddie-mac/get name: credit-asset-report-freddie-mac-get description: REST surface for credit-asset_report-freddie_mac-get. operations: - method: POST name: creditassetreportfreddiemacget description: Plaid Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint. call: plaid-plaid.creditassetreportfreddiemacget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/credit/audit-copy-token/create name: credit-audit-copy-token-create description: REST surface for credit-audit_copy_token-create. operations: - method: POST name: creditauditcopytokencreate description: Plaid Create Asset or Income Report Audit Copy Token call: plaid-plaid.creditauditcopytokencreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/credit/audit-copy-token/remove name: credit-audit-copy-token-remove description: REST surface for credit-audit_copy_token-remove. operations: - method: POST name: creditreportauditcopyremove description: Plaid Remove an Audit Copy token call: plaid-plaid.creditreportauditcopyremove with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/credit/audit-copy-token/update name: credit-audit-copy-token-update description: REST surface for credit-audit_copy_token-update. operations: - method: POST name: creditauditcopytokenupdate description: Plaid Update an Audit Copy Token call: plaid-plaid.creditauditcopytokenupdate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/credit/bank-income/get name: credit-bank-income-get description: REST surface for credit-bank_income-get. operations: - method: POST name: creditbankincomeget description: Plaid Retrieve information from the bank accounts used for income verification call: plaid-plaid.creditbankincomeget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/credit/bank-income/pdf/get name: credit-bank-income-pdf-get description: REST surface for credit-bank_income-pdf-get. operations: - method: POST name: creditbankincomepdfget description: Plaid Retrieve information from the bank accounts used for income verification in PDF format call: plaid-plaid.creditbankincomepdfget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/credit/bank-income/refresh name: credit-bank-income-refresh description: REST surface for credit-bank_income-refresh. operations: - method: POST name: creditbankincomerefresh description: Plaid Refresh a user's bank income information call: plaid-plaid.creditbankincomerefresh with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/credit/bank-income/webhook/update name: credit-bank-income-webhook-update description: REST surface for credit-bank_income-webhook-update. operations: - method: POST name: creditbankincomewebhookupdate description: Plaid Subscribe and unsubscribe to proactive notifications for a user's income profile call: plaid-plaid.creditbankincomewebhookupdate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/credit/bank-statements/uploads/get name: credit-bank-statements-uploads-get description: REST surface for credit-bank_statements-uploads-get. operations: - method: POST name: creditbankstatementsuploadsget description: Plaid Retrieve data for a user's uploaded bank statements call: plaid-plaid.creditbankstatementsuploadsget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/credit/employment/get name: credit-employment-get description: REST surface for credit-employment-get. operations: - method: POST name: creditemploymentget description: Plaid Retrieve a summary of an individual's employment information call: plaid-plaid.creditemploymentget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/credit/freddie-mac/reports/get name: credit-freddie-mac-reports-get description: REST surface for credit-freddie_mac-reports-get. operations: - method: POST name: creditfreddiemacreportsget description: 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 can use this endpoint. call: plaid-plaid.creditfreddiemacreportsget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/credit/payroll-income/get name: credit-payroll-income-get description: REST surface for credit-payroll_income-get. operations: - method: POST name: creditpayrollincomeget description: Plaid Retrieve a user's payroll information call: plaid-plaid.creditpayrollincomeget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/credit/payroll-income/parsing-config/update name: credit-payroll-income-parsing-config-update description: REST surface for credit-payroll_income-parsing_config-update. operations: - method: POST name: creditpayrollincomeparsingconfigupdate description: Plaid Update the parsing configuration for a document income verification call: plaid-plaid.creditpayrollincomeparsingconfigupdate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/credit/payroll-income/precheck name: credit-payroll-income-precheck description: REST surface for credit-payroll_income-precheck. operations: - method: POST name: creditpayrollincomeprecheck description: Plaid Check income verification eligibility and optimize conversion call: plaid-plaid.creditpayrollincomeprecheck with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/credit/payroll-income/refresh name: credit-payroll-income-refresh description: REST surface for credit-payroll_income-refresh. operations: - method: POST name: creditpayrollincomerefresh description: Plaid Refresh a digital payroll income verification call: plaid-plaid.creditpayrollincomerefresh with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/credit/payroll-income/risk-signals/get name: credit-payroll-income-risk-signals-get description: REST surface for credit-payroll_income-risk_signals-get. operations: - method: POST name: creditpayrollincomerisksignalsget description: Plaid Retrieve fraud insights for a user's manually uploaded document(s). call: plaid-plaid.creditpayrollincomerisksignalsget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/credit/relay/create name: credit-relay-create description: REST surface for credit-relay-create. operations: - method: POST name: creditrelaycreate description: Plaid Create a relay token to share an Asset Report with a partner client call: plaid-plaid.creditrelaycreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/credit/relay/get name: credit-relay-get description: REST surface for credit-relay-get. operations: - method: POST name: creditrelayget description: Plaid Retrieve the reports associated with a relay token that was shared with you call: plaid-plaid.creditrelayget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/credit/relay/pdf/get name: credit-relay-pdf-get description: REST surface for credit-relay-pdf-get. operations: - method: POST name: creditrelaypdfget description: Plaid Retrieve the pdf reports associated with a relay token that was shared with you (beta) call: plaid-plaid.creditrelaypdfget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/credit/relay/refresh name: credit-relay-refresh description: REST surface for credit-relay-refresh. operations: - method: POST name: creditrelayrefresh description: Plaid Refresh a report of a relay token call: plaid-plaid.creditrelayrefresh with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/credit/relay/remove name: credit-relay-remove description: REST surface for credit-relay-remove. operations: - method: POST name: creditrelayremove description: Plaid Remove relay token call: plaid-plaid.creditrelayremove with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/credit/sessions/get name: credit-sessions-get description: REST surface for credit-sessions-get. operations: - method: POST name: creditsessionsget description: Plaid Retrieve Link sessions for your user call: plaid-plaid.creditsessionsget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/dashboard-user/get name: dashboard-user-get description: REST surface for dashboard_user-get. operations: - method: POST name: dashboarduserget description: Plaid Retrieve a dashboard user call: plaid-plaid.dashboarduserget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/dashboard-user/list name: dashboard-user-list description: REST surface for dashboard_user-list. operations: - method: POST name: dashboarduserlist description: Plaid List dashboard users call: plaid-plaid.dashboarduserlist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/deposit-switch/alt/create name: deposit-switch-alt-create description: REST surface for deposit_switch-alt-create. operations: - method: POST name: depositswitchaltcreate description: Create a deposit switch without using Plaid Exchange call: plaid-plaid.depositswitchaltcreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/deposit-switch/create name: deposit-switch-create description: REST surface for deposit_switch-create. operations: - method: POST name: depositswitchcreate description: Plaid Create a deposit switch call: plaid-plaid.depositswitchcreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/deposit-switch/get name: deposit-switch-get description: REST surface for deposit_switch-get. operations: - method: POST name: depositswitchget description: Plaid Retrieve a deposit switch call: plaid-plaid.depositswitchget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/deposit-switch/token/create name: deposit-switch-token-create description: REST surface for deposit_switch-token-create. operations: - method: POST name: depositswitchtokencreate description: Plaid Create a deposit switch token call: plaid-plaid.depositswitchtokencreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/employers/search name: employers-search description: REST surface for employers-search. operations: - method: POST name: employerssearch description: Plaid Search employer database call: plaid-plaid.employerssearch with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/employment/verification/get name: employment-verification-get description: REST surface for employment-verification-get. operations: - method: POST name: employmentverificationget description: Plaid (Deprecated) Retrieve a summary of an individual's employment information call: plaid-plaid.employmentverificationget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/fdx/notifications name: fdx-notifications description: REST surface for fdx-notifications. operations: - method: POST name: fdxnotifications description: Plaid Webhook receiver for fdx notifications call: plaid-plaid.fdxnotifications with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/identity/documents/uploads/get name: identity-documents-uploads-get description: REST surface for identity-documents-uploads-get. operations: - method: POST name: identitydocumentsuploadsget description: Plaid Returns uploaded document identity call: plaid-plaid.identitydocumentsuploadsget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/identity/get name: identity-get description: REST surface for identity-get. operations: - method: POST name: identityget description: Plaid Retrieve identity data call: plaid-plaid.identityget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/identity/match name: identity-match description: REST surface for identity-match. operations: - method: POST name: identitymatch description: Plaid Retrieve identity match score call: plaid-plaid.identitymatch with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/identity/refresh name: identity-refresh description: REST surface for identity-refresh. operations: - method: POST name: identityrefresh description: Plaid Refresh identity data call: plaid-plaid.identityrefresh with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/identity-verification/autofill/create name: identity-verification-autofill-create description: REST surface for identity_verification-autofill-create. operations: - method: POST name: identityverificationautofillcreate description: Plaid Create autofill for an Identity Verification call: plaid-plaid.identityverificationautofillcreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/identity-verification/create name: identity-verification-create description: REST surface for identity_verification-create. operations: - method: POST name: identityverificationcreate description: Plaid Create a new Identity Verification call: plaid-plaid.identityverificationcreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/identity-verification/get name: identity-verification-get description: REST surface for identity_verification-get. operations: - method: POST name: identityverificationget description: Plaid Retrieve Identity Verification call: plaid-plaid.identityverificationget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/identity-verification/list name: identity-verification-list description: REST surface for identity_verification-list. operations: - method: POST name: identityverificationlist description: Plaid List Identity Verifications call: plaid-plaid.identityverificationlist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/identity-verification/retry name: identity-verification-retry description: REST surface for identity_verification-retry. operations: - method: POST name: identityverificationretry description: Plaid Retry an Identity Verification call: plaid-plaid.identityverificationretry with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/income/verification/create name: income-verification-create description: REST surface for income-verification-create. operations: - method: POST name: incomeverificationcreate description: Plaid (Deprecated) Create an income verification instance call: plaid-plaid.incomeverificationcreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/income/verification/documents/download name: income-verification-documents-download description: REST surface for income-verification-documents-download. operations: - method: POST name: incomeverificationdocumentsdownload description: Plaid (Deprecated) Download the original documents used for income verification call: plaid-plaid.incomeverificationdocumentsdownload with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/income/verification/paystubs/get name: income-verification-paystubs-get description: REST surface for income-verification-paystubs-get. operations: - method: POST name: incomeverificationpaystubsget description: Plaid (Deprecated) Retrieve information from the paystubs used for income verification call: plaid-plaid.incomeverificationpaystubsget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/income/verification/precheck name: income-verification-precheck description: REST surface for income-verification-precheck. operations: - method: POST name: incomeverificationprecheck description: Plaid (Deprecated) Check digital income verification eligibility and optimize conversion call: plaid-plaid.incomeverificationprecheck with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/income/verification/taxforms/get name: income-verification-taxforms-get description: REST surface for income-verification-taxforms-get. operations: - method: POST name: incomeverificationtaxformsget description: Plaid (Deprecated) Retrieve information from the tax documents used for income verification call: plaid-plaid.incomeverificationtaxformsget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/institutions/get name: institutions-get description: REST surface for institutions-get. operations: - method: POST name: institutionsget description: Plaid Get details of all supported institutions call: plaid-plaid.institutionsget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/institutions/get-by-id name: institutions-get-by-id description: REST surface for institutions-get_by_id. operations: - method: POST name: institutionsgetbyid description: Plaid Get details of an institution call: plaid-plaid.institutionsgetbyid with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/institutions/search name: institutions-search description: REST surface for institutions-search. operations: - method: POST name: institutionssearch description: Plaid Search institutions call: plaid-plaid.institutionssearch with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/investments/auth/get name: investments-auth-get description: REST surface for investments-auth-get. operations: - method: POST name: investmentsauthget description: Plaid Get data needed to authorize an investments transfer call: plaid-plaid.investmentsauthget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/investments/holdings/get name: investments-holdings-get description: REST surface for investments-holdings-get. operations: - method: POST name: investmentsholdingsget description: Plaid Get Investment holdings call: plaid-plaid.investmentsholdingsget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/investments/refresh name: investments-refresh description: REST surface for investments-refresh. operations: - method: POST name: investmentsrefresh description: Plaid Refresh investment data call: plaid-plaid.investmentsrefresh with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/investments/transactions/get name: investments-transactions-get description: REST surface for investments-transactions-get. operations: - method: POST name: investmentstransactionsget description: Plaid Get investment transactions call: plaid-plaid.investmentstransactionsget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/item/access-token/invalidate name: item-access-token-invalidate description: REST surface for item-access_token-invalidate. operations: - method: POST name: itemaccesstokeninvalidate description: Plaid Invalidate access_token call: plaid-plaid.itemaccesstokeninvalidate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/item/activity/list name: item-activity-list description: REST surface for item-activity-list. operations: - method: POST name: itemactivitylist description: Plaid List a historical log of user consent events call: plaid-plaid.itemactivitylist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/item/application/list name: item-application-list description: REST surface for item-application-list. operations: - method: POST name: itemapplicationlist description: Plaid List a user’s connected applications call: plaid-plaid.itemapplicationlist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/item/application/scopes/update name: item-application-scopes-update description: REST surface for item-application-scopes-update. operations: - method: POST name: itemapplicationscopesupdate description: Plaid Update the scopes of access for a particular application call: plaid-plaid.itemapplicationscopesupdate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/item/application/unlink name: item-application-unlink description: REST surface for item-application-unlink. operations: - method: POST name: itemapplicationunlink description: Plaid Unlink a user’s connected application call: plaid-plaid.itemapplicationunlink with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/item/get name: item-get description: REST surface for item-get. operations: - method: POST name: itemget description: Plaid Retrieve an Item call: plaid-plaid.itemget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/item/import name: item-import description: REST surface for item-import. operations: - method: POST name: itemimport description: Plaid Import Item call: plaid-plaid.itemimport with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/item/public-token/create name: item-public-token-create description: REST surface for item-public_token-create. operations: - method: POST name: itemcreatepublictoken description: Plaid Create public token call: plaid-plaid.itemcreatepublictoken with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/item/public-token/exchange name: item-public-token-exchange description: REST surface for item-public_token-exchange. operations: - method: POST name: itempublictokenexchange description: Plaid Exchange public token for an access token call: plaid-plaid.itempublictokenexchange with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/item/remove name: item-remove description: REST surface for item-remove. operations: - method: POST name: itemremove description: Plaid Remove an Item call: plaid-plaid.itemremove with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/item/webhook/update name: item-webhook-update description: REST surface for item-webhook-update. operations: - method: POST name: itemwebhookupdate description: Plaid Update Webhook URL call: plaid-plaid.itemwebhookupdate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/liabilities/get name: liabilities-get description: REST surface for liabilities-get. operations: - method: POST name: liabilitiesget description: Plaid Retrieve Liabilities data call: plaid-plaid.liabilitiesget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/link/oauth/correlation-id/exchange name: link-oauth-correlation-id-exchange description: REST surface for link-oauth-correlation_id-exchange. operations: - method: POST name: linkoauthcorrelationidexchange description: Plaid Exchange the Link Correlation Id for a Link Token call: plaid-plaid.linkoauthcorrelationidexchange with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/link/profile/eligibility/check name: link-profile-eligibility-check description: REST surface for link-profile-eligibility-check. operations: - method: POST name: linkprofileeligibilitycheck description: Plaid Check profile eligibility call: plaid-plaid.linkprofileeligibilitycheck with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/link/token/create name: link-token-create description: REST surface for link-token-create. operations: - method: POST name: linktokencreate description: Plaid Create Link Token call: plaid-plaid.linktokencreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/link/token/get name: link-token-get description: REST surface for link-token-get. operations: - method: POST name: linktokenget description: Plaid Get Link Token call: plaid-plaid.linktokenget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/link-delivery/create name: link-delivery-create description: REST surface for link_delivery-create. operations: - method: POST name: linkdeliverycreate description: Plaid Create Hosted Link session call: plaid-plaid.linkdeliverycreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/link-delivery/get name: link-delivery-get description: REST surface for link_delivery-get. operations: - method: POST name: linkdeliveryget description: Plaid Get Hosted Link session call: plaid-plaid.linkdeliveryget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/partner/customer/create name: partner-customer-create description: REST surface for partner-customer-create. operations: - method: POST name: partnercustomercreate description: Creates a new end customer for a Plaid reseller. call: plaid-plaid.partnercustomercreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/partner/customer/enable name: partner-customer-enable description: REST surface for partner-customer-enable. operations: - method: POST name: partnercustomerenable description: Enables a Plaid reseller's end customer in the Production environment. call: plaid-plaid.partnercustomerenable with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/partner/customer/get name: partner-customer-get description: REST surface for partner-customer-get. operations: - method: POST name: partnercustomerget description: Returns a Plaid reseller's end customer. call: plaid-plaid.partnercustomerget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/partner/customer/oauth-institutions/get name: partner-customer-oauth-institutions-get description: REST surface for partner-customer-oauth_institutions-get. operations: - method: POST name: partnercustomeroauthinstitutionsget description: Plaid Returns OAuth-institution registration information for a given end customer. call: plaid-plaid.partnercustomeroauthinstitutionsget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/partner/customer/remove name: partner-customer-remove description: REST surface for partner-customer-remove. operations: - method: POST name: partnercustomerremove description: Removes a Plaid reseller's end customer. call: plaid-plaid.partnercustomerremove with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/payment-initiation/consent/create name: payment-initiation-consent-create description: REST surface for payment_initiation-consent-create. operations: - method: POST name: paymentinitiationconsentcreate description: Plaid Create payment consent call: plaid-plaid.paymentinitiationconsentcreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/payment-initiation/consent/get name: payment-initiation-consent-get description: REST surface for payment_initiation-consent-get. operations: - method: POST name: paymentinitiationconsentget description: Plaid Get payment consent call: plaid-plaid.paymentinitiationconsentget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/payment-initiation/consent/payment/execute name: payment-initiation-consent-payment-execute description: REST surface for payment_initiation-consent-payment-execute. operations: - method: POST name: paymentinitiationconsentpaymentexecute description: Plaid Execute a single payment using consent call: plaid-plaid.paymentinitiationconsentpaymentexecute with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/payment-initiation/consent/revoke name: payment-initiation-consent-revoke description: REST surface for payment_initiation-consent-revoke. operations: - method: POST name: paymentinitiationconsentrevoke description: Plaid Revoke payment consent call: plaid-plaid.paymentinitiationconsentrevoke with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/payment-initiation/payment/create name: payment-initiation-payment-create description: REST surface for payment_initiation-payment-create. operations: - method: POST name: paymentinitiationpaymentcreate description: Plaid Create a payment call: plaid-plaid.paymentinitiationpaymentcreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/payment-initiation/payment/get name: payment-initiation-payment-get description: REST surface for payment_initiation-payment-get. operations: - method: POST name: paymentinitiationpaymentget description: Plaid Get payment details call: plaid-plaid.paymentinitiationpaymentget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/payment-initiation/payment/list name: payment-initiation-payment-list description: REST surface for payment_initiation-payment-list. operations: - method: POST name: paymentinitiationpaymentlist description: Plaid List payments call: plaid-plaid.paymentinitiationpaymentlist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/payment-initiation/payment/reverse name: payment-initiation-payment-reverse description: REST surface for payment_initiation-payment-reverse. operations: - method: POST name: paymentinitiationpaymentreverse description: Plaid Reverse an existing payment call: plaid-plaid.paymentinitiationpaymentreverse with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/payment-initiation/payment/token/create name: payment-initiation-payment-token-create description: REST surface for payment_initiation-payment-token-create. operations: - method: POST name: createpaymenttoken description: Plaid Create payment token call: plaid-plaid.createpaymenttoken with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/payment-initiation/recipient/create name: payment-initiation-recipient-create description: REST surface for payment_initiation-recipient-create. operations: - method: POST name: paymentinitiationrecipientcreate description: Plaid Create payment recipient call: plaid-plaid.paymentinitiationrecipientcreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/payment-initiation/recipient/get name: payment-initiation-recipient-get description: REST surface for payment_initiation-recipient-get. operations: - method: POST name: paymentinitiationrecipientget description: Plaid Get payment recipient call: plaid-plaid.paymentinitiationrecipientget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/payment-initiation/recipient/list name: payment-initiation-recipient-list description: REST surface for payment_initiation-recipient-list. operations: - method: POST name: paymentinitiationrecipientlist description: Plaid List payment recipients call: plaid-plaid.paymentinitiationrecipientlist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/payment-profile/create name: payment-profile-create description: REST surface for payment_profile-create. operations: - method: POST name: paymentprofilecreate description: Plaid Create payment profile call: plaid-plaid.paymentprofilecreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/payment-profile/get name: payment-profile-get description: REST surface for payment_profile-get. operations: - method: POST name: paymentprofileget description: Plaid Get payment profile call: plaid-plaid.paymentprofileget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/payment-profile/remove name: payment-profile-remove description: REST surface for payment_profile-remove. operations: - method: POST name: paymentprofileremove description: Plaid Remove payment profile call: plaid-plaid.paymentprofileremove with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/processor/account/get name: processor-account-get description: REST surface for processor-account-get. operations: - method: POST name: processoraccountget description: Plaid Retrieve the account associated with a processor token call: plaid-plaid.processoraccountget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/processor/apex/processor-token/create name: processor-apex-processor-token-create description: REST surface for processor-apex-processor_token-create. operations: - method: POST name: processorapexprocessortokencreate description: Plaid Create Apex bank account token call: plaid-plaid.processorapexprocessortokencreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/processor/auth/get name: processor-auth-get description: REST surface for processor-auth-get. operations: - method: POST name: processorauthget description: Plaid Retrieve Auth data call: plaid-plaid.processorauthget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/processor/balance/get name: processor-balance-get description: REST surface for processor-balance-get. operations: - method: POST name: processorbalanceget description: Plaid Retrieve Balance data call: plaid-plaid.processorbalanceget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/processor/bank-transfer/create name: processor-bank-transfer-create description: REST surface for processor-bank_transfer-create. operations: - method: POST name: processorbanktransfercreate description: Plaid Create a bank transfer as a processor call: plaid-plaid.processorbanktransfercreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/processor/identity/get name: processor-identity-get description: REST surface for processor-identity-get. operations: - method: POST name: processoridentityget description: Plaid Retrieve Identity data call: plaid-plaid.processoridentityget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/processor/identity/match name: processor-identity-match description: REST surface for processor-identity-match. operations: - method: POST name: processoridentitymatch description: Plaid Retrieve identity match score call: plaid-plaid.processoridentitymatch with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/processor/liabilities/get name: processor-liabilities-get description: REST surface for processor-liabilities-get. operations: - method: POST name: processorliabilitiesget description: Plaid Retrieve Liabilities data call: plaid-plaid.processorliabilitiesget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/processor/signal/decision/report name: processor-signal-decision-report description: REST surface for processor-signal-decision-report. operations: - method: POST name: processorsignaldecisionreport description: Plaid Report whether you initiated an ACH transaction call: plaid-plaid.processorsignaldecisionreport with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/processor/signal/evaluate name: processor-signal-evaluate description: REST surface for processor-signal-evaluate. operations: - method: POST name: processorsignalevaluate description: Plaid Evaluate a planned ACH transaction call: plaid-plaid.processorsignalevaluate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/processor/signal/prepare name: processor-signal-prepare description: REST surface for processor-signal-prepare. operations: - method: POST name: processorsignalprepare description: Plaid Opt-in a processor token to Signal call: plaid-plaid.processorsignalprepare with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/processor/signal/return/report name: processor-signal-return-report description: REST surface for processor-signal-return-report. operations: - method: POST name: processorsignalreturnreport description: Plaid Report a return for an ACH transaction call: plaid-plaid.processorsignalreturnreport with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/processor/stripe/bank-account-token/create name: processor-stripe-bank-account-token-create description: REST surface for processor-stripe-bank_account_token-create. operations: - method: POST name: processorstripebankaccounttokencreate description: Plaid Create Stripe bank account token call: plaid-plaid.processorstripebankaccounttokencreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/processor/token/create name: processor-token-create description: REST surface for processor-token-create. operations: - method: POST name: processortokencreate description: Plaid Create processor token call: plaid-plaid.processortokencreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/processor/token/permissions/get name: processor-token-permissions-get description: REST surface for processor-token-permissions-get. operations: - method: POST name: processortokenpermissionsget description: Plaid Get a processor token's product permissions call: plaid-plaid.processortokenpermissionsget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/processor/token/permissions/set name: processor-token-permissions-set description: REST surface for processor-token-permissions-set. operations: - method: POST name: processortokenpermissionsset description: Plaid Control a processor's access to products call: plaid-plaid.processortokenpermissionsset with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/processor/token/webhook/update name: processor-token-webhook-update description: REST surface for processor-token-webhook-update. operations: - method: POST name: processortokenwebhookupdate description: Plaid Update a processor token's webhook URL call: plaid-plaid.processortokenwebhookupdate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/processor/transactions/get name: processor-transactions-get description: REST surface for processor-transactions-get. operations: - method: POST name: processortransactionsget description: Plaid Get transaction data call: plaid-plaid.processortransactionsget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/processor/transactions/recurring/get name: processor-transactions-recurring-get description: REST surface for processor-transactions-recurring-get. operations: - method: POST name: processortransactionsrecurringget description: Plaid Fetch recurring transaction streams call: plaid-plaid.processortransactionsrecurringget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/processor/transactions/refresh name: processor-transactions-refresh description: REST surface for processor-transactions-refresh. operations: - method: POST name: processortransactionsrefresh description: Plaid Refresh transaction data call: plaid-plaid.processortransactionsrefresh with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/processor/transactions/sync name: processor-transactions-sync description: REST surface for processor-transactions-sync. operations: - method: POST name: processortransactionssync description: Plaid Get incremental transaction updates on a processor token call: plaid-plaid.processortransactionssync with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/profile/get name: profile-get description: REST surface for profile-get. operations: - method: POST name: profileget description: Plaid Retrieve a Profile call: plaid-plaid.profileget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/sandbox/bank-income/fire-webhook name: sandbox-bank-income-fire-webhook description: REST surface for sandbox-bank_income-fire_webhook. operations: - method: POST name: sandboxbankincomefirewebhook description: Plaid Manually fire a bank income webhook in sandbox call: plaid-plaid.sandboxbankincomefirewebhook with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/sandbox/bank-transfer/fire-webhook name: sandbox-bank-transfer-fire-webhook description: REST surface for sandbox-bank_transfer-fire_webhook. operations: - method: POST name: sandboxbanktransferfirewebhook description: Plaid Manually fire a Bank Transfer webhook call: plaid-plaid.sandboxbanktransferfirewebhook with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/sandbox/bank-transfer/simulate name: sandbox-bank-transfer-simulate description: REST surface for sandbox-bank_transfer-simulate. operations: - method: POST name: sandboxbanktransfersimulate description: Plaid Simulate a bank transfer event in Sandbox call: plaid-plaid.sandboxbanktransfersimulate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/sandbox/income/fire-webhook name: sandbox-income-fire-webhook description: REST surface for sandbox-income-fire_webhook. operations: - method: POST name: sandboxincomefirewebhook description: Plaid Manually fire an Income webhook call: plaid-plaid.sandboxincomefirewebhook with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/sandbox/item/fire-webhook name: sandbox-item-fire-webhook description: REST surface for sandbox-item-fire_webhook. operations: - method: POST name: sandboxitemfirewebhook description: Plaid Fire a test webhook call: plaid-plaid.sandboxitemfirewebhook with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/sandbox/item/reset-login name: sandbox-item-reset-login description: REST surface for sandbox-item-reset_login. operations: - method: POST name: sandboxitemresetlogin description: Plaid Force a Sandbox Item into an error state call: plaid-plaid.sandboxitemresetlogin with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/sandbox/item/set-verification-status name: sandbox-item-set-verification-status description: REST surface for sandbox-item-set_verification_status. operations: - method: POST name: sandboxitemsetverificationstatus description: Plaid Set verification status for Sandbox account call: plaid-plaid.sandboxitemsetverificationstatus with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/sandbox/oauth/select-accounts name: sandbox-oauth-select-accounts description: REST surface for sandbox-oauth-select_accounts. operations: - method: POST name: sandboxoauthselectaccounts description: Plaid Save the selected accounts when connecting to the Platypus Oauth institution call: plaid-plaid.sandboxoauthselectaccounts with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/sandbox/payment-profile/reset-login name: sandbox-payment-profile-reset-login description: REST surface for sandbox-payment_profile-reset_login. operations: - method: POST name: sandboxpaymentprofileresetlogin description: Plaid Reset the login of a Payment Profile call: plaid-plaid.sandboxpaymentprofileresetlogin with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/sandbox/processor-token/create name: sandbox-processor-token-create description: REST surface for sandbox-processor_token-create. operations: - method: POST name: sandboxprocessortokencreate description: Plaid Create a test Item and processor token call: plaid-plaid.sandboxprocessortokencreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/sandbox/public-token/create name: sandbox-public-token-create description: REST surface for sandbox-public_token-create. operations: - method: POST name: sandboxpublictokencreate description: Plaid Create a test Item call: plaid-plaid.sandboxpublictokencreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/sandbox/transfer/fire-webhook name: sandbox-transfer-fire-webhook description: REST surface for sandbox-transfer-fire_webhook. operations: - method: POST name: sandboxtransferfirewebhook description: Plaid Manually fire a Transfer webhook call: plaid-plaid.sandboxtransferfirewebhook with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/sandbox/transfer/ledger/deposit/simulate name: sandbox-transfer-ledger-deposit-simulate description: REST surface for sandbox-transfer-ledger-deposit-simulate. operations: - method: POST name: sandboxtransferledgerdepositsimulate description: Plaid Simulate a ledger deposit event in Sandbox call: plaid-plaid.sandboxtransferledgerdepositsimulate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/sandbox/transfer/ledger/simulate-available name: sandbox-transfer-ledger-simulate-available description: REST surface for sandbox-transfer-ledger-simulate_available. operations: - method: POST name: sandboxtransferledgersimulateavailable description: Plaid Simulate converting pending balance to available balance call: plaid-plaid.sandboxtransferledgersimulateavailable with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/sandbox/transfer/ledger/withdraw/simulate name: sandbox-transfer-ledger-withdraw-simulate description: REST surface for sandbox-transfer-ledger-withdraw-simulate. operations: - method: POST name: sandboxtransferledgerwithdrawsimulate description: Plaid Simulate a ledger withdraw event in Sandbox call: plaid-plaid.sandboxtransferledgerwithdrawsimulate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/sandbox/transfer/refund/simulate name: sandbox-transfer-refund-simulate description: REST surface for sandbox-transfer-refund-simulate. operations: - method: POST name: sandboxtransferrefundsimulate description: Plaid Simulate a refund event in Sandbox call: plaid-plaid.sandboxtransferrefundsimulate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/sandbox/transfer/repayment/simulate name: sandbox-transfer-repayment-simulate description: REST surface for sandbox-transfer-repayment-simulate. operations: - method: POST name: sandboxtransferrepaymentsimulate description: Plaid Trigger the creation of a repayment call: plaid-plaid.sandboxtransferrepaymentsimulate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/sandbox/transfer/simulate name: sandbox-transfer-simulate description: REST surface for sandbox-transfer-simulate. operations: - method: POST name: sandboxtransfersimulate description: Plaid Simulate a transfer event in Sandbox call: plaid-plaid.sandboxtransfersimulate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/sandbox/transfer/sweep/simulate name: sandbox-transfer-sweep-simulate description: REST surface for sandbox-transfer-sweep-simulate. operations: - method: POST name: sandboxtransfersweepsimulate description: Plaid Simulate creating a sweep call: plaid-plaid.sandboxtransfersweepsimulate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/sandbox/transfer/test-clock/advance name: sandbox-transfer-test-clock-advance description: REST surface for sandbox-transfer-test_clock-advance. operations: - method: POST name: sandboxtransfertestclockadvance description: Plaid Advance a test clock call: plaid-plaid.sandboxtransfertestclockadvance with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/sandbox/transfer/test-clock/create name: sandbox-transfer-test-clock-create description: REST surface for sandbox-transfer-test_clock-create. operations: - method: POST name: sandboxtransfertestclockcreate description: Plaid Create a test clock call: plaid-plaid.sandboxtransfertestclockcreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/sandbox/transfer/test-clock/get name: sandbox-transfer-test-clock-get description: REST surface for sandbox-transfer-test_clock-get. operations: - method: POST name: sandboxtransfertestclockget description: Plaid Get a test clock call: plaid-plaid.sandboxtransfertestclockget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/sandbox/transfer/test-clock/list name: sandbox-transfer-test-clock-list description: REST surface for sandbox-transfer-test_clock-list. operations: - method: POST name: sandboxtransfertestclocklist description: Plaid List test clocks call: plaid-plaid.sandboxtransfertestclocklist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/signal/decision/report name: signal-decision-report description: REST surface for signal-decision-report. operations: - method: POST name: signaldecisionreport description: Plaid Report whether you initiated an ACH transaction call: plaid-plaid.signaldecisionreport with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/signal/evaluate name: signal-evaluate description: REST surface for signal-evaluate. operations: - method: POST name: signalevaluate description: Plaid Evaluate a planned ACH transaction call: plaid-plaid.signalevaluate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/signal/prepare name: signal-prepare description: REST surface for signal-prepare. operations: - method: POST name: signalprepare description: Plaid Opt-in an Item to Signal call: plaid-plaid.signalprepare with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/signal/return/report name: signal-return-report description: REST surface for signal-return-report. operations: - method: POST name: signalreturnreport description: Plaid Report a return for an ACH transaction call: plaid-plaid.signalreturnreport with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/statements/download name: statements-download description: REST surface for statements-download. operations: - method: POST name: statementsdownload description: Plaid Retrieve a single statement. call: plaid-plaid.statementsdownload with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/statements/list name: statements-list description: REST surface for statements-list. operations: - method: POST name: statementslist description: Plaid Retrieve a list of all statements associated with an item. call: plaid-plaid.statementslist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/statements/refresh name: statements-refresh description: REST surface for statements-refresh. operations: - method: POST name: statementsrefresh description: Plaid Refresh statements data. call: plaid-plaid.statementsrefresh with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transactions/enrich name: transactions-enrich description: REST surface for transactions-enrich. operations: - method: POST name: transactionsenrich description: Plaid Enrich locally-held transaction data call: plaid-plaid.transactionsenrich with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transactions/get name: transactions-get description: REST surface for transactions-get. operations: - method: POST name: transactionsget description: Plaid Get transaction data call: plaid-plaid.transactionsget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transactions/recurring/get name: transactions-recurring-get description: REST surface for transactions-recurring-get. operations: - method: POST name: transactionsrecurringget description: Plaid Fetch recurring transaction streams call: plaid-plaid.transactionsrecurringget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transactions/refresh name: transactions-refresh description: REST surface for transactions-refresh. operations: - method: POST name: transactionsrefresh description: Plaid Refresh transaction data call: plaid-plaid.transactionsrefresh with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transactions/sync name: transactions-sync description: REST surface for transactions-sync. operations: - method: POST name: transactionssync description: Plaid Get incremental transaction updates on an Item call: plaid-plaid.transactionssync with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/authorization/cancel name: transfer-authorization-cancel description: REST surface for transfer-authorization-cancel. operations: - method: POST name: transferauthorizationcancel description: Plaid Cancel a transfer authorization call: plaid-plaid.transferauthorizationcancel with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/authorization/create name: transfer-authorization-create description: REST surface for transfer-authorization-create. operations: - method: POST name: transferauthorizationcreate description: Plaid Create a transfer authorization call: plaid-plaid.transferauthorizationcreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/balance/get name: transfer-balance-get description: REST surface for transfer-balance-get. operations: - method: POST name: transferbalanceget description: (Deprecated) Retrieve a balance held with Plaid call: plaid-plaid.transferbalanceget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/cancel name: transfer-cancel description: REST surface for transfer-cancel. operations: - method: POST name: transfercancel description: Plaid Cancel a transfer call: plaid-plaid.transfercancel with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/capabilities/get name: transfer-capabilities-get description: REST surface for transfer-capabilities-get. operations: - method: POST name: transfercapabilitiesget description: Plaid Get RTP eligibility information of a transfer call: plaid-plaid.transfercapabilitiesget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/configuration/get name: transfer-configuration-get description: REST surface for transfer-configuration-get. operations: - method: POST name: transferconfigurationget description: Plaid Get transfer product configuration call: plaid-plaid.transferconfigurationget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/create name: transfer-create description: REST surface for transfer-create. operations: - method: POST name: transfercreate description: Plaid Create a transfer call: plaid-plaid.transfercreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/diligence/document/upload name: transfer-diligence-document-upload description: REST surface for transfer-diligence-document-upload. operations: - method: POST name: transferdiligencedocumentupload description: Plaid Upload transfer diligence document on behalf of the originator call: plaid-plaid.transferdiligencedocumentupload with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/diligence/submit name: transfer-diligence-submit description: REST surface for transfer-diligence-submit. operations: - method: POST name: transferdiligencesubmit description: Plaid Submit transfer diligence on behalf of the originator call: plaid-plaid.transferdiligencesubmit with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/event/list name: transfer-event-list description: REST surface for transfer-event-list. operations: - method: POST name: transfereventlist description: Plaid List transfer events call: plaid-plaid.transfereventlist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/event/sync name: transfer-event-sync description: REST surface for transfer-event-sync. operations: - method: POST name: transfereventsync description: Plaid Sync transfer events call: plaid-plaid.transfereventsync with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/get name: transfer-get description: REST surface for transfer-get. operations: - method: POST name: transferget description: Plaid Retrieve a transfer call: plaid-plaid.transferget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/intent/create name: transfer-intent-create description: REST surface for transfer-intent-create. operations: - method: POST name: transferintentcreate description: Plaid Create a transfer intent object to invoke the Transfer UI call: plaid-plaid.transferintentcreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/intent/get name: transfer-intent-get description: REST surface for transfer-intent-get. operations: - method: POST name: transferintentget description: Plaid Retrieve more information about a transfer intent call: plaid-plaid.transferintentget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/ledger/deposit name: transfer-ledger-deposit description: REST surface for transfer-ledger-deposit. operations: - method: POST name: transferledgerdeposit description: Deposit funds into a Plaid Ledger balance call: plaid-plaid.transferledgerdeposit with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/ledger/distribute name: transfer-ledger-distribute description: REST surface for transfer-ledger-distribute. operations: - method: POST name: transferledgerdistribute description: Plaid Move available balance between the ledgers of the platform and one of its originators call: plaid-plaid.transferledgerdistribute with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/ledger/get name: transfer-ledger-get description: REST surface for transfer-ledger-get. operations: - method: POST name: transferledgerget description: Retrieve Plaid Ledger balance call: plaid-plaid.transferledgerget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/ledger/withdraw name: transfer-ledger-withdraw description: REST surface for transfer-ledger-withdraw. operations: - method: POST name: transferledgerwithdraw description: Withdraw funds from a Plaid Ledger balance call: plaid-plaid.transferledgerwithdraw with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/list name: transfer-list description: REST surface for transfer-list. operations: - method: POST name: transferlist description: Plaid List transfers call: plaid-plaid.transferlist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/metrics/get name: transfer-metrics-get description: REST surface for transfer-metrics-get. operations: - method: POST name: transfermetricsget description: Plaid Get transfer product usage metrics call: plaid-plaid.transfermetricsget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/migrate-account name: transfer-migrate-account description: REST surface for transfer-migrate_account. operations: - method: POST name: transfermigrateaccount description: Plaid Migrate account into Transfers call: plaid-plaid.transfermigrateaccount with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/originator/create name: transfer-originator-create description: REST surface for transfer-originator-create. operations: - method: POST name: transferoriginatorcreate description: Plaid Create a new originator call: plaid-plaid.transferoriginatorcreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/originator/funding-account/update name: transfer-originator-funding-account-update description: REST surface for transfer-originator-funding_account-update. operations: - method: POST name: transferoriginatorfundingaccountupdate description: Plaid Update the funding account associated with the originator call: plaid-plaid.transferoriginatorfundingaccountupdate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/originator/get name: transfer-originator-get description: REST surface for transfer-originator-get. operations: - method: POST name: transferoriginatorget description: Plaid Get status of an originator's onboarding call: plaid-plaid.transferoriginatorget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/originator/list name: transfer-originator-list description: REST surface for transfer-originator-list. operations: - method: POST name: transferoriginatorlist description: Plaid Get status of all originators' onboarding call: plaid-plaid.transferoriginatorlist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/questionnaire/create name: transfer-questionnaire-create description: REST surface for transfer-questionnaire-create. operations: - method: POST name: transferquestionnairecreate description: Generate a Plaid-hosted onboarding UI URL. call: plaid-plaid.transferquestionnairecreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/recurring/cancel name: transfer-recurring-cancel description: REST surface for transfer-recurring-cancel. operations: - method: POST name: transferrecurringcancel description: Plaid Cancel a recurring transfer. call: plaid-plaid.transferrecurringcancel with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/recurring/create name: transfer-recurring-create description: REST surface for transfer-recurring-create. operations: - method: POST name: transferrecurringcreate description: Plaid Create a recurring transfer call: plaid-plaid.transferrecurringcreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/recurring/get name: transfer-recurring-get description: REST surface for transfer-recurring-get. operations: - method: POST name: transferrecurringget description: Plaid Retrieve a recurring transfer call: plaid-plaid.transferrecurringget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/recurring/list name: transfer-recurring-list description: REST surface for transfer-recurring-list. operations: - method: POST name: transferrecurringlist description: Plaid List recurring transfers call: plaid-plaid.transferrecurringlist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/refund/cancel name: transfer-refund-cancel description: REST surface for transfer-refund-cancel. operations: - method: POST name: transferrefundcancel description: Plaid Cancel a refund call: plaid-plaid.transferrefundcancel with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/refund/create name: transfer-refund-create description: REST surface for transfer-refund-create. operations: - method: POST name: transferrefundcreate description: Plaid Create a refund call: plaid-plaid.transferrefundcreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/refund/get name: transfer-refund-get description: REST surface for transfer-refund-get. operations: - method: POST name: transferrefundget description: Plaid Retrieve a refund call: plaid-plaid.transferrefundget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/repayment/list name: transfer-repayment-list description: REST surface for transfer-repayment-list. operations: - method: POST name: transferrepaymentlist description: Plaid Lists historical repayments call: plaid-plaid.transferrepaymentlist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/repayment/return/list name: transfer-repayment-return-list description: REST surface for transfer-repayment-return-list. operations: - method: POST name: transferrepaymentreturnlist description: Plaid List the returns included in a repayment call: plaid-plaid.transferrepaymentreturnlist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/sweep/get name: transfer-sweep-get description: REST surface for transfer-sweep-get. operations: - method: POST name: transfersweepget description: Plaid Retrieve a sweep call: plaid-plaid.transfersweepget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/transfer/sweep/list name: transfer-sweep-list description: REST surface for transfer-sweep-list. operations: - method: POST name: transfersweeplist description: Plaid List sweeps call: plaid-plaid.transfersweeplist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/user/create name: user-create description: REST surface for user-create. operations: - method: POST name: usercreate description: Plaid Create user call: plaid-plaid.usercreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/user/update name: user-update description: REST surface for user-update. operations: - method: POST name: userupdate description: Plaid Update user information call: plaid-plaid.userupdate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/wallet/create name: wallet-create description: REST surface for wallet-create. operations: - method: POST name: walletcreate description: Plaid Create an e-wallet call: plaid-plaid.walletcreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/wallet/get name: wallet-get description: REST surface for wallet-get. operations: - method: POST name: walletget description: Plaid Fetch an e-wallet call: plaid-plaid.walletget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/wallet/list name: wallet-list description: REST surface for wallet-list. operations: - method: POST name: walletlist description: Plaid Fetch a list of e-wallets call: plaid-plaid.walletlist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/wallet/transaction/execute name: wallet-transaction-execute description: REST surface for wallet-transaction-execute. operations: - method: POST name: wallettransactionexecute description: Plaid Execute a transaction using an e-wallet call: plaid-plaid.wallettransactionexecute with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/wallet/transaction/get name: wallet-transaction-get description: REST surface for wallet-transaction-get. operations: - method: POST name: wallettransactionget description: Plaid Fetch an e-wallet transaction call: plaid-plaid.wallettransactionget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/wallet/transaction/list name: wallet-transaction-list description: REST surface for wallet-transaction-list. operations: - method: POST name: wallettransactionlist description: Plaid List e-wallet transactions call: plaid-plaid.wallettransactionlist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/watchlist-screening/entity/create name: watchlist-screening-entity-create description: REST surface for watchlist_screening-entity-create. operations: - method: POST name: watchlistscreeningentitycreate description: Plaid Create a watchlist screening for an entity call: plaid-plaid.watchlistscreeningentitycreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/watchlist-screening/entity/get name: watchlist-screening-entity-get description: REST surface for watchlist_screening-entity-get. operations: - method: POST name: watchlistscreeningentityget description: Plaid Get an entity screening call: plaid-plaid.watchlistscreeningentityget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/watchlist-screening/entity/history/list name: watchlist-screening-entity-history-list description: REST surface for watchlist_screening-entity-history-list. operations: - method: POST name: watchlistscreeningentityhistorylist description: Plaid List history for entity watchlist screenings call: plaid-plaid.watchlistscreeningentityhistorylist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/watchlist-screening/entity/hit/list name: watchlist-screening-entity-hit-list description: REST surface for watchlist_screening-entity-hit-list. operations: - method: POST name: watchlistscreeningentityhitlist description: Plaid List hits for entity watchlist screenings call: plaid-plaid.watchlistscreeningentityhitlist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/watchlist-screening/entity/list name: watchlist-screening-entity-list description: REST surface for watchlist_screening-entity-list. operations: - method: POST name: watchlistscreeningentitylist description: Plaid List entity watchlist screenings call: plaid-plaid.watchlistscreeningentitylist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/watchlist-screening/entity/program/get name: watchlist-screening-entity-program-get description: REST surface for watchlist_screening-entity-program-get. operations: - method: POST name: watchlistscreeningentityprogramget description: Plaid Get entity watchlist screening program call: plaid-plaid.watchlistscreeningentityprogramget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/watchlist-screening/entity/program/list name: watchlist-screening-entity-program-list description: REST surface for watchlist_screening-entity-program-list. operations: - method: POST name: watchlistscreeningentityprogramlist description: Plaid List entity watchlist screening programs call: plaid-plaid.watchlistscreeningentityprogramlist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/watchlist-screening/entity/review/create name: watchlist-screening-entity-review-create description: REST surface for watchlist_screening-entity-review-create. operations: - method: POST name: watchlistscreeningentityreviewcreate description: Plaid Create a review for an entity watchlist screening call: plaid-plaid.watchlistscreeningentityreviewcreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/watchlist-screening/entity/review/list name: watchlist-screening-entity-review-list description: REST surface for watchlist_screening-entity-review-list. operations: - method: POST name: watchlistscreeningentityreviewlist description: Plaid List reviews for entity watchlist screenings call: plaid-plaid.watchlistscreeningentityreviewlist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/watchlist-screening/entity/update name: watchlist-screening-entity-update description: REST surface for watchlist_screening-entity-update. operations: - method: POST name: watchlistscreeningentityupdate description: Plaid Update an entity screening call: plaid-plaid.watchlistscreeningentityupdate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/watchlist-screening/individual/create name: watchlist-screening-individual-create description: REST surface for watchlist_screening-individual-create. operations: - method: POST name: watchlistscreeningindividualcreate description: Plaid Create a watchlist screening for a person call: plaid-plaid.watchlistscreeningindividualcreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/watchlist-screening/individual/get name: watchlist-screening-individual-get description: REST surface for watchlist_screening-individual-get. operations: - method: POST name: watchlistscreeningindividualget description: Plaid Retrieve an individual watchlist screening call: plaid-plaid.watchlistscreeningindividualget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/watchlist-screening/individual/history/list name: watchlist-screening-individual-history-list description: REST surface for watchlist_screening-individual-history-list. operations: - method: POST name: watchlistscreeningindividualhistorylist description: Plaid List history for individual watchlist screenings call: plaid-plaid.watchlistscreeningindividualhistorylist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/watchlist-screening/individual/hit/list name: watchlist-screening-individual-hit-list description: REST surface for watchlist_screening-individual-hit-list. operations: - method: POST name: watchlistscreeningindividualhitlist description: Plaid List hits for individual watchlist screening call: plaid-plaid.watchlistscreeningindividualhitlist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/watchlist-screening/individual/list name: watchlist-screening-individual-list description: REST surface for watchlist_screening-individual-list. operations: - method: POST name: watchlistscreeningindividuallist description: Plaid List Individual Watchlist Screenings call: plaid-plaid.watchlistscreeningindividuallist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/watchlist-screening/individual/program/get name: watchlist-screening-individual-program-get description: REST surface for watchlist_screening-individual-program-get. operations: - method: POST name: watchlistscreeningindividualprogramget description: Plaid Get individual watchlist screening program call: plaid-plaid.watchlistscreeningindividualprogramget with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/watchlist-screening/individual/program/list name: watchlist-screening-individual-program-list description: REST surface for watchlist_screening-individual-program-list. operations: - method: POST name: watchlistscreeningindividualprogramlist description: Plaid List individual watchlist screening programs call: plaid-plaid.watchlistscreeningindividualprogramlist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/watchlist-screening/individual/review/create name: watchlist-screening-individual-review-create description: REST surface for watchlist_screening-individual-review-create. operations: - method: POST name: watchlistscreeningindividualreviewcreate description: Plaid Create a review for an individual watchlist screening call: plaid-plaid.watchlistscreeningindividualreviewcreate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/watchlist-screening/individual/review/list name: watchlist-screening-individual-review-list description: REST surface for watchlist_screening-individual-review-list. operations: - method: POST name: watchlistscreeningindividualreviewlist description: Plaid List reviews for individual watchlist screenings call: plaid-plaid.watchlistscreeningindividualreviewlist with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/watchlist-screening/individual/update name: watchlist-screening-individual-update description: REST surface for watchlist_screening-individual-update. operations: - method: POST name: watchlistscreeningindividualupdate description: Plaid Update individual watchlist screening call: plaid-plaid.watchlistscreeningindividualupdate with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/webhook-verification-key/get name: webhook-verification-key-get description: REST surface for webhook_verification_key-get. operations: - method: POST name: webhookverificationkeyget description: Plaid Get webhook verification key call: plaid-plaid.webhookverificationkeyget with: body: rest.body outputParameters: - type: object mapping: $. - type: mcp namespace: plaid-plaid-mcp port: 9090 transport: http description: MCP adapter for Plaid The Plaid API — Plaid. One tool per consumed operation, routed inline through this capability's consumes block. tools: - name: plaid-retrieve-real-time-balance description: Plaid Retrieve real-time balance data hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.accountsbalanceget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-accounts description: Plaid Retrieve accounts hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.accountsget with: body: tools.body outputParameters: - type: object mapping: $. - name: retrieve-information-about-plaid-application description: Retrieve information about a Plaid application hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.applicationget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-asset-report-audit description: Plaid Create Asset Report Audit Copy hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.assetreportauditcopycreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-asset-report-audit description: Plaid Retrieve an Asset Report Audit Copy hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.assetreportauditcopyget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-remove-asset-report-audit description: Plaid Remove Asset Report Audit Copy hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.assetreportauditcopyremove with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-asset-report description: Plaid Create an Asset Report hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.assetreportcreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-filter-asset-report description: Plaid Filter Asset Report hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.assetreportfilter with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-asset-report description: Plaid Retrieve an Asset Report hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.assetreportget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-pdf-asset-report description: Plaid Retrieve a PDF Asset Report hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.assetreportpdfget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-refresh-asset-report description: Plaid Refresh an Asset Report hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.assetreportrefresh with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-delete-asset-report description: Plaid Delete an Asset Report hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.assetreportremove with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-auth-data description: Plaid Retrieve auth data hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.authget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-balance-your-bank description: Plaid Get balance of your Bank Transfer account hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.banktransferbalanceget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-cancel-bank-transfer description: Plaid Cancel a bank transfer hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.banktransfercancel with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-bank-transfer description: Plaid Create a bank transfer hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.banktransfercreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-list-bank-transfer-events description: Plaid List bank transfer events hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.banktransfereventlist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-sync-bank-transfer-events description: Plaid Sync bank transfer events hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.banktransfereventsync with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-bank-transfer description: Plaid Retrieve a bank transfer hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.banktransferget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-list-bank-transfers description: Plaid List bank transfers hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.banktransferlist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-migrate-account-bank-transfers description: Plaid Migrate account into Bank Transfers hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.banktransfermigrateaccount with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-sweep description: Plaid Retrieve a sweep hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.banktransfersweepget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-list-sweeps description: Plaid List sweeps hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.banktransfersweeplist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-evaluate-risk-bank-account description: Plaid Evaluate risk of a bank account hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.beaconaccountriskevaluate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-beacon-duplicate description: Plaid Get a Beacon Duplicate hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.beaconduplicateget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-beacon-report description: Plaid Create a Beacon Report hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.beaconreportcreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-beacon-report description: Plaid Get a Beacon Report hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.beaconreportget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-list-beacon-reports-beacon description: Plaid List Beacon Reports for a Beacon User hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.beaconreportlist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-beacon-report-syndication description: Plaid Get a Beacon Report Syndication hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.beaconreportsyndicationget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-list-beacon-report-syndications description: Plaid List Beacon Report Syndications for a Beacon User hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.beaconreportsyndicationlist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-beacon-user description: Plaid Create a Beacon User hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.beaconusercreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-beacon-user description: Plaid Get a Beacon User hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.beaconuserget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-list-beacon-user-s-history description: Plaid List a Beacon User's history hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.beaconuserhistorylist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-review-beacon-user description: Plaid Review a Beacon User hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.beaconuserreview with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-update-identity-data-beacon description: Plaid Update the identity data of a Beacon User hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.beaconuserupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-information-bank-accounts description: Plaid Retrieve information from the bank accounts used for employment verification hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.creditbankemploymentget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-transaction-category-rule description: Plaid Create transaction category rule hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.transactionsrulescreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-return-list-rules-created description: Plaid Return a list of rules created for the Item associated with the access token. hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.transactionsruleslist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-remove-transaction-rule description: Plaid Remove transaction rule hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.transactionsrulesremove with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-obtain-user-insights-based description: Plaid Obtain user insights based on transactions sent through /transactions/enrich hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.transactionsuserinsightsget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-enhance-locally-held-transaction description: Plaid enhance locally-held transaction data hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.transactionsenhance with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-categories description: Plaid Get categories hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.categoriesget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-pdf-reports description: Plaid Retrieve a PDF Reports hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.consumerreportpdfget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-cra-report-income description: Plaid Create a CRA report for income verification hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.crabankincomecreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-information-bank-accounts-2 description: Plaid Retrieve information from the bank accounts used for income verification hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.crabankincomeget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-base-report description: Plaid Create a Base Report hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.basereportcreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-base-report description: Plaid Retrieve a Base Report hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.basereportget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-register-loan-applications-and description: Plaid Register loan applications and decisions. hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.craloansapplicationsregister with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-register-list-loans-their description: Plaid Register a list of loans to their applicants. hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.craloansregister with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-unregister-list-loans description: Plaid Unregister a list of loans. hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.craloansunregister with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-updates-loan-data description: Plaid Updates loan data. hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.craloansupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-cash-flow-insights description: Plaid Retrieve cash flow insights from the bank accounts used for income verification hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.crapartnerinsightsget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-asset-report-freddie description: Plaid Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint. hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.creditassetreportfreddiemacget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-asset-income-report description: Plaid Create Asset or Income Report Audit Copy Token hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.creditauditcopytokencreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-remove-audit-copy-token description: Plaid Remove an Audit Copy token hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.creditreportauditcopyremove with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-update-audit-copy-token description: Plaid Update an Audit Copy Token hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.creditauditcopytokenupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-information-bank-accounts-3 description: Plaid Retrieve information from the bank accounts used for income verification hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.creditbankincomeget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-information-bank-accounts-4 description: Plaid Retrieve information from the bank accounts used for income verification in PDF format hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.creditbankincomepdfget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-refresh-user-s-bank-income description: Plaid Refresh a user's bank income information hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.creditbankincomerefresh with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-subscribe-and-unsubscribe-proactive description: Plaid Subscribe and unsubscribe to proactive notifications for a user's income profile hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.creditbankincomewebhookupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-data-user-s-uploaded description: Plaid Retrieve data for a user's uploaded bank statements hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.creditbankstatementsuploadsget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-summary-individual-s-employment description: Plaid Retrieve a summary of an individual's employment information hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.creditemploymentget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-asset-report-freddie-2 description: 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 can use this endpoint. hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.creditfreddiemacreportsget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-user-s-payroll-information description: Plaid Retrieve a user's payroll information hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.creditpayrollincomeget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-update-parsing-configuration-document description: Plaid Update the parsing configuration for a document income verification hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.creditpayrollincomeparsingconfigupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-check-income-verification-eligibility description: Plaid Check income verification eligibility and optimize conversion hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.creditpayrollincomeprecheck with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-refresh-digital-payroll-income description: Plaid Refresh a digital payroll income verification hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.creditpayrollincomerefresh with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-fraud-insights-user-s description: Plaid Retrieve fraud insights for a user's manually uploaded document(s). hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.creditpayrollincomerisksignalsget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-relay-token-share description: Plaid Create a relay token to share an Asset Report with a partner client hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.creditrelaycreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-reports-associated-relay description: Plaid Retrieve the reports associated with a relay token that was shared with you hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.creditrelayget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-pdf-reports-associated description: Plaid Retrieve the pdf reports associated with a relay token that was shared with you (beta) hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.creditrelaypdfget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-refresh-report-relay-token description: Plaid Refresh a report of a relay token hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.creditrelayrefresh with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-remove-relay-token description: Plaid Remove relay token hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.creditrelayremove with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-link-sessions-your description: Plaid Retrieve Link sessions for your user hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.creditsessionsget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-dashboard-user description: Plaid Retrieve a dashboard user hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.dashboarduserget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-list-dashboard-users description: Plaid List dashboard users hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.dashboarduserlist with: body: tools.body outputParameters: - type: object mapping: $. - name: create-deposit-switch-without-using description: Create a deposit switch without using Plaid Exchange hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.depositswitchaltcreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-deposit-switch description: Plaid Create a deposit switch hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.depositswitchcreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-deposit-switch description: Plaid Retrieve a deposit switch hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.depositswitchget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-deposit-switch-token description: Plaid Create a deposit switch token hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.depositswitchtokencreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-search-employer-database description: Plaid Search employer database hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.employerssearch with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-deprecated-retrieve-summary-individual-s description: Plaid (Deprecated) Retrieve a summary of an individual's employment information hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.employmentverificationget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-webhook-receiver-fdx-notifications description: Plaid Webhook receiver for fdx notifications hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.fdxnotifications with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-returns-uploaded-document-identity description: Plaid Returns uploaded document identity hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.identitydocumentsuploadsget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-identity-data description: Plaid Retrieve identity data hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.identityget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-identity-match-score description: Plaid Retrieve identity match score hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.identitymatch with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-refresh-identity-data description: Plaid Refresh identity data hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.identityrefresh with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-autofill-identity-verification description: Plaid Create autofill for an Identity Verification hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.identityverificationautofillcreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-new-identity-verification description: Plaid Create a new Identity Verification hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.identityverificationcreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-identity-verification description: Plaid Retrieve Identity Verification hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.identityverificationget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-list-identity-verifications description: Plaid List Identity Verifications hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.identityverificationlist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retry-identity-verification description: Plaid Retry an Identity Verification hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.identityverificationretry with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-deprecated-create-income-verification description: Plaid (Deprecated) Create an income verification instance hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.incomeverificationcreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-deprecated-download-original-documents description: Plaid (Deprecated) Download the original documents used for income verification hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.incomeverificationdocumentsdownload with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-deprecated-retrieve-information-paystubs description: Plaid (Deprecated) Retrieve information from the paystubs used for income verification hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.incomeverificationpaystubsget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-deprecated-check-digital-income description: Plaid (Deprecated) Check digital income verification eligibility and optimize conversion hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.incomeverificationprecheck with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-deprecated-retrieve-information-tax description: Plaid (Deprecated) Retrieve information from the tax documents used for income verification hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.incomeverificationtaxformsget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-details-all-supported description: Plaid Get details of all supported institutions hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.institutionsget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-details-institution description: Plaid Get details of an institution hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.institutionsgetbyid with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-search-institutions description: Plaid Search institutions hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.institutionssearch with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-data-needed-authorize description: Plaid Get data needed to authorize an investments transfer hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.investmentsauthget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-investment-holdings description: Plaid Get Investment holdings hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.investmentsholdingsget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-refresh-investment-data description: Plaid Refresh investment data hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.investmentsrefresh with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-investment-transactions description: Plaid Get investment transactions hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.investmentstransactionsget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-invalidate-access-token description: Plaid Invalidate access_token hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.itemaccesstokeninvalidate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-list-historical-log-user description: Plaid List a historical log of user consent events hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.itemactivitylist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-list-user-s-connected-applications description: Plaid List a user’s connected applications hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.itemapplicationlist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-update-scopes-access-particular description: Plaid Update the scopes of access for a particular application hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.itemapplicationscopesupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-unlink-user-s-connected-application description: Plaid Unlink a user’s connected application hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.itemapplicationunlink with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-item description: Plaid Retrieve an Item hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.itemget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-import-item description: Plaid Import Item hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.itemimport with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-public-token description: Plaid Create public token hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.itemcreatepublictoken with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-exchange-public-token-access description: Plaid Exchange public token for an access token hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.itempublictokenexchange with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-remove-item description: Plaid Remove an Item hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.itemremove with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-update-webhook-url description: Plaid Update Webhook URL hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.itemwebhookupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-liabilities-data description: Plaid Retrieve Liabilities data hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.liabilitiesget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-exchange-link-correlation-id description: Plaid Exchange the Link Correlation Id for a Link Token hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.linkoauthcorrelationidexchange with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-check-profile-eligibility description: Plaid Check profile eligibility hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.linkprofileeligibilitycheck with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-link-token description: Plaid Create Link Token hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.linktokencreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-link-token description: Plaid Get Link Token hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.linktokenget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-hosted-link-session description: Plaid Create Hosted Link session hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.linkdeliverycreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-hosted-link-session description: Plaid Get Hosted Link session hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.linkdeliveryget with: body: tools.body outputParameters: - type: object mapping: $. - name: creates-new-end-customer-plaid description: Creates a new end customer for a Plaid reseller. hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.partnercustomercreate with: body: tools.body outputParameters: - type: object mapping: $. - name: enables-plaid-reseller-s-end-customer description: Enables a Plaid reseller's end customer in the Production environment. hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.partnercustomerenable with: body: tools.body outputParameters: - type: object mapping: $. - name: returns-plaid-reseller-s-end-customer description: Returns a Plaid reseller's end customer. hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.partnercustomerget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-returns-oauth-institution-registration description: Plaid Returns OAuth-institution registration information for a given end customer. hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.partnercustomeroauthinstitutionsget with: body: tools.body outputParameters: - type: object mapping: $. - name: removes-plaid-reseller-s-end-customer description: Removes a Plaid reseller's end customer. hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.partnercustomerremove with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-payment-consent description: Plaid Create payment consent hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.paymentinitiationconsentcreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-payment-consent description: Plaid Get payment consent hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.paymentinitiationconsentget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-execute-single-payment-using description: Plaid Execute a single payment using consent hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.paymentinitiationconsentpaymentexecute with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-revoke-payment-consent description: Plaid Revoke payment consent hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.paymentinitiationconsentrevoke with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-payment description: Plaid Create a payment hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.paymentinitiationpaymentcreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-payment-details description: Plaid Get payment details hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.paymentinitiationpaymentget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-list-payments description: Plaid List payments hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.paymentinitiationpaymentlist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-reverse-existing-payment description: Plaid Reverse an existing payment hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.paymentinitiationpaymentreverse with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-payment-token description: Plaid Create payment token hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.createpaymenttoken with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-payment-recipient description: Plaid Create payment recipient hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.paymentinitiationrecipientcreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-payment-recipient description: Plaid Get payment recipient hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.paymentinitiationrecipientget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-list-payment-recipients description: Plaid List payment recipients hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.paymentinitiationrecipientlist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-payment-profile description: Plaid Create payment profile hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.paymentprofilecreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-payment-profile description: Plaid Get payment profile hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.paymentprofileget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-remove-payment-profile description: Plaid Remove payment profile hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.paymentprofileremove with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-account-associated-processor description: Plaid Retrieve the account associated with a processor token hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.processoraccountget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-apex-bank-account description: Plaid Create Apex bank account token hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.processorapexprocessortokencreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-auth-data-2 description: Plaid Retrieve Auth data hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.processorauthget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-balance-data description: Plaid Retrieve Balance data hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.processorbalanceget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-bank-transfer-processor description: Plaid Create a bank transfer as a processor hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.processorbanktransfercreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-identity-data-2 description: Plaid Retrieve Identity data hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.processoridentityget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-identity-match-score-2 description: Plaid Retrieve identity match score hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.processoridentitymatch with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-liabilities-data-2 description: Plaid Retrieve Liabilities data hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.processorliabilitiesget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-report-whether-you-initiated description: Plaid Report whether you initiated an ACH transaction hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.processorsignaldecisionreport with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-evaluate-planned-ach-transaction description: Plaid Evaluate a planned ACH transaction hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.processorsignalevaluate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-opt-processor-token-signal description: Plaid Opt-in a processor token to Signal hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.processorsignalprepare with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-report-return-ach-transaction description: Plaid Report a return for an ACH transaction hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.processorsignalreturnreport with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-stripe-bank-account description: Plaid Create Stripe bank account token hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.processorstripebankaccounttokencreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-processor-token description: Plaid Create processor token hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.processortokencreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-processor-token-s-product description: Plaid Get a processor token's product permissions hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.processortokenpermissionsget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-control-processor-s-access-products description: Plaid Control a processor's access to products hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.processortokenpermissionsset with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-update-processor-token-s-webhook description: Plaid Update a processor token's webhook URL hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.processortokenwebhookupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-transaction-data description: Plaid Get transaction data hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.processortransactionsget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-fetch-recurring-transaction-streams description: Plaid Fetch recurring transaction streams hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.processortransactionsrecurringget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-refresh-transaction-data description: Plaid Refresh transaction data hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.processortransactionsrefresh with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-incremental-transaction-updates description: Plaid Get incremental transaction updates on a processor token hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.processortransactionssync with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-profile description: Plaid Retrieve a Profile hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.profileget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-manually-fire-bank-income description: Plaid Manually fire a bank income webhook in sandbox hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.sandboxbankincomefirewebhook with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-manually-fire-bank-transfer description: Plaid Manually fire a Bank Transfer webhook hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.sandboxbanktransferfirewebhook with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-simulate-bank-transfer-event description: Plaid Simulate a bank transfer event in Sandbox hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.sandboxbanktransfersimulate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-manually-fire-income-webhook description: Plaid Manually fire an Income webhook hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.sandboxincomefirewebhook with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-fire-test-webhook description: Plaid Fire a test webhook hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.sandboxitemfirewebhook with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-force-sandbox-item-error description: Plaid Force a Sandbox Item into an error state hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.sandboxitemresetlogin with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-set-verification-status-sandbox description: Plaid Set verification status for Sandbox account hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.sandboxitemsetverificationstatus with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-save-selected-accounts-when description: Plaid Save the selected accounts when connecting to the Platypus Oauth institution hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.sandboxoauthselectaccounts with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-reset-login-payment-profile description: Plaid Reset the login of a Payment Profile hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.sandboxpaymentprofileresetlogin with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-test-item-and description: Plaid Create a test Item and processor token hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.sandboxprocessortokencreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-test-item description: Plaid Create a test Item hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.sandboxpublictokencreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-manually-fire-transfer-webhook description: Plaid Manually fire a Transfer webhook hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.sandboxtransferfirewebhook with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-simulate-ledger-deposit-event description: Plaid Simulate a ledger deposit event in Sandbox hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.sandboxtransferledgerdepositsimulate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-simulate-converting-pending-balance description: Plaid Simulate converting pending balance to available balance hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.sandboxtransferledgersimulateavailable with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-simulate-ledger-withdraw-event description: Plaid Simulate a ledger withdraw event in Sandbox hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.sandboxtransferledgerwithdrawsimulate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-simulate-refund-event-sandbox description: Plaid Simulate a refund event in Sandbox hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.sandboxtransferrefundsimulate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-trigger-creation-repayment description: Plaid Trigger the creation of a repayment hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.sandboxtransferrepaymentsimulate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-simulate-transfer-event-sandbox description: Plaid Simulate a transfer event in Sandbox hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.sandboxtransfersimulate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-simulate-creating-sweep description: Plaid Simulate creating a sweep hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.sandboxtransfersweepsimulate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-advance-test-clock description: Plaid Advance a test clock hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.sandboxtransfertestclockadvance with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-test-clock description: Plaid Create a test clock hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.sandboxtransfertestclockcreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-test-clock description: Plaid Get a test clock hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.sandboxtransfertestclockget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-list-test-clocks description: Plaid List test clocks hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.sandboxtransfertestclocklist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-report-whether-you-initiated-2 description: Plaid Report whether you initiated an ACH transaction hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.signaldecisionreport with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-evaluate-planned-ach-transaction-2 description: Plaid Evaluate a planned ACH transaction hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.signalevaluate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-opt-item-signal description: Plaid Opt-in an Item to Signal hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.signalprepare with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-report-return-ach-transaction-2 description: Plaid Report a return for an ACH transaction hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.signalreturnreport with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-single-statement description: Plaid Retrieve a single statement. hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.statementsdownload with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-list-all-statements description: Plaid Retrieve a list of all statements associated with an item. hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.statementslist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-refresh-statements-data description: Plaid Refresh statements data. hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.statementsrefresh with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-enrich-locally-held-transaction description: Plaid Enrich locally-held transaction data hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.transactionsenrich with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-transaction-data-2 description: Plaid Get transaction data hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.transactionsget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-fetch-recurring-transaction-streams-2 description: Plaid Fetch recurring transaction streams hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.transactionsrecurringget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-refresh-transaction-data-2 description: Plaid Refresh transaction data hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.transactionsrefresh with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-incremental-transaction-updates-2 description: Plaid Get incremental transaction updates on an Item hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.transactionssync with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-cancel-transfer-authorization description: Plaid Cancel a transfer authorization hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.transferauthorizationcancel with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-transfer-authorization description: Plaid Create a transfer authorization hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.transferauthorizationcreate with: body: tools.body outputParameters: - type: object mapping: $. - name: deprecated-retrieve-balance-held-plaid description: (Deprecated) Retrieve a balance held with Plaid hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.transferbalanceget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-cancel-transfer description: Plaid Cancel a transfer hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.transfercancel with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-rtp-eligibility-information description: Plaid Get RTP eligibility information of a transfer hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.transfercapabilitiesget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-transfer-product-configuration description: Plaid Get transfer product configuration hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.transferconfigurationget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-transfer description: Plaid Create a transfer hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.transfercreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-upload-transfer-diligence-document description: Plaid Upload transfer diligence document on behalf of the originator hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.transferdiligencedocumentupload with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-submit-transfer-diligence-behalf description: Plaid Submit transfer diligence on behalf of the originator hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.transferdiligencesubmit with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-list-transfer-events description: Plaid List transfer events hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.transfereventlist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-sync-transfer-events description: Plaid Sync transfer events hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.transfereventsync with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-transfer description: Plaid Retrieve a transfer hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.transferget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-transfer-intent-object description: Plaid Create a transfer intent object to invoke the Transfer UI hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.transferintentcreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-more-information-about description: Plaid Retrieve more information about a transfer intent hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.transferintentget with: body: tools.body outputParameters: - type: object mapping: $. - name: deposit-funds-plaid-ledger-balance description: Deposit funds into a Plaid Ledger balance hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.transferledgerdeposit with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-move-available-balance-between description: Plaid Move available balance between the ledgers of the platform and one of its originators hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.transferledgerdistribute with: body: tools.body outputParameters: - type: object mapping: $. - name: retrieve-plaid-ledger-balance description: Retrieve Plaid Ledger balance hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.transferledgerget with: body: tools.body outputParameters: - type: object mapping: $. - name: withdraw-funds-plaid-ledger-balance description: Withdraw funds from a Plaid Ledger balance hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.transferledgerwithdraw with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-list-transfers description: Plaid List transfers hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.transferlist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-transfer-product-usage description: Plaid Get transfer product usage metrics hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.transfermetricsget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-migrate-account-transfers description: Plaid Migrate account into Transfers hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.transfermigrateaccount with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-new-originator description: Plaid Create a new originator hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.transferoriginatorcreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-update-funding-account-associated description: Plaid Update the funding account associated with the originator hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.transferoriginatorfundingaccountupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-status-originator-s-onboarding description: Plaid Get status of an originator's onboarding hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.transferoriginatorget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-status-all-originators description: Plaid Get status of all originators' onboarding hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.transferoriginatorlist with: body: tools.body outputParameters: - type: object mapping: $. - name: generate-plaid-hosted-onboarding-ui description: Generate a Plaid-hosted onboarding UI URL. hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.transferquestionnairecreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-cancel-recurring-transfer description: Plaid Cancel a recurring transfer. hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.transferrecurringcancel with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-recurring-transfer description: Plaid Create a recurring transfer hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.transferrecurringcreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-recurring-transfer description: Plaid Retrieve a recurring transfer hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.transferrecurringget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-list-recurring-transfers description: Plaid List recurring transfers hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.transferrecurringlist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-cancel-refund description: Plaid Cancel a refund hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.transferrefundcancel with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-refund description: Plaid Create a refund hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.transferrefundcreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-refund description: Plaid Retrieve a refund hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.transferrefundget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-lists-historical-repayments description: Plaid Lists historical repayments hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.transferrepaymentlist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-list-returns-included-repayment description: Plaid List the returns included in a repayment hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.transferrepaymentreturnlist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-sweep-2 description: Plaid Retrieve a sweep hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.transfersweepget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-list-sweeps-2 description: Plaid List sweeps hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.transfersweeplist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-user description: Plaid Create user hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.usercreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-update-user-information description: Plaid Update user information hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.userupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-e-wallet description: Plaid Create an e-wallet hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.walletcreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-fetch-e-wallet description: Plaid Fetch an e-wallet hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.walletget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-fetch-list-e-wallets description: Plaid Fetch a list of e-wallets hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.walletlist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-execute-transaction-using-e description: Plaid Execute a transaction using an e-wallet hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.wallettransactionexecute with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-fetch-e-wallet-transaction description: Plaid Fetch an e-wallet transaction hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.wallettransactionget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-list-e-wallet-transactions description: Plaid List e-wallet transactions hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.wallettransactionlist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-watchlist-screening-entity description: Plaid Create a watchlist screening for an entity hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.watchlistscreeningentitycreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-entity-screening description: Plaid Get an entity screening hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.watchlistscreeningentityget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-list-history-entity-watchlist description: Plaid List history for entity watchlist screenings hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.watchlistscreeningentityhistorylist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-list-hits-entity-watchlist description: Plaid List hits for entity watchlist screenings hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.watchlistscreeningentityhitlist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-list-entity-watchlist-screenings description: Plaid List entity watchlist screenings hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.watchlistscreeningentitylist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-entity-watchlist-screening description: Plaid Get entity watchlist screening program hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.watchlistscreeningentityprogramget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-list-entity-watchlist-screening description: Plaid List entity watchlist screening programs hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.watchlistscreeningentityprogramlist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-review-entity-watchlist description: Plaid Create a review for an entity watchlist screening hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.watchlistscreeningentityreviewcreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-list-reviews-entity-watchlist description: Plaid List reviews for entity watchlist screenings hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.watchlistscreeningentityreviewlist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-update-entity-screening description: Plaid Update an entity screening hints: readOnly: false destructive: false idempotent: false call: plaid-plaid.watchlistscreeningentityupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-watchlist-screening-person description: Plaid Create a watchlist screening for a person hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.watchlistscreeningindividualcreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-retrieve-individual-watchlist-screening description: Plaid Retrieve an individual watchlist screening hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.watchlistscreeningindividualget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-list-history-individual-watchlist description: Plaid List history for individual watchlist screenings hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.watchlistscreeningindividualhistorylist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-list-hits-individual-watchlist description: Plaid List hits for individual watchlist screening hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.watchlistscreeningindividualhitlist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-list-individual-watchlist-screenings description: Plaid List Individual Watchlist Screenings hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.watchlistscreeningindividuallist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-individual-watchlist-screening description: Plaid Get individual watchlist screening program hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.watchlistscreeningindividualprogramget with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-list-individual-watchlist-screening description: Plaid List individual watchlist screening programs hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.watchlistscreeningindividualprogramlist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-create-review-individual-watchlist description: Plaid Create a review for an individual watchlist screening hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.watchlistscreeningindividualreviewcreate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-list-reviews-individual-watchlist description: Plaid List reviews for individual watchlist screenings hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.watchlistscreeningindividualreviewlist with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-update-individual-watchlist-screening description: Plaid Update individual watchlist screening hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.watchlistscreeningindividualupdate with: body: tools.body outputParameters: - type: object mapping: $. - name: plaid-get-webhook-verification-key description: Plaid Get webhook verification key hints: readOnly: true destructive: false idempotent: false call: plaid-plaid.webhookverificationkeyget with: body: tools.body outputParameters: - type: object mapping: $.