Sample - Plaid API
01
Accounts
2 endpoints
02
Application
1 endpoint
03
Asset_report
10 endpoints
- POST/asset_report/audit_copy/createCreate an Asset Report Audit Copy
- POST/asset_report/audit_copy/getRetrieve an Asset Report Audit Copy
- POST/asset_report/audit_copy/pdf/getRetrieve a PDF Asset Report Audit Copy
- POST/asset_report/audit_copy/removeRemove an Asset Report Audit Copy
- POST/asset_report/createCreate an Asset Report
- POST/asset_report/filterFilter an Asset Report
- POST/asset_report/getRetrieve an Asset Report
- POST/asset_report/pdf/getRetrieve a PDF Asset Report
- POST/asset_report/refreshRefresh an Asset Report
- POST/asset_report/removeDelete an Asset Report
04
Auth
2 endpoints
05
Bank_transfer
10 endpoints
- POST/bank_transfer/balance/getGet a bank transfer account balanceDeprecated
- POST/bank_transfer/cancelCancel a bank transferDeprecated
- POST/bank_transfer/createCreate a bank transferDeprecated
- POST/bank_transfer/event/listList bank transfer events
- POST/bank_transfer/event/syncSync bank transfer events
- POST/bank_transfer/getRetrieve a bank transferDeprecated
- POST/bank_transfer/listList bank transfersDeprecated
- POST/bank_transfer/migrate_accountMigrate an account into Bank TransfersDeprecated
- POST/bank_transfer/sweep/getRetrieve a bank transfer sweepDeprecated
- POST/bank_transfer/sweep/listList bank transfer sweepsDeprecated
06
Beacon
13 endpoints
- POST/beacon/account_risk/v1/evaluateEvaluate bank account riskDeprecated
- POST/beacon/duplicate/getGet a Beacon DuplicateDeprecated
- POST/beacon/report_syndication/getGet a Beacon Report SyndicationDeprecated
- POST/beacon/report_syndication/listList Beacon Report Syndications for a Beacon UserDeprecated
- POST/beacon/report/createCreate a Beacon ReportDeprecated
- POST/beacon/report/getGet a Beacon ReportDeprecated
- POST/beacon/report/listList Beacon Reports for a Beacon UserDeprecated
- POST/beacon/user/account_insights/getGet Beacon User account insightsDeprecated
- POST/beacon/user/createCreate a Beacon UserDeprecated
- POST/beacon/user/getGet a Beacon UserDeprecated
- POST/beacon/user/history/listList Beacon User historyDeprecated
- POST/beacon/user/reviewReview a Beacon UserDeprecated
- POST/beacon/user/updateUpdate a Beacon UserDeprecated
07
Beta
17 endpoints
- POST/beta/credit/v1/bank_employment/getRetrieve bank employment reports
- POST/beta/ewa_report/v1/getGet an EWA score report
- POST/beta/issues/v1/getGet an institution issue
- POST/beta/issues/v1/listList institution issues
- POST/beta/issues/v1/matchMatch an Item to institution issues
- POST/beta/issues/v1/subscribeSubscribe to issue resolution notifications
- POST/beta/issues/v1/unsubscribeUnsubscribe from issue notifications
- POST/beta/partner/customer/v1/createCreate a beta reseller end customer
- POST/beta/partner/customer/v1/enableEnable an end customer
- POST/beta/partner/customer/v1/getGet a beta reseller end customer
- POST/beta/partner/customer/v1/updateUpdate an end customer
- POST/beta/transactions/rules/v1/createCreate a transaction category rule
- POST/beta/transactions/rules/v1/listList transaction category rules
- POST/beta/transactions/rules/v1/removeRemove a transaction category rule
- POST/beta/transactions/user_insights/v1/getGet user transaction insights
- POST/beta/transactions/v1/enhanceEnhance local transaction data
- POST/beta/webhook_events/listList webhook events
08
Business_verification
2 endpoints
09
Cashflow_report
4 endpoints
10
Categories
1 endpoint
11
Consent
1 endpoint
12
Consumer_report
1 endpoint
13
Cra
25 endpoints
- POST/cra/check_report/base_report/getRetrieve a Base Report
- POST/cra/check_report/cashflow_insights/getGet Cashflow Insights
- POST/cra/check_report/createCreate or refresh a Consumer Report
- POST/cra/check_report/income_insights/getRetrieve income insights
- POST/cra/check_report/lend_score/getGet a LendScore report
- POST/cra/check_report/network_insights/getGet Network Insights
- POST/cra/check_report/partner_insights/getRetrieve Partner Insights
- POST/cra/check_report/pdf/getRetrieve a Consumer Report PDF
- POST/cra/check_report/verification/getGet home lending verification reports
- POST/cra/check_report/verification/pdf/getGet a home lending verification PDF
- POST/cra/credit_profile/report/getRetrieve a credit profile report
- POST/cra/loans/applications/registerRegister loan applications and decisions
- POST/cra/loans/registerRegister loans for applicants
- POST/cra/loans/unregisterUnregister finalized loans
- POST/cra/loans/updateUpdate loan status and payment history
- POST/cra/monitoring_insights/getRetrieve a Cash Flow Updates reportDeprecated
- POST/cra/monitoring_insights/subscribeSubscribe to Cash Flow UpdatesDeprecated
- POST/cra/monitoring_insights/unsubscribeUnsubscribe from Cash Flow UpdatesDeprecated
- POST/cra/partner_insights/getRetrieve cash flow insights
- POST/cra/report/getRetrieve a CRA report
- POST/cra/servicing/subscription/createCreate a CRA servicing subscription
- POST/cra/servicing/subscription/deleteDelete a CRA servicing subscription
- POST/cra/servicing/subscription/getGet a CRA servicing subscription
- POST/cra/servicing/subscription/listList a user's CRA servicing subscriptions
- POST/cra/servicing/subscription/updateUpdate a CRA servicing subscription
14
Credit
22 endpoints
- POST/credit/asset_report/freddie_mac/getRetrieve a Freddie Mac Asset Report
- POST/credit/audit_copy_token/createCreate an Audit Copy token
- POST/credit/audit_copy_token/removeRemove an Audit Copy token
- POST/credit/audit_copy_token/updateUpdate an Audit Copy Token
- POST/credit/bank_income/getRetrieve bank income reports
- POST/credit/bank_income/pdf/getRetrieve information from the bank accounts used for income verification in PDF format
- POST/credit/bank_income/refreshRefresh bank income informationDeprecated
- POST/credit/bank_income/webhook/updateUpdate bank income webhook subscription
- POST/credit/bank_statements/uploads/getRetrieve uploaded bank statement data
- POST/credit/employment/getGet verified employment information
- POST/credit/freddie_mac/reports/getRetrieve Freddie Mac asset and employment reports
- POST/credit/payroll_income/getRetrieve payroll income information
- POST/credit/payroll_income/parsing_config/updateUpdate document income parsing configuration
- POST/credit/payroll_income/precheckCheck payroll income verification eligibilityDeprecated
- POST/credit/payroll_income/refreshRefresh a digital payroll income verification
- POST/credit/payroll_income/risk_signals/getGet payroll document risk signals
- POST/credit/relay/createCreate an Asset Report relay token
- POST/credit/relay/getGet a relayed Asset Report
- POST/credit/relay/pdf/getRetrieve the PDF reports associated with a relay token that was shared with you (beta)
- POST/credit/relay/refreshRefresh a relayed Asset Report
- POST/credit/relay/removeRemove an Asset Report relay token
- POST/credit/sessions/getList Link sessions for a user
15
Dashboard_user
2 endpoints
16
Employers
1 endpoint
17
Employment
1 endpoint
18
Fdx
7 endpoints
- GET/fdx/consentsList FDX consent grants
- GET/fdx/consents/{consentId}Get an FDX consent grant
- GET/fdx/consents/{consentId}/revocationGet consent grant revocations
- GET/fdx/recipient/{recipientId}Get recipient metadata
- GET/fdx/recipientsList connected recipient applications
- POST/fdx/notificationsReceive FDX notification events
- PUT/fdx/consents/{consentId}/revocationRevoke FDX consent grant
19
Identity_verification
5 endpoints
- POST/identity_verification/autofill/createCreate Identity Verification autofill
- POST/identity_verification/createCreate an Identity Verification
- POST/identity_verification/getRetrieve an Identity Verification
- POST/identity_verification/listList Identity Verifications
- POST/identity_verification/retryRetry an Identity Verification
20
Identity
5 endpoints
21
Income
5 endpoints
- POST/income/verification/createCreate an income verification instanceDeprecated
- POST/income/verification/documents/download(Deprecated) Download the original documents used for income verificationDeprecated
- POST/income/verification/paystubs/getGet income verification paystub dataDeprecated
- POST/income/verification/precheckPrecheck income verification eligibilityDeprecated
- POST/income/verification/taxforms/getGet income verification tax formsDeprecated
22
Institutions
3 endpoints
23
Investments
4 endpoints
24
Issues
3 endpoints
25
Item
12 endpoints
- POST/item/access_token/invalidateRotate an Item access token
- POST/item/activity/listList Item consent activity
- POST/item/application/listList connected applications
- POST/item/application/scopes/updateUpdate the scopes of access for a particular application
- POST/item/application/unlinkUnlink a connected application
- POST/item/getGet Item status
- POST/item/importImport an Item for a customer
- POST/item/products/terminateTerminate products for an Item
- POST/item/public_token/createCreate a public token for an ItemDeprecated
- POST/item/public_token/exchangeExchange a public token for an access token
- POST/item/removeRemove an Item
- POST/item/webhook/updateUpdate an Item webhook URL
26
Liabilities
1 endpoint
27
Link_delivery
2 endpoints
28
Link
3 endpoints
29
Network
1 endpoint
30
Oauth
3 endpoints
31
Partner
5 endpoints
- POST/partner/customer/createCreate a reseller end customer
- POST/partner/customer/enableEnable a reseller end customer
- POST/partner/customer/getGet a reseller end customer
- POST/partner/customer/oauth_institutions/getGet OAuth institution registrations
- POST/partner/customer/removeRemove a reseller end customer
32
Payment_initiation
12 endpoints
- POST/payment_initiation/consent/createCreate payment consent
- POST/payment_initiation/consent/getGet payment consent
- POST/payment_initiation/consent/payment/executeExecute a consent payment
- POST/payment_initiation/consent/revokeRevoke payment consent
- POST/payment_initiation/payment/createCreate a payment
- POST/payment_initiation/payment/getGet payment details
- POST/payment_initiation/payment/listList payment initiation payments
- POST/payment_initiation/payment/reverseReverse a settled payment
- POST/payment_initiation/payment/token/createCreate a payment tokenDeprecated
- POST/payment_initiation/recipient/createCreate a payment recipient
- POST/payment_initiation/recipient/getGet a payment recipient
- POST/payment_initiation/recipient/listList payment recipients
33
Payment_profile
3 endpoints
34
Processor
24 endpoints
- POST/processor/account/getGet the account for a processor token
- POST/processor/apex/processor_token/createCreate an Apex processor token
- POST/processor/auth/getRetrieve Auth data
- POST/processor/balance/getGet real-time processor balance data
- POST/processor/bank_transfer/createCreate a bank transfer as a processorDeprecated
- POST/processor/identity/getGet processor identity data
- POST/processor/identity/matchGet a processor identity match score
- POST/processor/investments/auth/getGet investment account authentication data
- POST/processor/investments/holdings/getGet investment holdings
- POST/processor/investments/transactions/getGet investment transaction data
- POST/processor/liabilities/getGet processor liabilities data
- POST/processor/signal/decision/reportReport an ACH transaction decision
- POST/processor/signal/evaluateEvaluate a planned ACH transaction
- POST/processor/signal/prepareOpt in a processor token to Signal
- POST/processor/signal/return/reportReport an ACH transaction return
- POST/processor/stripe/bank_account_token/createCreate a Stripe bank account token
- POST/processor/token/createCreate a processor token
- POST/processor/token/permissions/getGet processor token permissions
- POST/processor/token/permissions/setSet processor token product permissions
- POST/processor/token/webhook/updateUpdate a processor token webhook URL
- POST/processor/transactions/getGet transaction data
- POST/processor/transactions/recurring/getGet recurring transaction streams
- POST/processor/transactions/refreshRefresh processor transaction data
- POST/processor/transactions/syncGet incremental transaction updates
35
Profile
1 endpoint
36
Protect
7 endpoints
- POST/protect/cash_advance/decision/createRecord a cash advance decision
- POST/protect/cash_advance/repayment/createRecord a cash advance repayment
- POST/protect/computeCompute Protect Trust Index scores
- POST/protect/event/getGet information about a user eventDeprecated
- POST/protect/event/sendSend a new event to enrich user dataDeprecated
- POST/protect/report/createCreate a Protect report
- POST/protect/user/insights/getGet Protect user insights
37
Sandbox
31 endpoints
- POST/sandbox/bank_income/fire_webhookTrigger a Bank Income webhookDeprecated
- POST/sandbox/bank_transfer/fire_webhookTrigger a Sandbox Bank Transfers webhookDeprecated
- POST/sandbox/bank_transfer/simulateSimulate a bank transfer eventDeprecated
- POST/sandbox/cra/cashflow_updates/updateTrigger Cash Flow Updates events
- POST/sandbox/cra/servicing/simulateSimulate a CRA Servicing report
- POST/sandbox/fdx/consent/seedSeed an FDX consent grant
- POST/sandbox/income/fire_webhookTrigger an Income webhook
- POST/sandbox/item/application/seedSeed a Sandbox connected application
- POST/sandbox/item/fire_webhookFire a test webhook
- POST/sandbox/item/reset_loginTrigger a Sandbox login error
- POST/sandbox/item/set_verification_statusSet a Sandbox account verification status
- POST/sandbox/oauth/select_accountsSave selected OAuth accounts
- POST/sandbox/payment_profile/reset_loginReset a Payment Profile loginDeprecated
- POST/sandbox/payment/simulateSimulate a Sandbox payment event
- POST/sandbox/processor_token/createCreate a test Item and processor token
- POST/sandbox/public_token/createCreate a test Item
- POST/sandbox/transactions/createCreate sandbox transactions
- POST/sandbox/transfer/fire_webhookTrigger a Transfer webhook
- POST/sandbox/transfer/ledger/deposit/simulateSimulate a ledger deposit event
- POST/sandbox/transfer/ledger/simulate_availableSimulate converting pending balance to available balance
- POST/sandbox/transfer/ledger/withdraw/simulateSimulate a ledger withdrawal event
- POST/sandbox/transfer/refund/simulateSimulate a refund event
- POST/sandbox/transfer/repayment/simulateTrigger creation of a repayment
- POST/sandbox/transfer/simulateSimulate a transfer event
- POST/sandbox/transfer/sweep/simulateSimulate creating a transfer sweep
- POST/sandbox/transfer/test_clock/advanceAdvance a test clock
- POST/sandbox/transfer/test_clock/createCreate a test clock
- POST/sandbox/transfer/test_clock/getGet a test clock
- POST/sandbox/transfer/test_clock/listList test clocks
- POST/sandbox/user/fire_webhookFire a test user webhook
- POST/sandbox/user/reset_loginReset Sandbox User Item login states
38
Session
1 endpoint
39
Signal
5 endpoints
40
Statements
3 endpoints
41
Transactions
5 endpoints
42
Transfer
43 endpoints
- POST/transfer/authorization/cancelCancel a transfer authorization
- POST/transfer/authorization/createCreate a transfer authorization
- POST/transfer/balance/getRetrieve a Plaid transfer balanceDeprecated
- POST/transfer/cancelCancel a transfer
- POST/transfer/capabilities/getGet transfer network capabilities
- POST/transfer/configuration/getGet transfer product configuration
- POST/transfer/createCreate a transfer
- POST/transfer/diligence/document/uploadUpload an originator diligence document
- POST/transfer/diligence/submitSubmit originator transfer diligence
- POST/transfer/event/listList transfer events
- POST/transfer/event/syncSync transfer events
- POST/transfer/getRetrieve a transfer
- POST/transfer/intent/createCreate a transfer intent
- POST/transfer/intent/getGet transfer intent details
- POST/transfer/ledger/depositDeposit funds into a Plaid Ledger
- POST/transfer/ledger/distributeMove balance between Plaid Ledgers
- POST/transfer/ledger/event/listList transfer ledger events
- POST/transfer/ledger/getGet a Plaid Ledger balance
- POST/transfer/ledger/withdrawWithdraw funds from a Plaid Ledger
- POST/transfer/listList transfers
- POST/transfer/metrics/getGet transfer product usage metrics
- POST/transfer/migrate_accountMigrate an account into Transfers
- POST/transfer/originator/createCreate an originator
- POST/transfer/originator/funding_account/createCreate an originator funding account
- POST/transfer/originator/funding_account/updateUpdate an originator funding account
- POST/transfer/originator/getGet originator onboarding status
- POST/transfer/originator/listList originator onboarding statuses
- POST/transfer/platform/originator/createCreate a Transfer for Platforms originator
- POST/transfer/platform/person/createCreate an originator-associated person
- POST/transfer/platform/requirement/submitSubmit originator onboarding requirements
- POST/transfer/questionnaire/createCreate an originator onboarding URL
- POST/transfer/recurring/cancelCancel a recurring transfer
- POST/transfer/recurring/createCreate a recurring transfer
- POST/transfer/recurring/getRetrieve a recurring transfer
- POST/transfer/recurring/listList recurring transfers
- POST/transfer/refund/cancelCancel a refund
- POST/transfer/refund/createCreate a refund
- POST/transfer/refund/getRetrieve a refund
- POST/transfer/repayment/listList historical repayments
- POST/transfer/repayment/return/listList returns in a repayment
- POST/transfer/return/recoverReport a return recovery
- POST/transfer/sweep/getRetrieve a transfer sweep
- POST/transfer/sweep/listList transfer sweeps
43
User_account
2 endpoints
44
User
13 endpoints
- POST/user/createCreate a user
- POST/user/financial_data/refreshRefresh all user financial data
- POST/user/getRetrieve user identity and information
- POST/user/identity/removeRemove user identity data
- POST/user/items/associateAssociate Items with a user
- POST/user/items/getList Items associated with a user
- POST/user/items/removeRemove Items from a user
- POST/user/products/terminateTerminate user-based products
- POST/user/removeRemove a user
- POST/user/third_party_token/createCreate a third-party user token
- POST/user/third_party_token/removeRemove a third-party user token
- POST/user/transactions/refreshRefresh all user Transactions data
- POST/user/updateUpdate user information
45
Wallet
6 endpoints
46
Watchlist_screening
20 endpoints
- POST/watchlist_screening/entity/createCreate an entity watchlist screening
- POST/watchlist_screening/entity/getGet an entity watchlist screening
- POST/watchlist_screening/entity/history/listList entity screening history
- POST/watchlist_screening/entity/hit/listList entity screening hits
- POST/watchlist_screening/entity/listList entity watchlist screenings
- POST/watchlist_screening/entity/program/getGet an entity watchlist screening program
- POST/watchlist_screening/entity/program/listList entity watchlist screening programs
- POST/watchlist_screening/entity/review/createCreate an entity screening review
- POST/watchlist_screening/entity/review/listList entity screening reviews
- POST/watchlist_screening/entity/updateUpdate an entity watchlist screening
- POST/watchlist_screening/individual/createCreate an individual watchlist screening
- POST/watchlist_screening/individual/getRetrieve an individual watchlist screening
- POST/watchlist_screening/individual/history/listList individual watchlist screening history
- POST/watchlist_screening/individual/hit/listList hits for an individual watchlist screening
- POST/watchlist_screening/individual/listList individual watchlist screenings
- POST/watchlist_screening/individual/program/getGet an individual watchlist screening program
- POST/watchlist_screening/individual/program/listList individual watchlist screening programs
- POST/watchlist_screening/individual/review/createCreate an individual screening review
- POST/watchlist_screening/individual/review/listList reviews for an individual watchlist screening
- POST/watchlist_screening/individual/updateUpdate an individual watchlist screening
47
Webhook_verification_key
1 endpoint