Allow or disallow product access by account. Unlisted (e.g. missing) accounts will be considered new_accounts.
Asset information about an account
A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by /accounts/balance/get.
A single account at a financial institution.
The account_filters specified in the original call to /link/token/create.
Identity information about an account
Identity match scores for an account
An object with keys of account_id’s that are mapped to their respective identity attributes that changed.
Allow the application to access specific products on this account
An optional object to filter /accounts/balance/get results.
An optional object containing payment details. If set, a payment risk assessment is performed and returned as AccountsBalanceGetResponsePaymentRiskAssessment.
This object provides detailed risk assessment for the requested transaction
An optional object to filter /accounts/get results.
AccountsGetResponse defines the response schema for /accounts/get and /accounts/balance/get.
Describes a consent activity.
A physical mailing address.
Data about the components comprising an address.
Data about the components comprising an address.
Score found by matching address provided by the API with the address on the account at the financial institution. The score can range from 0 to 100 where 100 is a perfect match and 0 is a no match. If the account contains multiple owners, the maximum match score is filled.
Metadata about the application
ApplicationGetResponse defines the response schema for /application/get
Information about the APR on the account.
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
Details about an asset.
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
An object representing an Asset Report
AssetReportAuditCopyCreateResponse defines the response schema for /asset_report/audit_copy/get
AssetReportAuditCopyRemoveResponse defines the response schema for /asset_report/audit_copy/remove
An optional object to filter /asset_report/create results. If provided, must be non-null. The optional user object is required for the report to be eligible for Fannie Mae’s Day 1 Certainty program.
AssetReportCreateResponse defines the response schema for /asset_report/create
AssetReportFilterResponse defines the response schema for /asset_report/filter
An object representing an Asset Report with Freddie Mac schema.
AssetReportFreddieGetResponse defines the response schema for /asset_report/get
An optional object to filter or add data to /asset_report/get results. If provided, must be non-null.
AssetReportGetResponse defines the response schema for /asset_report/get
A transaction within an investment account.
A representation of an Item within an Asset Report.
An optional object to filter or add data to /asset_report/get results. If provided, must be non-null.
An optional object to filter /asset_report/refresh results. If provided, cannot be null. If not specified, the options from the original call to /asset_report/create will be used.
AssetReportRefreshResponse defines the response schema for /asset_report/refresh
AssetReportRemoveResponse defines the response schema for /asset_report/remove
A transaction on the asset report
The user object allows you to provide additional information about the user to be appended to the Asset Report. All fields are optional. The first_name, last_name, and ssn fields are required if you would like the Report to be eligible for Fannie Mae’s Day 1 Certainty™ program.
An object representing…
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
Fired when Asset Report generation has failed. The resulting error will have an error_type of ASSET_REPORT_ERROR.
Fired when the Asset Report has been generated and /asset_report/get is ready to be called. If you attempt to retrieve an Asset Report before this webhook has fired, you’ll receive a response with the HTTP status code 400 and a Plaid error code of PRODUCT_NOT_READY.
An object containing identifying numbers used for making electronic transfers to and from the accounts. The identifying number type (ACH, EFT, IBAN, or BACS) used will depend on the country of the account. An account may have more than one number type. If a particular identifying number type is not used by any accounts for which data has been requested, the array for that type will be empty.
An optional object to filter /auth/get results.
AuthGetResponse defines the response schema for /auth/get
Metadata that captures information about the Auth features of an institution.
Metadata specifically related to which auth methods an institution supports.
Fired when an Item is verified via automated micro-deposits. We recommend communicating to your users when this event is received to notify them that their account is verified and ready for use.
Fired when a bank income report has finished generating or failed to generate, triggered by calling /credit/bank_income/get in CRA enabled client.
Fired when a refreshed bank income report has finished generating or failed to generate, triggered by calling
/credit/bank_income/refresh. To get this webhook, subscribe via the
Dashboard.
Fired when a change to the user’s income is detected. You should call
/credit/bank_income/refresh to get updated income data for the user. To receive this webhook, subscribe in the
Dashboard.
The object contains a risk score and a risk tier that evaluate the transaction return risk because an account is overdrawn or because an ineligible account is used. Common return codes in this category include: “R01”, “R02”, “R03”, “R04”, “R06”, “R08”, “R09”, “R13”, “R16”, “R17”, “R20”, “R23”. These returns have a turnaround time of 2 banking days.
Represents a bank transfer within the Bank Transfers API.
Information about the balance of a bank transfer
Defines the response schema for /bank_transfer/balance/get
Defines the response schema for /bank_transfer/cancel
Defines the response schema for /bank_transfer/create
Represents an event in the Bank Transfers API.
Defines the response schema for /bank_transfer/event/list
Defines the response schema for /bank_transfer/event/sync
The failure reason if the type of this transfer is "failed" or "reversed". Null value otherwise.
Defines the response schema for /bank_transfer/get
Defines the response schema for /bank_transfer/list
The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply:
The JSON values must be Strings (no nested JSON objects allowed)
Only ASCII characters may be used
Maximum of 50 key/value pairs
Maximum key length of 40 characters
Maximum value length of 500 characters
Defines the response schema for /bank_transfer/migrate_account
BankTransferSweep describes a sweep transfer.
BankTransferSweepGetResponse defines the response schema for /bank_transfer/sweep/get
BankTransferSweepListResponse defines the response schema for /bank_transfer/sweep/list
The legal name and other information for the account holder.
Fired when new bank transfer events are available. Receiving this webhook indicates you should fetch the new events from /bank_transfer/event/sync.
An object representing a Base Report
Base Report information about an account
Base Report information about an account’s balances
Calculated insights derived from transaction-level data.
Average dollar amount of credit or debit transactions out of the account. This field will only added for depository accounts
BaseReportGetResponse defines the response schema for /cra/base_report/get
A representation of an Item within a Base Report.
Largest number of days between sequential transactions per calendar month
The number of credits or debits out of the account. This field will only added for depository accounts
A transaction on the Base Report
It is possible for an Base Report to be returned with missing account owner information. In such cases, the Base Report will contain warning data in the response, indicating why obtaining the owner information failed.
Fired when Base Report generation has failed. The resulting error will have an error_type of BASE_REPORT_ERROR.
Fired when the Base Report has been generated and /cra/base_report/get is ready to be called. If you attempt to retrieve a Base Report before this webhook has fired, you’ll receive a response with the HTTP status code 400 and a Plaid error code of PRODUCT_NOT_READY.
Information about the last change made to the parent object specifying what caused the change as well as when it occurred.
Fired when a Beacon User created within your organization matches one of your existing users.
A Beacon Duplicate represents a pair of matching Beacon Users and an analysis of the fields they matched on.
Analysis of which fields matched between one Beacon User and another.
A Beacon Report describes the type of fraud committed by a user as well as the date the fraud was committed and the total amount of money lost due to the fraud incident.
A Beacon Report describes the type of fraud committed by a user as well as the date the fraud was committed and the total amount of money lost due to the fraud incident.
Fired when one of your Beacon Users is first reported to the Beacon network.
A Beacon Report describes the type of fraud committed by a user as well as the date the fraud was committed and the total amount of money lost due to the fraud incident.
The response schema for /beacon/report/list
A Beacon Report Syndication represents a Beacon Report created either by your organization or another Beacon customer that matches a specific Beacon User you’ve created.
Analysis of which fields matched between the originally reported Beacon User and the Beacon User that the report was syndicated to.
Fired when a report created on the Beacon Network matches with one of your Beacon Users.
A Beacon Report Syndication represents a Beacon Report created either by your organization or another Beacon customer that matches a specific Beacon User you’ve created.
The response schema for /beacon/report_syndication/list
A subset of information from a Beacon Report that has been syndicated to a matching Beacon User in your program.
Fired when one of your existing Beacon Reports has been modified or removed from the Beacon Network.
Even if an address has been collected, some fields may be null depending on the region’s addressing system. For example:
A Beacon User represents an end user that has been scanned against the Beacon Network.
A Beacon User’s data and resulting analysis when checked against duplicate records and the Beacon Fraud Network.
A Beacon User represents an end user that has been scanned against the Beacon Network.
The ID number associated with a Beacon User.
The full name for a given Beacon User.
The full name for a given Beacon User.
A Beacon User’s data which is used to check against duplicate records and the Beacon Fraud Network.
A Beacon User Revision identifies a Beacon User at some point in its revision history.
Fired when a Beacon User status has changed, which can occur manually via the dashboard or when information is reported to the Beacon network.
A subset of a Beacon User’s data which is used to patch the existing identity data associated with a Beacon User. At least one field must be provided,.
A Beacon User represents an end user that has been scanned against the Beacon Network.
CategoriesGetResponse defines the response schema for /categories/get
Information describing a transaction category
Insights object for categories.
Insights on a user’s top personal finance categories.
An error object and associated item_id used to identify a specific Item and error when a batch operation operating on multiple Items has encountered an error in one of the Items.
A client-provided transaction that Plaid has enhanced.
A client-provided transaction that Plaid has enriched.
A client-provided transaction for Plaid to enhance.
A client-provided transaction for Plaid to enrich.
A representation of where a transaction took place.
Describes the connected application for a particular end user.
ConsumerReportUserIdentity defines the user identity data collected for consumer report purpose. This field is required to be set if you later use the created user for consumer report purpose.
The counterparty, such as the merchant or financial institution, is extracted by Plaid from the raw description.
Insights around a user’s counterparties
The report of the Bank Income data for an end user.
The Item’s bank accounts that have the selected data.
An error object and associated item_id used to identify a specific Item and error when a batch operation operating on multiple Items has encountered an error in one of the Items.
Fired when a bank income report has finished generating or failed to generate, triggered by calling /cra/bank_income/get.
The object containing employer data.
CraBankIncomeGetResponse defines the response schema for /cra/bank_income/get.
The end user’s monthly summary for the income source(s).
The details and metadata for an end user’s Item.
Detailed information for the income source.
Summary for bank income across all income sources and items (max history of 730 days).
The transactions data for the end user’s income source(s).
The warning associated with the data that was unavailable for the Bank Income Report.
An object representing an end user’s 1099 tax form
An object representing a filer used by 1099-K tax documents.
An object representing a payer used by 1099-MISC tax documents.
An object representing a recipient used in both 1099-K and 1099-MISC tax documents.
This contains an amount, denominated in the currency specified by either iso_currency_code or unofficial_currency_code
CreditAuditCopyTokenCreateResponse defines the response schema for /credit/audit_copy_token/get
CreditAuditCopyTokenRemoveResponse defines the response schema for /credit/audit_copy_token/remove
CreditAuditCopyTokenUpdateResponse defines the response schema for /credit/audit_copy_token/update
Object containing employer data.
Detailed information for the bank employment.
CreditBankEmploymentGetResponse defines the response schema for /beta/credit/v1/bank_employment/get.
The details and metadata for an end user’s Item.
The report of the Bank Employment data for an end user.
The warning associated with the data that was unavailable for the Bank Employment Report.
The report of the Bank Income data for an end user.
The Item’s bank accounts that have the selected data.
An error object and associated item_id used to identify a specific Item and error when a batch operation operating on multiple Items has encountered an error in one of the Items.
An optional object for /credit/bank_income/get request options.
CreditBankIncomeGetResponse defines the response schema for /credit/bank_income/get
The end user’s monthly summary for the income source(s).
The details and metadata for an end user’s Item.
An optional object for /credit/bank_income/refresh request options.
CreditBankIncomeRefreshResponse defines the response schema for /credit/bank_income/refresh.
Detailed information for the income source.
Summary for bank income across all income sources and items (max history of 730 days).
The transactions data for the end user’s income source(s).
The warning associated with the data that was unavailable for the Bank Income Report.
CreditBankIncomeWebhookUpdateResponse defines the response schema for /credit/bank_income/webhook/update.
An object containing data about the owner of the bank account for the uploaded bank statement.
Address on the uploaded bank statement
An object containing data about a user’s bank account related to an uploaded bank statement.
An object containing data on the overall period of the statement.
An object containing information about the bank statement upload Item.
An object containing data that has been parsed from a user-uploaded bank statement.
An object containing data about a transaction appearing on a user-uploaded bank statement.
CreditBankStatementsUploadsGetResponse defines the response schema for /credit/bank_statements/uploads/get
An object representing a credit card account.
Information describing the intent of the transaction. Most relevant for credit use cases, but not limited to such use cases.
Object representing metadata pertaining to the document.
An object containing employer data.
CreditEmploymentGetResponse defines the response schema for /credit/employment/get.
The object containing employment items.
The object containing proof of employment data for an individual.
A filter to apply to credit-type accounts
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
An object representing…
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
Information specific to a mortgage loan agreement between one or more borrowers and a mortgage lender.
Collection of current and previous identifiers for this loan.
A collection of loans that are part of a single deal.
A collection of objects that define specific parties to a deal. This includes the direct participating parties, such as borrower and seller and the indirect parties such as the credit report provider.
A collection of information about a single party to a transaction. Included direct participants like the borrower and seller as well as indirect participants such as the flood certificate provider.
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
Information about an report identifier and a report name.
CreditFreddieMacReportsGetResponse defines the response schema for /credit/freddie_mac/reports/get
A collection of details related to a fulfillment service or product in terms of request, process and result.
A collection of objects that describe requests and responses for services.
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
An object representing an Asset Report with Freddie Mac schema.
An object representing an end user’s pay stub.
Address on the pay stub.
An object with the deduction information found on a pay stub.
An object representing both a breakdown of earnings on a pay stub and the total earnings.
Data about the employee.
Information about the employer on the pay stub.
An object representing information about the net pay amount on the pay stub.
Defines the response body for /credit/payroll_income/get.
CreditPayrollIncomeParsingConfigUpdateResponse defines the response schema for /credit/payroll_income/documents/update.
Defines the response schema for /credit/payroll_income/precheck.
An optional object for /credit/payroll_income/refresh request options.
CreditPayrollIncomeRefreshResponse defines the response schema for /credit/payroll_income/refresh
CreditPayrollIncomeRiskSignalsGetRequest defines the response schema for /credit/payroll_income/risk_signals/get
The object containing a set of ids related to an employee.
CreditRelayCreateResponse defines the response schema for /credit/relay/create
CreditRelayRefreshResponse defines the response schema for /credit/relay/refresh
CreditRelayRemoveResponse defines the response schema for /credit/relay/remove
Metadata and results for a Link session
The details of a bank employment verification in Link.
The details of a bank income verification in Link
The details of a document income verification in Link
The details of a Link error.
The details of an Item add in Link.
The details of a digital payroll income verification in Link
The set of results for a Link session.
CreditSessionsGetResponse defines the response schema for /credit/sessions/get
W2 is an object that represents income data taken from a W2 tax document.
The object contains a risk score and a risk tier that evaluate the transaction return risk of an unauthorized debit. Common return codes in this category include: “R05”, “R07”, “R10”, “R11”, “R29”. These returns typically have a return time frame of up to 60 calendar days. During this period, the customer of financial institutions can dispute a transaction as unauthorized.
Account information associated with a team member with access to the Plaid dashboard.
Account information associated with a team member with access to the Plaid dashboard.
Paginated list of dashboard users
A date range with a start and end date
An object with the deduction information found on a paystub.
An object representing the deduction line items for the pay period
An object representing the total deductions for the pay period
Fired when new transaction data is available for an Item. Plaid will typically check for new transaction data several times a day.
The user’s address.
DepositSwitchAltCreateResponse defines the response schema for /deposit_switch/alt/create
Options to configure the /deposit_switch/create request. If provided, cannot be null.
DepositSwitchCreateResponse defines the response schema for /deposit_switch/create
DepositSwitchGetResponse defines the response schema for /deposit_switch/get
Fired when the status of a deposit switch request has changed.
The deposit switch destination account
The deposit switch target user
DepositSwitchTokenCreateResponse defines the response schema for /deposit_switch/token/create
A filter to apply to depository-type accounts
Originator and their status.
A possible account detected to be associated with a transaction user.
Information about the accounts that the payment was distributed to.
High level descriptions of how the associated document was processed. If a document fails verification, the details in the analysis object should help clarify why the document was rejected.
An object representing metadata from the end user’s uploaded document.
Details about a certain reason as to why a document could potentially be fraudulent.
An object which contains additional metadata about the institution used to compute the verification attribute
Object containing fraud risk data for a set of income documents.
A summary across all risk signals associated with a document
Data, images, analysis, and results from the documentary_verification step. This field will be null unless steps.documentary_verification has reached a terminal state of either success or failed.
Images, extracted data, and analysis from a user’s identity document
An object representing both a breakdown of earnings on a paystub and the total earnings.
An object representing the earnings line items for the pay period.
An object representing both the current pay period and year to date amount for an earning category.
An object representing an email address
Score found by matching email provided by the API with the email on the account at the financial institution. 100 is a perfect match and 0 is a no match. If the account contains multiple owners, the maximum match score is filled.
Data about the employee.
Data about the employer.
An object containing employer data.
EmployersSearchResponse defines the response schema for /employers/search.
An object representing employment details found on a paystub.
An object containing proof of employment data for an individual
EmploymentVerificationGetResponse defines the response schema for /employment/verification/get.
A grouping of the Plaid produced transaction enhancement fields.
A grouping of the Plaid produced transaction enrichment fields.
An official document, usually issued by a governing body or institution, with an associated identifier.
Analysis information describing why a screening hit matched the provided entity information
Information associated with the entity watchlist hit
Analyzed documents for the associated hit
Email address information for the associated entity watchlist hit
Analyzed emails for the associated hit
Name information for the associated entity watchlist hit
Analyzed names for the associated hit
Phone number information associated with the entity screening hit
URLs associated with the entity screening hit
Analyzed URLs for the associated hit
Analyzed phone numbers for the associated hit
Fired when an entity screening status has changed, which can occur manually via the dashboard or during ongoing monitoring.
A program that configures the active lists, search parameters, and other behavior for initial and ongoing screening of entities.
The entity screening object allows you to represent an entity in your system, update its profile, and search for it on various watchlists. Note: Rejected entity screenings will not receive new hits, regardless of entity program configuration.
Data from a government watchlist that has been attached to the screening.
A review submitted by a team member for an entity watchlist screening. A review can be either a comment on the current screening state, actions taken
against hits attached to the watchlist screening, or both.
Search terms associated with an entity used for searching against watchlists
Search inputs for creating an entity watchlist screening
Additional payment consent options
Additional payment options
Details about external payment refund
The schedule that the payment will be executed on. If a schedule is provided, the payment is automatically set up as a standing order. If no schedule is specified, the payment will be executed only once.
Fires when an account is automatically verified using micro-deposits
Fires when an account has an expired verification when using micro-deposits
Financial Institution provider-specific attribute
REST application constraint (Hypermedia As The Engine Of Application State)
Custom key-value pairs payload for a notification
FDX Participant - an entity or person that is a part of a FDX API transaction
Insights surrounding external financial institution counterparties associated with a user.
The amount and currency of the fraud or attempted fraud.
fraud_amount should be omitted to indicate an unknown fraud amount.
Analyzed location information for the associated hit
A status health incident
An object representing a balance held by an account in the past
Fired when an Item’s historical transaction pull is completed and Plaid has prepared as much historical transaction data as possible for the Item. Once this webhook has been fired, transaction data beyond the most recent 30 days can be fetched for the Item. If
Account Select v2 is enabled, this webhook will also be fired if account selections for the Item are updated, with
new_transactions set to the number of net new transactions pulled after the account selection update.
A securities holding at an institution.
Fired when new or updated holdings have been detected on an investment account. The webhook typically fires in response to any newly added holdings or price changes to existing holdings, most commonly after market close.
Specify the holdings on the account.
Contains the state of a hosted same-day microdeposits verification session.
Fired when a change to identity data has been detected on an Item. Items are checked for identity updates every 30-90 days. We recommend that upon receiving this webhook you make another call to /identity/get to fetch the user’s latest identity data.
Document object with metadata of the document uploaded
In closed beta. Object representing metadata pertaining to the document.
An optional object to filter /identity/get results.
IdentityGetResponse defines the response schema for /identity/get
An optional object to filter /identity/match results
IdentityMatchResponse defines the response schema for /identity/match
The user’s legal name, phone number, email address and address used to perform fuzzy match. If Financial Account Matching is enabled in the Identity Verification product, leave this field empty to automatically match against PII collected from the Identity Verification checks.
IdentityRefreshResponse defines the response schema for /identity/refresh
A identity verification attempt represents a customer’s attempt to verify their identity, reflecting the required steps for completing the session, the results for each step, and information collected in the process.
Even if an address has been autofilled, some fields may be null depending on the region’s addressing system. For example:
Autofill represents unverified customer information. This needs to be confirmed by the customer before using.
User information that was autofilled. All this information should be confirmed by the user before using.
User information collected outside of Link, most likely via your own onboarding process.
A identity verification attempt represents a customer’s attempt to verify their identity, reflecting the required steps for completing the session, the results for each step, and information collected in the process.
The address extracted from the document. The address must at least contain the following fields to be a valid address: street, city, country. If any are missing or unable to be extracted, the address will be null.
A identity verification attempt represents a customer’s attempt to verify their identity, reflecting the required steps for completing the session, the results for each step, and information collected in the process.
Paginated list of Plaid sessions.
User information collected outside of Link, most likely via your own onboarding process.
You can use this field to pre-populate the user’s legal name; if it is provided here, they will not be prompted to enter their name in the identity verification attempt.
The full name provided by the user. If the user has not submitted their name, this field will be null. Otherwise, both fields are guaranteed to be filled.
Fired when identity verification has been retried, which can be triggered via the dashboard or the API.
Instructions for the custom retry strategy specifying which steps should be required or skipped.
A identity verification attempt represents a customer’s attempt to verify their identity, reflecting the required steps for completing the session, the results for each step, and information collected in the process.
Fired when the status of an identity verification has been updated, which can be triggered via the dashboard or the API.
Each step will be one of the following values:
Fired when an end user has completed a step of the Identity Verification process.
The resource ID and version number of the template configuring the behavior of a given Identity Verification.
Even if an address has been collected, some fields may be null depending on the region’s addressing system. For example:
The identity data that was either collected from the user or provided via API in order to perform an Identity Verification.
An update on the health incident
An object representing a breakdown of the different income types on the paystub.
Specify payroll data on the account.
Field number for income summary
Data about the income summary
Optional arguments for /income/verification/create
IncomeVerificationCreateResponse defines the response schema for /income/verification/create.
IncomeVerificationPaystubsGetResponse defines the response schema for /income/verification/paystubs/get.
Information about the end user’s employer
The address of the employer
Data about military info in the income verification precheck.
Information about the end user’s payroll institution
IncomeVerificationPrecheckResponse defines the response schema for /income/verification/precheck.
Information about the user whose eligibility is being evaluated.
Fired when the attempt to refresh Payroll Income data for a user via /credit/payroll_income/refresh failed because the user must re-connect their payroll account.
Fired when risk signals have been processed for documents uploaded via Document Income. It will typically take a minute or two for this webhook to fire after the end user has uploaded their documents in the Document Income flow. Once this webhook has fired, /credit/payroll_income/risk_signals/get may then be called to determine whether the documents were successfully processed and to retrieve risk data.
Fired when the status of an income verification instance has changed. It will typically take several minutes for this webhook to fire after the end user has uploaded their documents in the Document Income flow.
IncomeVerificationTaxformsGetResponse defines the response schema for /income/verification/taxforms/get
Parent container for name that allows for choice group between parsed and unparsed containers.Parent container for name that allows for choice group between parsed and unparsed containers.
Name information for the associated individual watchlist hit
A program that configures the active lists, search parameters, and other behavior for initial and ongoing screening of individuals.
The inflow_model allows you to model a test account that receives regular income or make regular payments on a loan. Any transactions generated by the inflow_model will appear in addition to randomly generated test data or transactions specified by override_accounts.
Fired when an Item’s initial transaction pull is completed. Once this webhook has been fired, transaction data for the most recent 30 days can be fetched for the Item. If
Account Select v2 is enabled, this webhook will also be fired if account selections for the Item are updated, with
new_transactions set to the number of net new transactions pulled after the account selection update.
Details relating to a specific financial institution
The status of an institution is determined by the health of its Item logins, Transactions updates, Investments updates, Liabilities updates, Auth requests, Balance requests, Identity requests, Investments requests, and Liabilities requests. A login attempt is conducted during the initial Item add in Link. If there is not enough traffic to accurately calculate an institution’s status, Plaid will return null rather than potentially inaccurate data.
Fired when institution status meets the conditions configured in the developer dashboard.
Contains the RTP network and types supported by the linked Item’s institution.
Specifies optional parameters for /institutions/get_by_id. If provided, must not be null.
InstitutionsGetByIdResponse defines the response schema for /institutions/get_by_id
An optional object to filter /institutions/get results.
InstitutionsGetResponse defines the response schema for /institutions/get
Additional options that will be used to filter institutions by various Payment Initiation configurations.
An optional object to filter /institutions/search results.
InstitutionsSearchResponse defines the response schema for /institutions/search
A filter to apply to investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier).
An optional object to filter /investments/holdings/get results. If provided, must not be null.
A transaction within an investment account.
Identifying information for transferring holdings to an investments account.
An optional object to filter /investments/auth/get results.
InvestmentsAuthGetResponse defines the response schema for /investments/auth/get
Information on the ownership of an investments account
Fired when new transactions have been detected on an investment account.
Fired after an asynchronous extraction on an investments account.
InvestmentsHoldingsGetResponse defines the response schema for /investments/holdings/get
InvestmentsRefreshResponse defines the response schema for /investments/refresh
An optional object to filter /investments/transactions/get results. If provided, must be non-null.
InvestmentsTransactionsGetResponse defines the response schema for /investments/transactions/get
Specify the list of investments transactions on the account.
Metadata about the Item.
ItemAccessTokenInvalidateResponse defines the response schema for /item/access_token/invalidate
Describes a historical log of user consent events.
Describes the connected application for a particular end user.
ItemApplicationScopesUpdateResponse defines the response schema for /item/application/scopes/update
ItemApplicationUnlinkResponse defines the response schema for /item/application/unlink
Fired when an error is encountered with an Item. The error can be resolved by having the user go through Link’s update mode.
ItemGetResponse defines the response schema for /item/get and /item/webhook/update
An optional object to configure /item/import request.
Object of user ID and auth token pair, permitting Plaid to aggregate a user’s accounts
ItemImportResponse defines the response schema for /item/import
Fired when an Item has exited the ITEM_LOGIN_REQUIRED state without the user having gone through the update mode flow in your app (this can happen if the user completed the update mode in a different app). If you have messaging that tells the user to complete the update mode flow, you should silence this messaging upon receiving the LOGIN_REPAIRED webhook.
Fired once Plaid calculates income from an Item.
ItemPublicTokenCreateResponse defines the response schema for /item/public_token/create
ItemPublicTokenExchangeResponse defines the response schema for /item/public_token/exchange
ItemRemoveResponse defines the response schema for /item/remove
An object with information about the status of the Item.
Information about the last successful and failed investments update for the Item.
Information about the last webhook fired for the Item.
Information about the last successful and failed transactions update for the Item.
ItemWebhookUpdateResponse defines the response schema for /item/webhook/update
A JSON Web Key (JWK) that can be used in conjunction with
JWT libraries to verify Plaid webhooks
Result summary object specifying how the address field matched.
Result summary object specifying how the date_of_birth field matched.
Additional information for the kyc_check step. This field will be null unless steps.kyc_check has reached a terminal state of either success or failed.
Result summary object specifying how the id_number field matched.
Result summary object specifying how the name field matched.
Result summary object specifying how the phone field matched.
Describes the last time each datatype was accessed by an application.
An object with keys of account_id’s that are mapped to their respective liabilities fields that changed.
The webhook of type LIABILITIES and code DEFAULT_UPDATE will be fired when new or updated liabilities have been detected on a liabilities item.
An optional object to filter /liabilities/get results. If provided, options cannot be null.
LiabilitiesGetResponse defines the response schema for /liabilities/get
An object containing liability accounts
Used to configure Sandbox test data for the Liabilities product
Information related to the callback from the Hosted Link session.
Information related to account attached to the connected Item
Webhook containing metadata proxied over from Link callback e.g onEvent, onExit, onSuccess.
The communication method containing both the type and address to send the URL.
LinkDeliveryCreateResponse defines the response schema for /link_delivery/create
LinkDeliveryGetRequest defines the response schema for /link_delivery/get
Information related to the financial institution.
Information related to the related to the delivery of the link session to users
Optional metadata related to the Hosted Link session
Metadata related to the recipient. If the information required to populate this field is not available, leave it blank.
An event that occurred while the user was going through Link
Contains a summary of the events from a link session
LinkOAuthCorrelationIdExchangeResponse defines the response schema for /link/oauth/correlation_id/exchange
An object representing an
onExit callback from Link.
Displayed if a user exits Link without successfully linking an Item.
An institution object. If the Item was created via Same-Day micro-deposit verification, will be null.
Contains the state of a completed Link session, along with the public token if available.
An object representing an
onSuccess callback from Link.
Displayed once a user has successfully linked their Item.
An account attached to the connected Item.
An institution object. If the Item was created via Same-Day micro-deposit verification, will be null.
By default, Link will provide limited account filtering: it will only display Institutions that are compatible with all products supplied in the
products parameter of
/link/token/create, and, if
auth is specified in the
products array, will also filter out accounts other than
checking and
savings accounts on the Account Select pane. You can further limit the accounts shown in Link by using
account_filters to specify the account subtypes to be shown in Link. Only the specified subtypes will be shown. This filtering applies to both the Account Select view (if enabled) and the Institution Select view. Institutions that do not support the selected subtypes will be omitted from Link. To indicate that all subtypes should be shown, use the value
"all". If the
account_filters filter is used, any account type for which a filter is not specified will be entirely omitted from Link. For a full list of valid types and subtypes, see the
Account schema.
A map containing data to pass in for the Card Switch flow.
Configuration parameters for Hosted Link (beta). Only available for participants in the Hosted Link beta program.
A map containing data used to highlight institutions in Link.
Specifies options for initializing Link for use with the Auth product. This field can be used to enable or disable extended Auth flows for the resulting Link session. Omitting any field will result in a default that can be configured by your account manager.
Specifies options for initializing Link for use with the Base Report product. This field is required if assets is included in the products array and the client is CRA-enabled.
Specifies options for initializing Link for use with the Deposit Switch (beta) product. This field is required if deposit_switch is included in the products array.
Specifies options for initializing Link for use with the Employment product. This field is required if employment is included in the products array.
Specifies options for initializing Link for use with Bank Employment. This field is required if employment is included in the products array and bank is specified in employment_source_types.
Specifies option for initializing Link for use with the Identity Verification product.
Specifies options for initializing Link for use with the Income product. This field is required if income_verification is included in the products array.
Specifies options for initializing Link for use with Bank Income. This field is required if income_verification is included in the products array and bank is specified in income_source_types.
Specifies options for initializing Link for use with Payroll Income (including Document Income). Further customization options for Document Income, such as customizing which document types may be uploaded, are also available via the
Link Customization pane in the Dashboard. (Requires Production enablement.)
Specifies options for initializing Link for use with the Payment Initiation (Europe) product. This field is required if payment_initiation is included in the products array. Either payment_id or consent_id must be provided.
Specifies options for initializing Link for use with the Statements product.
Specifies options for initializing Link for use with the Transfer product.
Specifies options for initializing Link for
update mode.
An object specifying information about the end user who will be linking their account.
Specifies user stated income sources for the Income product
LinkTokenCreateResponse defines the response schema for /link/token/create
Configuration parameters for EU flows
An object specifying the arguments originally provided to the /link/token/create call.
LinkTokenGetResponse defines the response schema for /link/token/get
An object containing information about a link session. This field will only be present if your client is enabled for Hosted Link (beta). Session data will be provided for up to six hours after the session has ended.
Configuration parameters for the Investments product
Configuration parameters for the Investments Auth Product
Configuration parameters for the Transactions product
Webhook indicating that the status of the delivery of the Hosted Link session to a user
Information specific to a mortgage loan agreement between one or more borrowers and a mortgage lender.
A filter to apply to loan-type accounts
The information used to identify this loan by various parties to the transaction or other organizations.
Collection of current and previous identifiers for this loan.
A collection of loans that are part of a single deal.
A representation of where a transaction took place
Summary object reflecting the match result of the associated data
Insights into a user’s top merchants.
Allows specifying the metadata of the test account
Object containing metadata about the interest rate for the mortgage.
Contains details about a mortgage account.
Object containing fields describing property address.
Object containing risk signals and relevant metadata for a set of uploaded documents
Score found by matching name provided by the API with the name on the account at the financial institution. If the account contains multiple owners, the maximum match score is filled.
An object representing information about the net pay amount on the paystub.
Account and bank identifier number data used to configure the test account. All values are optional.
Identifying information for transferring holdings to an investments account via ACATS.
Identifying information for transferring money to or from a US account via ACH or wire transfer.
Identifying information for transferring holdings to an investments account via ATON.
Identifying information for transferring money to or from a UK bank account via BACS.
Identifying information for transferring money to or from a Canadian bank account via EFT.
Identifying information for transferring money to or from an international bank account via wire transfer.
Account numbers using the International Bank Account Number and BIC/SWIFT code format.
Details about the option security.
Originator and their status.
A filter to apply to other-type accounts
Data returned from the financial institution about the owner or owners of an account. Only the names array must be non-empty.
Data about the owner or owners of an account. Any fields not specified will be filled in with default Sandbox information.
A collection of objects that define specific parties to a deal. This includes the direct participating parties, such as borrower and seller and the indirect parties such as the credit report provider.
Response schema for /partner/customer/create.
Response schema for /partner/customer/enable.
Response schema for /partner/customer/get.
Response schema for /partner/customer/oauth_institutions/get.
Response schema for /partner/customer/remove.
The details for an end customer.
The end customer’s address.
Assets under management for the given end customer. Required for end customers with monthly service commitments.
The billing contact for the end customer. Defaults to partner’s billing contact if omitted.
This information is public. Users of your app will see this information when managing connections between your app and their bank accounts in Plaid Portal. Defaults to partner’s customer support info if omitted.
The OAuth registration information for an institution.
Registration statuses by environment.
The webhook of type PARTNER and code END_CUSTOMER_OAUTH_STATUS_UPDATED will be fired when a partner’s end customer has an update on their OAuth registration status with an institution.
The technical contact for the end customer. Defaults to partner’s technical contact if omitted.
The details for the newly created end customer, including secrets for non-Production environments.
A collection of information about a single party to a transaction. Included direct participants like the borrower and seller as well as indirect participants such as the flood certificate provider.
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
An object representing a monetary amount.
Details about the pay period.
An object representing the deduction line items for the pay period
An object representing the total deductions for the pay period
Information about the accounts that the payment was distributed to.
An object representing the earnings line items for the pay period.
An object representing both the current pay period and year to date amount for an earning category.
Details about the pay period.
Taxpayer ID of the individual receiving the paystub.
The amount and currency of a payment
The amount and currency of a payment
Defines consent payments limitations per period.
Life span for the payment consent. After the to date the payment consent expires and can no longer be used for payment initiation.
The optional address of the payment recipient’s bank account. Required by most institutions outside of the UK.
Limitations that will be applied to payments initiated using the payment consent.
PaymentInitiationConsentCreateResponse defines the response schema for /payment_initiation/consent/create
PaymentInitiationConsentGetResponse defines the response schema for /payment_initation/consent/get
PaymentInitiationConsentPaymentExecuteResponse defines the response schema for /payment_initiation/consent/payment/execute
PaymentInitiationConsentRevokeResponse defines the response schema for /payment_initation/consent/revoke
A mapping of currency to maximum payment amount (denominated in the smallest unit of currency) supported by the institution.
Metadata that captures what specific payment configurations an institution supports when making Payment Initiation requests.
PaymentInitiationPayment defines a payment initiation payment
PaymentInitiationPaymentCreateResponse defines the response schema for /payment_initiation/payment/create
PaymentInitiationPaymentGetResponse defines the response schema for /payment_initation/payment/get
PaymentInitiationPaymentListResponse defines the response schema for /payment_initiation/payment/list
PaymentInitiationPaymentReverseResponse defines the response schema for /payment_initation/payment/reverse
PaymentInitiationPaymentTokenCreateResponse defines the response schema for /payment_initiation/payment/token/create
PaymentInitiationRecipient defines a payment initiation recipient
PaymentInitiationRecipientCreateResponse defines the response schema for /payment_initation/recipient/create
PaymentInitiationRecipientGetResponse defines the response schema for /payment_initiation/recipient/get
PaymentInitiationRecipientListResponse defines the response schema for /payment_initiation/recipient/list
Metadata specifically related to valid Payment Initiation standing order configurations for the institution.
Transaction information specific to inter-bank transfers. If the transaction was not an inter-bank transfer, all fields will be null.
PaymentProfileCreateResponse defines the response schema for /payment_profile/create
PaymentProfileGetResponse defines the response schema for /payment_profile/get
PaymentProfileRemoveResponse defines the response schema for /payment_profile/remove
Fired when the status of a payment has changed.
An object containing account level data.
An object representing payroll data.
An object representing the rate at which an individual is paid.
An object containing information about the payroll item.
Details about the status of the payroll item.
Object containing fraud risk data pertaining to the Item linked as part of the verification.
An object representing data extracted from the end user’s paystub.
Address on the paystub
An object representing details that can be found on the paystub.
Information about the employer on the paystub
An object representing data from a paystub.
Information about the accounts that the payment was distributed to.
The employee on the paystub.
The address of the employee.
The employer on the paystub.
Details about the pay period.
The amount of income earned year to date, as based on paystub data.
Fired when an Item’s access consent is expiring in 7 days. Some Items have explicit expiration times and we try to relay this when possible to reduce service disruption. This can be resolved by having the user go through Link’s update mode.
Information describing the intent of the transaction. Most relevant for personal finance use cases, but not limited to such use cases.
A phone number
Score found by matching phone number provided by the API with the phone number on the account at the financial institution. 100 is a perfect match and 0 is a no match. If the account contains multiple owners, the maximum match score is filled.
Data extracted from a user-submitted document.
Analysis of the data extracted from the submitted document.
URLs for downloading original and cropped images for this document submission. The URLs are designed to only allow downloading, not hot linking, so the URL will only serve the document image for 60 seconds before expiring. The expiration time is 60 seconds after the GET request for the associated Identity Verification attempt. A new expiring URL is generated with each request, so you can always rerequest the Identity Verification attempt if one of your URLs expires.
We use standard HTTP response codes for success and failure notifications, and our errors are further classified by error_type. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. An Item with a non-null error object will only be part of an API response when calling /item/get to view Item status. Otherwise, error fields will be null if no error has occurred; if an error has occurred, an error code will be returned instead.
An object containing a set of ids related to an employee
ProcessorAccountGetResponse defines the response schema for /processor/account/get
ProcessorAuthGetResponse defines the response schema for /processor/auth/get
An optional object to filter /processor/balance/get results.
ProcessorBalanceGetResponse defines the response schema for /processor/balance/get
Defines the response schema for /processor/bank_transfer/create
ProcessorIdentityGetResponse defines the response schema for /processor/identity/get
ProcessorIdentityMatchResponse defines the response schema for /processor/identity/match
ProcessorLiabilitiesGetResponse defines the response schema for /processor/liabilities/get
An object containing identifying numbers used for making electronic transfers to and from the account. The identifying number type (ACH, EFT, IBAN, or BACS) used will depend on the country of the account. An account may have more than one number type. If a particular identifying number type is not used by the account for which auth data has been requested, a null value will be returned.
ProcessorSignalDecisionReportResponse defines the response schema for /processor/signal/decision/report
ProcessorSignalEvaluateResponse defines the response schema for /processor/signal/evaluate
ProcessorSignalPrepareResponse defines the response schema for /processor/signal/prepare
ProcessorSignalReturnReportResponse defines the response schema for /processor/signal/return/report
ProcessorStripeBankAccountTokenCreateResponse defines the response schema for /processor/stripe/bank_account/create
ProcessorTokenCreateResponse defines the response schema for /processor/token/create and /processor/apex/processor_token/create
ProcessorTokenPermissionsGetResponse defines the response schema for /processor/token/permissions/get
ProcessorTokenPermissionsSetResponse defines the response schema for /processor/token/permissions/set
ProcessorTokenWebhookUpdateResponse defines the response schema for /processor/token/webhook/update
An optional object to be used with the request. If specified, options must not be null.
ProcessorTransactionsGetResponse defines the response schema for /processor/transactions/get
ProcessorTransactionsRecurringGetResponse defines the response schema for /processor/transactions/recurring/get
ProcessorTransactionsRefreshResponse defines the response schema for /processor/transactions/refresh
ProcessorTransactionsSyncResponse defines the response schema for /processor/transactions/sync
The product access being requested. Used to or disallow product access across all accounts. If unset, defaults to all products allowed.
Fired when an ACCESS_NOT_GRANTED error is hit for Auth. The error can be resolved by putting the user through update mode with auth in the products array, as well as through the limited beta for update mode Authentication product validations.
Fired when an ACCESS_NOT_GRANTED error is hit for Identity. The error can be resolved by putting the user through update mode with identity in the products array, as well as through the limited beta for update mode Identity product validations.
A representation of the status health of a request type. Auth requests, Balance requests, Identity requests, Investments requests, Liabilities requests, Transactions updates, Investments updates, Liabilities updates, and Item logins each have their own status object.
A detailed breakdown of the institution’s performance for a request type. The values for
success,
error_plaid, and
error_institution sum to 1. The time range used for calculating the breakdown may range from the most recent few minutes to the past six hours. In general, smaller institutions will show status that was calculated over a longer period of time. For Investment updates, which are refreshed less frequently, the period assessed may be 24 hours or more. For more details, see
Institution status details.
Information about the student’s eligibility in the Public Service Loan Forgiveness program. This is only returned if the institution is FedLoan (ins_116527).
An object containing a BACS account number and sort code. If an IBAN is not provided or if you need to accept domestic GBP-denominated payments, BACS data is required.
Insights relating to expenses and deposits that are predicted to occur on a scheduled basis, such as biweekly, monthly, or annually.
Fired when a recurring transfer is cancelled by Plaid.
Insights object for recurring transactions streams.
Fired when a new transfer of a recurring transfer is originated.
Insights object for recurring transactions for /beta/transactions/user_insights/v1/get endpoint
Fired when recurring transactions data is updated. This includes when a new recurring stream is detected or when a new transaction is added to an existing recurring stream. The RECURRING_TRANSACTIONS_UPDATE webhook will also fire when one or more attributes of the recurring stream changes, which is usually a result of the addition, update, or removal of transactions to the stream.
Represents a recurring transfer within the Transfers API.
Represents a recurring transfer within the Transfers API.
Fired when Plaid is unable to originate a new ACH transaction of the recurring transfer on the planned date.
A representation of a removed transaction
Information about an report identifier and a report name.
Result summary object specifying values for behavior attributes of risk check, when available.
Additional information for the risk_check step.
Result summary object specifying values for device attributes of risk check.
Result summary object specifying values for email attributes of risk check.
Result summary object capturing abuse signals related to identity abuse, e.g. stolen and synthetic identity fraud.
Result summary object specifying values for phone attributes of risk check.
Field containing the data used in determining the outcome of the stolen identity risk check.
Field containing the data used in determining the outcome of the synthetic identity risk check.
Details about the transaction result after evaluated by the requested risk profile. If a risk_profile_key is not provided, this field will be omitted. This feature is currently in closed beta; to request access, contact your account manager.
Object containing metadata for the document
ADocumentation not found in the MISMO model viewer and not provided by Freddie Mac.
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
SandboxBankIncomeFireWebhookResponse defines the response schema for /sandbox/bank_income/fire_webhook
Optional fields which will be populated in the simulated webhook
Defines the response schema for /sandbox/bank_transfer/fire_webhook
Defines the response schema for /sandbox/bank_transfer/simulate
SandboxIncomeFireWebhookResponse defines the response schema for /sandbox/income/fire_webhook
SandboxItemFireWebhookResponse defines the response schema for /sandbox/item/fire_webhook
SandboxItemResetLoginResponse defines the response schema for /sandbox/item/reset_login
SandboxItemSetVerificationStatusResponse defines the response schema for /sandbox/item/set_verification_status
Defines the response schema for /sandbox/oauth/select_accounts
SandboxPaymentProfileResetLoginResponse defines the response schema for /sandbox/payment_profile/reset_login
An optional set of options to be used when configuring the Item. If specified, must not be null.
SandboxProcessorTokenCreateResponse defines the response schema for /sandbox/processor_token/create
Specifies options for Bank Income. This field is required if income_verification is included in the initial_products array and bank is specified in income_source_types.
An optional set of options to be used when configuring the Item. If specified, must not be null.
A set of parameters for income verification options. This field is required if income_verification is included in the initial_products array.
An optional set of parameters corresponding to transactions options.
SandboxPublicTokenCreateResponse defines the response schema for /sandbox/public_token/create
Defines the response schema for /sandbox/transfer/fire_webhook
Defines the response schema for /sandbox/transfer/ledger/deposit/simulate
Defines the response schema for /sandbox/transfer/ledger/simulate_available
Defines the response schema for /sandbox/transfer/ledger/withdraw/simulate
Defines the response schema for /sandbox/transfer/refund/simulate
Defines the response schema for /sandbox/transfer/repayment/simulate
Defines the response schema for /sandbox/transfer/simulate
Defines the response schema for /sandbox/transfer/sweep/simulate
Defines the response schema for /sandbox/transfer/test_clock/advance
Defines the response schema for /sandbox/transfer/test_clock/create
Defines the response schema for /sandbox/transfer/test_clock/get
Defines the response schema for /sandbox/transfer/test_clock/list
The scopes object
Analysis information describing why a screening hit matched the provided user information
Information associated with the watchlist hit
Analyzed date of birth for the associated hit
Analyzed document information for the associated hit
Analyzed name information for the associated hit
Fired when an individual screening status has changed, which can occur manually via the dashboard or during ongoing monitoring.
Contains details about a security
Specify the security associated with the holding or investment transaction. When inputting custom security data to the Sandbox, Plaid will perform post-data-retrieval normalization and enrichment. These processes may cause the data returned by the Sandbox to be slightly different from the data you input. An ISO-4217 currency code and a security identifier (ticker_symbol, cusip, isin, or sedol) are required.
High level descriptions of how the associated selfie was processed. If a selfie fails verification, the details in the analysis object should help clarify why the selfie was rejected.
The image or video capture of a selfie. Only one of image or video URL will be populated per selfie.
Additional information for the selfie_check step. This field will be null unless steps.selfie_check has reached a terminal state of either success or failed.
Captures and analysis from a user’s selfie.
A collection of details related to a fulfillment service or product in terms of request, process and result.
A collection of details related to a fulfillment service or product in terms of request, process and result.
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
The address of the student loan servicer. This is generally the remittance address to which payments should be sent.
A collection of objects that describe requests and responses for services.
Data about the components comprising an address.
SignalDecisionReportResponse defines the response schema for /signal/decision/report
Details about the end user’s device
The core attributes object contains additional data that can be used to assess the ACH return risk. Examples of data include:
SignalEvaluateResponse defines the response schema for /signal/income/evaluate
The user’s legal name
SignalPrepareResponse defines the response schema for /signal/prepare
SignalReturnReportResponse defines the response schema for /signal/return/report
Risk scoring details broken down by risk category.
Details about the end user initiating the transaction (i.e., the account holder).
Conveys information about the errors causing missing or stale bank data used to construct the /signal/evaluate scores and response
A sweep returned from the /sandbox/transfer/sweep/simulate endpoint.
Can be null if there are no transfers to include in a sweep.
Object containing all risk signals and relevant metadata for a single document
Account associated with the Item.
StatementsListResponse defines the response schema for /statements/list
Fired when refreshed statements extraction is completed or failed to be completed. Triggered by calling /statements/refresh.
StatementsRefreshResponse defines the response schema for /statements/refresh
A statement’s metadata associated with an account
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
A collection of STATUS containers.
Contains details about a student loan account
Student loan repayment information used to configure Sandbox test data for the Liabilities product
An object representing the status of the student loan
An object representing the repayment plan for the student loan
Fired when an Item’s transactions change. This can be due to any event resulting in new changes, such as an initial 30-day transactions fetch upon the initialization of an Item with transactions, the backfill of historical transactions that occurs shortly after, or when changes are populated from a regularly-scheduled transactions update job. It is recommended to listen for the SYNC_UPDATES_AVAILABLE webhook when using the /transactions/sync endpoint. Note that when using /transactions/sync the older webhooks INITIAL_UPDATE, HISTORICAL_UPDATE, DEFAULT_UPDATE, and TRANSACTIONS_REMOVED, which are intended for use with /transactions/get, will also continue to be sent in order to maintain backwards compatibility. It is not necessary to listen for and respond to those webhooks when using /transactions/sync.
Data about an official document used to report the user’s income to the IRS.
Taxpayer ID of the individual receiving the paystub.
Information about the Taxpayer identification values assigned to the individual or legal entity.Information about the Taxpayer identification values assigned to the individual or legal entity.
The collection of TAXPAYER_IDENTIFICATION elements
An object representing both the current pay period and year to date amount for a category.
A representation of a transaction
A representation of a transaction
The counterparty, such as the merchant or financial institution, is extracted by Plaid from the raw description.
Data to populate as test transaction data. If not specified, random transactions will be generated instead.
A grouping of related transactions
Object with data pertaining to an amount on the transaction stream.
A representation of a transactions category rule.
TransactionsEnhanceGetResponse defines the response schema for /beta/transactions/v1/enhance.
An optional object to be used with the request.
TransactionsEnrichResponse defines the response schema for /transactions/enrich.
An optional object to be used with the request. If specified, options must not be null.
TransactionsGetResponse defines the response schema for /transactions/get
An optional object to be used with the request. If specified, options must not be null.
TransactionsRecurringGetResponse defines the response schema for /transactions/recurring/get
TransactionsRefreshResponse defines the response schema for /transactions/refresh
Fired when transaction(s) for an Item are deleted. The deleted transaction IDs are included in the webhook payload. Plaid will typically check for deleted transaction data several times a day.
A representation of transactions rule details.
TransactionsRulesCreateResponse defines the response schema for /beta/transactions/rules/v1/create
TransactionsRulesListResponse defines the response schema for /beta/transactions/rules/v1/list
TransactionsRulesRemoveResponse defines the response schema for /beta/transactions/rules/v1/remove
An optional object to be used with the request. If specified, options must not be null.
TransactionsSyncResponse defines the response schema for /transactions/sync
TransactionsUserInsightsGetResponse defines the response schema for /beta/transactions/user_insights/v1/get.
Represents a transfer within the Transfers API.
Contains the authorization decision for a proposed transfer.
Defines the response schema for /transfer/authorization/create
The rationale for Plaid’s decision regarding a proposed transfer. It is always set for declined decisions, and may or may not be null for approved decisions.
Information about the device being used to initiate the authorization. These fields are not currently incorporated into the risk check.
The rationale for Plaid’s decision to not guarantee a transfer. Will be null unless guarantee_decision is NOT_GUARANTEED.
This object includes the scores and risk level. This response is offered as an add-on to /transfer/authorization/create. To request access to these fields please contact your Plaid account manager.
Details regarding the proposed transfer.
The legal name and other information for the account holder. The user.legal_name field is required. Other fields are not currently used and are present to support planned future functionality.
Information about the balance held with Plaid.
Defines the response schema for /transfer/balance/get
Defines the response schema for /transfer/cancel
Defines the response schema for /transfer/capabilities/get
Contains the supported service types in RTP
Defines the response schema for /transfer/configuration/get
Defines the response schema for /transfer/create
Specifies the originator’s expected usage of credits. For all dollar amounts, use a decimal string with two digits of precision e.g. “10.00”. This field is required if the originator is expected to process credit transfers.
Specifies the originator’s expected usage of debits. For all dollar amounts, use a decimal string with two digits of precision e.g. “10.00”. This field is required if the originator is expected to process debit transfers.
Information about the device being used to initiate the authorization.
Defines the response schema for /transfer/diligence/document/upload
Defines the response schema for /transfer/diligence/submit
Represents an event in the Transfers API.
Defines the response schema for /transfer/event/list
Defines the response schema for /transfer/event/sync
Fired when new transfer events are available. Receiving this webhook indicates you should fetch the new events from /transfer/event/sync.
Defines an expected sweep date and amount.
The failure reason if the event type for a transfer is "failed" or "returned". Null value otherwise.
The originator’s funding account, linked with Plaid Link or /transfer/migrate_account.
Defines the response schema for /transfer/get
Represents a transfer intent within Transfer UI.
Defines the response schema for /transfer/intent/create
Represents a transfer intent within Transfer UI.
The reason for a failed transfer intent. Returned only if the transfer intent status is failed. Null otherwise.
Defines the response schema for /transfer/intent/get
Information about the balance of the ledger held with Plaid.
Defines the response schema for /transfer/ledger/deposit
Defines the response schema for /transfer/ledger/distribute
Defines the response schema for /transfer/ledger/get
Defines the response schema for /transfer/ledger/withdraw
Defines the response schema for /transfer/list
The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply:
The JSON values must be Strings (no nested JSON objects allowed)
Only ASCII characters may be used
Maximum of 50 key/value pairs
Maximum key length of 40 characters
Maximum value length of 500 characters
Defines the response schema for /transfer/metrics/get
Defines the response schema for /transfer/migrate_account
The originator’s address.
Defines the response schema for /transfer/originator/create
The diligence information for the originator.
Defines the response schema for /transfer/originator/funding_account/update
Defines the response schema for /transfer/originator/get
Defines the response schema for /transfer/originator/list
Defines the response schema for /transfer/questionnaire/create
Defines the response schema for /transfer/recurring/cancel
Defines the response schema for /transfer/recurring/create
Defines the response schema for /transfer/recurring/get
Defines the response schema for /transfer/recurring/list
The schedule that the recurring transfer will be executed on.
Represents a refund within the Transfers API.
Defines the response schema for /transfer/refund/cancel
Defines the response schema for /transfer/refund/create
The failure reason if the event type for a refund is "failed" or "returned". Null value otherwise.
Defines the response schema for /transfer/refund/get
A repayment is created automatically after one or more guaranteed transactions receive a return. If there are multiple eligible returns in a day, they are batched together into a single repayment.
Defines the response schema for /transfer/repayments/list
Represents a return on a Guaranteed ACH transfer that is included in the specified repayment.
Defines the response schema for /transfer/repayments/return/list
Describes a sweep of funds to / from the sweep account.
Defines the response schema for /transfer/sweep/get
Defines the response schema for /transfer/sweep/list
Defines the test clock for a transfer.
The address associated with the account holder.
The address associated with the account holder.
The legal name and other information for the account holder.
The legal name and other information for the account holder.
The legal name and other information for the account holder.
Search terms for editing an entity watchlist screening
Search terms for editing an individual watchlist screening
The USER_ACCOUNT_REVOKED webhook is fired when an end user has revoked access to their account on the Data Provider’s portal. The user can restore access to the revoked account by regranting permissions on the Data Provider’s portal. This webhook is currently in beta. It will be available in GA in Jan 2024.
Home address for the user. Supported values are: not provided, address with only country code or full address.
UserCreateResponse defines the response schema for /user/create
metadata for the set of insights provided in TransactionsUserInsightsGetResponse
ID number submitted by the user, currently used only for the Identity Verification product. If the user has not submitted this data yet, this field will be null. Otherwise, both fields are guaranteed to be filled.
The
USER_PERMISSION_REVOKED webhook may be fired when an end user has used either the
my.plaid.com portal or the financial institution’s OAuth consent portal to revoke the permission that they previously granted to access an Item. This webhook is not guaranteed to always be fired upon consent revocation, since some institutions’ consent portals do not trigger this webhook. Once access to an Item has been revoked, it cannot be restored. If the user subsequently returns to your application, a new Item must be created for the user.
UserUpdateResponse defines the response schema for /user/update
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
Fired when an Item was not verified via automated micro-deposits after seven days since the automated micro-deposit was made.
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
W2 is an object that represents income data taken from a W2 tax document.
Data on the W2 Box 12
W2 state and local wages
An object representing the e-wallet
An object representing the e-wallet balance
WalletCreateResponse defines the response schema for /wallet/create
WalletGetResponse defines the response schema for /wallet/get
WalletListResponse defines the response schema for /wallet/list
An object representing the e-wallet account numbers
The transaction details
The amount and currency of a transaction
An object representing the e-wallet transaction’s counterparty
International Bank Account Number for a Wallet Transaction
The counterparty’s bank account numbers. Exactly one of IBAN or BACS data is required.
WalletTransactionExecuteResponse defines the response schema for /wallet/transaction/execute
WalletTransactionGetResponse defines the response schema for /wallet/transaction/get
Additional wallet transaction options
WalletTransactionListResponse defines the response schema for /wallet/transaction/list
Fired when the status of a wallet transaction has changed.
It is possible for an Asset Report to be returned with missing account owner information. In such cases, the Asset Report will contain warning data in the response, indicating why obtaining the owner information failed.
Information about the last change made to the parent object specifying what caused the change as well as when it occurred.
An official document, usually issued by a governing body or institution, with an associated identifier.
The entity screening object allows you to represent an entity in your system, update its profile, and search for it on various watchlists. Note: Rejected entity screenings will not receive new hits, regardless of entity program configuration.
The entity screening object allows you to represent an entity in your system, update its profile, and search for it on various watchlists. Note: Rejected entity screenings will not receive new hits, regardless of entity program configuration.
Paginated list of entity watchlist screenings
Paginated list of entity watchlist screening hits
Paginated list of entity watchlist screenings
A program that configures the active lists, search parameters, and other behavior for initial and ongoing screening of entities.
Paginated list of entity watchlist screening programs
A review submitted by a team member for an entity watchlist screening. A review can be either a comment on the current screening state, actions taken
against hits attached to the watchlist screening, or both.
Paginated list of entity watchlist screening reviews
The entity screening object allows you to represent an entity in your system, update its profile, and search for it on various watchlists. Note: Rejected entity screenings will not receive new hits, regardless of entity program configuration.
Data from a government watchlist or PEP list that has been attached to the screening.
Location information for the associated individual watchlist hit
The screening object allows you to represent a customer in your system, update their profile, and search for them on various watchlists. Note: Rejected customers will not receive new hits, regardless of program configuration.
The screening object allows you to represent a customer in your system, update their profile, and search for them on various watchlists. Note: Rejected customers will not receive new hits, regardless of program configuration.
The screening object allows you to represent a customer in your system, update their profile, and search for them on various watchlists. Note: Rejected customers will not receive new hits, regardless of program configuration.
Paginated list of individual watchlist screenings.
Paginated list of individual watchlist screening hits
Paginated list of individual watchlist screenings.
A program that configures the active lists, search parameters, and other behavior for initial and ongoing screening of individuals.
Paginated list of individual watchlist screening programs
A review submitted by a team member for an individual watchlist screening. A review can be either a comment on the current screening state, actions taken
against hits attached to the watchlist screening, or both.
Paginated list of screening reviews
The screening object allows you to represent a customer in your system, update their profile, and search for them on various watchlists. Note: Rejected customers will not receive new hits, regardless of program configuration.
Search inputs for creating a watchlist screening
A review submitted by a team member for an individual watchlist screening. A review can be either a comment on the current screening state, actions taken
against hits attached to the watchlist screening, or both.
Search terms for creating an individual watchlist screening
Fired when an Item’s webhook is updated. This will be sent to the newly specified webhook.
WebhookVerificationKeyGetResponse defines the response schema for /webhook_verification_key/get