Finance — entry 033 of 47

Plaid

Verified Jul 2026

Plaid links apps to end users' US, Canadian, and UK/EU bank accounts, exposing products for account and identity verification, balance and transaction history, income/asset checks, and (via Transfer) ACH money movement, all authenticated with a client_id/secret pair and returned as JSON. New integrators get an indefinite free Sandbox plus a Limited Production tier capped at 200 live calls per product; beyond that, production is billed Pay-as-you-go, on a 12-month Growth contract, or Custom enterprise terms, combining one-time, monthly, and per-request fees with no flat public price list. A live probe of production.plaid.com found no Access-Control-Allow-Origin header on a POST request, confirming CORS is disabled.

open-bankingbank-linkingtransactionsidentity-verificationfintech

Visit plaid.com ↗Read the docs ↗Status ↗More Finance

AuthenticationAPI KeySign up with the provider to obtain credentials.

HTTPSSupportedTraffic is encrypted in transit.

CORSDisabledBrowser calls need a server-side proxy.

PricingFreemiumA usable free tier exists, with paid plans for more volume.

FormatsJSONResponses can be requested as JSON.

GreatAPIs Score

Score81out of 100

Authentication15/25API key required

Pricing17/20Freemium tier available

Docs20/20Machine-readable spec file bundled

Formats9/15Single response format

Freshness20/20Verified within 6 months

Embed this badge

<a href="https://greatapis.com/api/plaid/"><img src="https://greatapis.com/badge/plaid.svg" alt="Scored 81 on greatapis.com"></a>

Auth quickstart

Sign up with the provider to get an API key.
Send it on every request as a headerAuthorization: <key>
The exact header isn't documented — Authorization is a common default; confirm in the provider's docs.

Stored keyNo key stored

Your key is stored only in this browser (localStorage) and sent directly to the API — never to greatapis.

Endpoints

Servers

https://production.plaid.comhttps://sandbox.plaid.com

Auth

clientIdsecretplaidVersion

plaid331

The Plaid API

POST/accounts/balance/getRetrieve real-time balance data

Request body

application/json — AccountsBalanceGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`AccountsGetResponse`
`default`	Error response	`PlaidError`

POST/accounts/getRetrieve accounts

Request body

application/json — AccountsGetRequest (required)

Responses

Status	Description	Schema
`200`	success	`AccountsGetResponse`
`default`	Error response.	`PlaidError`

POST/application/getRetrieve information about a Plaid application

Request body

application/json — ApplicationGetRequest (required)

Responses

Status	Description	Schema
`200`	success	`ApplicationGetResponse`
`default`	Error response.	`PlaidError`

POST/asset_report/audit_copy/createCreate Asset Report Audit Copy

Request body

application/json — AssetReportAuditCopyCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`AssetReportAuditCopyCreateResponse`
`default`	Error response	`PlaidError`

POST/asset_report/audit_copy/getRetrieve an Asset Report Audit Copy

Request body

application/json — AssetReportAuditCopyGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`AssetReportGetResponse`
`default`	Error response	`PlaidError`

POST/asset_report/audit_copy/pdf/getRetrieve a PDF Asset Report Audit Copy

Request body

application/json — AssetReportAuditCopyPdfGetRequest (required)

Responses

Status	Description	Schema
`200`	A PDF of the Asset Report Audit Copy	`AssetReportAuditCopyPdfGetResponse`
`default`	Error response	`PlaidError`

POST/asset_report/audit_copy/removeRemove Asset Report Audit Copy

Request body

application/json — AssetReportAuditCopyRemoveRequest (required)

Responses

Status	Description	Schema
`200`	OK	`AssetReportAuditCopyRemoveResponse`
`default`	Error response	`PlaidError`

POST/asset_report/createCreate an Asset Report

Request body

application/json — AssetReportCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`AssetReportCreateResponse`
`default`	Error response	`PlaidError`

POST/asset_report/filterFilter Asset Report

Request body

application/json — AssetReportFilterRequest (required)

Responses

Status	Description	Schema
`200`	OK	`AssetReportFilterResponse`
`default`	Error response	`PlaidError`

POST/asset_report/getRetrieve an Asset Report

Request body

application/json — AssetReportGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`AssetReportGetResponse`
`default`	Error response	`PlaidError`

POST/asset_report/pdf/getRetrieve a PDF Asset Report

Request body

application/json — AssetReportPDFGetRequest (required)

Responses

Status	Description	Schema
`200`	A PDF of the Asset Report	`AssetReportPDFGetResponse`
`default`	Error response	`PlaidError`

POST/asset_report/refreshRefresh an Asset Report

Request body

application/json — AssetReportRefreshRequest (required)

Responses

Status	Description	Schema
`200`	OK	`AssetReportRefreshResponse`
`default`	Error response	`PlaidError`

POST/asset_report/removeDelete an Asset Report

Request body

application/json — AssetReportRemoveRequest (required)

Responses

Status	Description	Schema
`200`	OK	`AssetReportRemoveResponse`
`default`	Error response	`PlaidError`

POST/auth/getRetrieve auth data

Request body

application/json — AuthGetRequest (required)

Responses

Status	Description	Schema
`200`	success	`AuthGetResponse`
`default`	Default error	`PlaidError`

POST/auth/verifyVerify auth data

Request body

application/json — AuthVerifyRequest (required)

Responses

Status	Description	Schema
`200`	success	`AuthVerifyResponse`
`default`	Default error	`PlaidError`

POST/bank_transfer/balance/getGet balance of your Bank Transfer account

Request body

application/json — BankTransferBalanceGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`BankTransferBalanceGetResponse`
`default`	Error response	`PlaidError`

POST/bank_transfer/cancelCancel a bank transfer

Request body

application/json — BankTransferCancelRequest (required)

Responses

Status	Description	Schema
`200`	OK	`BankTransferCancelResponse`
`default`	Error response	`PlaidError`

POST/bank_transfer/createCreate a bank transfer

Request body

application/json — BankTransferCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`BankTransferCreateResponse`
`default`	Error response	`PlaidError`

POST/bank_transfer/event/listList bank transfer events

Request body

application/json — BankTransferEventListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`BankTransferEventListResponse`
`default`	Error response	`PlaidError`

POST/bank_transfer/event/syncSync bank transfer events

Request body

application/json — BankTransferEventSyncRequest (required)

Responses

Status	Description	Schema
`200`	OK	`BankTransferEventSyncResponse`
`default`	Error response	`PlaidError`

POST/bank_transfer/getRetrieve a bank transfer

Request body

application/json — BankTransferGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`BankTransferGetResponse`
`default`	Error response	`PlaidError`

POST/bank_transfer/listList bank transfers

Request body

application/json — BankTransferListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`BankTransferListResponse`
`default`	Error response	`PlaidError`

POST/bank_transfer/migrate_accountMigrate account into Bank Transfers

Request body

application/json — BankTransferMigrateAccountRequest (required)

Responses

Status	Description	Schema
`200`	OK	`BankTransferMigrateAccountResponse`
`default`	Error response	`PlaidError`

POST/bank_transfer/sweep/getRetrieve a sweep

Request body

application/json — BankTransferSweepGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`BankTransferSweepGetResponse`
`default`	Error response	`PlaidError`

POST/bank_transfer/sweep/listList sweeps

Request body

application/json — BankTransferSweepListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`BankTransferSweepListResponse`
`default`	Error response	`PlaidError`

POST/beacon/account_risk/v1/evaluateEvaluate risk of a bank account

Request body

application/json — BeaconAccountRiskEvaluateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`BeaconAccountRiskEvaluateResponse`
`default`	Error response.	`PlaidError`

POST/beacon/duplicate/getGet a Beacon Duplicate

Request body

application/json — BeaconDuplicateGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`BeaconDuplicateGetResponse`

POST/beacon/report/createCreate a Beacon Report

Request body

application/json — BeaconReportCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`BeaconReportCreateResponse`

POST/beacon/report/getGet a Beacon Report

Request body

application/json — BeaconReportGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`BeaconReportGetResponse`

POST/beacon/report/listList Beacon Reports for a Beacon User

Request body

application/json — BeaconReportListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`BeaconReportListResponse`

POST/beacon/report_syndication/getGet a Beacon Report Syndication

Request body

application/json — BeaconReportSyndicationGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`BeaconReportSyndicationGetResponse`

POST/beacon/report_syndication/listList Beacon Report Syndications for a Beacon User

Request body

application/json — BeaconReportSyndicationListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`BeaconReportSyndicationListResponse`

POST/beacon/user/account_insights/getGet Account Insights for a Beacon User

Request body

application/json — BeaconUserAccountInsightsGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`BeaconUserAccountInsightsGetResponse`

POST/beacon/user/createCreate a Beacon User

Request body

application/json — BeaconUserCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`BeaconUserCreateResponse`

POST/beacon/user/getGet a Beacon User

Request body

application/json — BeaconUserGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`BeaconUserGetResponse`

POST/beacon/user/history/listList a Beacon User's history

Request body

application/json — BeaconUserHistoryListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`BeaconUserHistoryListResponse`

POST/beacon/user/reviewReview a Beacon User

Request body

application/json — BeaconUserReviewRequest (required)

Responses

Status	Description	Schema
`200`	OK	`BeaconUserGetResponse`

POST/beacon/user/updateUpdate the identity data of a Beacon User

Request body

application/json — BeaconUserUpdateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`BeaconUserUpdateResponse`

POST/beta/credit/v1/bank_employment/getRetrieve information from the bank accounts used for employment verification

Request body

application/json — CreditBankEmploymentGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CreditBankEmploymentGetResponse`
`default`	Error response	`PlaidError`

POST/beta/ewa_report/v1/getGet EWA Score Report

Request body

application/json — BetaEwaReportV1GetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`BetaEwaReportV1GetResponse`
`default`	Error response	`PlaidError`

POST/beta/partner/customer/v1/createCreates a new end customer for a Plaid reseller.

Request body

application/json — BetaPartnerCustomerV1CreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`BetaPartnerCustomerV1CreateResponse`
`default`	Error response	`PlaidError`

POST/beta/partner/customer/v1/enableEnables a Plaid reseller's end customer in the Production environment.

Request body

application/json — BetaPartnerCustomerV1EnableRequest (required)

Responses

Status	Description	Schema
`200`	OK	`BetaPartnerCustomerV1EnableResponse`
`default`	Error response	`PlaidError`

POST/beta/partner/customer/v1/getRetrieves the details of a Plaid reseller's end customer.

Request body

application/json — BetaPartnerCustomerV1GetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`BetaPartnerCustomerV1GetResponse`
`default`	Error response	`PlaidError`

POST/beta/partner/customer/v1/updateUpdates an existing end customer.

Request body

application/json — BetaPartnerCustomerV1UpdateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`BetaPartnerCustomerV1UpdateResponse`
`default`	Error response	`PlaidError`

POST/beta/transactions/rules/v1/createCreate transaction category rule

Request body

application/json — TransactionsRulesCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransactionsRulesCreateResponse`
`default`	Error response	`PlaidError`

POST/beta/transactions/rules/v1/listReturn a list of rules created for the Item associated with the access token.

Request body

application/json — TransactionsRulesListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransactionsRulesListResponse`
`default`	Error response	`PlaidError`

POST/beta/transactions/rules/v1/removeRemove transaction rule

Request body

application/json — TransactionsRulesRemoveRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransactionsRulesRemoveResponse`
`default`	Error response	`PlaidError`

POST/beta/transactions/user_insights/v1/getObtain user insights based on transactions sent through /transactions/enrich

Request body

application/json — TransactionsUserInsightsGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransactionsUserInsightsGetResponse`
`default`	Error response	`PlaidError`

POST/beta/transactions/v1/enhanceEnhance locally-held transaction data

Request body

application/json — TransactionsEnhanceGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransactionsEnhanceGetResponse`
`default`	Error response	`PlaidError`

POST/business_verification/createCreate a Business Verification

Request body

application/json — BusinessVerificationCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`BusinessVerificationCreateResponse`

POST/business_verification/getGet a Business Verification

Request body

application/json — BusinessVerificationGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`BusinessVerificationGetResponse`

POST/cashflow_report/getGets transaction data in `cashflow_report`

Request body

application/json — CashflowReportGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CashflowReportGetResponse`
`default`	Error response	`PlaidError`

POST/cashflow_report/insights/getGets insights data in Cashflow Report

Request body

application/json — CashflowReportInsightsGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CashflowReportInsightsGetResponse`
`default`	Error response	`PlaidError`

POST/cashflow_report/refreshRefresh transaction data in `cashflow_report`

Request body

application/json — CashflowReportRefreshRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CashflowReportRefreshResponse`
`default`	Error response	`PlaidError`

POST/cashflow_report/transactions/getGets transaction data in `cashflow_report`

Request body

application/json — CashflowReportTransactionsGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CashflowReportTransactionsGetResponse`
`default`	Error response	`PlaidError`

POST/categories/get(Deprecated) Get legacy categories

Request body

application/json — CategoriesGetRequest (required)

Responses

Status	Description	Schema
`200`	success	`CategoriesGetResponse`
`default`	Error response.	`PlaidError`

POST/consent/events/getList a historical log of item consent events

Request body

application/json — ConsentEventsGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ConsentEventsGetResponse`
`default`	Error response.	`PlaidError`

POST/consumer_report/pdf/getRetrieve PDF Reports

Request body

application/json — ConsumerReportPDFGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ConsumerReportPDFGetResponse`
`default`	Error response	`PlaidError`

POST/cra/check_report/base_report/getRetrieve a Base Report

Request body

application/json — CraCheckReportBaseReportGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CraCheckReportBaseReportGetResponse`
`default`	Error response	`PlaidError`

POST/cra/check_report/cashflow_insights/getRetrieve cash flow insights from your user's banking data

Request body

application/json — CraCheckReportCashflowInsightsGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CraCheckReportCashflowInsightsGetResponse`
`default`	Error response	`PlaidError`

POST/cra/check_report/createRefresh or create a Consumer Report

Request body

application/json — CraCheckReportCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CraCheckReportCreateResponse`
`default`	Error response	`PlaidError`

POST/cra/check_report/income_insights/getRetrieve cash flow information from your user's banks

Request body

application/json — CraCheckReportIncomeInsightsGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CraCheckReportIncomeInsightsGetResponse`
`default`	Error response	`PlaidError`

POST/cra/check_report/lend_score/getRetrieve the LendScore from your user's banking data

Request body

application/json — CraCheckReportLendScoreGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CraCheckReportLendScoreGetResponse`
`default`	Error response	`PlaidError`

POST/cra/check_report/network_insights/getRetrieve network attributes for the user

Request body

application/json — CraCheckReportNetworkInsightsGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CraCheckReportNetworkInsightsGetResponse`
`default`	Error response	`PlaidError`

POST/cra/check_report/partner_insights/getRetrieve cash flow insights from partners

Request body

application/json — CraCheckReportPartnerInsightsGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CraCheckReportPartnerInsightsGetResponse`
`default`	Error response	`PlaidError`

POST/cra/check_report/pdf/getRetrieve a Consumer Report as a PDF

Request body

application/json — CraCheckReportPDFGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CraCheckReportPDFGetResponse`
`default`	Error response	`PlaidError`

POST/cra/check_report/verification/getRetrieve various home lending reports for a user

Request body

application/json — CraCheckReportVerificationGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CraCheckReportVerificationGetResponse`
`default`	Error response	`PlaidError`

POST/cra/check_report/verification/pdf/getRetrieve a Consumer Report as a Verification PDF

Request body

application/json — CraCheckReportVerificationPdfGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CraCheckReportVerificationPdfGetResponse`
`default`	Error response	`PlaidError`

POST/cra/credit_profile/report/getRetrieve the credit profile report for a user

Request body

application/json — CraCreditProfileReportGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CraCreditProfileReportGetResponse`
`default`	Error response	`PlaidError`

POST/cra/loans/applications/registerRegister loan applications and decisions

Request body

application/json — CraLoansApplicationsRegisterRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CraLoansApplicationsRegisterResponse`
`default`	Error response	`PlaidError`

POST/cra/loans/registerRegister a list of loans to their applicants

Request body

application/json — CRALoansRegisterRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CraLoansRegisterResponse`
`default`	Error response	`PlaidError`

POST/cra/loans/unregisterUnregister a list of loans

Request body

application/json — CraLoansUnregisterRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CraLoanUnregisterResponse`
`default`	Error response	`PlaidError`

POST/cra/loans/updateUpdate loan data

Request body

application/json — CraLoansUpdateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CraLoansUpdateResponse`
`default`	Error response	`PlaidError`

POST/cra/monitoring_insights/getRetrieve a Monitoring Insights Report

Request body

application/json — CraMonitoringInsightsGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CraMonitoringInsightsGetResponse`
`default`	Error response	`PlaidError`

POST/cra/monitoring_insights/subscribeSubscribe to Monitoring Insights

Request body

application/json — CraMonitoringInsightsSubscribeRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CraMonitoringInsightsSubscribeResponse`
`default`	Error response	`PlaidError`

POST/cra/monitoring_insights/unsubscribeUnsubscribe from Monitoring Insights

Request body

application/json — CraMonitoringInsightsUnsubscribeRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CraMonitoringInsightsUnsubscribeResponse`
`default`	Error response	`PlaidError`

POST/cra/partner_insights/getRetrieve cash flow insights from the bank accounts used for income verification

Request body

application/json — CraPartnerInsightsGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CraPartnerInsightsGetResponse`
`default`	Error response	`PlaidError`

POST/credit/asset_report/freddie_mac/getRetrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint.

Request body

application/json — AssetReportFreddieGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`AssetReportFreddieGetResponse`
`default`	Error response	`PlaidError`

POST/credit/audit_copy_token/createCreate Asset or Income Report Audit Copy Token

Request body

application/json — CreditAuditCopyTokenCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CreditAuditCopyTokenCreateResponse`
`default`	Error response	`PlaidError`

POST/credit/audit_copy_token/removeRemove an Audit Copy token

Request body

application/json — CreditAuditCopyTokenRemoveRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CreditAuditCopyTokenRemoveResponse`
`default`	Error response	`PlaidError`

POST/credit/audit_copy_token/updateUpdate an Audit Copy Token

Request body

application/json — CreditAuditCopyTokenUpdateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CreditAuditCopyTokenUpdateResponse`
`default`	Error response	`PlaidError`

POST/credit/bank_income/getRetrieve information from the bank accounts used for income verification

Request body

application/json — CreditBankIncomeGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CreditBankIncomeGetResponse`
`default`	Error response	`PlaidError`

POST/credit/bank_income/pdf/getRetrieve information from the bank accounts used for income verification in PDF format

Request body

application/json — CreditBankIncomePDFGetRequest (required)

Responses

Status	Description	Schema
`200`	A PDF of the Bank Income Report	`CreditBankIncomePDFGetResponse`
`default`	Error response	`PlaidError`

POST/credit/bank_income/refreshRefresh a user's bank income information

Request body

application/json — CreditBankIncomeRefreshRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CreditBankIncomeRefreshResponse`
`default`	Error response	`PlaidError`

POST/credit/bank_income/webhook/updateSubscribe and unsubscribe to proactive notifications for a user's income profile

Request body

application/json — CreditBankIncomeWebhookUpdateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CreditBankIncomeWebhookUpdateResponse`
`default`	Error response	`PlaidError`

POST/credit/bank_statements/uploads/getRetrieve data for a user's uploaded bank statements

Request body

application/json — CreditBankStatementsUploadsGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CreditBankStatementsUploadsGetResponse`
`default`	Error response.	`PlaidError`

POST/credit/employment/getRetrieve a summary of an individual's employment information

Request body

application/json — CreditEmploymentGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CreditEmploymentGetResponse`
`default`	Error response	`PlaidError`

POST/credit/freddie_mac/reports/getRetrieve 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.

Request body

application/json — CreditFreddieMacReportsGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CreditFreddieMacReportsGetResponse`
`default`	Error response	`PlaidError`

POST/credit/payroll_income/getRetrieve a user's payroll information

Request body

application/json — CreditPayrollIncomeGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CreditPayrollIncomeGetResponse`
`default`	Error response	`PlaidError`

POST/credit/payroll_income/parsing_config/updateUpdate the parsing configuration for a document income verification

Request body

application/json — CreditPayrollIncomeParsingConfigUpdateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CreditPayrollIncomeParsingConfigUpdateResponse`
`default`	Error response	`PlaidError`

POST/credit/payroll_income/precheckCheck income verification eligibility and optimize conversion

Request body

application/json — CreditPayrollIncomePrecheckRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CreditPayrollIncomePrecheckResponse`
`default`	Error response	`PlaidError`

POST/credit/payroll_income/refreshRefresh a digital payroll income verification

Request body

application/json — CreditPayrollIncomeRefreshRequest (required)

Responses

Status	Description	Schema
`200`	success	`CreditPayrollIncomeRefreshResponse`
`default`	Error response.	`PlaidError`

POST/credit/payroll_income/risk_signals/getRetrieve fraud insights for a user's manually uploaded document(s).

Request body

application/json — CreditPayrollIncomeRiskSignalsGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CreditPayrollIncomeRiskSignalsGetResponse`
`default`	Error response	`PlaidError`

POST/credit/relay/createCreate a relay token to share an Asset Report with a partner client

Request body

application/json — CreditRelayCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CreditRelayCreateResponse`
`default`	Error response	`PlaidError`

POST/credit/relay/getRetrieve the reports associated with a relay token that was shared with you

Request body

application/json — CreditRelayGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`AssetReportGetResponse`
`default`	Error response	`PlaidError`

POST/credit/relay/pdf/getRetrieve the pdf reports associated with a relay token that was shared with you (beta)

Request body

application/json — CreditRelayPDFGetRequest (required)

Responses

Status	Description	Schema
`200`	A PDF of the Asset Report	`CreditRelayPDFGetResponse`
`default`	Error response	`PlaidError`

POST/credit/relay/refreshRefresh a report of a relay token

Request body

application/json — CreditRelayRefreshRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CreditRelayRefreshResponse`
`default`	Error response	`PlaidError`

POST/credit/relay/removeRemove relay token

Request body

application/json — CreditRelayRemoveRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CreditRelayRemoveResponse`
`default`	Error response	`PlaidError`

POST/credit/sessions/getRetrieve Link sessions for your user

Request body

application/json — CreditSessionsGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`CreditSessionsGetResponse`
`default`	Error response	`PlaidError`

POST/dashboard_user/getRetrieve a Dashboard user

Request body

application/json — DashboardUserGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`DashboardUserGetResponse`

POST/dashboard_user/listList Dashboard users

Request body

application/json — DashboardUserListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`DashboardUserListResponse`

POST/employers/searchSearch employer database

Request body

application/json — EmployersSearchRequest (required)

Responses

Status	Description	Schema
`200`	OK	`EmployersSearchResponse`
`default`	Error response	`PlaidError`

POST/employment/verification/get(Deprecated) Retrieve a summary of an individual's employment information

Request body

application/json — EmploymentVerificationGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`EmploymentVerificationGetResponse`
`default`	Error response	`PlaidError`

GET/fdx/consents/{consentId}Get FDX Consent Grant

Parameters

Name	In	Required	Type
`consentId`	path	yes	string

Responses

Status	Description	Schema
`200`	OK	`FDXConsentGrant`
`default`	Error response	`PlaidError`

GET/fdx/consents/{consentId}/revocationRetrieve FDX Consent Grant revocation records

Parameters

Name	In	Required	Type
`consentId`	path	yes	string

Responses

Status	Description	Schema
`200`	OK	`FDXConsentRevocations`
`default`	Error response	`PlaidError`

PUT/fdx/consents/{consentId}/revocationRevoke FDX Consent Grant

Parameters

Name	In	Required	Type
`consentId`	path	yes	string

Request body

application/json — FDXConsentRevocation (required)

Responses

Status	Description	Schema
`204`	No Content	—
`default`	Error response	`PlaidError`

POST/fdx/notificationsWebhook receiver for fdx notifications

Request body

application/json — FDXNotification (required)

Responses

Status	Description	Schema
`200`	OK	—
`default`	Error response.	`PlaidError`

GET/fdx/recipient/{recipientId}Get Recipient

Parameters

Name	In	Required	Type
`recipientId`	path	yes	string
`OAUTH-STATE-ID`	header	no	string

Responses

Status	Description	Schema
`200`	OK	`GetRecipientResponse`
`default`	Error response	`PlaidError`

GET/fdx/recipientsGet Recipients

Responses

Status	Description	Schema
`200`	OK	`GetRecipientsResponse`
`default`	Error response	`PlaidError`

POST/identity/documents/uploads/getReturns uploaded document identity

Request body

application/json — IdentityDocumentsUploadsGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`IdentityDocumentsUploadsGetResponse`
`default`	Error response	`PlaidError`

POST/identity/getRetrieve identity data

Request body

application/json — IdentityGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`IdentityGetResponse`
`default`	Error response	`PlaidError`

POST/identity/matchRetrieve identity match score

Request body

application/json — IdentityMatchRequest (required)

Responses

Status	Description	Schema
`200`	OK	`IdentityMatchResponse`
`default`	Error response	`PlaidError`

POST/identity/refreshRefresh identity data

Request body

application/json — IdentityRefreshRequest (required)

Responses

Status	Description	Schema
`200`	OK	`IdentityRefreshResponse`
`default`	Error response	`PlaidError`

POST/identity_verification/autofill/createCreate autofill for an Identity Verification

Request body

application/json — IdentityVerificationAutofillCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`IdentityVerificationAutofillCreateResponse`

POST/identity_verification/createCreate a new Identity Verification

Request body

application/json — IdentityVerificationCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`IdentityVerificationCreateResponse`

POST/identity_verification/getRetrieve Identity Verification

Request body

application/json — IdentityVerificationGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`IdentityVerificationGetResponse`

POST/identity_verification/listList Identity Verifications

Request body

application/json — IdentityVerificationListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`IdentityVerificationListResponse`

POST/identity_verification/retryRetry an Identity Verification

Request body

application/json — IdentityVerificationRetryRequest (required)

Responses

Status	Description	Schema
`200`	OK	`IdentityVerificationRetryResponse`

POST/income/verification/create(Deprecated) Create an income verification instance

Request body

application/json — IncomeVerificationCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`IncomeVerificationCreateResponse`
`default`	Error response	`PlaidError`

POST/income/verification/documents/download(Deprecated) Download the original documents used for income verification

Request body

application/json — IncomeVerificationDocumentsDownloadRequest (required)

Responses

Status	Description	Schema
`200`	A ZIP file containing source documents(s) used as the basis for income verification.	—
`default`	Error response	`PlaidError`

POST/income/verification/paystubs/get(Deprecated) Retrieve information from the paystubs used for income verification

Request body

application/json — IncomeVerificationPaystubsGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`IncomeVerificationPaystubsGetResponse`
`default`	Error response	`PlaidError`

POST/income/verification/precheck(Deprecated) Check digital income verification eligibility and optimize conversion

Request body

application/json — IncomeVerificationPrecheckRequest (required)

Responses

Status	Description	Schema
`200`	OK	`IncomeVerificationPrecheckResponse`
`default`	Error response	`PlaidError`

POST/income/verification/taxforms/get(Deprecated) Retrieve information from the tax documents used for income verification

Request body

application/json — IncomeVerificationTaxformsGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`IncomeVerificationTaxformsGetResponse`
`default`	Error response.	`PlaidError`

POST/institutions/getGet details of all supported institutions

Request body

application/json — InstitutionsGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`InstitutionsGetResponse`
`default`	Error response	`PlaidError`

POST/institutions/get_by_idGet details of an institution

Request body

application/json — InstitutionsGetByIdRequest (required)

Responses

Status	Description	Schema
`200`	OK	`InstitutionsGetByIdResponse`
`default`	Error response	`PlaidError`

POST/institutions/searchSearch institutions

Request body

application/json — InstitutionsSearchRequest (required)

Responses

Status	Description	Schema
`200`	OK	`InstitutionsSearchResponse`
`default`	Error response	`PlaidError`

POST/investments/auth/getGet data needed to authorize an investments transfer

Request body

application/json — InvestmentsAuthGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`InvestmentsAuthGetResponse`
`default`	Error response	`PlaidError`

POST/investments/holdings/getGet Investment holdings

Request body

application/json — InvestmentsHoldingsGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`InvestmentsHoldingsGetResponse`
`default`	Error response	`PlaidError`

POST/investments/refreshRefresh investment data

Request body

application/json — InvestmentsRefreshRequest (required)

Responses

Status	Description	Schema
`200`	OK	`InvestmentsRefreshResponse`
`default`	Error response	`PlaidError`

POST/investments/transactions/getGet investment transactions

Request body

application/json — InvestmentsTransactionsGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`InvestmentsTransactionsGetResponse`
`default`	Error response	`PlaidError`

POST/issues/getGet an Issue

Request body

application/json — IssuesGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`IssuesGetResponse`
`default`	Error response	`PlaidError`

POST/issues/searchSearch for an Issue

Request body

application/json — IssuesSearchRequest (required)

Responses

Status	Description	Schema
`200`	OK	`IssuesSearchResponse`
`default`	Error response	`PlaidError`

POST/issues/subscribeSubscribe to an Issue

Request body

application/json — IssuesSubscribeRequest (required)

Responses

Status	Description	Schema
`200`	Subscription was successful	`IssuesSubscribeResponse`
`default`	Error response	`PlaidError`

POST/item/access_token/invalidateInvalidate access_token

Request body

application/json — ItemAccessTokenInvalidateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ItemAccessTokenInvalidateResponse`
`default`	Error response	`PlaidError`

POST/item/activity/listList a historical log of user consent events

Request body

application/json — ItemActivityListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ItemActivityListResponse`
`default`	Error response.	`PlaidError`

POST/item/application/listList a user's connected applications

Request body

application/json — ItemApplicationListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ItemApplicationListResponse`
`default`	Error response.	`PlaidError`

POST/item/application/scopes/updateUpdate the scopes of access for a particular application

Request body

application/json — ItemApplicationScopesUpdateRequest (required)

Responses

Status	Description	Schema
`200`	success	`ItemApplicationScopesUpdateResponse`
`default`	Error response.	`PlaidError`

POST/item/application/unlinkUnlink a user's connected application

Request body

application/json — ItemApplicationUnlinkRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ItemApplicationUnlinkResponse`
`default`	Error response.	`PlaidError`

POST/item/getRetrieve an Item

Request body

application/json — ItemGetRequest (required)

Responses

Status	Description	Schema
`200`	success	`ItemGetResponse`
`default`	Error response.	`PlaidError`

POST/item/importImport Item

Request body

application/json — ItemImportRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ItemImportResponse`
`default`	Error response	`PlaidError`

POST/item/products/terminateTerminate products for an Item

Request body

application/json — ItemProductsTerminateRequest (required)

Responses

Status	Description	Schema
`200`	success	`ItemProductsTerminateResponse`
`default`	Error response.	`PlaidError`

POST/item/public_token/createCreate public token

Request body

application/json — ItemPublicTokenCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ItemPublicTokenCreateResponse`
`default`	Error response	`PlaidError`

POST/item/public_token/exchangeExchange public token for an access token

Request body

application/json — ItemPublicTokenExchangeRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ItemPublicTokenExchangeResponse`
`default`	Error response	`PlaidError`

POST/item/removeRemove an Item

Request body

application/json — ItemRemoveRequest (required)

Responses

Status	Description	Schema
`200`	success	`ItemRemoveResponse`
`default`	Error response.	`PlaidError`

POST/item/webhook/updateUpdate Webhook URL

Request body

application/json — ItemWebhookUpdateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ItemWebhookUpdateResponse`
`default`	Error response	`PlaidError`

POST/liabilities/getRetrieve Liabilities data

Request body

application/json — LiabilitiesGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`LiabilitiesGetResponse`
`default`	Error response	`PlaidError`

POST/link/oauth/correlation_id/exchangeExchange the Link Correlation ID for a Link Token

Request body

application/json — LinkOAuthCorrelationIdExchangeRequest (required)

Responses

Status	Description	Schema
`200`	OK	`LinkOAuthCorrelationIdExchangeResponse`
`default`	Error response	`PlaidError`

POST/link/token/createCreate Link Token

Request body

application/json — LinkTokenCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`LinkTokenCreateResponse`
`default`	Error response	`PlaidError`

POST/link/token/getGet Link Token

Request body

application/json — LinkTokenGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`LinkTokenGetResponse`
`default`	Error response	`PlaidError`

POST/link_delivery/createCreate Hosted Link session

Request body

application/json — LinkDeliveryCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`LinkDeliveryCreateResponse`
`default`	Error response	`PlaidError`

POST/link_delivery/getGet Hosted Link session

Request body

application/json — LinkDeliveryGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`LinkDeliveryGetResponse`
`default`	Error response	`PlaidError`

POST/network/status/getCheck a user's Plaid Network status

Request body

application/json — NetworkStatusGetRequest (required)

Responses

Status	Description	Schema
`200`	success	`NetworkStatusGetResponse`
`default`	Error response.	`PlaidError`

POST/oauth/introspectGet metadata about an OAuth token

Request body

application/json — OAuthIntrospectRequest (required)

Responses

Status	Description	Schema
`200`	OK	`OAuthIntrospectResponse`
`default`	Error response.	`OAuthErrorResponse`

POST/oauth/revokeRevoke an OAuth token

Request body

application/json — OAuthRevokeRequest (required)

Responses

Status	Description	Schema
`200`	OK	`OAuthRevokeResponse`
`default`	Error response.	`OAuthErrorResponse`

POST/oauth/tokenCreate or refresh an OAuth access token

Request body

application/json — OAuthTokenRequest (required)

Responses

Status	Description	Schema
`200`	OK	`OAuthTokenResponse`
`default`	Error response.	`OAuthErrorResponse`

POST/partner/customer/createCreates a new end customer for a Plaid reseller.

Request body

application/json — PartnerCustomerCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`PartnerCustomerCreateResponse`
`default`	Error response	`PlaidError`

POST/partner/customer/enableEnables a Plaid reseller's end customer in the Production environment.

Request body

application/json — PartnerCustomerEnableRequest (required)

Responses

Status	Description	Schema
`200`	OK	`PartnerCustomerEnableResponse`
`default`	Error response	`PlaidError`

POST/partner/customer/getReturns a Plaid reseller's end customer.

Request body

application/json — PartnerCustomerGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`PartnerCustomerGetResponse`
`default`	Error response	`PlaidError`

POST/partner/customer/oauth_institutions/getReturns OAuth-institution registration information for a given end customer.

Request body

application/json — PartnerCustomerOAuthInstitutionsGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`PartnerCustomerOAuthInstitutionsGetResponse`
`default`	Error response	`PlaidError`

POST/partner/customer/removeRemoves a Plaid reseller's end customer.

Request body

application/json — PartnerCustomerRemoveRequest (required)

Responses

Status	Description	Schema
`200`	OK	`PartnerCustomerRemoveResponse`
`default`	Error response	`PlaidError`

POST/payment_initiation/consent/createCreate payment consent

Request body

application/json — PaymentInitiationConsentCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`PaymentInitiationConsentCreateResponse`
`default`	Error response	`PlaidError`

POST/payment_initiation/consent/getGet payment consent

Request body

application/json — PaymentInitiationConsentGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`PaymentInitiationConsentGetResponse`
`default`	Error response	`PlaidError`

POST/payment_initiation/consent/payment/executeExecute a single payment using consent

Request body

application/json — PaymentInitiationConsentPaymentExecuteRequest (required)

Responses

Status	Description	Schema
`200`	OK	`PaymentInitiationConsentPaymentExecuteResponse`
`default`	Error response	`PlaidError`

POST/payment_initiation/consent/revokeRevoke payment consent

Request body

application/json — PaymentInitiationConsentRevokeRequest (required)

Responses

Status	Description	Schema
`200`	OK	`PaymentInitiationConsentRevokeResponse`
`default`	Error response	`PlaidError`

POST/payment_initiation/payment/createCreate a payment

Request body

application/json — PaymentInitiationPaymentCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`PaymentInitiationPaymentCreateResponse`
`default`	Error response	`PlaidError`

POST/payment_initiation/payment/getGet payment details

Request body

application/json — PaymentInitiationPaymentGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`PaymentInitiationPaymentGetResponse`
`default`	Error response	`PlaidError`

POST/payment_initiation/payment/listList payments

Request body

application/json — PaymentInitiationPaymentListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`PaymentInitiationPaymentListResponse`
`default`	Error response	`PlaidError`

POST/payment_initiation/payment/reverseReverse an existing payment

Request body

application/json — PaymentInitiationPaymentReverseRequest (required)

Responses

Status	Description	Schema
`200`	OK	`PaymentInitiationPaymentReverseResponse`
`default`	Error response	`PlaidError`

POST/payment_initiation/payment/token/createCreate payment token

Request body

application/json — PaymentInitiationPaymentTokenCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`PaymentInitiationPaymentTokenCreateResponse`
`default`	Error response	`PlaidError`

POST/payment_initiation/recipient/createCreate payment recipient

Request body

application/json — PaymentInitiationRecipientCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`PaymentInitiationRecipientCreateResponse`
`default`	Error response	`PlaidError`

POST/payment_initiation/recipient/getGet payment recipient

Request body

application/json — PaymentInitiationRecipientGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`PaymentInitiationRecipientGetResponse`
`default`	Error response	`PlaidError`

POST/payment_initiation/recipient/listList payment recipients

Request body

application/json — PaymentInitiationRecipientListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`PaymentInitiationRecipientListResponse`
`default`	Error response	`PlaidError`

POST/payment_profile/createCreate payment profile

Request body

application/json — PaymentProfileCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`PaymentProfileCreateResponse`
`default`	Error response	`PlaidError`

POST/payment_profile/getGet payment profile

Request body

application/json — PaymentProfileGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`PaymentProfileGetResponse`
`default`	Error response	`PlaidError`

POST/payment_profile/removeRemove payment profile

Request body

application/json — PaymentProfileRemoveRequest (required)

Responses

Status	Description	Schema
`200`	OK	`PaymentProfileRemoveResponse`
`default`	Error response	`PlaidError`

POST/processor/account/getRetrieve the account associated with a processor token

Request body

application/json — ProcessorAccountGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ProcessorAccountGetResponse`
`default`	Error response	`PlaidError`

POST/processor/apex/processor_token/createCreate Apex bank account token

Request body

application/json — ProcessorApexProcessorTokenCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ProcessorTokenCreateResponse`
`default`	Error response	`PlaidError`

POST/processor/auth/getRetrieve Auth data

Request body

application/json — ProcessorAuthGetRequest (required)

Responses

Status	Description	Schema
`200`	success	`ProcessorAuthGetResponse`
`default`	Error response	`PlaidError`

POST/processor/balance/getRetrieve Balance data

Request body

application/json — ProcessorBalanceGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ProcessorBalanceGetResponse`
`default`	Error response	`PlaidError`

POST/processor/bank_transfer/createCreate a bank transfer as a processor

Request body

application/json — ProcessorBankTransferCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ProcessorBankTransferCreateResponse`
`default`	Error response	`PlaidError`

POST/processor/identity/getRetrieve Identity data

Request body

application/json — ProcessorIdentityGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ProcessorIdentityGetResponse`
`default`	Error response	`PlaidError`

POST/processor/identity/matchRetrieve identity match score

Request body

application/json — ProcessorIdentityMatchRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ProcessorIdentityMatchResponse`
`default`	Error response	`PlaidError`

POST/processor/investments/auth/getGet investment account authentication data

Request body

application/json — ProcessorInvestmentsAuthGetRequest (required)

Responses

Status	Description	Schema
`200`	success	`ProcessorInvestmentsAuthGetResponse`
`default`	Error response	`PlaidError`

POST/processor/investments/holdings/getRetrieve Investment Holdings

Request body

application/json — ProcessorInvestmentsHoldingsGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ProcessorInvestmentsHoldingsGetResponse`
`default`	Error response	`PlaidError`

POST/processor/investments/transactions/getGet investment transactions data

Request body

application/json — ProcessorInvestmentsTransactionsGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ProcessorInvestmentsTransactionsGetResponse`
`default`	Error response	`PlaidError`

POST/processor/liabilities/getRetrieve Liabilities data

Request body

application/json — ProcessorLiabilitiesGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ProcessorLiabilitiesGetResponse`
`default`	Error response	`PlaidError`

POST/processor/signal/decision/reportReport whether you initiated an ACH transaction

Request body

application/json — ProcessorSignalDecisionReportRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ProcessorSignalDecisionReportResponse`
`default`	Error response.	`PlaidError`

POST/processor/signal/evaluateEvaluate a planned ACH transaction

Request body

application/json — ProcessorSignalEvaluateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ProcessorSignalEvaluateResponse`
`default`	Error response.	`PlaidError`

POST/processor/signal/prepareOpt-in a processor token to Signal

Request body

application/json — ProcessorSignalPrepareRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ProcessorSignalPrepareResponse`
`default`	Error response.	`PlaidError`

POST/processor/signal/return/reportReport a return for an ACH transaction

Request body

application/json — ProcessorSignalReturnReportRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ProcessorSignalReturnReportResponse`
`default`	Error response.	`PlaidError`

POST/processor/stripe/bank_account_token/createCreate Stripe bank account token

Request body

application/json — ProcessorStripeBankAccountTokenCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ProcessorStripeBankAccountTokenCreateResponse`
`default`	Error response	`PlaidError`

POST/processor/token/createCreate processor token

Request body

application/json — ProcessorTokenCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ProcessorTokenCreateResponse`
`default`	Error response	`PlaidError`

POST/processor/token/permissions/getGet a processor token's product permissions

Request body

application/json — ProcessorTokenPermissionsGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ProcessorTokenPermissionsGetResponse`
`default`	Error response	`PlaidError`

POST/processor/token/permissions/setControl a processor's access to products

Request body

application/json — ProcessorTokenPermissionsSetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ProcessorTokenPermissionsSetResponse`
`default`	Error response	`PlaidError`

POST/processor/token/webhook/updateUpdate a processor token's webhook URL

Request body

application/json — ProcessorTokenWebhookUpdateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ProcessorTokenWebhookUpdateResponse`
`default`	Error response	`PlaidError`

POST/processor/transactions/getGet transaction data

Request body

application/json — ProcessorTransactionsGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ProcessorTransactionsGetResponse`
`default`	Error response	`PlaidError`

POST/processor/transactions/recurring/getFetch recurring transaction streams

Request body

application/json — ProcessorTransactionsRecurringGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ProcessorTransactionsRecurringGetResponse`
`default`	Error response	`PlaidError`

POST/processor/transactions/refreshRefresh transaction data

Request body

application/json — ProcessorTransactionsRefreshRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ProcessorTransactionsRefreshResponse`
`default`	Error response	`PlaidError`

POST/processor/transactions/syncGet incremental transaction updates on a processor token

Request body

application/json — ProcessorTransactionsSyncRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ProcessorTransactionsSyncResponse`
`default`	Error response	`PlaidError`

POST/profile/network_status/getCheck a user's Plaid Network status

Request body

application/json — ProfileNetworkStatusGetRequest (required)

Responses

Status	Description	Schema
`200`	success	`ProfileNetworkStatusGetResponse`
`default`	Error response.	`PlaidError`

POST/protect/computeCompute Protect Trust Index scores and subscores

Request body

application/json — ProtectComputeRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ProtectComputeResponse`

POST/protect/event/getGet information about a user event

Request body

application/json — ProtectEventGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ProtectEventGetResponse`

POST/protect/event/sendSend a new event to enrich user data

Request body

application/json — ProtectEventSendRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ProtectEventSendResponse`

POST/protect/report/createCreate a Protect report

Request body

application/json — ProtectReportCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ProtectReportCreateResponse`

POST/protect/user/insights/getGet Protect user insights

Request body

application/json — ProtectUserInsightsGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`ProtectUserInsightsGetResponse`

POST/sandbox/bank_income/fire_webhookManually fire a Bank Income webhook in Sandbox

Request body

application/json — SandboxBankIncomeFireWebhookRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SandboxBankIncomeFireWebhookResponse`
`default`	Error response	`PlaidError`

POST/sandbox/bank_transfer/fire_webhookManually fire a Bank Transfer webhook

Request body

application/json — SandboxBankTransferFireWebhookRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SandboxBankTransferFireWebhookResponse`
`default`	Error response	`PlaidError`

POST/sandbox/bank_transfer/simulateSimulate a bank transfer event in Sandbox

Request body

application/json — SandboxBankTransferSimulateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SandboxBankTransferSimulateResponse`
`default`	Error response	`PlaidError`

POST/sandbox/cra/cashflow_updates/updateTrigger an update for Cash Flow Updates

Request body

application/json — SandboxCraCashflowUpdatesUpdateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SandboxCraCashflowUpdatesUpdateResponse`
`default`	Error response	`PlaidError`

POST/sandbox/income/fire_webhookManually fire an Income webhook

Request body

application/json — SandboxIncomeFireWebhookRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SandboxIncomeFireWebhookResponse`
`default`	Error response	`PlaidError`

POST/sandbox/item/application/seedSeed a connected application for a Permissions Manager sandbox item

Request body

application/json — SandboxItemApplicationSeedRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SandboxItemApplicationSeedResponse`
`default`	Error response	`PlaidError`

POST/sandbox/item/fire_webhookFire a test webhook

Request body

application/json — SandboxItemFireWebhookRequest (required)

Responses

Status	Description	Schema
`200`	success	`SandboxItemFireWebhookResponse`
`default`	Error response.	`PlaidError`

POST/sandbox/item/reset_loginForce a Sandbox Item into an error state

Request body

application/json — SandboxItemResetLoginRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SandboxItemResetLoginResponse`
`default`	Error response	`PlaidError`

POST/sandbox/item/set_verification_statusSet verification status for Sandbox account

Request body

application/json — SandboxItemSetVerificationStatusRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SandboxItemSetVerificationStatusResponse`
`default`	Error response	`PlaidError`

POST/sandbox/oauth/select_accountsSave the selected accounts when connecting to the Platypus OAuth institution

Request body

application/json — SandboxOauthSelectAccountsRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SandboxOauthSelectAccountsResponse`
`default`	Error response.	`PlaidError`

POST/sandbox/payment/simulateSimulate a payment event in Sandbox

Request body

application/json — SandboxPaymentSimulateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SandboxPaymentSimulateResponse`
`default`	Error response.	`PlaidError`

POST/sandbox/payment_profile/reset_loginReset the login of a Payment Profile

Request body

application/json — SandboxPaymentProfileResetLoginRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SandboxPaymentProfileResetLoginResponse`
`default`	Error response	`PlaidError`

POST/sandbox/processor_token/createCreate a test Item and processor token

Request body

application/json — SandboxProcessorTokenCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SandboxProcessorTokenCreateResponse`
`default`	Error response.	`PlaidError`

POST/sandbox/public_token/createCreate a test Item

Request body

application/json — SandboxPublicTokenCreateRequest (required)

Responses

Status	Description	Schema
`200`	success	`SandboxPublicTokenCreateResponse`
`default`	Error response.	`PlaidError`

POST/sandbox/transactions/createCreate sandbox transactions

Request body

application/json — SandboxTransactionsCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SandboxTransactionsCreateResponse`
`400`	Invalid request	`PlaidError`
`default`	Error response	`PlaidError`

POST/sandbox/transfer/fire_webhookManually fire a Transfer webhook

Request body

application/json — SandboxTransferFireWebhookRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SandboxTransferFireWebhookResponse`
`default`	Error response	`PlaidError`

POST/sandbox/transfer/ledger/deposit/simulateSimulate a ledger deposit event in Sandbox

Request body

application/json — SandboxTransferLedgerDepositSimulateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SandboxTransferLedgerDepositSimulateResponse`
`default`	Error response	`PlaidError`

POST/sandbox/transfer/ledger/simulate_availableSimulate converting pending balance to available balance

Request body

application/json — SandboxTransferLedgerSimulateAvailableRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SandboxTransferLedgerSimulateAvailableResponse`
`default`	Error response	`PlaidError`

POST/sandbox/transfer/ledger/withdraw/simulateSimulate a ledger withdraw event in Sandbox

Request body

application/json — SandboxTransferLedgerWithdrawSimulateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SandboxTransferLedgerWithdrawSimulateResponse`
`default`	Error response	`PlaidError`

POST/sandbox/transfer/refund/simulateSimulate a refund event in Sandbox

Request body

application/json — SandboxTransferRefundSimulateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SandboxTransferRefundSimulateResponse`
`default`	Error response	`PlaidError`

POST/sandbox/transfer/repayment/simulateTrigger the creation of a repayment

Request body

application/json — SandboxTransferRepaymentSimulateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SandboxTransferRepaymentSimulateResponse`
`default`	Error response	`PlaidError`

POST/sandbox/transfer/simulateSimulate a transfer event in Sandbox

Request body

application/json — SandboxTransferSimulateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SandboxTransferSimulateResponse`
`default`	Error response	`PlaidError`

POST/sandbox/transfer/sweep/simulateSimulate creating a sweep

Request body

application/json — SandboxTransferSweepSimulateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SandboxTransferSweepSimulateResponse`
`default`	Error response	`PlaidError`

POST/sandbox/transfer/test_clock/advanceAdvance a test clock

Request body

application/json — SandboxTransferTestClockAdvanceRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SandboxTransferTestClockAdvanceResponse`
`default`	Error response	`PlaidError`

POST/sandbox/transfer/test_clock/createCreate a test clock

Request body

application/json — SandboxTransferTestClockCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SandboxTransferTestClockCreateResponse`
`default`	Error response	`PlaidError`

POST/sandbox/transfer/test_clock/getGet a test clock

Request body

application/json — SandboxTransferTestClockGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SandboxTransferTestClockGetResponse`
`default`	Error response	`PlaidError`

POST/sandbox/transfer/test_clock/listList test clocks

Request body

application/json — SandboxTransferTestClockListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SandboxTransferTestClockListResponse`
`default`	Error response	`PlaidError`

POST/sandbox/user/reset_loginForce item(s) for a Sandbox User into an error state

Request body

application/json — SandboxUserResetLoginRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SandboxUserResetLoginResponse`
`default`	Error response	`PlaidError`

POST/session/token/createCreate a Link token for Layer

Request body

application/json — SessionTokenCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SessionTokenCreateResponse`
`default`	Error response	`PlaidError`

POST/signal/decision/reportReport whether you initiated an ACH transaction

Request body

application/json — SignalDecisionReportRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SignalDecisionReportResponse`
`default`	Error response.	`PlaidError`

POST/signal/evaluateEvaluate a planned ACH transaction

Request body

application/json — SignalEvaluateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SignalEvaluateResponse`
`default`	Error response.	`PlaidError`

POST/signal/prepareOpt-in an Item to Signal Transaction Scores

Request body

application/json — SignalPrepareRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SignalPrepareResponse`
`default`	Error response.	`PlaidError`

POST/signal/return/reportReport a return for an ACH transaction

Request body

application/json — SignalReturnReportRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SignalReturnReportResponse`
`default`	Error response.	`PlaidError`

POST/signal/scheduleSchedule a planned ACH transaction

Request body

application/json — SignalScheduleRequest (required)

Responses

Status	Description	Schema
`200`	OK	`SignalScheduleResponse`
`default`	Error response.	`PlaidError`

POST/statements/downloadRetrieve a single statement.

Request body

application/json — StatementsDownloadRequest (required)

Responses

Status	Description	Schema
`200`	OK	`StatementsDownloadResponse`
`default`	Error response	`PlaidError`

POST/statements/listRetrieve a list of all statements associated with an Item.

Request body

application/json — StatementsListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`StatementsListResponse`
`default`	Error response	`PlaidError`

POST/statements/refreshRefresh statements data.

Request body

application/json — StatementsRefreshRequest (required)

Responses

Status	Description	Schema
`200`	OK	`StatementsRefreshResponse`
`default`	Error response	`PlaidError`

POST/transactions/enrichEnrich locally-held transaction data

Request body

application/json — TransactionsEnrichRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransactionsEnrichResponse`
`default`	Error response	`PlaidError`

POST/transactions/getGet transaction data

Request body

application/json — TransactionsGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransactionsGetResponse`
`default`	Error response	`PlaidError`

POST/transactions/recurring/getFetch recurring transaction streams

Request body

application/json — TransactionsRecurringGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransactionsRecurringGetResponse`
`default`	Error response	`PlaidError`

POST/transactions/refreshRefresh transaction data

Request body

application/json — TransactionsRefreshRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransactionsRefreshResponse`
`default`	Error response	`PlaidError`

POST/transactions/syncGet incremental transaction updates on an Item

Request body

application/json — TransactionsSyncRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransactionsSyncResponse`
`default`	Error response	`PlaidError`

POST/transfer/authorization/cancelCancel a transfer authorization

Request body

application/json — TransferAuthorizationCancelRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferAuthorizationCancelResponse`
`default`	Error response	`PlaidError`

POST/transfer/authorization/createCreate a transfer authorization

Request body

application/json — TransferAuthorizationCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferAuthorizationCreateResponse`
`default`	Error response	`PlaidError`

POST/transfer/balance/get(Deprecated) Retrieve a balance held with Plaid

Request body

application/json — TransferBalanceGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferBalanceGetResponse`
`default`	Error response	`PlaidError`

POST/transfer/cancelCancel a transfer

Request body

application/json — TransferCancelRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferCancelResponse`
`default`	Error response	`PlaidError`

POST/transfer/capabilities/getGet RTP eligibility information of a transfer

Request body

application/json — TransferCapabilitiesGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferCapabilitiesGetResponse`
`default`	Error response	`PlaidError`

POST/transfer/configuration/getGet transfer product configuration

Request body

application/json — TransferConfigurationGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferConfigurationGetResponse`
`default`	Error response	`PlaidError`

POST/transfer/createCreate a transfer

Request body

application/json — TransferCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferCreateResponse`
`default`	Error response	`PlaidError`

POST/transfer/diligence/document/uploadUpload transfer diligence document on behalf of the originator

Request body

application/json — TransferDiligenceDocumentUploadRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferDiligenceDocumentUploadResponse`
`default`	Error response	`PlaidError`

POST/transfer/diligence/submitSubmit transfer diligence on behalf of the originator

Request body

application/json — TransferDiligenceSubmitRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferDiligenceSubmitResponse`
`default`	Error response	`PlaidError`

POST/transfer/event/listList transfer events

Request body

application/json — TransferEventListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferEventListResponse`
`default`	Error response	`PlaidError`

POST/transfer/event/syncSync transfer events

Request body

application/json — TransferEventSyncRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferEventSyncResponse`
`default`	Error response	`PlaidError`

POST/transfer/getRetrieve a transfer

Request body

application/json — TransferGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferGetResponse`
`default`	Error response	`PlaidError`

POST/transfer/intent/createCreate a transfer intent object to invoke the Transfer UI

Request body

application/json — TransferIntentCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferIntentCreateResponse`
`default`	Error response	`PlaidError`

POST/transfer/intent/getRetrieve more information about a transfer intent

Request body

application/json — TransferIntentGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferIntentGetResponse`
`default`	Error response	`PlaidError`

POST/transfer/ledger/depositDeposit funds into a Plaid Ledger balance

Request body

application/json — TransferLedgerDepositRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferLedgerDepositResponse`
`default`	Error response	`PlaidError`

POST/transfer/ledger/distributeMove available balance between ledgers

Request body

application/json — TransferLedgerDistributeRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferLedgerDistributeResponse`
`default`	Error response	`PlaidError`

POST/transfer/ledger/event/listList transfer ledger events

Request body

application/json — TransferLedgerEventListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferLedgerEventListResponse`
`default`	Error response	`PlaidError`

POST/transfer/ledger/getRetrieve Plaid Ledger balance

Request body

application/json — TransferLedgerGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferLedgerGetResponse`
`default`	Error response	`PlaidError`

POST/transfer/ledger/withdrawWithdraw funds from a Plaid Ledger balance

Request body

application/json — TransferLedgerWithdrawRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferLedgerWithdrawResponse`
`default`	Error response	`PlaidError`

POST/transfer/listList transfers

Request body

application/json — TransferListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferListResponse`
`default`	Error response	`PlaidError`

POST/transfer/metrics/getGet transfer product usage metrics

Request body

application/json — TransferMetricsGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferMetricsGetResponse`
`default`	Error response	`PlaidError`

POST/transfer/migrate_accountMigrate account into Transfers

Request body

application/json — TransferMigrateAccountRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferMigrateAccountResponse`
`default`	Error response	`PlaidError`

POST/transfer/originator/createCreate a new originator

Request body

application/json — TransferOriginatorCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferOriginatorCreateResponse`
`default`	Error response	`PlaidError`

POST/transfer/originator/funding_account/createCreate a new funding account for an originator

Request body

application/json — TransferOriginatorFundingAccountCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferOriginatorFundingAccountCreateResponse`
`default`	Error response	`PlaidError`

POST/transfer/originator/funding_account/updateUpdate the funding account associated with the originator

Request body

application/json — TransferOriginatorFundingAccountUpdateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferOriginatorFundingAccountUpdateResponse`
`default`	Error response	`PlaidError`

POST/transfer/originator/getGet status of an originator's onboarding

Request body

application/json — TransferOriginatorGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferOriginatorGetResponse`
`default`	Error response	`PlaidError`

POST/transfer/originator/listGet status of all originators' onboarding

Request body

application/json — TransferOriginatorListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferOriginatorListResponse`
`default`	Error response	`PlaidError`

POST/transfer/platform/originator/createCreate an originator for Transfer for Platforms customers

Request body

application/json — TransferPlatformOriginatorCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferPlatformOriginatorCreateResponse`
`default`	Error response	`PlaidError`

POST/transfer/platform/person/createCreate a person associated with an originator

Request body

application/json — TransferPlatformPersonCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferPlatformPersonCreateResponse`
`default`	Error response	`PlaidError`

POST/transfer/platform/requirement/submitSubmit additional onboarding information on behalf of an originator

Request body

application/json — TransferPlatformRequirementSubmitRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferPlatformRequirementSubmitResponse`
`default`	Error response	`PlaidError`

POST/transfer/questionnaire/createGenerate a Plaid-hosted onboarding UI URL.

Request body

application/json — TransferQuestionnaireCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferQuestionnaireCreateResponse`
`default`	Error response	`PlaidError`

POST/transfer/recurring/cancelCancel a recurring transfer.

Request body

application/json — TransferRecurringCancelRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferRecurringCancelResponse`
`default`	Error response	`PlaidError`

POST/transfer/recurring/createCreate a recurring transfer

Request body

application/json — TransferRecurringCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferRecurringCreateResponse`
`default`	Error response	`PlaidError`

POST/transfer/recurring/getRetrieve a recurring transfer

Request body

application/json — TransferRecurringGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferRecurringGetResponse`
`default`	Error response	`PlaidError`

POST/transfer/recurring/listList recurring transfers

Request body

application/json — TransferRecurringListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferRecurringListResponse`
`default`	Error response	`PlaidError`

POST/transfer/refund/cancelCancel a refund

Request body

application/json — TransferRefundCancelRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferRefundCancelResponse`
`default`	Error response	`PlaidError`

POST/transfer/refund/createCreate a refund

Request body

application/json — TransferRefundCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferRefundCreateResponse`
`default`	Error response	`PlaidError`

POST/transfer/refund/getRetrieve a refund

Request body

application/json — TransferRefundGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferRefundGetResponse`
`default`	Error response	`PlaidError`

POST/transfer/repayment/listLists historical repayments

Request body

application/json — TransferRepaymentListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferRepaymentListResponse`
`default`	Error response	`PlaidError`

POST/transfer/repayment/return/listList the returns included in a repayment

Request body

application/json — TransferRepaymentReturnListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferRepaymentReturnListResponse`
`default`	Error response	`PlaidError`

POST/transfer/sweep/getRetrieve a sweep

Request body

application/json — TransferSweepGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferSweepGetResponse`
`default`	Error response	`PlaidError`

POST/transfer/sweep/listList sweeps

Request body

application/json — TransferSweepListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`TransferSweepListResponse`
`default`	Error response	`PlaidError`

POST/user/createCreate user

Parameters

Name	In	Required	Type
`Plaid-New-User-API-Enabled`	header	no	boolean

Request body

application/json — UserCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`UserCreateResponse`
`201`	Created	`UserCreateResponse`
`default`	Error response	`PlaidError`

POST/user/financial_data/refreshRefresh user items for Financial-Insights bundle

Request body

application/json — UserFinancialDataRefreshRequest (required)

Responses

Status	Description	Schema
`200`	OK	`UserFinancialDataRefreshResponse`
`default`	Error response	`PlaidError`

POST/user/getRetrieve user identity and information

Parameters

Name	In	Required	Type
`Plaid-New-User-API-Enabled`	header	no	boolean

Request body

application/json — UserGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`UserGetResponse`
`default`	Error response.	`PlaidError`

POST/user/identity/removeRemove user identity data

Parameters

Name	In	Required	Type
`Plaid-New-User-API-Enabled`	header	no	boolean

Request body

application/json — UserIdentityRemoveRequest (required)

Responses

Status	Description	Schema
`200`	OK	`UserIdentityRemoveResponse`
`default`	Error response	`PlaidError`

POST/user/items/associateAssociate Items to a User

Request body

application/json — UserItemsAssociateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`UserItemsAssociateResponse`
`default`	Error response	`PlaidError`

POST/user/items/getGet Items associated with a User

Request body

application/json — UserItemsGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`UserItemsGetResponse`
`default`	Error response	`PlaidError`

POST/user/items/removeRemove Items from a User

Request body

application/json — UserItemsRemoveRequest (required)

Responses

Status	Description	Schema
`200`	OK	`UserItemsRemoveResponse`
`default`	Error response	`PlaidError`

POST/user/products/terminateTerminate user-based products

Request body

application/json — UserProductsTerminateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`UserProductsTerminateResponse`
`default`	Error response	`PlaidError`

POST/user/removeRemove user

Parameters

Name	In	Required	Type
`Plaid-New-User-API-Enabled`	header	no	boolean

Request body

application/json — UserRemoveRequest (required)

Responses

Status	Description	Schema
`200`	OK	`UserRemoveResponse`
`default`	Error response	`PlaidError`

POST/user/third_party_token/createCreate a third-party user token

Request body

application/json — UserThirdPartyTokenCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`UserThirdPartyTokenCreateResponse`
`default`	Error response.	`PlaidError`

POST/user/third_party_token/removeRemove a third-party user token

Request body

application/json — UserThirdPartyTokenRemoveRequest (required)

Responses

Status	Description	Schema
`200`	OK	`UserThirdPartyTokenRemoveResponse`
`default`	Error response.	`PlaidError`

POST/user/transactions/refreshRefresh user items for Transactions bundle

Request body

application/json — UserTransactionsRefreshRequest (required)

Responses

Status	Description	Schema
`200`	OK	`UserTransactionsRefreshResponse`
`default`	Error response	`PlaidError`

POST/user/updateUpdate user information

Parameters

Name	In	Required	Type
`Plaid-New-User-API-Enabled`	header	no	boolean

Request body

application/json — UserUpdateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`UserUpdateResponse`
`default`	Error response	`PlaidError`

POST/user_account/session/event/sendSend User Account Session Event

Request body

application/json — UserAccountSessionEventSendRequest (required)

Responses

Status	Description	Schema
`200`	success	`UserAccountSessionEventSendResponse`
`default`	Error response.	`PlaidError`

POST/user_account/session/getRetrieve User Account

Request body

application/json — UserAccountSessionGetRequest (required)

Responses

Status	Description	Schema
`200`	success	`UserAccountSessionGetResponse`
`default`	Error response.	`PlaidError`

POST/wallet/createCreate an e-wallet

Request body

application/json — WalletCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`WalletCreateResponse`
`default`	Error response	`PlaidError`

POST/wallet/getFetch an e-wallet

Request body

application/json — WalletGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`WalletGetResponse`
`default`	Error response	`PlaidError`

POST/wallet/listFetch a list of e-wallets

Request body

application/json — WalletListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`WalletListResponse`
`default`	Error response	`PlaidError`

POST/wallet/transaction/executeExecute a transaction using an e-wallet

Request body

application/json — WalletTransactionExecuteRequest (required)

Responses

Status	Description	Schema
`200`	OK	`WalletTransactionExecuteResponse`
`default`	Error response	`PlaidError`

POST/wallet/transaction/getFetch an e-wallet transaction

Request body

application/json — WalletTransactionGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`WalletTransactionGetResponse`
`default`	Error response	`PlaidError`

POST/wallet/transaction/listList e-wallet transactions

Request body

application/json — WalletTransactionListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`WalletTransactionListResponse`
`default`	Error response	`PlaidError`

POST/watchlist_screening/entity/createCreate a watchlist screening for an entity

Request body

application/json — WatchlistScreeningEntityCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`WatchlistScreeningEntityCreateResponse`

POST/watchlist_screening/entity/getGet an entity screening

Request body

application/json — WatchlistScreeningEntityGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`WatchlistScreeningEntityGetResponse`

POST/watchlist_screening/entity/history/listList history for entity watchlist screenings

Request body

application/json — WatchlistScreeningEntityHistoryListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`WatchlistScreeningEntityHistoryListResponse`

POST/watchlist_screening/entity/hit/listList hits for entity watchlist screenings

Request body

application/json — WatchlistScreeningEntityHitListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`WatchlistScreeningEntityHitListResponse`

POST/watchlist_screening/entity/listList entity watchlist screenings

Request body

application/json — WatchlistScreeningEntityListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`WatchlistScreeningEntityListResponse`

POST/watchlist_screening/entity/program/getGet entity watchlist screening program

Request body

application/json — WatchlistScreeningEntityProgramGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`WatchlistScreeningEntityProgramGetResponse`

POST/watchlist_screening/entity/program/listList entity watchlist screening programs

Request body

application/json — WatchlistScreeningEntityProgramListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`WatchlistScreeningEntityProgramListResponse`

POST/watchlist_screening/entity/review/createCreate a review for an entity watchlist screening

Request body

application/json — WatchlistScreeningEntityReviewCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`WatchlistScreeningEntityReviewCreateResponse`

POST/watchlist_screening/entity/review/listList reviews for entity watchlist screenings

Request body

application/json — WatchlistScreeningEntityReviewListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`WatchlistScreeningEntityReviewListResponse`

POST/watchlist_screening/entity/updateUpdate an entity screening

Request body

application/json — WatchlistScreeningEntityUpdateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`WatchlistScreeningEntityUpdateResponse`

POST/watchlist_screening/individual/createCreate a watchlist screening for a person

Request body

application/json — WatchlistScreeningIndividualCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`WatchlistScreeningIndividualCreateResponse`

POST/watchlist_screening/individual/getRetrieve an individual watchlist screening

Request body

application/json — WatchlistScreeningIndividualGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`WatchlistScreeningIndividualGetResponse`

POST/watchlist_screening/individual/history/listList history for individual watchlist screenings

Request body

application/json — WatchlistScreeningIndividualHistoryListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`WatchlistScreeningIndividualHistoryListResponse`

POST/watchlist_screening/individual/hit/listList hits for individual watchlist screening

Request body

application/json — WatchlistScreeningIndividualHitListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`WatchlistScreeningIndividualHitListResponse`

POST/watchlist_screening/individual/listList Individual Watchlist Screenings

Request body

application/json — WatchlistScreeningIndividualListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`WatchlistScreeningIndividualListResponse`

POST/watchlist_screening/individual/program/getGet individual watchlist screening program

Request body

application/json — WatchlistScreeningIndividualProgramGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`WatchlistScreeningIndividualProgramGetResponse`

POST/watchlist_screening/individual/program/listList individual watchlist screening programs

Request body

application/json — WatchlistScreeningIndividualProgramListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`WatchlistScreeningIndividualProgramListResponse`

POST/watchlist_screening/individual/review/createCreate a review for an individual watchlist screening

Request body

application/json — WatchlistScreeningIndividualReviewCreateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`WatchlistScreeningIndividualReviewCreateResponse`

POST/watchlist_screening/individual/review/listList reviews for individual watchlist screenings

Request body

application/json — WatchlistScreeningIndividualReviewListRequest (required)

Responses

Status	Description	Schema
`200`	OK	`WatchlistScreeningIndividualReviewListResponse`

POST/watchlist_screening/individual/updateUpdate individual watchlist screening

Request body

application/json — WatchlistScreeningIndividualUpdateRequest (required)

Responses

Status	Description	Schema
`200`	OK	`WatchlistScreeningIndividualUpdateResponse`

POST/webhook_verification_key/getGet webhook verification key

Request body

application/json — WebhookVerificationKeyGetRequest (required)

Responses

Status	Description	Schema
`200`	OK	`WebhookVerificationKeyGetResponse`
`default`	Error response	`PlaidError`

Try it

Operation

API key

Developer reference

Base URLhttps://production.plaid.com

Rate limit

Plaid publishes per-endpoint rate limits at both the per-Item and per-client level, enforced with a 429 RATE_LIMIT_EXCEEDED error; the published table is non-exhaustive and thresholds vary by contract. Examples: `/link/token/create` has no per-Item cap and 20,000 requests/minute per client; `/accounts/get` is 15/minute per Item and 15,000/minute per client; `/auth/get` is 15/minute per Item and 12,000/minute per client; `/identity/get` is 15/minute per Item and 2,000/minute per client; `/transactions/sync` is 50/minute per Item and 2,500/minute per client (500/minute per empty-cursor request).

Key endpoints

POST/link/token/create
POST/accounts/get
POST/auth/get
POST/identity/get
POST/transactions/sync

SDKs

TypeScript ↗Python ↗Java ↗Go ↗Ruby ↗

Changelog

Spec version2020-09-14_1.740.1

Tracked paths360

Sep 2026content changed

Tracking since Sep 2026. See every tracked change ↗ ·Subscribe with RSS ↗

Featured in

1 collection

Spec-backed APIs

GreatAPIs Score

Embed this badge

Auth quickstart

Endpoints

Try it

Developer reference

Changelog

Featured in

People comparing Plaid also look at…

Fed Treasury

Indian Mutual Fund

Portfolio Optimizer

Razorpay IFSC

SEC EDGAR Data

CongressInvests