Can I use Plaid as a CLI?

Yes. KosmoKrator exposes a Plaid CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose Plaid through MCP?

Yes. The KosmoKrator MCP gateway can expose selected Plaid tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are Plaid credentials stored?

Plaid credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for Plaid MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

data

Plaid Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Plaid KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.plaid.*. Use lua_read_doc("integrations.plaid") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic Plaid workflow without starting an interactive agent session.

Inline Lua call

kosmo integrations:lua --eval 'dump(app.integrations.plaid.create_asset_report({}))' --json

Read Lua docs headlessly

kosmo integrations:lua --eval 'print(docs.read("plaid"))' --json
kosmo integrations:lua --eval 'print(docs.read("plaid.create_asset_report"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua

local plaid = app.integrations.plaid
local result = plaid.create_asset_report({})

dump(result)

Run the workflow

kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json

Namespace note. integrations:lua exposes app.integrations.plaid, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.plaid.default.* or app.integrations.plaid.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Plaid, use the narrower mcp:lua command.

MCP Lua command

# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Plaid Lua Docs

Plaid tools are exposed under app.integrations.plaid. This package is generated from Plaid’s official OpenAPI document for API version 2020-09-14 and exposes all 330 operations found in that spec.

Authentication

Configure client_id, secret, plaid_version, and url. Use https://sandbox.plaid.com for sandbox, https://development.plaid.com for development, and https://production.plaid.com for production.

The integration sends PLAID-CLIENT-ID, PLAID-SECRET, and Plaid-Version headers. Do not include credentials in tool bodies.

Usage Pattern

Most Plaid endpoints are JSON POST calls. Pass the official request schema under body:

local result = app.integrations.plaid.plaid_transactions_get({
  body = {
    access_token = "access-sandbox-example",
    start_date = "2026-01-01",
    end_date = "2026-01-31",
  }
})

For path-based FDX endpoints, pass path parameters as top-level arguments:

local result = app.integrations.plaid.plaid_get_recipient({
  recipientId = "recipient-example"
})

Binary endpoints such as PDF report downloads return { body, status } when Plaid returns non-JSON content. Agents should write body to a file only when the host workflow explicitly needs an artifact.

Coverage Notes

The manifest file plaid-openapi-manifest.json records the OpenAPI source, API version, operation count, tool slug, class, method, and path for every generated operation. Lua examples should follow Plaid’s official request schemas because this integration intentionally does not flatten all product-specific request bodies into top-level arguments.

Representative Tools

plaid_asset_report_create - POST /asset_report/create
plaid_asset_report_get - POST /asset_report/get
plaid_asset_report_pdf_get - POST /asset_report/pdf/get
plaid_asset_report_refresh - POST /asset_report/refresh
plaid_asset_report_filter - POST /asset_report/filter
plaid_asset_report_remove - POST /asset_report/remove
plaid_asset_report_audit_copy_create - POST /asset_report/audit_copy/create
plaid_asset_report_audit_copy_get - POST /asset_report/audit_copy/get
plaid_asset_report_audit_copy_pdf_get - POST /asset_report/audit_copy/pdf/get
plaid_asset_report_audit_copy_remove - POST /asset_report/audit_copy/remove
plaid_cra_monitoring_insights_subscribe - POST /cra/monitoring_insights/subscribe
plaid_cra_monitoring_insights_unsubscribe - POST /cra/monitoring_insights/unsubscribe
plaid_cra_monitoring_insights_get - POST /cra/monitoring_insights/get
plaid_credit_audit_copy_token_update - POST /credit/audit_copy_token/update
plaid_cra_partner_insights_get - POST /cra/partner_insights/get
plaid_cra_check_report_income_insights_get - POST /cra/check_report/income_insights/get
plaid_cra_check_report_base_report_get - POST /cra/check_report/base_report/get
plaid_cra_check_report_pdf_get - POST /cra/check_report/pdf/get
plaid_cra_check_report_create - POST /cra/check_report/create
plaid_cra_check_report_partner_insights_get - POST /cra/check_report/partner_insights/get

Raw agent markdown

# Plaid Lua Docs

Plaid tools are exposed under `app.integrations.plaid`. This package is generated from Plaid's official OpenAPI document for API version `2020-09-14` and exposes all 330 operations found in that spec.

## Authentication

Configure `client_id`, `secret`, `plaid_version`, and `url`. Use `https://sandbox.plaid.com` for sandbox, `https://development.plaid.com` for development, and `https://production.plaid.com` for production.

The integration sends `PLAID-CLIENT-ID`, `PLAID-SECRET`, and `Plaid-Version` headers. Do not include credentials in tool bodies.

## Usage Pattern

Most Plaid endpoints are JSON `POST` calls. Pass the official request schema under `body`:

```lua
local result = app.integrations.plaid.plaid_transactions_get({
  body = {
    access_token = "access-sandbox-example",
    start_date = "2026-01-01",
    end_date = "2026-01-31",
  }
})
```

For path-based FDX endpoints, pass path parameters as top-level arguments:

```lua
local result = app.integrations.plaid.plaid_get_recipient({
  recipientId = "recipient-example"
})
```

Binary endpoints such as PDF report downloads return `{ body, status }` when Plaid returns non-JSON content. Agents should write `body` to a file only when the host workflow explicitly needs an artifact.

## Coverage Notes

The manifest file `plaid-openapi-manifest.json` records the OpenAPI source, API version, operation count, tool slug, class, method, and path for every generated operation. Lua examples should follow Plaid's official request schemas because this integration intentionally does not flatten all product-specific request bodies into top-level arguments.

## Representative Tools

- `plaid_asset_report_create` - POST `/asset_report/create`
- `plaid_asset_report_get` - POST `/asset_report/get`
- `plaid_asset_report_pdf_get` - POST `/asset_report/pdf/get`
- `plaid_asset_report_refresh` - POST `/asset_report/refresh`
- `plaid_asset_report_filter` - POST `/asset_report/filter`
- `plaid_asset_report_remove` - POST `/asset_report/remove`
- `plaid_asset_report_audit_copy_create` - POST `/asset_report/audit_copy/create`
- `plaid_asset_report_audit_copy_get` - POST `/asset_report/audit_copy/get`
- `plaid_asset_report_audit_copy_pdf_get` - POST `/asset_report/audit_copy/pdf/get`
- `plaid_asset_report_audit_copy_remove` - POST `/asset_report/audit_copy/remove`
- `plaid_cra_monitoring_insights_subscribe` - POST `/cra/monitoring_insights/subscribe`
- `plaid_cra_monitoring_insights_unsubscribe` - POST `/cra/monitoring_insights/unsubscribe`
- `plaid_cra_monitoring_insights_get` - POST `/cra/monitoring_insights/get`
- `plaid_credit_audit_copy_token_update` - POST `/credit/audit_copy_token/update`
- `plaid_cra_partner_insights_get` - POST `/cra/partner_insights/get`
- `plaid_cra_check_report_income_insights_get` - POST `/cra/check_report/income_insights/get`
- `plaid_cra_check_report_base_report_get` - POST `/cra/check_report/base_report/get`
- `plaid_cra_check_report_pdf_get` - POST `/cra/check_report/pdf/get`
- `plaid_cra_check_report_create` - POST `/cra/check_report/create`
- `plaid_cra_check_report_partner_insights_get` - POST `/cra/check_report/partner_insights/get`

Metadata-derived Lua example

local result = app.integrations.plaid.create_asset_report({})
print(result)

Functions

create_asset_report Write

The `/asset_report/create` endpoint initiates the process of creating an Asset Report, which can then be retrieved by passing the `asset_report_token` return value to the `/asse...

Lua path: app.integrations.plaid.create_asset_report
Full name: plaid.plaid_asset_report_create

Parameter	Type	Required	Description
No parameters.

retrieve_asset_report Read

The `/asset_report/get` endpoint retrieves the Asset Report in JSON format. Before calling `/asset_report/get`, you must first create the Asset Report using `/asset_report/creat...

Lua path: app.integrations.plaid.retrieve_asset_report
Full name: plaid.plaid_asset_report_get

Parameter	Type	Required	Description
No parameters.

retrieve_pdf_asset_report Read

The `/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/asset_report/pdf/get`, you must first create the Asset Report using `/asset_repor...

Lua path: app.integrations.plaid.retrieve_pdf_asset_report
Full name: plaid.plaid_asset_report_pdf_get

Parameter	Type	Required	Description
No parameters.

refresh_asset_report Write

An Asset Report is an immutable snapshot of a user's assets. In order to "refresh" an Asset Report you created previously, you can use the `/asset_report/refresh` endpoint to cr...

Lua path: app.integrations.plaid.refresh_asset_report
Full name: plaid.plaid_asset_report_refresh

Parameter	Type	Required	Description
No parameters.

filter_asset_report Read

By default, an Asset Report will contain all of the accounts on a given Item. In some cases, you may not want the Asset Report to contain all accounts. For example, you might ha...

Lua path: app.integrations.plaid.filter_asset_report
Full name: plaid.plaid_asset_report_filter

Parameter	Type	Required	Description
No parameters.

delete_asset_report Write

The `/item/remove` endpoint allows you to invalidate an `access_token`, meaning you will not be able to create new Asset Reports with it. Removing an Item does not affect any As...

Lua path: app.integrations.plaid.delete_asset_report
Full name: plaid.plaid_asset_report_remove

Parameter	Type	Required	Description
No parameters.

create_asset_report_audit_copy Write

Plaid can provide an Audit Copy of any Asset Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy directly to the GSEs on y...

Lua path: app.integrations.plaid.create_asset_report_audit_copy
Full name: plaid.plaid_asset_report_audit_copy_create

Parameter	Type	Required	Description
No parameters.

retrieve_asset_report_audit_copy Read

`/asset_report/audit_copy/get` allows auditors to get a copy of an Asset Report that was previously shared via the `/asset_report/audit_copy/create` endpoint. The caller of `/as...

Lua path: app.integrations.plaid.retrieve_asset_report_audit_copy
Full name: plaid.plaid_asset_report_audit_copy_get

Parameter	Type	Required	Description
No parameters.

retrieve_pdf_asset_report_audit_copy Read

The `/asset_report/audit_copy/pdf/get` endpoint retrieves an Asset Report Audit Copy in PDF format. The caller must provide the `audit_copy_token` that was shared via the `/asse...

Lua path: app.integrations.plaid.retrieve_pdf_asset_report_audit_copy
Full name: plaid.plaid_asset_report_audit_copy_pdf_get

Parameter	Type	Required	Description
No parameters.

remove_asset_report_audit_copy Write

The `/asset_report/audit_copy/remove` endpoint allows you to remove an Audit Copy. Removing an Audit Copy invalidates the `audit_copy_token` associated with it, meaning both you...

Lua path: app.integrations.plaid.remove_asset_report_audit_copy
Full name: plaid.plaid_asset_report_audit_copy_remove

Parameter	Type	Required	Description
No parameters.

subscribe_monitoring_insights Write

This endpoint allows you to subscribe to insights for a user's linked CRA Item, which are updated between one and four times per day (best-effort). In the current Cash Flow Upda...

Lua path: app.integrations.plaid.subscribe_monitoring_insights
Full name: plaid.plaid_cra_monitoring_insights_subscribe

Parameter	Type	Required	Description
No parameters.

unsubscribe_from_monitoring_insights Write

This endpoint allows you to unsubscribe from previously subscribed Monitoring Insights.

Lua path: app.integrations.plaid.unsubscribe_from_monitoring_insights
Full name: plaid.plaid_cra_monitoring_insights_unsubscribe

Parameter	Type	Required	Description
No parameters.

retrieve_monitoring_insights_report Read

This endpoint allows you to retrieve a Cash Flow Updates report by passing in the `user_id` referred to in the webhook you received.

Lua path: app.integrations.plaid.retrieve_monitoring_insights_report
Full name: plaid.plaid_cra_monitoring_insights_get

Parameter	Type	Required	Description
No parameters.

update_audit_copy_token Write

The `/credit/audit_copy_token/update` endpoint updates an existing Audit Copy Token by adding the report tokens in the `report_tokens` field to the `audit_copy_token`. If the Au...

Lua path: app.integrations.plaid.update_audit_copy_token
Full name: plaid.plaid_credit_audit_copy_token_update

Parameter	Type	Required	Description
No parameters.

retrieve_cash_flow_insights_from_bank_accounts_used_income_verification Read

`/cra/partner_insights/get` returns cash flow insights for a specified user.

Lua path: app.integrations.plaid.retrieve_cash_flow_insights_from_bank_accounts_used_income_verification
Full name: plaid.plaid_cra_partner_insights_get

Parameter	Type	Required	Description
No parameters.

retrieve_cash_flow_information_from_your_user_banks Read

This endpoint allows you to retrieve the Income Insights report for your user. You should call this endpoint after you’ve received a `CHECK_REPORT_READY` or a `USER_CHECK_REPO...

Lua path: app.integrations.plaid.retrieve_cash_flow_information_from_your_user_banks
Full name: plaid.plaid_cra_check_report_income_insights_get

Parameter	Type	Required	Description
No parameters.

retrieve_base_report Read

This endpoint allows you to retrieve the Base Report for your user, allowing you to receive comprehensive bank account and cash flow data. You should call this endpoint after yo...

Lua path: app.integrations.plaid.retrieve_base_report
Full name: plaid.plaid_cra_check_report_base_report_get

Parameter	Type	Required	Description
No parameters.

retrieve_consumer_reports_pdf Read

`/cra/check_report/pdf/get` retrieves the most recent Consumer Report in PDF format. By default, the most recent Base Report (if it exists) for the user will be returned. To req...

Lua path: app.integrations.plaid.retrieve_consumer_reports_pdf
Full name: plaid.plaid_cra_check_report_pdf_get

Parameter	Type	Required	Description
No parameters.

refresh_or_create_consumer_report Write

Use `/cra/check_report/create` to refresh data in an existing report. A Consumer Report will last for 24 hours before expiring; you should call any `/get` endpoints on the repor...

Lua path: app.integrations.plaid.refresh_or_create_consumer_report
Full name: plaid.plaid_cra_check_report_create

Parameter	Type	Required	Description
No parameters.

retrieve_cash_flow_insights_from_partners Read

This endpoint allows you to retrieve the Partner Insights report for your user. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPOR...

Lua path: app.integrations.plaid.retrieve_cash_flow_insights_from_partners
Full name: plaid.plaid_cra_check_report_partner_insights_get

Parameter	Type	Required	Description
No parameters.

retrieve_cash_flow_insights_from_your_user_banking_data Read

This endpoint allows you to retrieve the Cashflow Insights report for your user. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPO...

Lua path: app.integrations.plaid.retrieve_cash_flow_insights_from_your_user_banking_data
Full name: plaid.plaid_cra_check_report_cashflow_insights_get

Parameter	Type	Required	Description
No parameters.

retrieve_lendscore_from_your_user_banking_data Read

This endpoint allows you to retrieve the LendScore report for your user. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY...

Lua path: app.integrations.plaid.retrieve_lendscore_from_your_user_banking_data
Full name: plaid.plaid_cra_check_report_lend_score_get

Parameter	Type	Required	Description
No parameters.

retrieve_network_attributes_user Read

This endpoint allows you to retrieve the Network Insights product for your user. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPO...

Lua path: app.integrations.plaid.retrieve_network_attributes_user
Full name: plaid.plaid_cra_check_report_network_insights_get

Parameter	Type	Required	Description
No parameters.

retrieve_various_home_lending_reports_user Read

This endpoint allows you to retrieve home lending reports for a user. To obtain a VoA or Employment Refresh report, you need to make sure that `cra_base_report` is included in t...

Lua path: app.integrations.plaid.retrieve_various_home_lending_reports_user
Full name: plaid.plaid_cra_check_report_verification_get

Parameter	Type	Required	Description
No parameters.

retrieve_consumer_reports_verification_pdf Read

The `/cra/check_report/verification/pdf/get` endpoint retrieves the most recent Consumer Report in PDF format, specifically formatted for Home Lending verification use cases. Be...

Lua path: app.integrations.plaid.retrieve_consumer_reports_verification_pdf
Full name: plaid.plaid_cra_check_report_verification_pdf_get

Parameter	Type	Required	Description
No parameters.

register_loan_applications_and_decisions Write

`/cra/loans/applications/register` registers loan applications and decisions.

Lua path: app.integrations.plaid.register_loan_applications_and_decisions
Full name: plaid.plaid_cra_loans_applications_register

Parameter	Type	Required	Description
No parameters.

register_list_loans_their_applicants Write

`/cra/loans/register` registers a list of loans to their applicants.

Lua path: app.integrations.plaid.register_list_loans_their_applicants
Full name: plaid.plaid_cra_loans_register

Parameter	Type	Required	Description
No parameters.

updates_loan_data Write

`/cra/loans/update` updates loan information such as the status and payment history.

Lua path: app.integrations.plaid.updates_loan_data
Full name: plaid.plaid_cra_loans_update

Parameter	Type	Required	Description
No parameters.

unregister_list_loans Write

`/cra/loans/unregister` indicates the loans have reached a final status and no further updates are expected.

Lua path: app.integrations.plaid.unregister_list_loans
Full name: plaid.plaid_cra_loans_unregister

Parameter	Type	Required	Description
No parameters.

retrieve_credit_profile_report_user Read

`/cra/credit_profile/report/get` retrieves a credit profile report for a user.

Lua path: app.integrations.plaid.retrieve_credit_profile_report_user
Full name: plaid.plaid_cra_credit_profile_report_get

Parameter	Type	Required	Description
No parameters.

retrieve_pdf_reports Read

Retrieves all existing CRB Bank Income and Base reports for the consumer in PDF format. Response is PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header.

Lua path: app.integrations.plaid.retrieve_pdf_reports
Full name: plaid.plaid_consumer_report_pdf_get

Parameter	Type	Required	Description
No parameters.

create_or_refresh_oauth_access_token Write

`/oauth/token` issues an access token and refresh token depending on the `grant_type` provided. This endpoint supports `Content-Type: application/x-www-form-urlencoded` as well ...

Lua path: app.integrations.plaid.create_or_refresh_oauth_access_token
Full name: plaid.plaid_oauth_token

Parameter	Type	Required	Description
No parameters.

get_metadata_about_oauth_token Read

`/oauth/introspect` returns metadata about an access token or refresh token. Note: This endpoint supports `Content-Type: application/x-www-form-urlencoded` as well as JSON. The ...

Lua path: app.integrations.plaid.get_metadata_about_oauth_token
Full name: plaid.plaid_oauth_introspect

Parameter	Type	Required	Description
No parameters.

revoke_oauth_token Write

`/oauth/revoke` revokes an access or refresh token, preventing any further use. If a refresh token is revoked, all access and refresh tokens derived from it are also revoked, in...

Lua path: app.integrations.plaid.revoke_oauth_token
Full name: plaid.plaid_oauth_revoke

Parameter	Type	Required	Description
No parameters.

retrieve_list_all_statements_associated_with_item Read

The `/statements/list` endpoint retrieves a list of all statements associated with an item.

Lua path: app.integrations.plaid.retrieve_list_all_statements_associated_with_item
Full name: plaid.plaid_statements_list

Parameter	Type	Required	Description
No parameters.

retrieve_single_statement Read

The `/statements/download` endpoint retrieves a single statement PDF in binary format. The response will contain a `Plaid-Content-Hash` header containing a SHA 256 checksum of t...

Lua path: app.integrations.plaid.retrieve_single_statement
Full name: plaid.plaid_statements_download

Parameter	Type	Required	Description
No parameters.

refresh_statements_data Write

`/statements/refresh` initiates an on-demand extraction to fetch the statements for the provided dates.

Lua path: app.integrations.plaid.refresh_statements_data
Full name: plaid.plaid_statements_refresh

Parameter	Type	Required	Description
No parameters.

list_historical_log_item_consent_events Read

List a historical log of Item consent events. Consent logs are only available for events occurring on or after November 7, 2024. Extremely recent events (occurring within the pa...

Lua path: app.integrations.plaid.list_historical_log_item_consent_events
Full name: plaid.plaid_consent_events_get

Parameter	Type	Required	Description
No parameters.

list_historical_log_user_consent_events Read

List a historical log of user consent events

Lua path: app.integrations.plaid.list_historical_log_user_consent_events
Full name: plaid.plaid_item_activity_list

Parameter	Type	Required	Description
No parameters.

list_user_connected_applications Read

List a user’s connected applications

Lua path: app.integrations.plaid.list_user_connected_applications
Full name: plaid.plaid_item_application_list

Parameter	Type	Required	Description
No parameters.

unlink_user_connected_application Read

Unlink a user’s connected application. On an unlink request, Plaid will immediately revoke the Application’s access to the User’s data. The User will have to redo the OAut...

Lua path: app.integrations.plaid.unlink_user_connected_application
Full name: plaid.plaid_item_application_unlink

Parameter	Type	Required	Description
No parameters.

update_scopes_access_particular_application Write

Enable consumers to update product access on selected accounts for an application.

Lua path: app.integrations.plaid.update_scopes_access_particular_application
Full name: plaid.plaid_item_application_scopes_update

Parameter	Type	Required	Description
No parameters.

retrieve_information_about_application Read

Allows financial institutions to retrieve information about Plaid clients for the purpose of building control-tower experiences

Lua path: app.integrations.plaid.retrieve_information_about_application
Full name: plaid.plaid_application_get

Parameter	Type	Required	Description
No parameters.

retrieve_item Read

Returns information about the status of an Item.

Lua path: app.integrations.plaid.retrieve_item
Full name: plaid.plaid_item_get

Parameter	Type	Required	Description
No parameters.

retrieve_user_account Read

This endpoint returns user permissioned account data, including identity and Item access tokens, for use with [Plaid Layer](https://plaid.com/docs/layer). Note that end users ar...

Lua path: app.integrations.plaid.retrieve_user_account
Full name: plaid.plaid_user_account_session_get

Parameter	Type	Required	Description
No parameters.

send_user_account_session_event Read

This endpoint allows sending client-specific events related to Layer sessions for analytics and tracking purposes.

Lua path: app.integrations.plaid.send_user_account_session_event
Full name: plaid.plaid_user_account_session_event_send

Parameter	Type	Required	Description
No parameters.

check_user_network_status Read

The `/profile/network_status/get` endpoint can be used to check whether Plaid has a matching profile for the user.

Lua path: app.integrations.plaid.check_user_network_status
Full name: plaid.plaid_profile_network_status_get

Parameter	Type	Required	Description
No parameters.

check_user_network_status Read

The `/network/status/get` endpoint can be used to check whether Plaid has a matching profile for the user. This is useful for determining if a user is eligible for a streamlined...

Lua path: app.integrations.plaid.check_user_network_status
Full name: plaid.plaid_network_status_get

Parameter	Type	Required	Description
No parameters.

retrieve_auth_data Read

The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking, savings, and cas...

Lua path: app.integrations.plaid.retrieve_auth_data
Full name: plaid.plaid_auth_get

Parameter	Type	Required	Description
No parameters.

verify_auth_data Read

The `/auth/verify` endpoint verifies bank account and routing numbers and (optionally) account owner names against Plaid's database via [Database Auth](https://plaid.com/docs/au...

Lua path: app.integrations.plaid.verify_auth_data
Full name: plaid.plaid_auth_verify

Parameter	Type	Required	Description
No parameters.

get_transaction_data Read

Note: All new implementations are encouraged to use `/transactions/sync` rather than `/transactions/get`. `/transactions/sync` provides the same functionality as `/transactions/...

Lua path: app.integrations.plaid.get_transaction_data
Full name: plaid.plaid_transactions_get

Parameter	Type	Required	Description
No parameters.

refresh_transaction_data Write

`/transactions/refresh` is an optional endpoint that initiates an on-demand extraction to fetch the newest transactions for an Item. The on-demand extraction takes place in addi...

Lua path: app.integrations.plaid.refresh_transaction_data
Full name: plaid.plaid_transactions_refresh

Parameter	Type	Required	Description
No parameters.

create_sandbox_transactions Write

Use the `/sandbox/transactions/create` endpoint to create new transactions for an existing Item. This endpoint can be used to add up to 10 transactions to any Item at a time. Th...

Lua path: app.integrations.plaid.create_sandbox_transactions
Full name: plaid.plaid_sandbox_transactions_create

Parameter	Type	Required	Description
No parameters.

refresh_transaction_data_cashflow_report Write

`/cashflow_report/refresh` is an endpoint that initiates an on-demand extraction to fetch the newest transactions for an item (given an `item_id`). The item must already have Ca...

Lua path: app.integrations.plaid.refresh_transaction_data_cashflow_report
Full name: plaid.plaid_cashflow_report_refresh

Parameter	Type	Required	Description
No parameters.

gets_transaction_data_cashflow_report Read

The `/cashflow_report/get` endpoint retrieves transactions data associated with an item. Transactions data is standardized across financial institutions. Transactions are return...

Lua path: app.integrations.plaid.gets_transaction_data_cashflow_report
Full name: plaid.plaid_cashflow_report_get

Parameter	Type	Required	Description
No parameters.

gets_transaction_data_cashflow_report Read

The `/cashflow_report/transactions/get` endpoint retrieves transactions data associated with an item. Transactions data is standardized across financial institutions. Transactio...

Lua path: app.integrations.plaid.gets_transaction_data_cashflow_report
Full name: plaid.plaid_cashflow_report_transactions_get

Parameter	Type	Required	Description
No parameters.

gets_insights_data_cashflow_report Read

The `/cashflow_report/insights/get` endpoint retrieves insights data associated with an item. Insights are only calculated on credit and depository accounts.

Lua path: app.integrations.plaid.gets_insights_data_cashflow_report
Full name: plaid.plaid_cashflow_report_insights_get

Parameter	Type	Required	Description
No parameters.

fetch_recurring_transaction_streams Read

The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, s...

Lua path: app.integrations.plaid.fetch_recurring_transaction_streams
Full name: plaid.plaid_transactions_recurring_get

Parameter	Type	Required	Description
No parameters.

get_incremental_transaction_updates_item Read

The `/transactions/sync` endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For importan...

Lua path: app.integrations.plaid.get_incremental_transaction_updates_item
Full name: plaid.plaid_transactions_sync

Parameter	Type	Required	Description
No parameters.

enrich_locally_held_transaction_data Read

The `/transactions/enrich` endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources.

Lua path: app.integrations.plaid.enrich_locally_held_transaction_data
Full name: plaid.plaid_transactions_enrich

Parameter	Type	Required	Description
No parameters.

refresh_user_items_transactions_bundle Write

`/user/transactions/refresh` is an optional endpoint that initiates an on-demand extraction to fetch the newest transactions for a User using the Transactions bundle. This bundl...

Lua path: app.integrations.plaid.refresh_user_items_transactions_bundle
Full name: plaid.plaid_user_transactions_refresh

Parameter	Type	Required	Description
No parameters.

refresh_user_items_financial_insights_bundle Write

`/user/financial_data/refresh` is an optional endpoint that initiates an on-demand extraction to fetch the newest transactions for a User using the Financial Insights bundle. Th...

Lua path: app.integrations.plaid.refresh_user_items_financial_insights_bundle
Full name: plaid.plaid_user_financial_data_refresh

Parameter	Type	Required	Description
No parameters.

get_details_all_supported_institutions Read

Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. I...

Lua path: app.integrations.plaid.get_details_all_supported_institutions
Full name: plaid.plaid_institutions_get

Parameter	Type	Required	Description
No parameters.

search_institutions Read

Returns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query. Versioning note: API versions 2019-05...

Lua path: app.integrations.plaid.search_institutions
Full name: plaid.plaid_institutions_search

Parameter	Type	Required	Description
No parameters.

get_details_institution Read

Returns a JSON response containing details on a specified financial institution currently supported by Plaid. Versioning note: API versions 2019-05-29 and earlier allow use of t...

Lua path: app.integrations.plaid.get_details_institution
Full name: plaid.plaid_institutions_get_by_id

Parameter	Type	Required	Description
No parameters.

remove_item Write

The `/item/remove` endpoint allows you to remove an Item. Once removed, the `access_token`, as well as any processor tokens or bank account tokens associated with the Item, is n...

Lua path: app.integrations.plaid.remove_item
Full name: plaid.plaid_item_remove

Parameter	Type	Required	Description
No parameters.

terminate_products_item Read

The `/item/products/terminate` endpoint allows you to terminate an Item. Once terminated, the `access_token` associated with the Item is no longer valid, billing for the Item's ...

Lua path: app.integrations.plaid.terminate_products_item
Full name: plaid.plaid_item_products_terminate

Parameter	Type	Required	Description
No parameters.

report_fraud_item Read

Use this endpoint to create a fraud report and terminate the associated Item. The `access_token` associated with the Item will be deactivated and billing for the Item's products...

Lua path: app.integrations.plaid.report_fraud_item
Full name: plaid.plaid_item_handle_fraud_report

Parameter	Type	Required	Description
No parameters.

retrieve_accounts Read

The `/accounts/get` endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts — that is, accounts that a...

Lua path: app.integrations.plaid.retrieve_accounts
Full name: plaid.plaid_accounts_get

Parameter	Type	Required	Description
No parameters.

deprecated_get_legacy_categories Read

Send a request to the `/categories/get` endpoint to get detailed information on legacy categories returned by Plaid. This endpoint does not require authentication. All implement...

Lua path: app.integrations.plaid.deprecated_get_legacy_categories
Full name: plaid.plaid_categories_get

Parameter	Type	Required	Description
No parameters.

create_test_item_and_processor_token Write

Use the `/sandbox/processor_token/create` endpoint to create a valid `processor_token` for an arbitrary institution ID and test credentials. The created `processor_token` corres...

Lua path: app.integrations.plaid.create_test_item_and_processor_token
Full name: plaid.plaid_sandbox_processor_token_create

Parameter	Type	Required	Description
No parameters.

create_test_item Write

Use the `/sandbox/public_token/create` endpoint to create a valid `public_token` for an arbitrary institution ID, initial products, and test credentials. The created `public_tok...

Lua path: app.integrations.plaid.create_test_item
Full name: plaid.plaid_sandbox_public_token_create

Parameter	Type	Required	Description
No parameters.

fire_test_webhook Write

The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Webhook to be...

Lua path: app.integrations.plaid.fire_test_webhook
Full name: plaid.plaid_sandbox_item_fire_webhook

Parameter	Type	Required	Description
No parameters.

retrieve_real_time_balance_data Read

The `/accounts/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints, such as `/accounts/get`, return a balance object, `/acc...

Lua path: app.integrations.plaid.retrieve_real_time_balance_data
Full name: plaid.plaid_accounts_balance_get

Parameter	Type	Required	Description
No parameters.

retrieve_identity_data Read

The `/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addres...

Lua path: app.integrations.plaid.retrieve_identity_data
Full name: plaid.plaid_identity_get

Parameter	Type	Required	Description
No parameters.

returns_uploaded_document_identity Read

Use `/identity/documents/uploads/get` to retrieve identity details when using [Identity Document Upload](https://plaid.com/docs/identity/identity-document-upload/).

Lua path: app.integrations.plaid.returns_uploaded_document_identity
Full name: plaid.plaid_identity_documents_uploads_get

Parameter	Type	Required	Description
No parameters.

retrieve_identity_match_score Read

The `/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's fi...

Lua path: app.integrations.plaid.retrieve_identity_match_score
Full name: plaid.plaid_identity_match

Parameter	Type	Required	Description
No parameters.

refresh_identity_data Write

`/identity/refresh` is an optional endpoint for users of the Identity product. It initiates an on-demand extraction to fetch the most up to date Identity information from the Fi...

Lua path: app.integrations.plaid.refresh_identity_data
Full name: plaid.plaid_identity_refresh

Parameter	Type	Required	Description
No parameters.

retrieve_dashboard_user Read

The `/dashboard_user/get` endpoint provides details (such as email address) about a specific Dashboard user based on the `dashboard_user_id` field, which is returned in the `aud...

Lua path: app.integrations.plaid.retrieve_dashboard_user
Full name: plaid.plaid_dashboard_user_get

Parameter	Type	Required	Description
No parameters.

list_dashboard_users Read

The `/dashboard_user/list` endpoint provides details (such as email address) all Dashboard users associated with your account. This can use used to audit or track the list of re...

Lua path: app.integrations.plaid.list_dashboard_users
Full name: plaid.plaid_dashboard_user_list

Parameter	Type	Required	Description
No parameters.

create_new_identity_verification Write

Create a new Identity Verification for the user specified by the `client_user_id` and/or `user_id` field. At least one of these two fields must be provided. The requirements and...

Lua path: app.integrations.plaid.create_new_identity_verification
Full name: plaid.plaid_identity_verification_create

Parameter	Type	Required	Description
No parameters.

retrieve_identity_verification Read

Retrieve a previously created Identity Verification.

Lua path: app.integrations.plaid.retrieve_identity_verification
Full name: plaid.plaid_identity_verification_get

Parameter	Type	Required	Description
No parameters.

list_identity_verifications Read

Filter and list Identity Verifications created by your account

Lua path: app.integrations.plaid.list_identity_verifications
Full name: plaid.plaid_identity_verification_list

Parameter	Type	Required	Description
No parameters.

retry_identity_verification Write

Allow a customer to retry their Identity Verification

Lua path: app.integrations.plaid.retry_identity_verification
Full name: plaid.plaid_identity_verification_retry

Parameter	Type	Required	Description
No parameters.

create_watchlist_screening_entity Write

Create a new entity watchlist screening to check your customer against watchlists defined in the associated entity watchlist program. If your associated program has ongoing scre...

Lua path: app.integrations.plaid.create_watchlist_screening_entity
Full name: plaid.plaid_watchlist_screening_entity_create

Parameter	Type	Required	Description
No parameters.

get_entity_screening Read

Retrieve an entity watchlist screening.

Lua path: app.integrations.plaid.get_entity_screening
Full name: plaid.plaid_watchlist_screening_entity_get

Parameter	Type	Required	Description
No parameters.

list_history_entity_watchlist_screenings Read

List all changes to the entity watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be returned.

Lua path: app.integrations.plaid.list_history_entity_watchlist_screenings
Full name: plaid.plaid_watchlist_screening_entity_history_list

Parameter	Type	Required	Description
No parameters.

list_hits_entity_watchlist_screenings Read

List all hits for the entity watchlist screening.

Lua path: app.integrations.plaid.list_hits_entity_watchlist_screenings
Full name: plaid.plaid_watchlist_screening_entity_hit_list

Parameter	Type	Required	Description
No parameters.

list_entity_watchlist_screenings Read

List all entity screenings.

Lua path: app.integrations.plaid.list_entity_watchlist_screenings
Full name: plaid.plaid_watchlist_screening_entity_list

Parameter	Type	Required	Description
No parameters.

get_entity_watchlist_screening_program Read

Get an entity watchlist screening program

Lua path: app.integrations.plaid.get_entity_watchlist_screening_program
Full name: plaid.plaid_watchlist_screening_entity_program_get

Parameter	Type	Required	Description
No parameters.

list_entity_watchlist_screening_programs Read

List all entity watchlist screening programs

Lua path: app.integrations.plaid.list_entity_watchlist_screening_programs
Full name: plaid.plaid_watchlist_screening_entity_program_list

Parameter	Type	Required	Description
No parameters.

create_review_entity_watchlist_screening Write

Create a review for an entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.

Lua path: app.integrations.plaid.create_review_entity_watchlist_screening
Full name: plaid.plaid_watchlist_screening_entity_review_create

Parameter	Type	Required	Description
No parameters.

list_reviews_entity_watchlist_screenings Read

List all reviews for a particular entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits foun...

Lua path: app.integrations.plaid.list_reviews_entity_watchlist_screenings
Full name: plaid.plaid_watchlist_screening_entity_review_list

Parameter	Type	Required	Description
No parameters.

update_entity_screening Write

Update an entity watchlist screening.

Lua path: app.integrations.plaid.update_entity_screening
Full name: plaid.plaid_watchlist_screening_entity_update

Parameter	Type	Required	Description
No parameters.

create_watchlist_screening_person Write

Create a new Watchlist Screening to check your customer against watchlists defined in the associated Watchlist Program. If your associated program has ongoing screening enabled,...

Lua path: app.integrations.plaid.create_watchlist_screening_person
Full name: plaid.plaid_watchlist_screening_individual_create

Parameter	Type	Required	Description
No parameters.

retrieve_individual_watchlist_screening Read

Retrieve a previously created individual watchlist screening

Lua path: app.integrations.plaid.retrieve_individual_watchlist_screening
Full name: plaid.plaid_watchlist_screening_individual_get

Parameter	Type	Required	Description
No parameters.

list_history_individual_watchlist_screenings Read

List all changes to the individual watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be returned.

Lua path: app.integrations.plaid.list_history_individual_watchlist_screenings
Full name: plaid.plaid_watchlist_screening_individual_history_list

Parameter	Type	Required	Description
No parameters.

list_hits_individual_watchlist_screening Read

List all hits found by Plaid for a particular individual watchlist screening.

Lua path: app.integrations.plaid.list_hits_individual_watchlist_screening
Full name: plaid.plaid_watchlist_screening_individual_hit_list

Parameter	Type	Required	Description
No parameters.

list_individual_watchlist_screenings Read

List previously created watchlist screenings for individuals

Lua path: app.integrations.plaid.list_individual_watchlist_screenings
Full name: plaid.plaid_watchlist_screening_individual_list

Parameter	Type	Required	Description
No parameters.

get_individual_watchlist_screening_program Read

Get an individual watchlist screening program

Lua path: app.integrations.plaid.get_individual_watchlist_screening_program
Full name: plaid.plaid_watchlist_screening_individual_program_get

Parameter	Type	Required	Description
No parameters.

list_individual_watchlist_screening_programs Read

List all individual watchlist screening programs

Lua path: app.integrations.plaid.list_individual_watchlist_screening_programs
Full name: plaid.plaid_watchlist_screening_individual_program_list

Parameter	Type	Required	Description
No parameters.

create_review_individual_watchlist_screening Write

Create a review for the individual watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by P...

Lua path: app.integrations.plaid.create_review_individual_watchlist_screening
Full name: plaid.plaid_watchlist_screening_individual_review_create

Parameter	Type	Required	Description
No parameters.

list_reviews_individual_watchlist_screenings Read

List all reviews for the individual watchlist screening.

Lua path: app.integrations.plaid.list_reviews_individual_watchlist_screenings
Full name: plaid.plaid_watchlist_screening_individual_review_list

Parameter	Type	Required	Description
No parameters.

update_individual_watchlist_screening Write

Update a specific individual watchlist screening. This endpoint can be used to add additional customer information, correct outdated information, add a reference id, assign the ...

Lua path: app.integrations.plaid.update_individual_watchlist_screening
Full name: plaid.plaid_watchlist_screening_individual_update

Parameter	Type	Required	Description
No parameters.

evaluate_risk_bank_account Read

Use `/beacon/account_risk/v1/evaluate` to get risk insights for a linked account.

Lua path: app.integrations.plaid.evaluate_risk_bank_account
Full name: plaid.plaid_beacon_account_risk_evaluate

Parameter	Type	Required	Description
No parameters.

create_beacon_user Write

Create and scan a Beacon User against your Beacon Program, according to your program's settings. When you submit a new user to `/beacon/user/create`, several checks are performe...

Lua path: app.integrations.plaid.create_beacon_user
Full name: plaid.plaid_beacon_user_create

Parameter	Type	Required	Description
No parameters.

get_beacon_user Read

Fetch a Beacon User. The Beacon User is returned with all of their associated information and a `status` based on the Beacon Network duplicate record and fraud checks.

Lua path: app.integrations.plaid.get_beacon_user
Full name: plaid.plaid_beacon_user_get

Parameter	Type	Required	Description
No parameters.

review_beacon_user Read

Update the status of a Beacon User. When updating a Beacon User's status via this endpoint, Plaid validates that the status change is consistent with the related state for this ...

Lua path: app.integrations.plaid.review_beacon_user
Full name: plaid.plaid_beacon_user_review

Parameter	Type	Required	Description
No parameters.

create_beacon_report Write

Create a fraud report for a given Beacon User.

Lua path: app.integrations.plaid.create_beacon_report
Full name: plaid.plaid_beacon_report_create

Parameter	Type	Required	Description
No parameters.

list_beacon_reports_beacon_user Read

Use the `/beacon/report/list` endpoint to view all Beacon Reports you created for a specific Beacon User. The reports returned by this endpoint are exclusively reports you creat...

Lua path: app.integrations.plaid.list_beacon_reports_beacon_user
Full name: plaid.plaid_beacon_report_list

Parameter	Type	Required	Description
No parameters.

list_beacon_report_syndications_beacon_user Read

Use the `/beacon/report_syndication/list` endpoint to view all Beacon Reports that have been syndicated to a specific Beacon User. This endpoint returns Beacon Report Syndicatio...

Lua path: app.integrations.plaid.list_beacon_report_syndications_beacon_user
Full name: plaid.plaid_beacon_report_syndication_list

Parameter	Type	Required	Description
No parameters.

get_beacon_report Read

Returns a Beacon report for a given Beacon report id.

Lua path: app.integrations.plaid.get_beacon_report
Full name: plaid.plaid_beacon_report_get

Parameter	Type	Required	Description
No parameters.

get_beacon_report_syndication Read

Returns a Beacon Report Syndication for a given Beacon Report Syndication id.

Lua path: app.integrations.plaid.get_beacon_report_syndication
Full name: plaid.plaid_beacon_report_syndication_get

Parameter	Type	Required	Description
No parameters.

update_identity_data_beacon_user Write

Update the identity data for a Beacon User in your Beacon Program or add new accounts to the Beacon User. Similar to `/beacon/user/create`, several checks are performed immediat...

Lua path: app.integrations.plaid.update_identity_data_beacon_user
Full name: plaid.plaid_beacon_user_update

Parameter	Type	Required	Description
No parameters.

get_beacon_duplicate Read

Returns a Beacon Duplicate for a given Beacon Duplicate id. A Beacon Duplicate represents a pair of similar Beacon Users within your organization. Two Beacon User revisions are ...

Lua path: app.integrations.plaid.get_beacon_duplicate
Full name: plaid.plaid_beacon_duplicate_get

Parameter	Type	Required	Description
No parameters.

create_autofill_identity_verification Write

Try to autofill an Identity Verification based of the provided phone number, date of birth and country of residence.

Lua path: app.integrations.plaid.create_autofill_identity_verification
Full name: plaid.plaid_identity_verification_autofill_create

Parameter	Type	Required	Description
No parameters.

list_beacon_user_history Read

List all changes to the Beacon User in reverse-chronological order.

Lua path: app.integrations.plaid.list_beacon_user_history
Full name: plaid.plaid_beacon_user_history_list

Parameter	Type	Required	Description
No parameters.

get_account_insights_beacon_user Read

Get Account Insights for all Accounts linked to this Beacon User. The insights for each account are computed based on the information that was last retrieved from the financial ...

Lua path: app.integrations.plaid.get_account_insights_beacon_user
Full name: plaid.plaid_beacon_user_account_insights_get

Parameter	Type	Required	Description
No parameters.

get_protect_user_insights Read

Use this endpoint to get basic information about a user as it relates to their fraud profile with Protect.

Lua path: app.integrations.plaid.get_protect_user_insights
Full name: plaid.plaid_protect_user_insights_get

Parameter	Type	Required	Description
No parameters.

create_protect_report Write

Use this endpoint to create a Protect report to document fraud incidents, investigation outcomes, or other risk events. This endpoint allows you to report various types of incid...

Lua path: app.integrations.plaid.create_protect_report
Full name: plaid.plaid_protect_report_create

Parameter	Type	Required	Description
No parameters.

compute_protect_trust_index_score Read

Use this endpoint to compute a Protect Trust Index score and retrieve fraud attributes. For link-session models, if the Link session is not yet complete, the endpoint returns HT...

Lua path: app.integrations.plaid.compute_protect_trust_index_score
Full name: plaid.plaid_protect_compute

Parameter	Type	Required	Description
No parameters.

send_new_event_enrich_user_data Read

Send a new event to enrich user data and optionally get a Trust Index score for the event.

Lua path: app.integrations.plaid.send_new_event_enrich_user_data
Full name: plaid.plaid_protect_event_send

Parameter	Type	Required	Description
No parameters.

get_information_about_user_event Read

Get information about a user event including Trust Index score and fraud attributes.

Lua path: app.integrations.plaid.get_information_about_user_event
Full name: plaid.plaid_protect_event_get

Parameter	Type	Required	Description
No parameters.

get_business_verification Read

Retrieve the current state of a specific business verification.

Lua path: app.integrations.plaid.get_business_verification
Full name: plaid.plaid_business_verification_get

Parameter	Type	Required	Description
No parameters.

create_business_verification Write

Create a new business verification to check a business's identity and risk profile.

Lua path: app.integrations.plaid.create_business_verification
Full name: plaid.plaid_business_verification_create

Parameter	Type	Required	Description
No parameters.

retrieve_auth_data Read

The `/processor/auth/get` endpoint returns the bank account and bank identification number (such as the routing number, for US accounts), for a checking, savings, or cash manage...

Lua path: app.integrations.plaid.retrieve_auth_data
Full name: plaid.plaid_processor_auth_get

Parameter	Type	Required	Description
No parameters.

retrieve_account_associated_with_processor_token Read

This endpoint returns the account associated with a given processor token. This endpoint retrieves cached information, rather than extracting fresh information from the institut...

Lua path: app.integrations.plaid.retrieve_account_associated_with_processor_token
Full name: plaid.plaid_processor_account_get

Parameter	Type	Required	Description
No parameters.

retrieve_investment_holdings Read

This endpoint returns the stock position data of the account associated with a given processor token.

Lua path: app.integrations.plaid.retrieve_investment_holdings
Full name: plaid.plaid_processor_investments_holdings_get

Parameter	Type	Required	Description
No parameters.

get_investment_account_authentication_data Read

The `/processor/investments/auth/get` endpoint allows you to retrieve information about the account authorized by a processor token, including account numbers, account owners, h...

Lua path: app.integrations.plaid.get_investment_account_authentication_data
Full name: plaid.plaid_processor_investments_auth_get

Parameter	Type	Required	Description
No parameters.

get_investment_transactions_data Read

The `/processor/investments/transactions/get` endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for the investment account associated wi...

Lua path: app.integrations.plaid.get_investment_transactions_data
Full name: plaid.plaid_processor_investments_transactions_get

Parameter	Type	Required	Description
No parameters.

get_transaction_data Read

The `/processor/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with acc...

Lua path: app.integrations.plaid.get_transaction_data
Full name: plaid.plaid_processor_transactions_get

Parameter	Type	Required	Description
No parameters.

get_incremental_transaction_updates_processor_token Read

The `/processor/transactions/sync` endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. Fo...

Lua path: app.integrations.plaid.get_incremental_transaction_updates_processor_token
Full name: plaid.plaid_processor_transactions_sync

Parameter	Type	Required	Description
No parameters.

refresh_transaction_data Write

`/processor/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a proc...

Lua path: app.integrations.plaid.refresh_transaction_data
Full name: plaid.plaid_processor_transactions_refresh

Parameter	Type	Required	Description
No parameters.

fetch_recurring_transaction_streams Read

The `/processor/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s c...

Lua path: app.integrations.plaid.fetch_recurring_transaction_streams
Full name: plaid.plaid_processor_transactions_recurring_get

Parameter	Type	Required	Description
No parameters.

evaluate_planned_ach_transaction Read

Use `/processor/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment and additional risk signals. `/processor/signal/evaluate` uses Rulesets th...

Lua path: app.integrations.plaid.evaluate_planned_ach_transaction
Full name: plaid.plaid_processor_signal_evaluate

Parameter	Type	Required	Description
No parameters.

report_whether_you_initiated_ach_transaction Write

After you call `/processor/signal/evaluate`, Plaid will normally infer the outcome from your Signal Rules. However, if you are not using Signal Rules, if the Signal Rules outcom...

Lua path: app.integrations.plaid.report_whether_you_initiated_ach_transaction
Full name: plaid.plaid_processor_signal_decision_report

Parameter	Type	Required	Description
No parameters.

report_return_ach_transaction Read

Call the `/processor/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/processor/signal/evaluate` endpoint. Your feedback will be...

Lua path: app.integrations.plaid.report_return_ach_transaction
Full name: plaid.plaid_processor_signal_return_report

Parameter	Type	Required	Description
No parameters.

opt_processor_token_signal Read

When a processor token is not initialized with `signal`, call `/processor/signal/prepare` to opt-in that processor token to the data collection process, which will improve the a...

Lua path: app.integrations.plaid.opt_processor_token_signal
Full name: plaid.plaid_processor_signal_prepare

Parameter	Type	Required	Description
No parameters.

create_bank_transfer_processor Write

Use the `/processor/bank_transfer/create` endpoint to initiate a new bank transfer as a processor

Lua path: app.integrations.plaid.create_bank_transfer_processor
Full name: plaid.plaid_processor_bank_transfer_create

Parameter	Type	Required	Description
No parameters.

retrieve_liabilities_data Read

The `/processor/liabilities/get` endpoint returns various details about a loan or credit account. Liabilities data is available primarily for US financial institutions, with som...

Lua path: app.integrations.plaid.retrieve_liabilities_data
Full name: plaid.plaid_processor_liabilities_get

Parameter	Type	Required	Description
No parameters.

retrieve_identity_data Read

The `/processor/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, ...

Lua path: app.integrations.plaid.retrieve_identity_data
Full name: plaid.plaid_processor_identity_get

Parameter	Type	Required	Description
No parameters.

retrieve_identity_match_score Read

The `/processor/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account h...

Lua path: app.integrations.plaid.retrieve_identity_match_score
Full name: plaid.plaid_processor_identity_match

Parameter	Type	Required	Description
No parameters.

retrieve_balance_data Read

The `/processor/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints may return a balance object, only `/processor/balance/g...

Lua path: app.integrations.plaid.retrieve_balance_data
Full name: plaid.plaid_processor_balance_get

Parameter	Type	Required	Description
No parameters.

update_webhook_url Write

The POST `/item/webhook/update` allows you to update the webhook URL associated with an Item. This request triggers a [`WEBHOOK_UPDATE_ACKNOWLEDGED`](https://plaid.com/docs/api/...

Lua path: app.integrations.plaid.update_webhook_url
Full name: plaid.plaid_item_webhook_update

Parameter	Type	Required	Description
No parameters.

invalidate_access_token Write

By default, the `access_token` associated with an Item does not expire and should be stored in a persistent, secure manner. You can use the `/item/access_token/invalidate` endpo...

Lua path: app.integrations.plaid.invalidate_access_token
Full name: plaid.plaid_item_access_token_invalidate

Parameter	Type	Required	Description
No parameters.

get_webhook_verification_key Read

Plaid signs all outgoing webhooks and provides JSON Web Tokens (JWTs) so that you can verify the authenticity of any incoming webhooks to your application. A message signature i...

Lua path: app.integrations.plaid.get_webhook_verification_key
Full name: plaid.plaid_webhook_verification_key_get

Parameter	Type	Required	Description
No parameters.

retrieve_liabilities_data Read

The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with s...

Lua path: app.integrations.plaid.retrieve_liabilities_data
Full name: plaid.plaid_liabilities_get

Parameter	Type	Required	Description
No parameters.

create_payment_recipient Write

Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA) or a non-Eurozone co...

Lua path: app.integrations.plaid.create_payment_recipient
Full name: plaid.plaid_payment_initiation_recipient_create

Parameter	Type	Required	Description
No parameters.

reverse_existing_payment Read

Reverse a settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded. To refund partially, specify the amount as part of the re...

Lua path: app.integrations.plaid.reverse_existing_payment
Full name: plaid.plaid_payment_initiation_payment_reverse

Parameter	Type	Required	Description
No parameters.

get_payment_recipient Read

Get details about a payment recipient you have previously created.

Lua path: app.integrations.plaid.get_payment_recipient
Full name: plaid.plaid_payment_initiation_recipient_get

Parameter	Type	Required	Description
No parameters.

list_payment_recipients Read

The `/payment_initiation/recipient/list` endpoint list the payment recipients that you have previously created.

Lua path: app.integrations.plaid.list_payment_recipients
Full name: plaid.plaid_payment_initiation_recipient_list

Parameter	Type	Required	Description
No parameters.

create_payment Write

After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing ord...

Lua path: app.integrations.plaid.create_payment
Full name: plaid.plaid_payment_initiation_payment_create

Parameter	Type	Required	Description
No parameters.

create_payment_token Write

The `/payment_initiation/payment/token/create` endpoint has been deprecated. New Plaid customers will be unable to use this endpoint, and existing customers are encouraged to mi...

Lua path: app.integrations.plaid.create_payment_token
Full name: plaid.plaid_create_payment_token

Parameter	Type	Required	Description
No parameters.

create_payment_consent Write

The `/payment_initiation/consent/create` endpoint is used to create a payment consent, which can be used to initiate payments on behalf of the user. Payment consents are created...

Lua path: app.integrations.plaid.create_payment_consent
Full name: plaid.plaid_payment_initiation_consent_create

Parameter	Type	Required	Description
No parameters.

get_payment_consent Read

The `/payment_initiation/consent/get` endpoint can be used to check the status of a payment consent, as well as to receive basic information such as recipient and constraints.

Lua path: app.integrations.plaid.get_payment_consent
Full name: plaid.plaid_payment_initiation_consent_get

Parameter	Type	Required	Description
No parameters.

revoke_payment_consent Write

The `/payment_initiation/consent/revoke` endpoint can be used to revoke the payment consent. Once the consent is revoked, it is not possible to initiate payments using it.

Lua path: app.integrations.plaid.revoke_payment_consent
Full name: plaid.plaid_payment_initiation_consent_revoke

Parameter	Type	Required	Description
No parameters.

execute_single_payment_using_consent Read

The `/payment_initiation/consent/payment/execute` endpoint can be used to execute payments using payment consent.

Lua path: app.integrations.plaid.execute_single_payment_using_consent
Full name: plaid.plaid_payment_initiation_consent_payment_execute

Parameter	Type	Required	Description
No parameters.

force_sandbox_item_into_error_state Write

`/sandbox/item/reset_login/` forces an Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [u...

Lua path: app.integrations.plaid.force_sandbox_item_into_error_state
Full name: plaid.plaid_sandbox_item_reset_login

Parameter	Type	Required	Description
No parameters.

seed_connected_application_permissions_manager_sandbox_item Write

`/sandbox/item/application/seed` creates a test connected application on an existing Permissions Manager Item's login. The seeded application will appear in subsequent calls to ...

Lua path: app.integrations.plaid.seed_connected_application_permissions_manager_sandbox_item
Full name: plaid.plaid_sandbox_item_application_seed

Parameter	Type	Required	Description
No parameters.

set_verification_status_sandbox_account Write

The `/sandbox/item/set_verification_status` endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit ...

Lua path: app.integrations.plaid.set_verification_status_sandbox_account
Full name: plaid.plaid_sandbox_item_set_verification_status

Parameter	Type	Required	Description
No parameters.

force_item_sandbox_user_into_error_state Write

`/sandbox/user/reset_login/` functions the same as `/sandbox/item/reset_login`, but will modify Items related to a User. This endpoint forces each Item into an `ITEM_LOGIN_REQUI...

Lua path: app.integrations.plaid.force_item_sandbox_user_into_error_state
Full name: plaid.plaid_sandbox_user_reset_login

Parameter	Type	Required	Description
No parameters.

exchange_public_token_access_token Write

Exchange a Link `public_token` for an API `access_token`. Link hands off the `public_token` client-side via the `onSuccess` callback once a user has successfully created an Item...

Lua path: app.integrations.plaid.exchange_public_token_access_token
Full name: plaid.plaid_item_public_token_exchange

Parameter	Type	Required	Description
No parameters.

create_public_token Write

Note: As of July 2020, the `/item/public_token/create` endpoint is deprecated. Instead, use `/link/token/create` with an `access_token` to create a Link token for use with [upda...

Lua path: app.integrations.plaid.create_public_token
Full name: plaid.plaid_item_create_public_token

Parameter	Type	Required	Description
No parameters.

create_user Write

For Plaid products and flows that use the user object, `/user/create` provides you a single token to access all data associated with the user. You must call this endpoint before...

Lua path: app.integrations.plaid.create_user
Full name: plaid.plaid_user_create

Parameter	Type	Required	Description
No parameters.

retrieve_user_identity_and_information Read

Get user details using a `user_id`. This endpoint only supports users that were created on the new user API flow, without a `user_token`. For more details, see [New User APIs](h...

Lua path: app.integrations.plaid.retrieve_user_identity_and_information
Full name: plaid.plaid_user_get

Parameter	Type	Required	Description
No parameters.

remove_user_identity_data Write

This endpoint allows customers to explicitly purge identity/PII data provided to Plaid for a given user. This is not exposed to customers by default, as it is meant for special ...

Lua path: app.integrations.plaid.remove_user_identity_data
Full name: plaid.plaid_user_identity_remove

Parameter	Type	Required	Description
No parameters.

update_user_information Write

This endpoint updates user information for an existing `user_id` or `user_token`. If an existing `user_id` or `user_token` is missing fields required for a given use case (e.g. ...

Lua path: app.integrations.plaid.update_user_information
Full name: plaid.plaid_user_update

Parameter	Type	Required	Description
No parameters.

remove_user Write

`/user/remove` deletes a `user_id` or `user_token` and and associated information, including any Items associated with the user.

Lua path: app.integrations.plaid.remove_user
Full name: plaid.plaid_user_remove

Parameter	Type	Required	Description
No parameters.

terminate_user_based_products Read

`/user/products/terminate` terminates user-based recurring subscriptions for a given client user. This will remove user-based products (Financial Management, Protect, and CRA pr...

Lua path: app.integrations.plaid.terminate_user_based_products
Full name: plaid.plaid_user_products_terminate

Parameter	Type	Required	Description
No parameters.

get_items_associated_with_user Read

Returns Items associated with a `user_id`, along with their corresponding statuses. Plaid associates an Item with a User when it has been successfully connected within a Link se...

Lua path: app.integrations.plaid.get_items_associated_with_user
Full name: plaid.plaid_user_items_get

Parameter	Type	Required	Description
No parameters.

associate_items_user Read

Associates Items to the target user. If an Item is already associated to another user, the Item will be disassociated with the existing user and associated to the target user. T...

Lua path: app.integrations.plaid.associate_items_user
Full name: plaid.plaid_user_items_associate

Parameter	Type	Required	Description
No parameters.

remove_items_from_user Write

Removes specific Items associated with a user. It is equivalent to calling `/item/remove` on each Item individually, but supports use cases (such as Plaid Check) where access to...

Lua path: app.integrations.plaid.remove_items_from_user
Full name: plaid.plaid_user_items_remove

Parameter	Type	Required	Description
No parameters.

create_third_party_user_token Write

This endpoint is used to create a third-party user token. This token can be shared with and used by a specified third-party client to access data associated with the user throug...

Lua path: app.integrations.plaid.create_third_party_user_token
Full name: plaid.plaid_user_third_party_token_create

Parameter	Type	Required	Description
No parameters.

remove_third_party_user_token Write

This endpoint is used to delete a third-party user token. Once removed, the token can longer be used to access data associated with the user. Any subsequent calls to retrieve in...

Lua path: app.integrations.plaid.remove_third_party_user_token
Full name: plaid.plaid_user_third_party_token_remove

Parameter	Type	Required	Description
No parameters.

retrieve_link_sessions_your_user Read

This endpoint can be used for your end users after they complete the Link flow. This endpoint returns a list of Link sessions that your user completed, where each session includ...

Lua path: app.integrations.plaid.retrieve_link_sessions_your_user
Full name: plaid.plaid_credit_sessions_get

Parameter	Type	Required	Description
No parameters.

get_payment_details Read

The `/payment_initiation/payment/get` endpoint can be used to check the status of a payment, as well as to receive basic information such as recipient and payment amount. In the...

Lua path: app.integrations.plaid.get_payment_details
Full name: plaid.plaid_payment_initiation_payment_get

Parameter	Type	Required	Description
No parameters.

list_payments Read

The `/payment_initiation/payment/list` endpoint can be used to retrieve all created payments. By default, the 10 most recent payments are returned. You can request more payments...

Lua path: app.integrations.plaid.list_payments
Full name: plaid.plaid_payment_initiation_payment_list

Parameter	Type	Required	Description
No parameters.

get_investment_holdings Read

The `/investments/holdings/get` endpoint allows developers to receive user-authorized stock position data for `investment`-type accounts.

Lua path: app.integrations.plaid.get_investment_holdings
Full name: plaid.plaid_investments_holdings_get

Parameter	Type	Required	Description
No parameters.

get_investment_transactions Read

The `/investments/transactions/get` endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for investment accounts. Transactions are returned...

Lua path: app.integrations.plaid.get_investment_transactions
Full name: plaid.plaid_investments_transactions_get

Parameter	Type	Required	Description
No parameters.

refresh_investment_data Write

`/investments/refresh` is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest investment holdings and transaction...

Lua path: app.integrations.plaid.refresh_investment_data
Full name: plaid.plaid_investments_refresh

Parameter	Type	Required	Description
No parameters.

get_data_needed_authorize_investments_transfer Read

The `/investments/auth/get` endpoint allows developers to receive user-authorized data to facilitate the transfer of holdings

Lua path: app.integrations.plaid.get_data_needed_authorize_investments_transfer
Full name: plaid.plaid_investments_auth_get

Parameter	Type	Required	Description
No parameters.

create_processor_token Write

Used to create a token suitable for sending to one of Plaid's partners to enable integrations. Note that Stripe partnerships use bank account tokens instead; see `/processor/str...

Lua path: app.integrations.plaid.create_processor_token
Full name: plaid.plaid_processor_token_create

Parameter	Type	Required	Description
No parameters.

control_processor_access_products Write

Used to control a processor's access to products on the given processor token. By default, a processor will have access to all available products on the corresponding item. To r...

Lua path: app.integrations.plaid.control_processor_access_products
Full name: plaid.plaid_processor_token_permissions_set

Parameter	Type	Required	Description
No parameters.

get_processor_token_product_permissions Read

Used to get a processor token's product permissions. The `products` field will be an empty list if the processor can access all available products.

Lua path: app.integrations.plaid.get_processor_token_product_permissions
Full name: plaid.plaid_processor_token_permissions_get

Parameter	Type	Required	Description
No parameters.

update_processor_token_webhook_url Write

This endpoint allows you, the processor, to update the webhook URL associated with a processor token. This request triggers a `WEBHOOK_UPDATE_ACKNOWLEDGED` webhook to the newly ...

Lua path: app.integrations.plaid.update_processor_token_webhook_url
Full name: plaid.plaid_processor_token_webhook_update

Parameter	Type	Required	Description
No parameters.

create_stripe_bank_account_token Write

Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see [Add Stripe to your app](https://plaid...

Lua path: app.integrations.plaid.create_stripe_bank_account_token
Full name: plaid.plaid_processor_stripe_bank_account_token_create

Parameter	Type	Required	Description
No parameters.

create_apex_bank_account_token Write

Used to create a token suitable for sending to Apex to enable Plaid-Apex integrations.

Lua path: app.integrations.plaid.create_apex_bank_account_token
Full name: plaid.plaid_processor_apex_processor_token_create

Parameter	Type	Required	Description
No parameters.

import_item Write

`/item/import` creates an Item via your Plaid Exchange Integration and returns an `access_token`. As part of an `/item/import` request, you will include a User ID (`user_auth.us...

Lua path: app.integrations.plaid.import_item
Full name: plaid.plaid_item_import

Parameter	Type	Required	Description
No parameters.

create_link_token Write

The `/link/token/create` endpoint creates a `link_token`, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a `public_token`. F...

Lua path: app.integrations.plaid.create_link_token
Full name: plaid.plaid_link_token_create

Parameter	Type	Required	Description
No parameters.

get_link_token Read

The `/link/token/get` endpoint gets information about a Link session, including all callbacks fired during the session along with their metadata, including the public token. Thi...

Lua path: app.integrations.plaid.get_link_token
Full name: plaid.plaid_link_token_get

Parameter	Type	Required	Description
No parameters.

exchange_link_correlation_link_token Write

Exchange an OAuth `link_correlation_id` for the corresponding `link_token`. The `link_correlation_id` is only available for `payment_initiation` products and is provided to the ...

Lua path: app.integrations.plaid.exchange_link_correlation_link_token
Full name: plaid.plaid_link_oauth_correlation_id_exchange

Parameter	Type	Required	Description
No parameters.

create_link_token_layer Write

`/session/token/create` is used to create a Link token for Layer. The returned Link token is used as an parameter when initializing the Link SDK. For more details, see the [Link...

Lua path: app.integrations.plaid.create_link_token_layer
Full name: plaid.plaid_session_token_create

Parameter	Type	Required	Description
No parameters.

retrieve_transfer Read

The `/transfer/get` endpoint fetches information about the transfer corresponding to the given `transfer_id` or `authorization_id`. One of `transfer_id` or `authorization_id` mu...

Lua path: app.integrations.plaid.retrieve_transfer
Full name: plaid.plaid_transfer_get

Parameter	Type	Required	Description
No parameters.

retrieve_recurring_transfer Read

The `/transfer/recurring/get` fetches information about the recurring transfer corresponding to the given `recurring_transfer_id`.

Lua path: app.integrations.plaid.retrieve_recurring_transfer
Full name: plaid.plaid_transfer_recurring_get

Parameter	Type	Required	Description
No parameters.

retrieve_bank_transfer Read

The `/bank_transfer/get` fetches information about the bank transfer corresponding to the given `bank_transfer_id`.

Lua path: app.integrations.plaid.retrieve_bank_transfer
Full name: plaid.plaid_bank_transfer_get

Parameter	Type	Required	Description
No parameters.

create_transfer_authorization Write

Use the `/transfer/authorization/create` endpoint to authorize a transfer. This endpoint must be called prior to calling `/transfer/create`. The transfer authorization will expi...

Lua path: app.integrations.plaid.create_transfer_authorization
Full name: plaid.plaid_transfer_authorization_create

Parameter	Type	Required	Description
No parameters.

cancel_transfer_authorization Write

Use the `/transfer/authorization/cancel` endpoint to cancel a transfer authorization. A transfer authorization is eligible for cancellation if it has not yet been used to create...

Lua path: app.integrations.plaid.cancel_transfer_authorization
Full name: plaid.plaid_transfer_authorization_cancel

Parameter	Type	Required	Description
No parameters.

deprecated_retrieve_balance_held_with Read

(Deprecated) Use the `/transfer/balance/get` endpoint to view a balance held with Plaid.

Lua path: app.integrations.plaid.deprecated_retrieve_balance_held_with
Full name: plaid.plaid_transfer_balance_get

Parameter	Type	Required	Description
No parameters.

get_rtp_eligibility_information_transfer Read

Use the `/transfer/capabilities/get` endpoint to determine the RTP eligibility information of an account to be used with Transfer. This endpoint works on all Transfer-capable It...

Lua path: app.integrations.plaid.get_rtp_eligibility_information_transfer
Full name: plaid.plaid_transfer_capabilities_get

Parameter	Type	Required	Description
No parameters.

get_transfer_product_configuration Read

Use the `/transfer/configuration/get` endpoint to view your transfer product configurations.

Lua path: app.integrations.plaid.get_transfer_product_configuration
Full name: plaid.plaid_transfer_configuration_get

Parameter	Type	Required	Description
No parameters.

retrieve_ledger_balance Read

Use the `/transfer/ledger/get` endpoint to view a balance on the ledger held with Plaid.

Lua path: app.integrations.plaid.retrieve_ledger_balance
Full name: plaid.plaid_transfer_ledger_get

Parameter	Type	Required	Description
No parameters.

move_available_balance_between_ledgers Write

Use the `/transfer/ledger/distribute` endpoint to move available balance between ledgers, if you have multiple. If you’re a platform, you can move funds between one of your le...

Lua path: app.integrations.plaid.move_available_balance_between_ledgers
Full name: plaid.plaid_transfer_ledger_distribute

Parameter	Type	Required	Description
No parameters.

deposit_funds_into_ledger_balance Write

Use the `/transfer/ledger/deposit` endpoint to deposit funds into Plaid Ledger.

Lua path: app.integrations.plaid.deposit_funds_into_ledger_balance
Full name: plaid.plaid_transfer_ledger_deposit

Parameter	Type	Required	Description
No parameters.

withdraw_funds_from_ledger_balance Write

Use the `/transfer/ledger/withdraw` endpoint to withdraw funds from a Plaid Ledger balance.

Lua path: app.integrations.plaid.withdraw_funds_from_ledger_balance
Full name: plaid.plaid_transfer_ledger_withdraw

Parameter	Type	Required	Description
No parameters.

update_funding_account_associated_with_originator Write

Use the `/transfer/originator/funding_account/update` endpoint to update the funding account associated with the originator.

Lua path: app.integrations.plaid.update_funding_account_associated_with_originator
Full name: plaid.plaid_transfer_originator_funding_account_update

Parameter	Type	Required	Description
No parameters.

create_new_funding_account_originator Write

Use the `/transfer/originator/funding_account/create` endpoint to create a new funding account for the originator.

Lua path: app.integrations.plaid.create_new_funding_account_originator
Full name: plaid.plaid_transfer_originator_funding_account_create

Parameter	Type	Required	Description
No parameters.

get_transfer_product_usage_metrics Read

Use the `/transfer/metrics/get` endpoint to view your transfer product usage metrics. In the Sandbox environment, this endpoint returns static placeholder values rather than met...

Lua path: app.integrations.plaid.get_transfer_product_usage_metrics
Full name: plaid.plaid_transfer_metrics_get

Parameter	Type	Required	Description
No parameters.

create_transfer Write

Use the `/transfer/create` endpoint to initiate a new transfer. This endpoint is retryable and idempotent; if a transfer with the provided `transfer_id` has already been created...

Lua path: app.integrations.plaid.create_transfer
Full name: plaid.plaid_transfer_create

Parameter	Type	Required	Description
No parameters.

create_recurring_transfer Write

Use the `/transfer/recurring/create` endpoint to initiate a new recurring transfer. This capability is not currently supported for Transfer UI or Transfer for Platforms (beta) c...

Lua path: app.integrations.plaid.create_recurring_transfer
Full name: plaid.plaid_transfer_recurring_create

Parameter	Type	Required	Description
No parameters.

create_bank_transfer Write

Use the `/bank_transfer/create` endpoint to initiate a new bank transfer.

Lua path: app.integrations.plaid.create_bank_transfer
Full name: plaid.plaid_bank_transfer_create

Parameter	Type	Required	Description
No parameters.

list_transfers Read

Use the `/transfer/list` endpoint to see a list of all your transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retrieve the de...

Lua path: app.integrations.plaid.list_transfers
Full name: plaid.plaid_transfer_list

Parameter	Type	Required	Description
No parameters.

list_recurring_transfers Read

Use the `/transfer/recurring/list` endpoint to see a list of all your recurring transfers and their statuses. Results are paginated; use the `count` and `offset` query parameter...

Lua path: app.integrations.plaid.list_recurring_transfers
Full name: plaid.plaid_transfer_recurring_list

Parameter	Type	Required	Description
No parameters.

list_bank_transfers Read

Use the `/bank_transfer/list` endpoint to see a list of all your bank transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retri...

Lua path: app.integrations.plaid.list_bank_transfers
Full name: plaid.plaid_bank_transfer_list

Parameter	Type	Required	Description
No parameters.

cancel_transfer Write

Use the `/transfer/cancel` endpoint to cancel a transfer. A transfer is eligible for cancellation if the `cancellable` property returned by `/transfer/get` is `true`.

Lua path: app.integrations.plaid.cancel_transfer
Full name: plaid.plaid_transfer_cancel

Parameter	Type	Required	Description
No parameters.

cancel_recurring_transfer Write

Use the `/transfer/recurring/cancel` endpoint to cancel a recurring transfer. Scheduled transfer that hasn't been submitted to bank will be cancelled.

Lua path: app.integrations.plaid.cancel_recurring_transfer
Full name: plaid.plaid_transfer_recurring_cancel

Parameter	Type	Required	Description
No parameters.

cancel_bank_transfer Write

Use the `/bank_transfer/cancel` endpoint to cancel a bank transfer. A transfer is eligible for cancelation if the `cancellable` property returned by `/bank_transfer/get` is `true`.

Lua path: app.integrations.plaid.cancel_bank_transfer
Full name: plaid.plaid_bank_transfer_cancel

Parameter	Type	Required	Description
No parameters.

list_transfer_events Read

Use the `/transfer/event/list` endpoint to get a list of transfer events based on specified filter criteria.

Lua path: app.integrations.plaid.list_transfer_events
Full name: plaid.plaid_transfer_event_list

Parameter	Type	Required	Description
No parameters.

list_transfer_ledger_events Read

Use the `/transfer/ledger/event/list` endpoint to get a list of ledger events for a specific ledger based on specified filter criteria.

Lua path: app.integrations.plaid.list_transfer_ledger_events
Full name: plaid.plaid_transfer_ledger_event_list

Parameter	Type	Required	Description
No parameters.

list_bank_transfer_events Read

Use the `/bank_transfer/event/list` endpoint to get a list of Plaid-initiated ACH or bank transfer events based on specified filter criteria. When using Auth with micro-deposit ...

Lua path: app.integrations.plaid.list_bank_transfer_events
Full name: plaid.plaid_bank_transfer_event_list

Parameter	Type	Required	Description
No parameters.

sync_transfer_events Write

`/transfer/event/sync` allows you to request up to the next 500 transfer events that happened after a specific `event_id`. Use the `/transfer/event/sync` endpoint to guarantee y...

Lua path: app.integrations.plaid.sync_transfer_events
Full name: plaid.plaid_transfer_event_sync

Parameter	Type	Required	Description
No parameters.

sync_bank_transfer_events Write

`/bank_transfer/event/sync` allows you to request up to the next 25 Plaid-initiated bank transfer events that happened after a specific `event_id`. When using Auth with micro-de...

Lua path: app.integrations.plaid.sync_bank_transfer_events
Full name: plaid.plaid_bank_transfer_event_sync

Parameter	Type	Required	Description
No parameters.

retrieve_sweep Read

The `/transfer/sweep/get` endpoint fetches a sweep corresponding to the given `sweep_id`.

Lua path: app.integrations.plaid.retrieve_sweep
Full name: plaid.plaid_transfer_sweep_get

Parameter	Type	Required	Description
No parameters.

retrieve_sweep Read

The `/bank_transfer/sweep/get` endpoint fetches information about the sweep corresponding to the given `sweep_id`.

Lua path: app.integrations.plaid.retrieve_sweep
Full name: plaid.plaid_bank_transfer_sweep_get

Parameter	Type	Required	Description
No parameters.

list_sweeps Read

The `/transfer/sweep/list` endpoint fetches sweeps matching the given filters.

Lua path: app.integrations.plaid.list_sweeps
Full name: plaid.plaid_transfer_sweep_list

Parameter	Type	Required	Description
No parameters.

list_sweeps Read

The `/bank_transfer/sweep/list` endpoint fetches information about the sweeps matching the given filters.

Lua path: app.integrations.plaid.list_sweeps
Full name: plaid.plaid_bank_transfer_sweep_list

Parameter	Type	Required	Description
No parameters.

get_balance_your_bank_transfer_account Read

Use the `/bank_transfer/balance/get` endpoint to see the available balance in your bank transfer account. Debit transfers increase this balance once their status is posted. Cred...

Lua path: app.integrations.plaid.get_balance_your_bank_transfer_account
Full name: plaid.plaid_bank_transfer_balance_get

Parameter	Type	Required	Description
No parameters.

migrate_account_into_bank_transfers Write

As an alternative to adding Items via Link, you can also use the `/bank_transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. Note that...

Lua path: app.integrations.plaid.migrate_account_into_bank_transfers
Full name: plaid.plaid_bank_transfer_migrate_account

Parameter	Type	Required	Description
No parameters.

migrate_account_into_transfers Write

As an alternative to adding Items via Link, you can also use the `/transfer/migrate_account` endpoint to migrate previously-verified account and routing numbers to Plaid Items. ...

Lua path: app.integrations.plaid.migrate_account_into_transfers
Full name: plaid.plaid_transfer_migrate_account

Parameter	Type	Required	Description
No parameters.

create_transfer_intent_object_invoke_transfer_ui Write

Use the `/transfer/intent/create` endpoint to generate a transfer intent object and invoke the Transfer UI.

Lua path: app.integrations.plaid.create_transfer_intent_object_invoke_transfer_ui
Full name: plaid.plaid_transfer_intent_create

Parameter	Type	Required	Description
No parameters.

retrieve_more_information_about_transfer_intent Read

Use the `/transfer/intent/get` endpoint to retrieve more information about a transfer intent.

Lua path: app.integrations.plaid.retrieve_more_information_about_transfer_intent
Full name: plaid.plaid_transfer_intent_get

Parameter	Type	Required	Description
No parameters.

lists_historical_repayments Read

The `/transfer/repayment/list` endpoint fetches repayments matching the given filters. Repayments are returned in reverse-chronological order (most recent first) starting at the...

Lua path: app.integrations.plaid.lists_historical_repayments
Full name: plaid.plaid_transfer_repayment_list

Parameter	Type	Required	Description
No parameters.

list_returns_included_repayment Read

The `/transfer/repayment/return/list` endpoint retrieves the set of returns that were batched together into the specified repayment. The sum of amounts of returns retrieved by t...

Lua path: app.integrations.plaid.list_returns_included_repayment
Full name: plaid.plaid_transfer_repayment_return_list

Parameter	Type	Required	Description
No parameters.

submit_additional_onboarding_information_behalf_originator Write

Use the `/transfer/platform/requirement/submit` endpoint to submit additional onboarding information that is needed by Plaid to approve or decline the originator. See [Requireme...

Lua path: app.integrations.plaid.submit_additional_onboarding_information_behalf_originator
Full name: plaid.plaid_transfer_platform_requirement_submit

Parameter	Type	Required	Description
No parameters.

create_new_originator Write

Use the `/transfer/originator/create` endpoint to create a new originator and return an `originator_client_id`.

Lua path: app.integrations.plaid.create_new_originator
Full name: plaid.plaid_transfer_originator_create

Parameter	Type	Required	Description
No parameters.

generate_hosted_onboarding_ui_url Write

The `/transfer/questionnaire/create` endpoint generates a Plaid-hosted onboarding UI URL. Redirect the originator to this URL to provide their due diligence information and agre...

Lua path: app.integrations.plaid.generate_hosted_onboarding_ui_url
Full name: plaid.plaid_transfer_questionnaire_create

Parameter	Type	Required	Description
No parameters.

submit_transfer_diligence_behalf_originator Write

Use the `/transfer/diligence/submit` endpoint to submit transfer diligence on behalf of the originator (i.e., the end customer).

Lua path: app.integrations.plaid.submit_transfer_diligence_behalf_originator
Full name: plaid.plaid_transfer_diligence_submit

Parameter	Type	Required	Description
No parameters.

upload_transfer_diligence_document_behalf_originator Write

Third-party sender customers can use `/transfer/diligence/document/upload` endpoint to upload a document on behalf of its end customer (i.e. originator) to Plaid. You’ll need ...

Lua path: app.integrations.plaid.upload_transfer_diligence_document_behalf_originator
Full name: plaid.plaid_transfer_diligence_document_upload

Parameter	Type	Required	Description
No parameters.

get_status_originator_onboarding Read

The `/transfer/originator/get` endpoint gets status updates for an originator's onboarding process. This information is also available via the Transfer page on the Plaid dashboard.

Lua path: app.integrations.plaid.get_status_originator_onboarding
Full name: plaid.plaid_transfer_originator_get

Parameter	Type	Required	Description
No parameters.

get_status_all_originators_onboarding Read

The `/transfer/originator/list` endpoint gets status updates for all of your originators' onboarding. This information is also available via the Plaid dashboard.

Lua path: app.integrations.plaid.get_status_all_originators_onboarding
Full name: plaid.plaid_transfer_originator_list

Parameter	Type	Required	Description
No parameters.

create_refund Write

Use the `/transfer/refund/create` endpoint to create a refund for a transfer. A transfer can be refunded if the transfer was initiated in the past 180 days. Refunds come out of ...

Lua path: app.integrations.plaid.create_refund
Full name: plaid.plaid_transfer_refund_create

Parameter	Type	Required	Description
No parameters.

retrieve_refund Read

The `/transfer/refund/get` endpoint fetches information about the refund corresponding to the given `refund_id`.

Lua path: app.integrations.plaid.retrieve_refund
Full name: plaid.plaid_transfer_refund_get

Parameter	Type	Required	Description
No parameters.

cancel_refund Write

Use the `/transfer/refund/cancel` endpoint to cancel a refund. A refund is eligible for cancellation if it has not yet been submitted to the payment network.

Lua path: app.integrations.plaid.cancel_refund
Full name: plaid.plaid_transfer_refund_cancel

Parameter	Type	Required	Description
No parameters.

create_originator_transfer_platforms_customers Write

Use the `/transfer/platform/originator/create` endpoint to submit information about the originator you are onboarding, including the originator's agreement to the required legal...

Lua path: app.integrations.plaid.create_originator_transfer_platforms_customers
Full name: plaid.plaid_transfer_platform_originator_create

Parameter	Type	Required	Description
No parameters.

create_person_associated_with_originator Write

Use the `/transfer/platform/person/create` endpoint to create a person associated with an originator (e.g. beneficial owner or control person) and optionally submit personal ide...

Lua path: app.integrations.plaid.create_person_associated_with_originator
Full name: plaid.plaid_transfer_platform_person_create

Parameter	Type	Required	Description
No parameters.

simulate_bank_transfer_event_sandbox Write

Use the `/sandbox/bank_transfer/simulate` endpoint to simulate a bank transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when ...

Lua path: app.integrations.plaid.simulate_bank_transfer_event_sandbox
Full name: plaid.plaid_sandbox_bank_transfer_simulate

Parameter	Type	Required	Description
No parameters.

simulate_creating_sweep Write

Use the `/sandbox/transfer/sweep/simulate` endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all transfers with a sweep st...

Lua path: app.integrations.plaid.simulate_creating_sweep
Full name: plaid.plaid_sandbox_transfer_sweep_simulate

Parameter	Type	Required	Description
No parameters.

simulate_transfer_event_sandbox Write

Use the `/sandbox/transfer/simulate` endpoint to simulate a transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endp...

Lua path: app.integrations.plaid.simulate_transfer_event_sandbox
Full name: plaid.plaid_sandbox_transfer_simulate

Parameter	Type	Required	Description
No parameters.

simulate_refund_event_sandbox Write

Use the `/sandbox/transfer/refund/simulate` endpoint to simulate a refund event in the Sandbox environment. Note that while an event will be simulated and will appear when using...

Lua path: app.integrations.plaid.simulate_refund_event_sandbox
Full name: plaid.plaid_sandbox_transfer_refund_simulate

Parameter	Type	Required	Description
No parameters.

simulate_converting_pending_balance_available_balance Write

Use the `/sandbox/transfer/ledger/simulate_available` endpoint to simulate converting pending balance to available balance for all originators in the Sandbox environment.

Lua path: app.integrations.plaid.simulate_converting_pending_balance_available_balance
Full name: plaid.plaid_sandbox_transfer_ledger_simulate_available

Parameter	Type	Required	Description
No parameters.

simulate_ledger_deposit_event_sandbox Write

Use the `/sandbox/transfer/ledger/deposit/simulate` endpoint to simulate a ledger deposit event in the Sandbox environment.

Lua path: app.integrations.plaid.simulate_ledger_deposit_event_sandbox
Full name: plaid.plaid_sandbox_transfer_ledger_deposit_simulate

Parameter	Type	Required	Description
No parameters.

simulate_ledger_withdraw_event_sandbox Write

Use the `/sandbox/transfer/ledger/withdraw/simulate` endpoint to simulate a ledger withdraw event in the Sandbox environment.

Lua path: app.integrations.plaid.simulate_ledger_withdraw_event_sandbox
Full name: plaid.plaid_sandbox_transfer_ledger_withdraw_simulate

Parameter	Type	Required	Description
No parameters.

trigger_creation_repayment Write

Use the `/sandbox/transfer/repayment/simulate` endpoint to trigger the creation of a repayment. As a side effect of calling this route, a repayment is created that includes all ...

Lua path: app.integrations.plaid.trigger_creation_repayment
Full name: plaid.plaid_sandbox_transfer_repayment_simulate

Parameter	Type	Required	Description
No parameters.

manually_fire_transfer_webhook Write

Use the `/sandbox/transfer/fire_webhook` endpoint to manually trigger a `TRANSFER_EVENTS_UPDATE` webhook in the Sandbox environment.

Lua path: app.integrations.plaid.manually_fire_transfer_webhook
Full name: plaid.plaid_sandbox_transfer_fire_webhook

Parameter	Type	Required	Description
No parameters.

create_test_clock Write

Use the `/sandbox/transfer/test_clock/create` endpoint to create a `test_clock` in the Sandbox environment. A test clock object represents an independent timeline and has a `vir...

Lua path: app.integrations.plaid.create_test_clock
Full name: plaid.plaid_sandbox_transfer_test_clock_create

Parameter	Type	Required	Description
No parameters.

advance_test_clock Write

Use the `/sandbox/transfer/test_clock/advance` endpoint to advance a `test_clock` in the Sandbox environment. A test clock object represents an independent timeline and has a `v...

Lua path: app.integrations.plaid.advance_test_clock
Full name: plaid.plaid_sandbox_transfer_test_clock_advance

Parameter	Type	Required	Description
No parameters.

get_test_clock Read

Use the `/sandbox/transfer/test_clock/get` endpoint to get a `test_clock` in the Sandbox environment.

Lua path: app.integrations.plaid.get_test_clock
Full name: plaid.plaid_sandbox_transfer_test_clock_get

Parameter	Type	Required	Description
No parameters.

list_test_clocks Read

Use the `/sandbox/transfer/test_clock/list` endpoint to see a list of all your test clocks in the Sandbox environment, by ascending `virtual_time`. Results are paginated; use th...

Lua path: app.integrations.plaid.list_test_clocks
Full name: plaid.plaid_sandbox_transfer_test_clock_list

Parameter	Type	Required	Description
No parameters.

reset_login_payment_profile Write

`/sandbox/payment_profile/reset_login/` forces a Payment Profile into a state where the login is no longer valid. This makes it easy to test update mode for Payment Profile in t...

Lua path: app.integrations.plaid.reset_login_payment_profile
Full name: plaid.plaid_sandbox_payment_profile_reset_login

Parameter	Type	Required	Description
No parameters.

simulate_payment_event_sandbox Write

Use the `/sandbox/payment/simulate` endpoint to simulate various payment events in the Sandbox environment. This endpoint will trigger the corresponding payment status webhook.

Lua path: app.integrations.plaid.simulate_payment_event_sandbox
Full name: plaid.plaid_sandbox_payment_simulate

Parameter	Type	Required	Description
No parameters.

search_employer_database Read

`/employers/search` allows you the ability to search Plaid’s database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user's employer i...

Lua path: app.integrations.plaid.search_employer_database
Full name: plaid.plaid_employers_search

Parameter	Type	Required	Description
No parameters.

deprecated_create_income_verification_instance Write

`/income/verification/create` begins the income verification process by returning an `income_verification_id`. You can then provide the `income_verification_id` to `/link/token/...

Lua path: app.integrations.plaid.deprecated_create_income_verification_instance
Full name: plaid.plaid_income_verification_create

Parameter	Type	Required	Description
No parameters.

deprecated_retrieve_information_from_paystubs_used_income_verification Read

`/income/verification/paystubs/get` returns the information collected from the paystubs that were used to verify an end user's income. It can be called once the status of the ve...

Lua path: app.integrations.plaid.deprecated_retrieve_information_from_paystubs_used_income_verification
Full name: plaid.plaid_income_verification_paystubs_get

Parameter	Type	Required	Description
No parameters.

deprecated_download_original_documents_used_income_verification Read

`/income/verification/documents/download` provides the ability to download the source documents associated with the verification. If Document Income was used, the documents will...

Lua path: app.integrations.plaid.deprecated_download_original_documents_used_income_verification
Full name: plaid.plaid_income_verification_documents_download

Parameter	Type	Required	Description
No parameters.

deprecated_retrieve_information_from_tax_documents_used_income_verification Read

`/income/verification/taxforms/get` returns the information collected from forms that were used to verify an end user''s income. It can be called once the status of the verifica...

Lua path: app.integrations.plaid.deprecated_retrieve_information_from_tax_documents_used_income_verification
Full name: plaid.plaid_income_verification_taxforms_get

Parameter	Type	Required	Description
No parameters.

deprecated_check_digital_income_verification_eligibility_and_optimize_conversion Read

`/income/verification/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is suppo...

Lua path: app.integrations.plaid.deprecated_check_digital_income_verification_eligibility_and_optimize_conversion
Full name: plaid.plaid_income_verification_precheck

Parameter	Type	Required	Description
No parameters.

deprecated_retrieve_summary_individual_employment_information Read

`/employment/verification/get` returns a list of employments through a user payroll that was verified by an end user. This endpoint has been deprecated; new integrations should ...

Lua path: app.integrations.plaid.deprecated_retrieve_summary_individual_employment_information
Full name: plaid.plaid_employment_verification_get

Parameter	Type	Required	Description
No parameters.

create_asset_or_income_report_audit_copy_token Write

Plaid can create an Audit Copy token of an Asset Report and/or Income Report to share with a participating Government Sponsored Entity (GSE) if you participate in Fannie Mae's D...

Lua path: app.integrations.plaid.create_asset_or_income_report_audit_copy_token
Full name: plaid.plaid_credit_audit_copy_token_create

Parameter	Type	Required	Description
No parameters.

remove_audit_copy_token Write

The `/credit/audit_copy_token/remove` endpoint allows you to remove an Audit Copy. Removing an Audit Copy invalidates the `audit_copy_token` associated with it, meaning both you...

Lua path: app.integrations.plaid.remove_audit_copy_token
Full name: plaid.plaid_credit_report_audit_copy_remove

Parameter	Type	Required	Description
No parameters.

retrieve_asset_report_with_freddie_mac_format_only_freddie_mac_can_use_this_endpoint Read

The `credit/asset_report/freddie_mac/get` endpoint retrieves the Asset Report in Freddie Mac's JSON format.

Lua path: app.integrations.plaid.retrieve_asset_report_with_freddie_mac_format_only_freddie_mac_can_use_this_endpoint
Full name: plaid.plaid_credit_asset_report_freddie_mac_get

Parameter	Type	Required	Description
No parameters.

retrieve_asset_report_with_freddie_mac_format_aka_voa_verification_assets_and_verification_employment_voe_report_if_this_one_available_only_freddie_mac_can_use_this_endpoint

Read

The `credit/asset_report/freddie_mac/get` endpoint retrieves the Verification of Assets and Verification of Employment reports.

Lua path: app.integrations.plaid.retrieve_asset_report_with_freddie_mac_format_aka_voa_verification_assets_and_verification_employment_voe_report_if_this_one_available_only_freddie_mac_can_use_this_endpoint
Full name: plaid.plaid_credit_freddie_mac_reports_get

Parameter	Type	Required	Description
No parameters.

retrieve_information_from_bank_accounts_used_employment_verification Read

`/credit/bank_employment/get` returns the employment report(s) derived from bank transaction data for a specified user.

Lua path: app.integrations.plaid.retrieve_information_from_bank_accounts_used_employment_verification
Full name: plaid.plaid_credit_bank_employment_get

Parameter	Type	Required	Description
No parameters.

retrieve_information_from_bank_accounts_used_income_verification Read

`/credit/bank_income/get` returns the bank income report(s) for a specified user. A single report corresponds to all institutions linked in a single Link session. To include mul...

Lua path: app.integrations.plaid.retrieve_information_from_bank_accounts_used_income_verification
Full name: plaid.plaid_credit_bank_income_get

Parameter	Type	Required	Description
No parameters.

retrieve_information_from_bank_accounts_used_income_verification_pdf_format Read

`/credit/bank_income/pdf/get` returns the most recent bank income report for a specified user in PDF format. A single report corresponds to all institutions linked in a single L...

Lua path: app.integrations.plaid.retrieve_information_from_bank_accounts_used_income_verification_pdf_format
Full name: plaid.plaid_credit_bank_income_pdf_get

Parameter	Type	Required	Description
No parameters.

refresh_user_bank_income_information Write

`/credit/bank_income/refresh` is deprecated. The backend implementation was removed (returns an `Unimplemented` error at runtime), and the endpoint is no longer part of the docu...

Lua path: app.integrations.plaid.refresh_user_bank_income_information
Full name: plaid.plaid_credit_bank_income_refresh

Parameter	Type	Required	Description
No parameters.

subscribe_and_unsubscribe_proactive_notifications_user_income_profile Write

`/credit/bank_income/webhook/update` allows you to subscribe or unsubscribe a user for income webhook notifications. By default, all users start out unsubscribed. If a user is s...

Lua path: app.integrations.plaid.subscribe_and_unsubscribe_proactive_notifications_user_income_profile
Full name: plaid.plaid_credit_bank_income_webhook_update

Parameter	Type	Required	Description
No parameters.

update_parsing_configuration_document_income_verification Write

`/credit/payroll_income/parsing_config/update` updates the parsing configuration for a document income verification.

Lua path: app.integrations.plaid.update_parsing_configuration_document_income_verification
Full name: plaid.plaid_credit_payroll_income_parsing_config_update

Parameter	Type	Required	Description
No parameters.

retrieve_data_user_uploaded_bank_statements Read

`/credit/bank_statements/uploads/get` returns parsed data from bank statements uploaded by users as part of the Document Income flow. If your account is not enabled for Document...

Lua path: app.integrations.plaid.retrieve_data_user_uploaded_bank_statements
Full name: plaid.plaid_credit_bank_statements_uploads_get

Parameter	Type	Required	Description
No parameters.

retrieve_user_payroll_information Read

This endpoint gets payroll income information for a specific user, either as a result of the user connecting to their payroll provider or uploading a pay related document.

Lua path: app.integrations.plaid.retrieve_user_payroll_information
Full name: plaid.plaid_credit_payroll_income_get

Parameter	Type	Required	Description
No parameters.

retrieve_fraud_insights_user_manually_uploaded_document Read

`/credit/payroll_income/risk_signals/get` can be used as part of the Document Income flow to assess a user-uploaded document for signs of potential fraud or tampering. It return...

Lua path: app.integrations.plaid.retrieve_fraud_insights_user_manually_uploaded_document
Full name: plaid.plaid_credit_payroll_income_risk_signals_get

Parameter	Type	Required	Description
No parameters.

check_income_verification_eligibility_and_optimize_conversion Read

`/credit/payroll_income/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is sup...

Lua path: app.integrations.plaid.check_income_verification_eligibility_and_optimize_conversion
Full name: plaid.plaid_credit_payroll_income_precheck

Parameter	Type	Required	Description
No parameters.

retrieve_summary_individual_employment_information Read

`/credit/employment/get` returns a list of items with employment information from a user's payroll provider that was verified by an end user.

Lua path: app.integrations.plaid.retrieve_summary_individual_employment_information
Full name: plaid.plaid_credit_employment_get

Parameter	Type	Required	Description
No parameters.

refresh_digital_payroll_income_verification Write

`/credit/payroll_income/refresh` refreshes a given digital payroll income verification.

Lua path: app.integrations.plaid.refresh_digital_payroll_income_verification
Full name: plaid.plaid_credit_payroll_income_refresh

Parameter	Type	Required	Description
No parameters.

create_relay_token_share_asset_report_with_partner_client Write

Plaid can share an Asset Report directly with a participating third party on your behalf. The shared Asset Report is the exact same Asset Report originally created in `/asset_re...

Lua path: app.integrations.plaid.create_relay_token_share_asset_report_with_partner_client
Full name: plaid.plaid_credit_relay_create

Parameter	Type	Required	Description
No parameters.

retrieve_reports_associated_with_relay_token_that_was_shared_with_you Read

`/credit/relay/get` allows third parties to receive a report that was shared with them, using a `relay_token` that was created by the report owner.

Lua path: app.integrations.plaid.retrieve_reports_associated_with_relay_token_that_was_shared_with_you
Full name: plaid.plaid_credit_relay_get

Parameter	Type	Required	Description
No parameters.

retrieve_pdf_reports_associated_with_relay_token_that_was_shared_with_you_beta Read

`/credit/relay/pdf/get` allows third parties to receive a pdf report that was shared with them, using a `relay_token` that was created by the report owner. The `/credit/relay/pd...

Lua path: app.integrations.plaid.retrieve_pdf_reports_associated_with_relay_token_that_was_shared_with_you_beta
Full name: plaid.plaid_credit_relay_pdf_get

Parameter	Type	Required	Description
No parameters.

refresh_report_relay_token Write

The `/credit/relay/refresh` endpoint allows third parties to refresh a report that was relayed to them, using a `relay_token` that was created by the report owner. A new report ...

Lua path: app.integrations.plaid.refresh_report_relay_token
Full name: plaid.plaid_credit_relay_refresh

Parameter	Type	Required	Description
No parameters.

remove_relay_token Write

The `/credit/relay/remove` endpoint allows you to invalidate a `relay_token`. The third party holding the token will no longer be able to access or refresh the reports which the...

Lua path: app.integrations.plaid.remove_relay_token
Full name: plaid.plaid_credit_relay_remove

Parameter	Type	Required	Description
No parameters.

manually_fire_bank_transfer_webhook Write

Use the `/sandbox/bank_transfer/fire_webhook` endpoint to manually trigger a Bank Transfers webhook in the Sandbox environment.

Lua path: app.integrations.plaid.manually_fire_bank_transfer_webhook
Full name: plaid.plaid_sandbox_bank_transfer_fire_webhook

Parameter	Type	Required	Description
No parameters.

manually_fire_income_webhook Write

Use the `/sandbox/income/fire_webhook` endpoint to manually trigger a Payroll or Document Income webhook in the Sandbox environment.

Lua path: app.integrations.plaid.manually_fire_income_webhook
Full name: plaid.plaid_sandbox_income_fire_webhook

Parameter	Type	Required	Description
No parameters.

manually_fire_bank_income_webhook_sandbox Write

Use the `/sandbox/bank_income/fire_webhook` endpoint to manually trigger a Bank Income webhook in the Sandbox environment.

Lua path: app.integrations.plaid.manually_fire_bank_income_webhook_sandbox
Full name: plaid.plaid_sandbox_bank_income_fire_webhook

Parameter	Type	Required	Description
No parameters.

trigger_update_cash_flow_updates Write

Use the `/sandbox/cra/cashflow_updates/update` endpoint to manually trigger an update for Cash Flow Updates (Monitoring) in the Sandbox environment.

Lua path: app.integrations.plaid.trigger_update_cash_flow_updates
Full name: plaid.plaid_sandbox_cra_cashflow_updates_update

Parameter	Type	Required	Description
No parameters.

save_selected_accounts_when_connecting_platypus_oauth_institution Write

Save the selected accounts when connecting to the Platypus Oauth institution

Lua path: app.integrations.plaid.save_selected_accounts_when_connecting_platypus_oauth_institution
Full name: plaid.plaid_sandbox_oauth_select_accounts

Parameter	Type	Required	Description
No parameters.

evaluate_planned_ach_transaction Read

Use `/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment and additional risk signals. Before using `/signal/evaluate`, you must first [create...

Lua path: app.integrations.plaid.evaluate_planned_ach_transaction
Full name: plaid.plaid_signal_evaluate

Parameter	Type	Required	Description
No parameters.

schedule_planned_ach_transaction Read

Use `/signal/schedule` to schedule a planned ACH transaction.

Lua path: app.integrations.plaid.schedule_planned_ach_transaction
Full name: plaid.plaid_signal_schedule

Parameter	Type	Required	Description
No parameters.

report_whether_you_initiated_ach_transaction Write

After you call `/signal/evaluate`, Plaid will normally infer the outcome from your Signal Rules. However, if you are not using Signal Rules, if the Signal Rules outcome was `REV...

Lua path: app.integrations.plaid.report_whether_you_initiated_ach_transaction
Full name: plaid.plaid_signal_decision_report

Parameter	Type	Required	Description
No parameters.

report_return_ach_transaction Read

Call the `/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/signal/evaluate` endpoint. Your feedback will be used by the model t...

Lua path: app.integrations.plaid.report_return_ach_transaction
Full name: plaid.plaid_signal_return_report

Parameter	Type	Required	Description
No parameters.

opt_item_signal_transaction_scores Read

When an Item is not initialized with `signal`, call `/signal/prepare` to opt-in that Item to the data collection process used to develop a Signal Transaction Score. This should ...

Lua path: app.integrations.plaid.opt_item_signal_transaction_scores
Full name: plaid.plaid_signal_prepare

Parameter	Type	Required	Description
No parameters.

create_e_wallet Write

Create an e-wallet. The response is the newly created e-wallet object.

Lua path: app.integrations.plaid.create_e_wallet
Full name: plaid.plaid_wallet_create

Parameter	Type	Required	Description
No parameters.

fetch_e_wallet Read

Fetch an e-wallet. The response includes the current balance.

Lua path: app.integrations.plaid.fetch_e_wallet
Full name: plaid.plaid_wallet_get

Parameter	Type	Required	Description
No parameters.

fetch_list_e_wallets Read

This endpoint lists all e-wallets in descending order of creation.

Lua path: app.integrations.plaid.fetch_list_e_wallets
Full name: plaid.plaid_wallet_list

Parameter	Type	Required	Description
No parameters.

execute_transaction_using_e_wallet Read

Execute a transaction using the specified e-wallet. Specify the e-wallet to debit from, the counterparty to credit to, the idempotency key to prevent duplicate transactions, the...

Lua path: app.integrations.plaid.execute_transaction_using_e_wallet
Full name: plaid.plaid_wallet_transaction_execute

Parameter	Type	Required	Description
No parameters.

fetch_e_wallet_transaction Read

Fetch a specific e-wallet transaction

Lua path: app.integrations.plaid.fetch_e_wallet_transaction
Full name: plaid.plaid_wallet_transaction_get

Parameter	Type	Required	Description
No parameters.

list_e_wallet_transactions Read

This endpoint lists the latest transactions of the specified e-wallet. Transactions are returned in descending order by the `created_at` time.

Lua path: app.integrations.plaid.list_e_wallet_transactions
Full name: plaid.plaid_wallet_transaction_list

Parameter	Type	Required	Description
No parameters.

enhance_locally_held_transaction_data Read

The `/beta/transactions/v1/enhance` endpoint enriches raw transaction data provided directly by clients. The product is currently in beta.

Lua path: app.integrations.plaid.enhance_locally_held_transaction_data
Full name: plaid.plaid_transactions_enhance

Parameter	Type	Required	Description
No parameters.

create_transaction_category_rule Write

The `/transactions/rules/v1/create` endpoint creates transaction categorization rules. Rules will be applied on the Item's transactions returned in `/transactions/get` response....

Lua path: app.integrations.plaid.create_transaction_category_rule
Full name: plaid.plaid_transactions_rules_create

Parameter	Type	Required	Description
No parameters.

return_list_rules_created_item_associated_with_access_token Read

The `/transactions/rules/v1/list` returns a list of transaction rules created for the Item associated with the access token.

Lua path: app.integrations.plaid.return_list_rules_created_item_associated_with_access_token
Full name: plaid.plaid_transactions_rules_list

Parameter	Type	Required	Description
No parameters.

remove_transaction_rule Write

The `/transactions/rules/v1/remove` endpoint is used to remove a transaction rule.

Lua path: app.integrations.plaid.remove_transaction_rule
Full name: plaid.plaid_transactions_rules_remove

Parameter	Type	Required	Description
No parameters.

obtain_user_insights_based_transactions_sent_through_transactions_enrich Read

The `/beta/transactions/user_insights/v1/get` gets user insights for clients who have enriched data with `/transactions/enrich`. The product is currently in beta.

Lua path: app.integrations.plaid.obtain_user_insights_based_transactions_sent_through_transactions_enrich
Full name: plaid.plaid_transactions_user_insights_get

Parameter	Type	Required	Description
No parameters.

get_ewa_score_report Read

The `/beta/ewa_report/v1/get` endpoint provides an Earned Wage Access (EWA) score that quantifies the delinquency risk associated with a given item. The score is derived from a ...

Lua path: app.integrations.plaid.get_ewa_score_report
Full name: plaid.plaid_beta_ewa_report_v1_get

Parameter	Type	Required	Description
No parameters.

search_issue Read

Search for an issue associated with one of the following identifiers: `item_id`, `link_session_id` or Link session `request_id`. This endpoint returns a list of `Issue` objects,...

Lua path: app.integrations.plaid.search_issue
Full name: plaid.plaid_issues_search

Parameter	Type	Required	Description
No parameters.

get_issue Read

Retrieve detailed information about a specific `Issue`. This endpoint returns a single `Issue` object.

Lua path: app.integrations.plaid.get_issue
Full name: plaid.plaid_issues_get

Parameter	Type	Required	Description
No parameters.

subscribe_issue Write

Allows a user to subscribe to updates on a specific `Issue` using a POST method. Subscribers will receive webhook notifications when the issue status changes, particularly when ...

Lua path: app.integrations.plaid.subscribe_issue
Full name: plaid.plaid_issues_subscribe

Parameter	Type	Required	Description
No parameters.

create_payment_profile Write

Use `/payment_profile/create` endpoint to create a new payment profile. To initiate the account linking experience, call `/link/token/create` and provide the `payment_profile_to...

Lua path: app.integrations.plaid.create_payment_profile
Full name: plaid.plaid_payment_profile_create

Parameter	Type	Required	Description
No parameters.

get_payment_profile Read

Use `/payment_profile/get` endpoint to get the status of a given Payment Profile.

Lua path: app.integrations.plaid.get_payment_profile
Full name: plaid.plaid_payment_profile_get

Parameter	Type	Required	Description
No parameters.

remove_payment_profile Write

Use the `/payment_profile/remove` endpoint to remove a given Payment Profile. Once it’s removed, it can no longer be used to create transfers.

Lua path: app.integrations.plaid.remove_payment_profile
Full name: plaid.plaid_payment_profile_remove

Parameter	Type	Required	Description
No parameters.

creates_new_end_customer_reseller Write

The `/partner/customer/create` endpoint is used by reseller partners to create end customers. To create end customers, it should be called in the Production environment only, ev...

Lua path: app.integrations.plaid.creates_new_end_customer_reseller
Full name: plaid.plaid_partner_customer_create

Parameter	Type	Required	Description
No parameters.

returns_reseller_end_customer Read

The `/partner/customer/get` endpoint is used by reseller partners to retrieve data about a single end customer.

Lua path: app.integrations.plaid.returns_reseller_end_customer
Full name: plaid.plaid_partner_customer_get

Parameter	Type	Required	Description
No parameters.

enables_reseller_end_customer_production_environment Write

The `/partner/customer/enable` endpoint is used by reseller partners to enable an end customer in the full Production environment.

Lua path: app.integrations.plaid.enables_reseller_end_customer_production_environment
Full name: plaid.plaid_partner_customer_enable

Parameter	Type	Required	Description
No parameters.

removes_reseller_end_customer Write

The `/partner/customer/remove` endpoint is used by reseller partners to remove an end customer. Removing an end customer will remove it from view in the Plaid Dashboard and deac...

Lua path: app.integrations.plaid.removes_reseller_end_customer
Full name: plaid.plaid_partner_customer_remove

Parameter	Type	Required	Description
No parameters.

returns_oauth_institution_registration_information_given_end_customer Read

The `/partner/customer/oauth_institutions/get` endpoint is used by reseller partners to retrieve OAuth-institution registration information about a single end customer. To learn...

Lua path: app.integrations.plaid.returns_oauth_institution_registration_information_given_end_customer
Full name: plaid.plaid_partner_customer_oauth_institutions_get

Parameter	Type	Required	Description
No parameters.

creates_new_end_customer_reseller Write

The `/beta/partner/customer/v1/create` endpoint creates a new end customer record. You can provide as much information as you have available. If any required information is miss...

Lua path: app.integrations.plaid.creates_new_end_customer_reseller
Full name: plaid.plaid_beta_partner_customer_v1_create

Parameter	Type	Required	Description
No parameters.

retrieves_details_reseller_end_customer Read

The `/beta/partner/customer/v1/get` endpoint is used by reseller partners to retrieve data about a single end customer.

Lua path: app.integrations.plaid.retrieves_details_reseller_end_customer
Full name: plaid.plaid_beta_partner_customer_v1_get

Parameter	Type	Required	Description
No parameters.

updates_existing_end_customer Write

The `/beta/partner/customer/v1/update` endpoint updates an existing end customer record.

Lua path: app.integrations.plaid.updates_existing_end_customer
Full name: plaid.plaid_beta_partner_customer_v1_update

Parameter	Type	Required	Description
No parameters.

enables_reseller_end_customer_production_environment Write

The `/beta/partner/customer/v1/enable` endpoint is used by reseller partners to enable an end customer in the full Production environment.

Lua path: app.integrations.plaid.enables_reseller_end_customer_production_environment
Full name: plaid.plaid_beta_partner_customer_v1_enable

Parameter	Type	Required	Description
No parameters.

create_hosted_link_session Write

Use the `/link_delivery/create` endpoint to create a Hosted Link session.

Lua path: app.integrations.plaid.create_hosted_link_session
Full name: plaid.plaid_link_delivery_create

Parameter	Type	Required	Description
No parameters.

get_hosted_link_session Read

Use the `/link_delivery/get` endpoint to get the status of a Hosted Link session.

Lua path: app.integrations.plaid.get_hosted_link_session
Full name: plaid.plaid_link_delivery_get

Parameter	Type	Required	Description
No parameters.

webhook_receiver_fdx_notifications Read

A generic webhook receiver endpoint for FDX Event Notifications

Lua path: app.integrations.plaid.webhook_receiver_fdx_notifications
Full name: plaid.plaid_fdx_notifications

Parameter	Type	Required	Description
No parameters.

get_recipients Read

Returns a list of Recipients

Lua path: app.integrations.plaid.get_recipients
Full name: plaid.plaid_get_recipients

Parameter	Type	Required	Description
No parameters.

get_recipient Read

Get a specific recipient

Lua path: app.integrations.plaid.get_recipient
Full name: plaid.plaid_get_recipient

Parameter	Type	Required	Description
No parameters.

retrieve_network_insights_provided_access_tokens Read

This endpoint allows you to retrieve the Network Insights from a list of `access_tokens`.

Lua path: app.integrations.plaid.retrieve_network_insights_provided_access_tokens
Full name: plaid.plaid_network_insights_report_get

Parameter	Type	Required	Description
No parameters.