The Plaid REST API. Please see https://plaid.com/docs/api for more details.
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://production.plaid.com https://development.plaid.com https://sandbox.plaid.com
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
The Plaid REST API. Please see https://plaid.com/docs/api for more details.
| method | path | what the vendor says it does |
|---|---|---|
POST | /accounts/balance/get | Retrieve real-time balance data The `/accounts/balance/get` endpoint returns the real-time balance for each of |
POST | /accounts/get | Retrieve accounts The `/accounts/get` endpoint can be used to retrieve a list of accounts associated with any |
POST | /application/get | Retrieve information about a Plaid application Allows financial institutions to retrieve information about Pla |
POST | /asset_report/audit_copy/create | Create Asset Report Audit Copy Plaid can provide an Audit Copy of any Asset Report directly to a participating |
POST | /asset_report/audit_copy/get | Retrieve an Asset Report Audit Copy `/asset_report/audit_copy/get` allows auditors to get a copy of an Asset R |
POST | /asset_report/audit_copy/remove | Remove Asset Report Audit Copy The `/asset_report/audit_copy/remove` endpoint allows you to remove an Audit Co |
POST | /asset_report/create | Create an Asset Report The `/asset_report/create` endpoint initiates the process of creating an Asset Report, |
POST | /asset_report/filter | Filter Asset Report By default, an Asset Report will contain all of the accounts on a given Item. In some case |
POST | /asset_report/get | Retrieve an Asset Report The `/asset_report/get` endpoint retrieves the Asset Report in JSON format. Before ca |
POST | /asset_report/pdf/get | Retrieve a PDF Asset Report The `/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF format. Bef |
POST | /asset_report/refresh | Refresh an Asset Report An Asset Report is an immutable snapshot of a user's assets. In order to "refresh" an |
POST | /asset_report/remove | Delete an Asset Report The `/item/remove` endpoint allows you to invalidate an `access_token`, meaning you wil |
POST | /auth/get | Retrieve auth data The `/auth/get` endpoint returns the bank account and bank identification numbers (such as |
POST | /bank_transfer/balance/get | Get balance of your Bank Transfer account Use the `/bank_transfer/balance/get` endpoint to see the available b |
POST | /bank_transfer/cancel | Cancel a bank transfer Use the `/bank_transfer/cancel` endpoint to cancel a bank transfer. A transfer is elig |
POST | /bank_transfer/create | Create a bank transfer Use the `/bank_transfer/create` endpoint to initiate a new bank transfer. plaid |
POST | /bank_transfer/event/list | List bank transfer events Use the `/bank_transfer/event/list` endpoint to get a list of Plaid-initiated ACH or |
POST | /bank_transfer/event/sync | Sync bank transfer events `/bank_transfer/event/sync` allows you to request up to the next 25 Plaid-initiated |
POST | /bank_transfer/get | Retrieve a bank transfer The `/bank_transfer/get` fetches information about the bank transfer corresponding to |
POST | /bank_transfer/list | List bank transfers Use the `/bank_transfer/list` endpoint to see a list of all your bank transfers and their |
POST | /bank_transfer/migrate_account | Migrate account into Bank Transfers As an alternative to adding Items via Link, you can also use the `/bank_tr |
POST | /bank_transfer/sweep/get | Retrieve a sweep The `/bank_transfer/sweep/get` endpoint fetches information about the sweep corresponding to |
POST | /bank_transfer/sweep/list | List sweeps The `/bank_transfer/sweep/list` endpoint fetches information about the sweeps matching the given f |
POST | /beta/credit/v1/bank_employment/get | Retrieve information from the bank accounts used for employment verification `/credit/bank_employment/get` ret |
POST | /beta/transactions/rules/v1/create | Create transaction category rule The `/transactions/rules/v1/create` endpoint creates transaction categorizati |
POST | /beta/transactions/rules/v1/list | Return a list of rules created for the Item associated with the access token. The `/transactions/rules/v1/list |
POST | /beta/transactions/rules/v1/remove | Remove transaction rule The `/transactions/rules/v1/remove` endpoint is used to remove a transaction rule. pla |
POST | /beta/transactions/v1/enhance | enhance locally-held transaction data The `/beta/transactions/v1/enhance` endpoint enriches raw transaction da |
POST | /categories/get | Get Categories Send a request to the `/categories/get` endpoint to get detailed information on categories retu |
POST | /credit/asset_report/freddie_mac/get | Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint. The `credit/asset_re |
POST | /credit/audit_copy_token/create | Create Asset or Income Report Audit Copy Token Plaid can create an Audit Copy token of an Asset Report and/or |
POST | /credit/audit_copy_token/remove | Remove an Audit Copy token The `/credit/audit_copy_token/remove` endpoint allows you to remove an Audit Copy. |
POST | /credit/audit_copy_token/update | Update an Audit Copy Token The `/credit/audit_copy_token/update` endpoint updates the Audit Copy Token by addi |
POST | /credit/bank_income/get | Retrieve information from the bank accounts used for income verification `/credit/bank_income/get` returns the |
POST | /credit/bank_income/pdf/get | Retrieve information from the bank accounts used for income verification in PDF format `/credit/bank_income/pd |
POST | /credit/bank_income/refresh | Refresh a user's bank income information `/credit/bank_income/refresh` refreshes the bank income report data f |
POST | /credit/employment/get | Retrieve a summary of an individual's employment information `/credit/employment/get` returns a list of items |
POST | /credit/freddie_mac/reports/get | Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Emp |
POST | /credit/payroll_income/get | Retrieve a user's payroll information This endpoint gets payroll income information for a specific user, eithe |
POST | /credit/payroll_income/precheck | Check income verification eligibility and optimize conversion `/credit/payroll_income/precheck` is an optional |
and 158 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/plaid/plaid-openapi/master/2020-09-14.yml
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.