the-plaid-api — quality + safety report

---
name: the-plaid-api
description: "The Plaid API skill. Use when working with The Plaid for asset_report, cra, credit. Covers 325 endpoints."
version: 1.0.0
generator: lapsh
---

# The Plaid API
API version: 2020-09-14_1.681.5

## Auth
ApiKey PLAID-CLIENT-ID in header | ApiKey PLAID-SECRET in header | ApiKey Plaid-Version in header

## Base URL
https://production.plaid.com

## Setup
1. Set your API key in the appropriate header
2. GET /fdx/recipients -- verify access
3. POST /asset_report/create -- create first create

## Endpoints

325 endpoints across 48 groups. See references/api-spec.lap for full details.

### asset_report
| Method | Path | Description |
|--------|------|-------------|
| POST | /asset_report/create | Create an Asset Report |
| POST | /asset_report/get | Retrieve an Asset Report |
| POST | /asset_report/pdf/get | Retrieve a PDF Asset Report |
| POST | /asset_report/refresh | Refresh an Asset Report |
| POST | /asset_report/filter | Filter Asset Report |
| POST | /asset_report/remove | Delete an Asset Report |
| POST | /asset_report/audit_copy/create | Create Asset Report Audit Copy |
| POST | /asset_report/audit_copy/get | Retrieve an Asset Report Audit Copy |
| POST | /asset_report/audit_copy/pdf/get | Retrieve a PDF Asset Report Audit Copy |
| POST | /asset_report/audit_copy/remove | Remove Asset Report Audit Copy |

### cra
| Method | Path | Description |
|--------|------|-------------|
| POST | /cra/monitoring_insights/subscribe | Subscribe to Monitoring Insights |
| POST | /cra/monitoring_insights/unsubscribe | Unsubscribe from Monitoring Insights |
| POST | /cra/monitoring_insights/get | Retrieve a Monitoring Insights Report |
| POST | /cra/partner_insights/get | Retrieve cash flow insights from the bank accounts used for income verification |
| POST | /cra/check_report/income_insights/get | Retrieve cash flow information from your user's banks |
| POST | /cra/check_report/base_report/get | Retrieve a Base Report |
| POST | /cra/check_report/pdf/get | Retrieve Consumer Reports as a PDF |
| POST | /cra/check_report/create | Refresh or create a Consumer Report |
| POST | /cra/check_report/partner_insights/get | Retrieve cash flow insights from partners |
| POST | /cra/check_report/cashflow_insights/get | Retrieve cash flow insights from your user's banking data |
| POST | /cra/check_report/lend_score/get | Retrieve the LendScore from your user's banking data |
| POST | /cra/check_report/network_insights/get | Retrieve network attributes for the user |
| POST | /cra/check_report/verification/get | Retrieve various home lending reports for a user. |
| POST | /cra/check_report/verification/pdf/get | Retrieve Consumer Reports as a Verification PDF |
| POST | /cra/loans/applications/register | Register loan applications and decisions. |
| POST | /cra/loans/register | Register a list of loans to their applicants. |
| POST | /cra/loans/update | Updates loan data. |
| POST | /cra/loans/unregister | Unregister a list of loans. |

### credit
| Method | Path | Description |
|--------|------|-------------|
| POST | /credit/audit_copy_token/update | Update an Audit Copy Token |
| POST | /credit/sessions/get | Retrieve Link sessions for your user |
| POST | /credit/audit_copy_token/create | Create Asset or Income Report Audit Copy Token |
| POST | /credit/audit_copy_token/remove | Remove an Audit Copy token |
| POST | /credit/asset_report/freddie_mac/get | Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint. |
| POST | /credit/freddie_mac/reports/get | Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available. Only Freddie Mac can use this endpoint. |
| POST | /credit/bank_income/get | Retrieve information from the bank accounts used for income verification |
| POST | /credit/bank_income/pdf/get | Retrieve information from the bank accounts used for income verification in PDF format |
| POST | /credit/bank_income/refresh | Refresh a user's bank income information |
| POST | /credit/bank_income/webhook/update | Subscribe and unsubscribe to proactive notifications for a user's income profile |
| POST | /credit/payroll_income/parsing_config/update | Update the parsing configuration for a document income verification |
| POST | /credit/bank_statements/uploads/get | Retrieve data for a user's uploaded bank statements |
| POST | /credit/payroll_income/get | Retrieve a user's payroll information |
| POST | /credit/payroll_income/risk_signals/get | Retrieve fraud insights for a user's manually uploaded document(s). |
| POST | /credit/payroll_income/precheck | Check income verification eligibility and optimize conversion |
| POST | /credit/employment/get | Retrieve a summary of an individual's employment information |
| POST | /credit/payroll_income/refresh | Refresh a digital payroll income verification |
| POST | /credit/relay/create | Create a relay token to share an Asset Report with a partner client |
| POST | /credit/relay/get | Retrieve the reports associated with a relay token that was shared with you |
| POST | /credit/relay/pdf/get | Retrieve the pdf reports associated with a relay token that was shared with you (beta) |
| POST | /credit/relay/refresh | Refresh a report of a relay token |
| POST | /credit/relay/remove | Remove relay token |

### consumer_report
| Method | Path | Description |
|--------|------|-------------|
| POST | /consumer_report/pdf/get | Retrieve a PDF Reports |

### oauth
| Method | Path | Description |
|--------|------|-------------|
| POST | /oauth/token | Create or refresh an OAuth access token |
| POST | /oauth/introspect | Get metadata about an OAuth token |
| POST | /oauth/revoke | Revoke an OAuth token |

### statements
| Method | Path | Description |
|--------|------|-------------|
| POST | /statements/list | Retrieve a list of all statements associated with an item. |
| POST | /statements/download | Retrieve a single statement. |
| POST | /statements/refresh | Refresh statements data. |

### consent
| Method | Path | Description |
|--------|------|-------------|
| POST | /consent/events/get | List a historical log of item consent events |

### item
| Method | Path | Description |
|--------|------|-------------|
| POST | /item/activity/list | List a historical log of user consent events |
| POST | /item/application/list | List a user’s connected applications |
| POST | /item/application/unlink | Unlink a user’s connected application |
| POST | /item/application/scopes/update | Update the scopes of access for a particular application |
| POST | /item/get | Retrieve an Item |
| POST | /item/remove | Remove an Item |
| POST | /item/webhook/update | Update Webhook URL |
| POST | /item/access_token/invalidate | Invalidate access_token |
| POST | /item/public_token/exchange | Exchange public token for an access token |
| POST | /item/public_token/create | Create public token |
| POST | /item/import | Import Item |

### application
| Method | Path | Description |
|--------|------|-------------|
| POST | /application/get | Retrieve information about a Plaid application |

### user_account
| Method | Path | Description |
|--------|------|-------------|
| POST | /user_account/session/get | Retrieve User Account |
| POST | /user_account/session/event/send | Send User Account Session Event |

### profile
| Method | Path | Description |
|--------|------|-------------|
| POST | /profile/network_status/get | Check a user's Plaid Network status |

### network
| Method | Path | Description |
|--------|------|-------------|
| POST | /network/status/get | Check a user's Plaid Network status |

### auth
| Method | Path | Description |
|--------|------|-------------|
| POST | /auth/get | Retrieve auth data |
| POST | /auth/verify | Verify auth data |

### transactions
| Method | Path | Description |
|--------|------|-------------|
| POST | /transactions/get | Get transaction data |
| POST | /transactions/refresh | Refresh transaction data |
| POST | /transactions/recurring/get | Fetch recurring transaction streams |
| POST | /transactions/sync | Get incremental transaction updates on an Item |
| POST | /transactions/enrich | Enrich locally-held transaction data |

### sandbox
| Method | Path | Description |
|--------|------|-------------|
| POST | /sandbox/transactions/create | Create sandbox transactions |
| POST | /sandbox/processor_token/create | Create a test Item and processor token |
| POST | /sandbox/public_token/create | Create a test Item |
| POST | /sandbox/item/fire_webhook | Fire a test webhook |
| POST | /sandbox/item/reset_login | Force a Sandbox Item into an error state |
| POST | /sandbox/item/set_verification_status | Set verification status for Sandbox account |
| POST | /sandbox/user/reset_login | Force item(s) for a Sandbox User into an error state |
| POST | /sandbox/bank_transfer/simulate | Simulate a bank transfer event in Sandbox |
| POST | /sandbox/transfer/sweep/simulate | Simulate creating a sweep |
| POST | /sandbox/transfer/simulate | Simulate a transfer event in Sandbox |
| POST | /sandbox/transfer/refund/simulate | Simulate a refund event in Sandbox |
| POST | /sandbox/transfer/ledger/simulate_available | Simulate converting pending balance to available balance |
| POST | /sandbox/transfer/ledger/deposit/simulate | Simulate a ledger deposit event in Sandbox |
| POST | /sandbox/transfer/ledger/withdraw/simulate | Simulate a ledger withdraw event in Sandbox |
| POST | /sandbox/transfer/repayment/simulate | Trigger the creation of a repayment |
| POST | /sandbox/transfer/fire_webhook | Manually fire a Transfer webhook |
| POST | /sandbox/transfer/test_clock/create | Create a test clock |
| POST | /sandbox/transfer/test_clock/advance | Advance a test clock |
| POST | /sandbox/transfer/test_clock/get | Get a test clock |
| POST | /sandbox/transfer/test_clock/list | List test clocks |
| POST | /sandbox/payment_profile/reset_login | Reset the login of a Payment Profile |
| POST | /sandbox/payment/simulate | Simulate a payment event in Sandbox |
| POST | /sandbox/bank_transfer/fire_webhook | Manually fire a Bank Transfer webhook |
| POST | /sandbox/income/fire_webhook | Manually fire an Income webhook |
| POST | /sandbox/bank_income/fire_webhook | Manually fire a bank income webhook in sandbox |
| POST | /sandbox/cra/cashflow_updates/update | Trigger an update for Cash Flow Updates |
| POST | /sandbox/oauth/select_accounts | Save the selected accounts when connecting to the Platypus Oauth institution |

### cashflow_report
| Method | Path | Description |
|--------|------|-------------|
| POST | /cashflow_report/refresh | Refresh transaction data in `cashflow_report` |
| POST | /cashflow_report/get | Gets transaction data in `cashflow_report` |
| POST | /cashflow_report/transactions/get | Gets transaction data in cashflow_report |
| POST | /cashflow_report/insights/get | Gets insights data in Cashflow Report |

### user
| Method | Path | Description |
|--------|------|-------------|
| POST | /user/transactions/refresh | Refresh user items for Transactions bundle |
| POST | /user/financial_data/refresh | Refresh user items for Financial-Insights bundle |
| POST | /user/create | Create user |
| POST | /user/get | Retrieve user identity and information |
| POST | /user/identity/remove | Remove user identity data |
| POST | /user/update | Update user information |
| POST | /user/remove | Remove user |
| POST | /user/products/terminate | Terminate user-based products |
| POST | /user/items/get | Get Items associated with a User |
| POST | /user/items/associate | Associate Items to a User |
| POST | /user/items/remove | Remove Items from a User |
| POST | /user/third_party_token/create | Create a third-party user token |
| POST | /user/third_party_token/remove | Remove a third-party user token |

### institutions
| Method | Path | Description |
|--------|------|-------------|
| POST | /institutions

… (truncated)