Plaid

Authentication: Item-Scoped Access Token (JWT)

The Get Plaid Item endpoint returns information about the Plaid Item ID encoded in the JWT passed to this request.

An item represents a single set of credentials at a financial institution. Items are the core object in the Plaid API - all other resources are nested under an item. This endpoint returns essential information about the item. This endpoint does not require a request body.

Authentication: Item-Scoped Access Token (JWT)

The Get Plaid Accounts endpoint returns information about the accounts associated with a single Plaid Item. Include an optional array of account_ids in your request body to filter the repsonse to only select accounts. If no account_ids are provided, all accounts associated with the item will be returned.

Authentication: Item-Scoped Access Token (JWT)

The Get Plaid Transactions endpoint returns information about the transactions associated with a single Plaid Item. Include any of the following optional parameters in your request body to filter the response:

• start_date: The earliest date for which to return transactions. If no start_date is provided, the earliest available transaction will be returned.
• end_date: The latest date for which to return transactions. If no end_date is provided, the latest available transaction will be returned.
• account_ids: An array of account IDs for which to return transactions. If no account_ids are provided, transactions for all accounts associated with the item will be returned.

Authentication: Item-Scoped Access Token (JWT)

The Get Plaid Investment Holdings endpoint returns information about the investment holdings associated with a single Plaid Item. Include any of the following optional parameters in your request body to filter the response:

• account_ids: An array of account_ids to retrieve for the Item. An error will be returned if a provided account_id is not associated with the Item.

Authentication: Item-Scoped Access Token (JWT)

The Get Plaid Liabilities retrieve various details about an Item with loan or credit accounts. The types of information returned by Liabilities can include balances and due dates, loan terms, and specific details such as the original loan amount and guarantor. Include any of the following optional parameters in your request body to filter the response:

• account_ids: An array of account_ids to retrieve for the Item. An error will be returned if a provided account_id is not associated with the Item.

Authentication: Item-Scoped Access Token (JWT)

The Get Plaid Identity Information endpoint returns a range of account holder details stored by the financial institution, such as names, email addresses, phone numbers, and physical addresses. It's important to note that while the retrieval of name data is assured, other pieces of information might not be available. In such cases, these fields will appear as empty arrays if the institution hasn't supplied them. Include any of the following optional parameters in your request body to filter the response:

• account_ids: An array of account IDs for which to return transactions. If no account_ids are provided, transactions for all accounts associated with the item will be returned.

Authentication: Item-Scoped Access Token (JWT)

The Get Plaid Auth Information endpoint provides details of bank account and bank identification numbers (like routing numbers for U.S. accounts) linked with an Item's checking and savings accounts. This includes key account information and balance details, subject to availability. Include any of the following optional parameters in your request body to filter the response:

• account_ids: An array of account IDs for which to return transactions. If no account_ids are provided, transactions for all accounts associated with the item will be returned.

Authentication: Item-Scoped Access Token (JWT)

The Get All Institutions endpoint returns a list of supported financial institutions. Include any of the following optional parameters in your request body to filter the response:

• count: The total number of institutions to return. This field is required and limited to 500.
• offset: The number of institutions to skip in pagination.

Authentication: Item-Scoped Access Token (JWT)

The Get Plaid Institution By Id endpoint returns the specific financial institution corresponding to the institution_id. Include any of the following optional parameters in your request body to filter the response:

• institution_id: The ID of the institution to get details about.

Authentication: Item-Scoped Access Token (JWT)

The Search Plaid Institutions endpoint returns financial institutions that match the query parameters. Include any of the following optional parameters in your request body to filter the response:

• query: A string search query to filter down results.

Authentication: Item-Scoped Access Token (JWT)

The Test a Plaid Webhook in the Sandbox endpoint is used to test that code correctly handles webhooks. Include any of the following optional parameters in your request body to filter the response:

• webhook_code: The webhook codes that can be fired by this test endpoint.