Skip to content
OpenParablePublic APIs

Plaid API

by plaid.com

API keyHTTPSFinance
Open documentation ↗

Overview

Connect with user's bank accounts and access transaction data

Plaid is a finance API from plaid.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 198 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Category
Finance
Base URL
https://production.plaid.com
Version
2020-09-14_1.334.0
Endpoints
198
OpenAPI
Specification ↗
Spec updated
2023-03-06

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X POST "https://production.plaid.com/accounts/balance/get" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"
JavaScript
const response = await fetch("https://production.plaid.com/accounts/balance/get", {
  method: "POST",
  headers: {
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "POST",
    "https://production.plaid.com/accounts/balance/get",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
POST/accounts/balance/getRetrieve real-time balance data
POST/accounts/getRetrieve accounts
POST/application/getRetrieve information about a Plaid application
POST/asset_report/audit_copy/createCreate Asset Report Audit Copy
POST/asset_report/audit_copy/getRetrieve an Asset Report Audit Copy
POST/asset_report/audit_copy/removeRemove Asset Report Audit Copy
POST/asset_report/createCreate an Asset Report
POST/asset_report/filterFilter 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
POST/auth/getRetrieve auth data
POST/bank_transfer/balance/getGet balance of your Bank Transfer account
POST/bank_transfer/cancelCancel a bank transfer
POST/bank_transfer/createCreate a bank transfer
POST/bank_transfer/event/listList bank transfer events
POST/bank_transfer/event/syncSync bank transfer events
POST/bank_transfer/getRetrieve a bank transfer
POST/bank_transfer/listList bank transfers
POST/bank_transfer/migrate_accountMigrate account into Bank Transfers
POST/bank_transfer/sweep/getRetrieve a sweep
POST/bank_transfer/sweep/listList sweeps
POST/beta/credit/v1/bank_employment/getRetrieve information from the bank accounts used for employment verification
POST/beta/transactions/rules/v1/createCreate transaction category rule
POST/beta/transactions/rules/v1/listReturn a list of rules created for the Item associated with the access token.
POST/beta/transactions/rules/v1/removeRemove transaction rule
POST/beta/transactions/v1/enhanceenhance locally-held transaction data
POST/categories/getGet Categories
POST/credit/asset_report/freddie_mac/getRetrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint.
POST/credit/audit_copy_token/createCreate Asset or Income Report 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 information from the bank accounts used for income verification
POST/credit/bank_income/pdf/getRetrieve information from the bank accounts used for income verification in PDF format
POST/credit/bank_income/refreshRefresh a user's bank income information
POST/credit/employment/getRetrieve a summary of an individual's employment information
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. Onl
POST/credit/payroll_income/getRetrieve a user's payroll information
POST/credit/payroll_income/precheckCheck income verification eligibility and optimize conversion
POST/credit/payroll_income/refreshRefresh a digital payroll income verification
POST/credit/relay/createCreate a relay token to share an Asset Report with a partner client (beta)
POST/credit/relay/getRetrieve the reports associated with a relay token that was shared with you (beta)
POST/credit/relay/refreshRefresh a report of a relay token (beta)
POST/credit/relay/removeRemove relay token (beta)
POST/credit/sessions/getRetrieve Link sessions for your user
POST/dashboard_user/getRetrieve a dashboard user
POST/dashboard_user/listList dashboard users
POST/deposit_switch/alt/createCreate a deposit switch without using Plaid Exchange
POST/deposit_switch/createCreate a deposit switch
POST/deposit_switch/getRetrieve a deposit switch
POST/deposit_switch/token/createCreate a deposit switch token
POST/employers/searchSearch employer database
POST/employment/verification/getdeprecated(Deprecated) Retrieve a summary of an individual's employment information
POST/fdx/notificationsWebhook receiver for fdx notifications
POST/identity/getRetrieve identity data
POST/identity/matchRetrieve identity match score
POST/identity_verification/createCreate a new identity verification
POST/identity_verification/getRetrieve Identity Verification
POST/identity_verification/listList Identity Verifications
POST/identity_verification/retryRetry an Identity Verification
POST/income/verification/createdeprecated(Deprecated) Create an income verification instance
POST/income/verification/documents/downloaddeprecated(Deprecated) Download the original documents used for income verification
POST/income/verification/paystubs/getdeprecated(Deprecated) Retrieve information from the paystubs used for income verification
POST/income/verification/precheckdeprecated(Deprecated) Check digital income verification eligibility and optimize conversion
POST/income/verification/taxforms/getdeprecated(Deprecated) Retrieve information from the tax documents used for income verification
POST/institutions/getGet details of all supported institutions
POST/institutions/get_by_idGet details of an institution
POST/institutions/searchSearch institutions
POST/investments/holdings/getGet Investment holdings
POST/investments/transactions/getGet investment transactions
POST/item/access_token/invalidateInvalidate access_token
POST/item/activity/listList a historical log of user consent events
POST/item/application/listList a user’s connected applications
POST/item/application/scopes/updateUpdate the scopes of access for a particular application
POST/item/getRetrieve an Item
POST/item/importImport Item
POST/item/public_token/createCreate public token
POST/item/public_token/exchangeExchange public token for an access token
POST/item/removeRemove an Item
POST/item/webhook/updateUpdate Webhook URL
POST/liabilities/getRetrieve Liabilities data
POST/link/oauth/correlation_id/exchangeExchange the Link Correlation Id for a Link Token
POST/link/token/createCreate Link Token
POST/link/token/getGet Link Token
POST/link_delivery/createCreate Link Delivery session
POST/link_delivery/getGet Link Delivery session
POST/partner/customer/createCreates a new end customer for a Plaid reseller.
POST/partner/customer/enableEnables a Plaid reseller's end customer in the Production environment.
POST/partner/customer/getReturns a Plaid reseller's end customer.
POST/partner/customer/oauth_institutions/getReturns OAuth-institution registration information for a given end customer.
POST/partner/customer/removeRemoves a Plaid reseller's end customer.
POST/payment_initiation/consent/createCreate payment consent
POST/payment_initiation/consent/getGet payment consent
POST/payment_initiation/consent/payment/executeExecute a single payment using consent
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 payments
POST/payment_initiation/payment/reverseReverse an existing payment

Showing the first 100 of 198 endpoints; the full list is in the documentation.

Questions

Does the Plaid API need an API key?

Yes. The Plaid API uses API key authentication; the documentation explains how to get credentials.

Does the Plaid API support HTTPS?

Yes, the Plaid API is served over HTTPS.

How many endpoints does the Plaid API have?

Its OpenAPI description lists 198 endpoints in version 2020-09-14_1.334.0. The first 100 are shown on this page.

What are alternatives to the Plaid API?

Other Finance APIs include Stripe, SEC EDGAR Data, Fed Treasury, Razorpay IFSC, Klarna.

Compare alternatives →

Stripe

Finance

Payment processing, subscriptions, and financial management

API key446 endpoints

SEC EDGAR Data

Finance

API to access annual reports of public US companies

No authCORS

Fed Treasury

Finance

U.S. Department of the Treasury Data

No auth

Razorpay IFSC

Finance

Indian Financial Systems Code (Bank Branch Codes)

No auth

Klarna

Finance

Klarna payment and shopping service

API key

Citi

Finance

All Citigroup account and statement data APIs

API key

Listed from public-apis (MIT), public-apis database (MIT), APIs.guru (CC0).