| Class | Description |
|---|---|
| AccountAccess |
Allow or disallow product access by account.
|
| AccountAssets |
Asset information about an account
|
| AccountAssets.VerificationStatusEnum.Adapter | |
| AccountAssetsAllOf |
AccountAssetsAllOf
|
| AccountBalance |
A set of fields describing the balance for an account.
|
| AccountBase |
A single account at a financial institution.
|
| AccountBase.VerificationStatusEnum.Adapter | |
| AccountFilter |
Enumerates the account subtypes that the application wishes for the user to be able to select from.
|
| AccountFiltersResponse |
The `account_filters` specified in the original call to `/link/token/create`.
|
| AccountIdentity |
Identity information about an account
|
| AccountIdentity.VerificationStatusEnum.Adapter | |
| AccountIdentityAllOf |
AccountIdentityAllOf
|
| AccountIdentityMatchScore |
Identity match scores for an account
|
| AccountIdentityMatchScore.VerificationStatusEnum.Adapter | |
| AccountIdentityMatchScoreAllOf |
AccountIdentityMatchScoreAllOf
|
| AccountProductAccess |
Allow the application to access specific products on this account
|
| AccountProductAccessNullable |
Allow the application to access specific products on this account
|
| AccountsBalanceGetRequest |
AccountsBalanceGetRequest defines the request schema for `/accounts/balance/get`
|
| AccountsBalanceGetRequestOptions |
An optional object to filter `/accounts/balance/get` results.
|
| AccountSelectionCardinality.Adapter | |
| AccountsGetRequest |
AccountsGetRequest defines the request schema for `/accounts/get`
|
| AccountsGetRequestOptions |
An optional object to filter `/accounts/get` results.
|
| AccountsGetResponse |
AccountsGetResponse defines the response schema for `/accounts/get` and `/accounts/balance/get`.
|
| AccountSubtype.Adapter | |
| AccountType.Adapter | |
| ACHClass.Adapter | |
| ActionState.Adapter | |
| Activity |
Describes a consent activity.
|
| ActivityType.Adapter | |
| Address |
A physical mailing address.
|
| AddressData |
Data about the components comprising an address.
|
| AddressDataNullable |
Data about the components comprising an address.
|
| AddressMatchScore |
Score found by matching address provided by the API with the address on the account at the financial institution.
|
| AddressNullable |
A physical mailing address.
|
| AddressPurposeLabel.Adapter | |
| Application |
Metadata about the application
|
| ApplicationGetRequest |
ApplicationGetRequest defines the schema for `/application/get`
|
| ApplicationGetResponse |
ApplicationGetResponse defines the response schema for `/application/get`
|
| APR |
Information about the APR on the account.
|
| APR.AprTypeEnum.Adapter | |
| Asset |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| AssetDetail |
Details about an asset.
|
| AssetHolder |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| AssetHolderName |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| AssetOwner |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| AssetOwners |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| AssetReport |
An object representing an Asset Report
|
| AssetReportAuditCopyCreateRequest |
AssetReportAuditCopyCreateRequest defines the request schema for `/asset_report/audit_copy/get`
|
| AssetReportAuditCopyCreateResponse |
AssetReportAuditCopyCreateResponse defines the response schema for `/asset_report/audit_copy/get`
|
| AssetReportAuditCopyGetRequest |
AssetReportAuditCopyGetRequest defines the request schema for `/asset_report/audit_copy/get`
|
| AssetReportAuditCopyRemoveRequest |
AssetReportAuditCopyRemoveRequest defines the request schema for `/asset_report/audit_copy/remove`
|
| AssetReportAuditCopyRemoveResponse |
AssetReportAuditCopyRemoveResponse defines the response schema for `/asset_report/audit_copy/remove`
|
| AssetReportCreateRequest |
AssetReportCreateRequest defines the request schema for `/asset_report/create`
|
| AssetReportCreateRequestOptions |
An optional object to filter `/asset_report/create` results.
|
| AssetReportCreateResponse |
AssetReportCreateResponse defines the response schema for `/asset_report/create`
|
| AssetReportFilterRequest |
AssetReportFilterRequest defines the request schema for `/asset_report/filter`
|
| AssetReportFilterResponse |
AssetReportFilterResponse defines the response schema for `/asset_report/filter`
|
| AssetReportFreddie |
An object representing an Asset Report with Freddie Mac schema.
|
| AssetReportFreddieGetRequest |
AssetReportFreddieGetRequest defines the request schema for `credit/asset_report/freddie_mac/get`
|
| AssetReportFreddieGetResponse |
AssetReportFreddieGetResponse defines the response schema for `/asset_report/get`
|
| AssetReportGetRequest |
AssetReportGetRequest defines the request schema for `/asset_report/get`
|
| AssetReportGetRequestOptions |
An optional object to filter or add data to `/asset_report/get` results.
|
| AssetReportGetResponse |
AssetReportGetResponse defines the response schema for `/asset_report/get`
|
| AssetReportItem |
A representation of an Item within an Asset Report.
|
| AssetReportPDFGetRequest |
AssetReportPDFGetRequest defines the request schema for `/asset_report/pdf/get`
|
| AssetReportPDFGetRequestOptions |
An optional object to filter or add data to `/asset_report/get` results.
|
| AssetReportRefreshRequest |
AssetReportRefreshRequest defines the request schema for `/asset_report/refresh`
|
| AssetReportRefreshRequestOptions |
An optional object to filter `/asset_report/refresh` results.
|
| AssetReportRefreshResponse |
AssetReportRefreshResponse defines the response schema for `/asset_report/refresh`
|
| AssetReportRemoveRequest |
AssetReportRemoveRequest defines the request schema for `/asset_report/remove`
|
| AssetReportRemoveResponse |
AssetReportRemoveResponse defines the response schema for `/asset_report/remove`
|
| AssetReportTransaction |
A transaction on the asset report
|
| AssetReportTransaction.TransactionTypeEnum.Adapter | |
| AssetReportTransactionAllOf |
AssetReportTransactionAllOf
|
| AssetReportUser |
The user object allows you to provide additional information about the user to be appended to the Asset Report.
|
| Assets |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| AssetsErrorWebhook |
Fired when Asset Report generation has failed.
|
| AssetsProductReadyWebhook |
Fired when the Asset Report has been generated and `/asset_report/get` is ready to be called.
|
| AssetTransaction |
An object representing...
|
| AssetTransactionCategoryType.Adapter | |
| AssetTransactionDescription |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| AssetTransactionDetail |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| AssetTransactions |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| AssetTransactionType.Adapter | |
| AssetType.Adapter | |
| AuthGetNumbers |
An object containing identifying numbers used for making electronic transfers to and from the `accounts`.
|
| AuthGetRequest |
AuthGetRequest defines the request schema for `/auth/get`
|
| AuthGetRequestOptions |
An optional object to filter `/auth/get` results.
|
| AuthGetResponse |
AuthGetResponse defines the response schema for `/auth/get`
|
| AuthMetadata |
Metadata that captures information about the Auth features of an institution.
|
| AuthSupportedMethods |
Metadata specifically related to which auth methods an institution supports.
|
| AutomaticallyVerifiedWebhook |
Fired when an Item is verified via automated micro-deposits.
|
| BankInitiatedReturnRisk |
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.
|
| BankTransfer |
Represents a bank transfer within the Bank Transfers API.
|
| BankTransferBalance |
Information about the balance of a bank transfer
|
| BankTransferBalanceGetRequest |
Defines the request schema for `/bank_transfer/balance/get`
|
| BankTransferBalanceGetResponse |
Defines the response schema for `/bank_transfer/balance/get`
|
| BankTransferCancelRequest |
Defines the request schema for `/bank_transfer/cancel`
|
| BankTransferCancelResponse |
Defines the response schema for `/bank_transfer/cancel`
|
| BankTransferCreateRequest |
Defines the request schema for `/bank_transfer/create`
|
| BankTransferCreateResponse |
Defines the response schema for `/bank_transfer/create`
|
| BankTransferDirection.Adapter | |
| BankTransferEvent |
Represents an event in the Bank Transfers API.
|
| BankTransferEventListBankTransferType.Adapter | |
| BankTransferEventListDirection.Adapter | |
| BankTransferEventListRequest |
Defines the request schema for `/bank_transfer/event/list`
|
| BankTransferEventListResponse |
Defines the response schema for `/bank_transfer/event/list`
|
| BankTransferEventSyncRequest |
Defines the request schema for `/bank_transfer/event/sync`
|
| BankTransferEventSyncResponse |
Defines the response schema for `/bank_transfer/event/sync`
|
| BankTransferEventType.Adapter | |
| BankTransferFailure |
The failure reason if the type of this transfer is `\"failed\"` or `\"reversed\"`.
|
| BankTransferGetRequest |
Defines the request schema for `/bank_transfer/get`
|
| BankTransferGetResponse |
Defines the response schema for `/bank_transfer/get`
|
| BankTransferListRequest |
Defines the request schema for `/bank_transfer/list`
|
| BankTransferListResponse |
Defines the response schema for `/bank_transfer/list`
|
| BankTransferMigrateAccountRequest |
Defines the request schema for `/bank_transfer/migrate_account`
|
| BankTransferMigrateAccountResponse |
Defines the response schema for `/bank_transfer/migrate_account`
|
| BankTransferNetwork.Adapter | |
| BankTransfersEventsUpdateWebhook |
Fired when new bank transfer events are available.
|
| BankTransfersEventsUpdateWebhookForAuth |
Fired when new ACH events are available.
|
| BankTransferStatus.Adapter | |
| BankTransferSweep |
BankTransferSweep describes a sweep transfer.
|
| BankTransferSweepGetRequest |
Defines the request schema for `/bank_transfer/sweep/get`
|
| BankTransferSweepGetResponse |
BankTransferSweepGetResponse defines the response schema for `/bank_transfer/sweep/get`
|
| BankTransferSweepListRequest |
BankTransferSweepListRequest defines the request schema for `/bank_transfer/sweep/list`
|
| BankTransferSweepListResponse |
BankTransferSweepListResponse defines the response schema for `/bank_transfer/sweep/list`
|
| BankTransferType.Adapter | |
| BankTransferUser |
The legal name and other information for the account holder.
|
| CategoriesGetResponse |
CategoriesGetResponse defines the response schema for `/categories/get`
|
| Category |
Information describing a transaction category
|
| Cause |
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.
|
| CauseAllOf |
CauseAllOf
|
| ClientProvidedEnhancedTransaction |
A client-provided transaction that Plaid has enhanced.
|
| ClientProvidedEnrichedTransaction |
A client-provided transaction that Plaid has enriched.
|
| ClientProvidedRawTransaction |
A client-provided transaction for Plaid to enhance.
|
| ClientProvidedTransaction |
A client-provided transaction for Plaid to enrich.
|
| ClientProvidedTransactionLocation |
A representation of where a transaction took place.
|
| ConnectedApplication |
Describes the connected application for a particular end user.
|
| Counterparty |
The counterparty, such as the merchant or financial institution, is extracted by Plaid from the raw description.
|
| CounterpartyType.Adapter | |
| CountryCode.Adapter | |
| Credit1099 |
An object representing an end user's 1099 tax form
|
| Credit1099Filer |
An object representing a filer used by 1099-K tax documents.
|
| Credit1099Payer |
An object representing a payer used by 1099-MISC tax documents.
|
| Credit1099Recipient |
An object representing a recipient used in both 1099-K and 1099-MISC tax documents.
|
| CreditAccountSubtype.Adapter | |
| CreditAmountWithCurrency |
This contains an amount, denominated in the currency specified by either `iso_currency_code` or `unofficial_currency_code`
|
| CreditAuditCopyTokenCreateRequest |
CreditAuditCopyTokenCreateRequest defines the request schema for `/credit/audit_copy_token/create`
|
| CreditAuditCopyTokenCreateResponse |
CreditAuditCopyTokenCreateResponse defines the response schema for `/credit/audit_copy_token/get`
|
| CreditAuditCopyTokenRemoveRequest |
CreditAuditCopyTokenRemoveRequest defines the request schema for `/credit/audit_copy_token/remove`
|
| CreditAuditCopyTokenRemoveResponse |
CreditAuditCopyTokenRemoveResponse defines the response schema for `/credit/audit_copy_token/remove`
|
| CreditAuditCopyTokenUpdateRequest |
CreditAuditCopyTokenUpdateRequest defines the request schema for `/credit/audit_copy_token/update`
|
| CreditAuditCopyTokenUpdateResponse |
CreditAuditCopyTokenUpdateResponse defines the response schema for `/credit/audit_copy_token/update`
|
| CreditBankIncome |
The report of the Bank Income data for an end user.
|
| CreditBankIncomeAccount |
The Item's accounts that have Bank Income data.
|
| CreditBankIncomeAccountType.Adapter | |
| CreditBankIncomeCategory.Adapter | |
| CreditBankIncomeCause |
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.
|
| CreditBankIncomeErrorType.Adapter | |
| CreditBankIncomeGetRequest |
CreditBankIncomeGetRequest defines the request schema for `/credit/bank_income/get`.
|
| CreditBankIncomeGetRequestOptions |
An optional object for `/credit/bank_income/get` request options.
|
| CreditBankIncomeGetResponse |
CreditBankIncomeGetResponse defines the response schema for `/credit/bank_income/get`
|
| CreditBankIncomeHistoricalSummary |
The end user's monthly summary for the income source(s).
|
| CreditBankIncomeItem |
The details and metadata for an end user's Item.
|
| CreditBankIncomePayFrequency.Adapter | |
| CreditBankIncomePDFGetRequest |
CreditBankIncomePDFGetRequest defines the request schema for `/credit/bank_income/pdf/get`
|
| CreditBankIncomeRefreshRequest |
CreditBankIncomeRefreshRequest defines the request schema for `/credit/bank_income/refresh`.
|
| CreditBankIncomeRefreshRequestOptions |
An optional object for `/credit/bank_income/refresh` request options.
|
| CreditBankIncomeRefreshResponse |
CreditBankIncomeRefreshResponse defines the response schema for `/credit/bank_income/refresh`.
|
| CreditBankIncomeSource |
Detailed information for the income source.
|
| CreditBankIncomeSummary |
Summary for bank income across all income sources and items (max history of 730 days).
|
| CreditBankIncomeTransaction |
The transactions data for the end user's income source(s).
|
| CreditBankIncomeWarning |
The warning associated with the data that was unavailable for the Bank Income Report.
|
| CreditBankIncomeWarningCode.Adapter | |
| CreditBankIncomeWarningType.Adapter | |
| CreditCardLiability |
An object representing a credit card account.
|
| CreditCategory |
Information describing the intent of the transaction.
|
| CreditDocumentMetadata |
Object representing metadata pertaining to the document.
|
| CreditEmployerVerification |
An object containing employer data.
|
| CreditEmploymentGetRequest |
CreditEmploymentGetRequest defines the request schema for `/credit/employment/get`.
|
| CreditEmploymentGetResponse |
CreditEmploymentGetResponse defines the response schema for `/credit/employment/get`.
|
| CreditEmploymentItem |
The object containing employment items.
|
| CreditEmploymentVerification |
The object containing proof of employment data for an individual.
|
| CreditFilter |
A filter to apply to `credit`-type accounts
|
| CreditFreddieMacAssetDetailVOE25 |
Details about an asset.
|
| CreditFreddieMacAssetsVOA24 |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| CreditFreddieMacAssetsVOE25 |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| CreditFreddieMacAssetTransactionDetailVOE25 |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| CreditFreddieMacAssetTransactionsVOA24 |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| CreditFreddieMacAssetTransactionsVOE25 |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| CreditFreddieMacAssetTransactionVOA24 |
An object representing...
|
| CreditFreddieMacAssetTransactionVOE25 |
An object representing...
|
| CreditFreddieMacAssetVOA24 |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| CreditFreddieMacAssetVOE25 |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| CreditFreddieMacIndividualNameVOA24 |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| CreditFreddieMacLoanIdentifiersVOA24 |
Collection of current and previous identifiers for this loan.
|
| CreditFreddieMacLoansVOA24 |
A collection of loans that are part of a single deal.
|
| CreditFreddieMacLoanVOA24 |
Information specific to a mortgage loan agreement between one or more borrowers and a mortgage lender.
|
| CreditFreddieMacPartiesVOA24 |
A collection of objects that define specific parties to a deal.
|
| CreditFreddieMacPartyIndividualVOA24 |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| CreditFreddieMacPartyVOA24 |
A collection of information about a single party to a transaction.
|
| CreditFreddieMacReportingInformationVOA24 |
Information about an report identifier and a report name.
|
| CreditFreddieMacReportsGetRequest |
CreditFreddieMacReportsGetRequest defines the request schema for `credit/asset_report/freddie_mac/get`
|
| CreditFreddieMacReportsGetResponse |
CreditFreddieMacReportsGetResponse defines the response schema for `/credit/freddie_mac/reports/get`
|
| CreditFreddieMacServicesVOA24 |
A collection of objects that describe requests and responses for services.
|
| CreditFreddieMacServicesVOE25 |
A collection of objects that describe requests and responses for services.
|
| CreditFreddieMacServiceVOA24 |
A collection of details related to a fulfillment service or product in terms of request, process and result.
|
| CreditFreddieMacServiceVOE25 |
A collection of details related to a fulfillment service or product in terms of request, process and result.
|
| CreditFreddieMacVerificationOfAssetResponseVOA24 |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| CreditFreddieMacVerificationOfAssetResponseVOE25 |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| CreditFreddieMacVerificationOfAssetsDealVOA24 |
An object representing an Asset Report with Freddie Mac schema.
|
| CreditFreddieMacVerificationOfAssetsVOA24 |
Verification of Assets Report
|
| CreditFreddieMacVerificationOfAssetVOA24 |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| CreditFreddieMacVerificationOfAssetVOE25 |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| CreditFreddieVerificationOfEmploymentDealVOE25 |
An object representing a Verification of Employment report.
|
| CreditFreddieVerificationOfEmploymentVOE25 |
Verification of Employment Report
|
| CreditPayrollIncomeGetRequest |
CreditPayrollIncomeGetRequest defines the request schema for `/credit/payroll_income/get`.
|
| CreditPayrollIncomeGetResponse |
Defines the response body for `/credit/payroll_income/get`.
|
| CreditPayrollIncomePrecheckRequest |
Defines the request schema for `/credit/payroll_income/precheck`.
|
| CreditPayrollIncomePrecheckResponse |
Defines the response schema for `/credit/payroll_income/precheck`.
|
| CreditPayrollIncomeRefreshRequest |
CreditPayrollIncomeRefreshRequest defines the request schema for `/credit/payroll_income/refresh`
|
| CreditPayrollIncomeRefreshResponse |
CreditPayrollIncomeRefreshResponse defines the response schema for `/credit/payroll_income/refresh`
|
| CreditPayrollIncomeRiskSignalsGetRequest |
CreditPayrollIncomeRiskSignalsGetRequest defines the request schema for `/beta/credit/payroll_income/risk_signals/get`
|
| CreditPayrollIncomeRiskSignalsGetResponse |
CreditPayrollIncomeRiskSignalsGetRequest defines the response schema for `/beta/credit/payroll_income/risk_signals/get`
|
| CreditPayStub |
An object representing an end user's pay stub.
|
| CreditPayStubAddress |
Address on the pay stub.
|
| CreditPayStubDeductions |
An object with the deduction information found on a pay stub.
|
| CreditPayStubEarnings |
An object representing both a breakdown of earnings on a pay stub and the total earnings.
|
| CreditPayStubEmployee |
Data about the employee.
|
| CreditPayStubEmployer |
Information about the employer on the pay stub.
|
| CreditPayStubNetPay |
An object representing information about the net pay amount on the pay stub.
|
| CreditPayStubPayBasisType.Adapter | |
| CreditPlatformIds |
The object containing a set of ids related to an employee.
|
| CreditRelayCreateRequest |
CreditRelayCreateRequest defines the request schema for `/credit/relay/create`
|
| CreditRelayCreateResponse |
CreditRelayCreateResponse defines the response schema for `/credit/relay/create`
|
| CreditRelayGetRequest |
CreditRelayGetRequest defines the request schema for `/credit/relay/get`
|
| CreditRelayRefreshRequest |
CreditRelayRefreshRequest defines the request schema for `/credit/relay/refresh`
|
| CreditRelayRefreshResponse |
CreditRelayRefreshResponse defines the response schema for `/credit/relay/refresh`
|
| CreditRelayRemoveRequest |
CreditRelayRemoveRequest defines the request schema for `/credit/relay/remove`
|
| CreditRelayRemoveResponse |
CreditRelayRemoveResponse defines the response schema for `/credit/relay/remove`
|
| CreditSession |
Metadata and results for a Link session
|
| CreditSessionBankIncomeResult |
The details of a bank income verification in Link
|
| CreditSessionBankIncomeStatus.Adapter | |
| CreditSessionDocumentIncomeResult |
The details of a document income verification in Link
|
| CreditSessionError |
The details of a Link error.
|
| CreditSessionItemAddResult |
The details of an item add in Link
|
| CreditSessionPayrollIncomeResult |
The details of a digital payroll income verification in Link
|
| CreditSessionResults |
The set of results for a Link session.
|
| CreditSessionsGetRequest |
CreditSessionsGetRequest defines the request schema for `/credit/sessions/get`
|
| CreditSessionsGetResponse |
CreditSessionsGetResponse defines the response schema for `/credit/sessions/get`
|
| CreditW2 |
W2 is an object that represents income data taken from a W2 tax document.
|
| CustomerInitiatedReturnRisk |
The object contains a risk score and a risk tier that evaluate the transaction return risk of an unauthorized debit.
|
| DashboardUser |
Account information associated with a team member with access to the Plaid dashboard.
|
| DashboardUserGetRequest |
Request input for fetching a dashboard user
|
| DashboardUserGetResponse |
Account information associated with a team member with access to the Plaid dashboard.
|
| DashboardUserListRequest |
Request input for listing dashboard users
|
| DashboardUserListResponse |
Paginated list of dashboard users
|
| DashboardUserStatus.Adapter | |
| DateRange |
A date range with a start and end date
|
| Deductions |
An object with the deduction information found on a paystub.
|
| DeductionsBreakdown |
An object representing the deduction line items for the pay period
|
| DeductionsTotal |
An object representing the total deductions for the pay period
|
| DefaultUpdateWebhook |
Fired when new transaction data is available for an Item.
|
| DepositoryAccountSubtype.Adapter | |
| DepositoryFilter |
A filter to apply to `depository`-type accounts
|
| DepositSwitchAddressData |
The user's address.
|
| DepositSwitchAltCreateRequest |
DepositSwitchAltCreateRequest defines the request schema for `/deposit_switch/alt/create`
|
| DepositSwitchAltCreateRequest.CountryCodeEnum.Adapter | |
| DepositSwitchAltCreateResponse |
DepositSwitchAltCreateResponse defines the response schema for `/deposit_switch/alt/create`
|
| DepositSwitchCreateRequest |
DepositSwitchCreateRequest defines the request schema for `/deposit_switch/create`
|
| DepositSwitchCreateRequest.CountryCodeEnum.Adapter | |
| DepositSwitchCreateRequestOptions |
Options to configure the `/deposit_switch/create` request.
|
| DepositSwitchCreateResponse |
DepositSwitchCreateResponse defines the response schema for `/deposit_switch/create`
|
| DepositSwitchGetRequest |
DepositSwitchGetRequest defines the request schema for `/deposit_switch/get`
|
| DepositSwitchGetResponse |
DepositSwitchGetResponse defines the response schema for `/deposit_switch/get`
|
| DepositSwitchGetResponse.StateEnum.Adapter | |
| DepositSwitchGetResponse.SwitchMethodEnum.Adapter | |
| DepositSwitchStateUpdateWebhook |
Fired when the status of a deposit switch request has changed.
|
| DepositSwitchTargetAccount |
The deposit switch destination account
|
| DepositSwitchTargetAccount.AccountSubtypeEnum.Adapter | |
| DepositSwitchTargetUser |
The deposit switch target user
|
| DepositSwitchTokenCreateRequest |
DepositSwitchTokenCreateRequest defines the request schema for `/deposit_switch/token/create`
|
| DepositSwitchTokenCreateResponse |
DepositSwitchTokenCreateResponse defines the response schema for `/deposit_switch/token/create`
|
| DetailedOriginator |
Originator and their status.
|
| DistributionBreakdown |
Information about the accounts that the payment was distributed to.
|
| DocType.Adapter | |
| DocumentAnalysis |
High level descriptions of how the associated document was processed.
|
| DocumentaryVerification |
Data, images, analysis, and results from the `documentary_verification` step.
|
| DocumentaryVerificationDocument |
Images, extracted data, and analysis from a user's identity document
|
| DocumentAuthenticityMatchCode.Adapter | |
| DocumentDateOfBirthMatchCode.Adapter | |
| DocumentMetadata |
An object representing metadata from the end user's uploaded document.
|
| DocumentNameMatchCode.Adapter | |
| DocumentRiskSignal |
Details about a certain reason as to why a document could potentially be fraudulent.
|
| DocumentRiskSignalInstitutionMetadata |
An object which contains additional metadata about the institution used to compute the verification attribute
|
| DocumentRiskSignalsObject |
Object containing fraud risk data for a set of income documents
|
| DocumentRiskSummary |
A summary across all risk signals associated with a document
|
| DocumentStatus.Adapter | |
| Earnings |
An object representing both a breakdown of earnings on a paystub and the total earnings.
|
| EarningsBreakdown |
An object representing the earnings line items for the pay period.
|
| EarningsBreakdownCanonicalDescription.Adapter | |
| EarningsTotal |
An object representing both the current pay period and year to date amount for an earning category.
|
|
An object representing an email address
|
|
| Email.TypeEnum.Adapter | |
| EmailAddressMatchScore |
Score found by matching email provided by the API with the email on the account at the financial institution.
|
| Employee |
Data about the employee.
|
| EmployeeIncomeSummaryFieldString |
The name of the employee, as reported on the paystub.
|
| Employer |
Data about the employer.
|
| EmployerIncomeSummaryFieldString |
The name of the employer, as reported on the paystub.
|
| EmployersSearchRequest |
EmployersSearchRequest defines the request schema for `/employers/search`.
|
| EmployersSearchResponse |
EmployersSearchResponse defines the response schema for `/employers/search`.
|
| EmployerVerification |
An object containing employer data.
|
| EmploymentDetails |
An object representing employment details found on a paystub.
|
| EmploymentVerification |
An object containing proof of employment data for an individual
|
| EmploymentVerificationGetRequest |
EmploymentVerificationGetRequest defines the request schema for `/employment/verification/get`.
|
| EmploymentVerificationGetResponse |
EmploymentVerificationGetResponse defines the response schema for `/employment/verification/get`.
|
| EmploymentVerificationStatus.Adapter | |
| Enhancements |
A grouping of the Plaid produced transaction enhancement fields.
|
| Enrichments |
A grouping of the Plaid produced transaction enrichment fields.
|
| EnrichTransactionDirection.Adapter | |
| EntityDocument |
An official document, usually issued by a governing body or institution, with an associated identifier.
|
| EntityDocumentType.Adapter | |
| EntityScreeningHitAnalysis |
Analysis information describing why a screening hit matched the provided entity information
|
| EntityScreeningHitData |
Information associated with the entity watchlist hit
|
| EntityScreeningHitDocumentsItems |
Analyzed documents for the associated hit
|
| EntityScreeningHitEmails |
Email address information for the associated entity watchlist hit
|
| EntityScreeningHitEmailsItems |
Analyzed emails for the associated hit
|
| EntityScreeningHitNames |
Name information for the associated entity watchlist hit
|
| EntityScreeningHitNamesItems |
Analyzed names for the associated hit
|
| EntityScreeningHitPhoneNumbers |
Phone number information associated with the entity screening hit
|
| EntityScreeningHitsPhoneNumberItems |
Analyzed phone numbers for the associated hit
|
| EntityScreeningHitUrls |
URLs associated with the entity screening hit
|
| EntityScreeningHitUrlsItems |
Analyzed URLs for the associated hit
|
| EntityScreeningStatusUpdatedWebhook |
Fired when an entity screening status has changed, which can occur manually via the dashboard or during ongoing monitoring.
|
| EntityWatchlistCode.Adapter | |
| EntityWatchlistProgram |
A program that configures the active lists, search parameters, and other behavior for initial and ongoing screening of entities.
|
| EntityWatchlistScreening |
The entity screening object allows you to represent an entity in your system, update its profile, and search for it on various watchlists.
|
| EntityWatchlistScreeningHit |
Data from a government watchlist that has been attached to the screening.
|
| EntityWatchlistScreeningReview |
A review submitted by a team member for an entity watchlist screening.
|
| EntityWatchlistScreeningSearchTerms |
Search terms associated with an entity used for searching against watchlists
|
| EntityWatchlistSearchTerms |
Search inputs for creating an entity watchlist screening
|
| ExpirationDate.Adapter | |
| ExternalPaymentInitiationConsentOptions |
Additional payment consent options
|
| ExternalPaymentOptions |
Additional payment options
|
| ExternalPaymentRefundDetails |
Details about external payment refund
|
| ExternalPaymentScheduleBase |
The schedule that the payment will be executed on.
|
| ExternalPaymentScheduleGet |
The schedule that the payment will be executed on.
|
| ExternalPaymentScheduleRequest |
The schedule that the payment will be executed on.
|
| FDXContentTypes.Adapter | |
| FDXFiAttribute |
Financial Institution provider-specific attribute
|
| FDXHateoasLink |
REST application constraint (Hypermedia As The Engine Of Application State)
|
| FDXHateoasLinkAction.Adapter | |
| FDXNotification |
Provides the base fields of a notification.
|
| FDXNotificationCategory.Adapter | |
| FDXNotificationPayload |
Custom key-value pairs payload for a notification
|
| FDXNotificationPayloadIdType.Adapter | |
| FDXNotificationPriority.Adapter | |
| FDXNotificationSeverity.Adapter | |
| FDXNotificationType.Adapter | |
| FDXParty |
FDX Participant - an entity or person that is a part of a FDX API transaction
|
| FDXPartyRegistry.Adapter | |
| FDXPartyType.Adapter | |
| Form1099Type.Adapter | |
| FreddieReportType.Adapter | |
| GenericScreeningHitLocationItems |
Analyzed location information for the associated hit
|
| HealthIncident |
A status health incident
|
| HistoricalBalance |
An object representing a balance held by an account in the past
|
| HistoricalUpdateWebhook |
Fired when an Item's historical transaction pull is completed and Plaid has prepared as much historical transaction data as possible for the Item.
|
| Holding |
A securities holding at an institution.
|
| HoldingsDefaultUpdateWebhook |
Fired when new or updated holdings have been detected on an investment account.
|
| HoldingsOverride |
Specify the holdings on the account.
|
| IdentityDefaultUpdateWebhook |
Fired when a change to identity data has been detected on an Item.
|
| IdentityGetRequest |
IdentityGetRequest defines the request schema for `/identity/get`
|
| IdentityGetRequestOptions |
An optional object to filter `/identity/get` results.
|
| IdentityGetResponse |
IdentityGetResponse defines the response schema for `/identity/get`
|
| IdentityMatchRequest |
IdentityMatchRequest defines the request schema for `/identity/match`
|
| IdentityMatchRequestOptions |
An optional object to filter /identity/match results
|
| IdentityMatchResponse |
IdentityMatchResponse defines the response schema for `/identity/match`
|
| IdentityMatchUser |
The user's legal name, phone number, email address and address used to perform fuzzy match.
|
| IdentityUpdateTypes.Adapter | |
| IdentityVerification |
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.
|
| IdentityVerificationCreateRequest |
Request schema for '/identity_verification/create'
|
| IdentityVerificationCreateResponse |
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.
|
| IdentityVerificationGetRequest |
Request input for fetching an identity verification
|
| IdentityVerificationGetResponse |
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.
|
| IdentityVerificationListRequest |
Request input for listing identity verifications
|
| IdentityVerificationListResponse |
Paginated list of Plaid sessions.
|
| IdentityVerificationRequestUser |
User information collected outside of Link, most likely via your own onboarding process.
|
| IdentityVerificationRetriedWebhook |
Fired when identity verification has been retried, which can be triggered via the dashboard or the API.
|
| IdentityVerificationRetryRequest |
Request input for retrying an identity verification attempt
|
| IdentityVerificationRetryRequestStepsObject |
Instructions for the `custom` retry strategy specifying which steps should be required or skipped.
|
| IdentityVerificationRetryResponse |
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.
|
| IdentityVerificationStatus.Adapter | |
| IdentityVerificationStatusUpdatedWebhook |
Fired when the status of an identity verification has been updated, which can be triggered via the dashboard or the API.
|
| IdentityVerificationStepStatus.Adapter | |
| IdentityVerificationStepSummary |
Each step will be one of the following values: `active` - This step is the user's current step.
|
| IdentityVerificationStepUpdatedWebhook |
Fired when an end user has completed a step of the Identity Verification process.
|
| IdentityVerificationTemplateReference |
The resource ID and version number of the template configuring the behavior of a given identity verification.
|
| IdentityVerificationUserAddress |
Even if an address has been collected, some fields may be null depending on the region's addressing system.
|
| IdentityVerificationUserData |
The identity data that was either collected from the user or provided via API in order to perform an identity verification.
|
| IDNumberType.Adapter | |
| ImageQuality.Adapter | |
| IncidentUpdate |
An update on the health incident
|
| IncidentUpdate.StatusEnum.Adapter | |
| IncomeBreakdown |
An object representing a breakdown of the different income types on the paystub.
|
| IncomeBreakdownType.Adapter | |
| IncomeOverride |
Specify payroll data on the account.
|
| IncomeSummary |
The verified fields from a paystub verification.
|
| IncomeSummaryFieldNumber |
Field number for income summary
|
| IncomeSummaryFieldString |
Data about the income summary
|
| IncomeVerificationCreateRequest |
IncomeVerificationCreateRequest defines the request schema for `/income/verification/create`
|
| IncomeVerificationCreateRequestOptions |
Optional arguments for `/income/verification/create`
|
| IncomeVerificationCreateResponse |
IncomeVerificationCreateResponse defines the response schema for `/income/verification/create`.
|
| IncomeVerificationDocumentsDownloadRequest |
IncomeVerificationDocumentsDownloadRequest defines the request schema for `/income/verification/documents/download`.
|
| IncomeVerificationPayrollFlowType.Adapter | |
| IncomeVerificationPaystubsGetRequest |
IncomeVerificationPaystubsGetRequest defines the request schema for `/income/verification/paystubs/get`.
|
| IncomeVerificationPaystubsGetResponse |
IncomeVerificationPaystubsGetResponse defines the response schema for `/income/verification/paystubs/get`.
|
| IncomeVerificationPrecheckConfidence.Adapter | |
| IncomeVerificationPrecheckEmployer |
Information about the end user's employer
|
| IncomeVerificationPrecheckEmployerAddress |
The address of the employer
|
| IncomeVerificationPrecheckEmployerAddressData |
Data about the components comprising an address.
|
| IncomeVerificationPrecheckMilitaryInfo |
Data about military info in the income verification precheck.
|
| IncomeVerificationPrecheckPayrollInstitution |
Information about the end user's payroll institution
|
| IncomeVerificationPrecheckRequest |
IncomeVerificationPrecheckRequest defines the request schema for `/income/verification/precheck`
|
| IncomeVerificationPrecheckResponse |
IncomeVerificationPrecheckResponse defines the response schema for `/income/verification/precheck`.
|
| IncomeVerificationPrecheckUser |
Information about the user whose eligibility is being evaluated.
|
| IncomeVerificationSourceType.Adapter | |
| IncomeVerificationStatusWebhook |
Fired when the status of an income verification instance has changed.
|
| IncomeVerificationTaxformsGetRequest |
IncomeVerificationTaxformsGetRequest defines the request schema for `/income/verification/taxforms/get`
|
| IncomeVerificationTaxformsGetResponse |
IncomeVerificationTaxformsGetResponse defines the response schema for `/income/verification/taxforms/get`
|
| IncomeVerificationWebhookStatus |
Status of the income verification webhook
|
| IndividualName |
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.
|
| IndividualScreeningHitNames |
Name information for the associated individual watchlist hit
|
| IndividualWatchlistCode.Adapter | |
| IndividualWatchlistProgram |
A program that configures the active lists, search parameters, and other behavior for initial and ongoing screening of individuals.
|
| InflowModel |
The `inflow_model` allows you to model a test account that receives regular income or make regular payments on a loan.
|
| InitialUpdateWebhook |
Fired when an Item's initial transaction pull is completed.
|
| Institution |
Details relating to a specific financial institution
|
| InstitutionsGetByIdRequest |
InstitutionsGetByIdRequest defines the request schema for `/institutions/get_by_id`
|
| InstitutionsGetByIdRequestOptions |
Specifies optional parameters for `/institutions/get_by_id`.
|
| InstitutionsGetByIdResponse |
InstitutionsGetByIdResponse defines the response schema for `/institutions/get_by_id`
|
| InstitutionsGetRequest |
InstitutionsGetRequest defines the request schema for `/institutions/get`
|
| InstitutionsGetRequestOptions |
An optional object to filter `/institutions/get` results.
|
| InstitutionsGetResponse |
InstitutionsGetResponse defines the response schema for `/institutions/get`
|
| InstitutionsSearchAccountFilter |
An account filter to apply to institutions search requests
|
| InstitutionsSearchPaymentInitiationOptions |
Additional options that will be used to filter institutions by various Payment Initiation configurations.
|
| InstitutionsSearchRequest |
InstitutionsSearchRequest defines the request schema for `/institutions/search`
|
| InstitutionsSearchRequestOptions |
An optional object to filter `/institutions/search` results.
|
| InstitutionsSearchResponse |
InstitutionsSearchResponse defines the response schema for `/institutions/search`
|
| InstitutionStatus |
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.
|
| InstitutionSupportedNetworks |
Contains the supported RTP network and types by the linked item's institution
|
| InvestmentAccountSubtype.Adapter | |
| InvestmentFilter |
A filter to apply to `investment`-type accounts (or `brokerage`-type accounts for API versions 2018-05-22 and earlier).
|
| InvestmentHoldingsGetRequestOptions |
An optional object to filter `/investments/holdings/get` results.
|
| InvestmentsDefaultUpdateWebhook |
Fired when new transactions have been detected on an investment account.
|
| InvestmentsHoldingsGetRequest |
InvestmentsHoldingsGetRequest defines the request schema for `/investments/holdings/get`
|
| InvestmentsHoldingsGetResponse |
InvestmentsHoldingsGetResponse defines the response schema for `/investments/holdings/get`
|
| InvestmentsTransactionsGetRequest |
InvestmentsTransactionsGetRequest defines the request schema for `/investments/transactions/get`
|
| InvestmentsTransactionsGetRequestOptions |
An optional object to filter `/investments/transactions/get` results.
|
| InvestmentsTransactionsGetResponse |
InvestmentsTransactionsGetResponse defines the response schema for `/investments/transactions/get`
|
| InvestmentsTransactionsOverride |
Specify the list of investments transactions on the account.
|
| InvestmentTransaction |
A transaction within an investment account.
|
| InvestmentTransactionSubtype.Adapter | |
| InvestmentTransactionType.Adapter | |
| IssuingCountry.Adapter | |
| Item |
Metadata about the Item.
|
| Item.UpdateTypeEnum.Adapter | |
| ItemAccessTokenInvalidateRequest |
ItemAccessTokenInvalidateRequest defines the request schema for `/item/access_token/invalidate`
|
| ItemAccessTokenInvalidateResponse |
ItemAccessTokenInvalidateResponse defines the response schema for `/item/access_token/invalidate`
|
| ItemActivityListRequest |
Request to list a historical log of user consent events.
|
| ItemActivityListResponse |
Describes a historical log of user consent events.
|
| ItemApplicationListRequest |
Request to list connected applications for a user.
|
| ItemApplicationListResponse |
Describes the connected application for a particular end user.
|
| ItemApplicationListUserAuth |
User authentication parameters, for clients making a request without an `access_token`.
|
| ItemApplicationScopesUpdateRequest |
ItemApplicationScopesUpdateRequest defines the request schema for `/item/application/scopes/update`
|
| ItemApplicationScopesUpdateResponse |
ItemApplicationScopesUpdateResponse defines the response schema for `/item/application/scopes/update`
|
| ItemErrorWebhook |
Fired when an error is encountered with an Item.
|
| ItemGetRequest |
ItemGetRequest defines the request schema for `/item/get`
|
| ItemGetResponse |
ItemGetResponse defines the response schema for `/item/get` and `/item/webhook/update`
|
| ItemImportRequest |
ItemImportRequest defines the request schema for `/item/import`
|
| ItemImportRequestOptions |
An optional object to configure `/item/import` request.
|
| ItemImportRequestUserAuth |
Object of user ID and auth token pair, permitting Plaid to aggregate a user’s accounts
|
| ItemImportResponse |
ItemImportResponse defines the response schema for `/item/import`
|
| ItemProductReadyWebhook |
Fired once Plaid calculates income from an Item.
|
| ItemPublicTokenCreateRequest |
ItemPublicTokenCreateRequest defines the request schema for `/item/public_token/create`
|
| ItemPublicTokenCreateResponse |
ItemPublicTokenCreateResponse defines the response schema for `/item/public_token/create`
|
| ItemPublicTokenExchangeRequest |
ItemPublicTokenExchangeRequest defines the request schema for `/item/public_token/exchange`
|
| ItemPublicTokenExchangeResponse |
ItemPublicTokenExchangeResponse defines the response schema for `/item/public_token/exchange`
|
| ItemRemoveRequest |
ItemRemoveRequest defines the request schema for `/item/remove`
|
| ItemRemoveResponse |
ItemRemoveResponse defines the response schema for `/item/remove`
|
| ItemStatus |
An object with information about the status of the Item.
|
| ItemStatusInvestments |
Information about the last successful and failed investments update for the Item.
|
| ItemStatusLastWebhook |
Information about the last webhook fired for the Item.
|
| ItemStatusNullable |
Information about the last successful and failed transactions update for the Item.
|
| ItemStatusTransactions |
Information about the last successful and failed transactions update for the Item.
|
| ItemWebhookUpdateRequest |
ItemWebhookUpdateRequest defines the request schema for `/item/webhook/update`
|
| ItemWebhookUpdateResponse |
ItemWebhookUpdateResponse defines the response schema for `/item/webhook/update`
|
| JWKPublicKey |
A JSON Web Key (JWK) that can be used in conjunction with [JWT libraries](https://jwt.io/#libraries-io) to verify Plaid webhooks
|
| JWTHeader |
A JWT Header, used for webhook validation
|
| KYCCheckAddressSummary |
Result summary object specifying how the `address` field matched.
|
| KYCCheckDateOfBirthSummary |
Result summary object specifying how the `date_of_birth` field matched.
|
| KYCCheckDetails |
Additional information for the `kyc_check` step.
|
| KYCCheckIDNumberSummary |
Result summary object specifying how the `id_number` field matched.
|
| KYCCheckNameSummary |
Result summary object specifying how the `name` field matched.
|
| KYCCheckPhoneSummary |
Result summary object specifying how the `phone` field matched.
|
| LiabilitiesDefaultUpdateWebhook |
The webhook of type `LIABILITIES` and code `DEFAULT_UPDATE` will be fired when new or updated liabilities have been detected on a liabilities item.
|
| LiabilitiesGetRequest |
LiabilitiesGetRequest defines the request schema for `/liabilities/get`
|
| LiabilitiesGetRequestOptions |
An optional object to filter `/liabilities/get` results.
|
| LiabilitiesGetResponse |
LiabilitiesGetResponse defines the response schema for `/liabilities/get`
|
| LiabilitiesObject |
An object containing liability accounts
|
| LiabilityOverride |
Used to configure Sandbox test data for the Liabilities product
|
| LinkDeliveryCreateRequest |
LinkDeliveryCreateRequest defines the request schema for `/link_delivery/create`
|
| LinkDeliveryCreateResponse |
LinkDeliveryCreateResponse defines the response schema for `/link_delivery/create`
|
| LinkDeliveryDeliveryMethod.Adapter | |
| LinkDeliveryGetRequest |
LinkDeliveryGetRequest defines the request schema for `/link_delivery/get`
|
| LinkDeliveryGetResponse |
LinkDeliveryGetRequest defines the response schema for `/link_delivery/get`
|
| LinkDeliverySessionStatus.Adapter | |
| LinkOAuthCorrelationIdExchangeRequest |
LinkOAuthCorrelationIdExchangeRequest defines the request schema for `/link/oauth/correlation_id/exchange`
|
| LinkOAuthCorrelationIdExchangeResponse |
LinkOAuthCorrelationIdExchangeResponse defines the response schema for `/link/oauth/correlation_id/exchange`
|
| LinkTokenAccountFilters |
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.
|
| LinkTokenCreateCreditFilter |
A filter to apply to `credit`-type accounts
|
| LinkTokenCreateDepositoryFilter |
A filter to apply to `depository`-type accounts
|
| LinkTokenCreateInstitutionData |
A map containing data used to highlight institutions in Link.
|
| LinkTokenCreateInvestmentFilter |
A filter to apply to `investment`-type accounts (or `brokerage`-type accounts for API versions 2018-05-22 and earlier).
|
| LinkTokenCreateLoanFilter |
A filter to apply to `loan`-type accounts
|
| LinkTokenCreateRequest |
LinkTokenCreateRequest defines the request schema for `/link/token/create`
|
| LinkTokenCreateRequestAccountSubtypes |
By default, Link will only display account types that are compatible with all products supplied in the `products` parameter of `/link/token/create`.
|
| LinkTokenCreateRequestAuth |
Specifies options for initializing Link for use with the Auth product.
|
| LinkTokenCreateRequestAuth.FlowTypeEnum.Adapter | |
| LinkTokenCreateRequestDepositSwitch |
Specifies options for initializing Link for use with the Deposit Switch (beta) product.
|
| LinkTokenCreateRequestIdentityVerification |
Specifies option for initializing Link for use with the Identity Verification product.
|
| LinkTokenCreateRequestIncomeVerification |
Specifies options for initializing Link for use with the Income product.
|
| LinkTokenCreateRequestIncomeVerificationBankIncome |
Specifies options for initializing Link for use with Bank Income.
|
| LinkTokenCreateRequestIncomeVerificationPayrollIncome |
Specifies options for initializing Link for use with Payroll Income.
|
| LinkTokenCreateRequestPaymentInitiation |
Specifies options for initializing Link for use with the Payment Initiation (Europe) product.
|
| LinkTokenCreateRequestTransfer |
Specifies options for initializing Link for use with the Transfer product.
|
| LinkTokenCreateRequestUpdate |
Specifies options for initializing Link for [update mode](https://plaid.com/docs/link/update-mode).
|
| LinkTokenCreateRequestUser |
An object specifying information about the end user who will be linking their account.
|
| LinkTokenCreateRequestUserStatedIncomeSource |
Specifies user stated income sources for the Income product
|
| LinkTokenCreateResponse |
LinkTokenCreateResponse defines the response schema for `/link/token/create`
|
| LinkTokenEUConfig |
Configuration parameters for EU flows
|
| LinkTokenGetMetadataResponse |
An object specifying the arguments originally provided to the `/link/token/create` call.
|
| LinkTokenGetRequest |
LinkTokenGetRequest defines the request schema for `/link/token/get`
|
| LinkTokenGetResponse |
LinkTokenGetResponse defines the response schema for `/link/token/get`
|
| LinkTokenInvestments |
Configuration parameters for the Investments product
|
| Loan |
Information specific to a mortgage loan agreement between one or more borrowers and a mortgage lender.
|
| LoanAccountSubtype.Adapter | |
| LoanFilter |
A filter to apply to `loan`-type accounts
|
| LoanIdentifier |
The information used to identify this loan by various parties to the transaction or other organizations.
|
| LoanIdentifiers |
Collection of current and previous identifiers for this loan.
|
| LoanIdentifierType.Adapter | |
| Loans |
A collection of loans that are part of a single deal.
|
| Location |
A representation of where a transaction took place
|
| MatchSummary |
Summary object reflecting the match result of the associated data
|
| MatchSummaryCode.Adapter | |
| Meta |
Allows specifying the metadata of the test account
|
| MFA |
Specifies the multi-factor authentication settings to use with this test account
|
| MortgageInterestRate |
Object containing metadata about the interest rate for the mortgage.
|
| MortgageLiability |
Contains details about a mortgage account.
|
| MortgagePropertyAddress |
Object containing fields describing property address.
|
| MultiDocumentRiskSignal |
Object containing risk signals and relevant metadata for a set of uploaded documents
|
| NameMatchScore |
Score found by matching name provided by the API with the name on the account at the financial institution.
|
| NetPay |
An object representing information about the net pay amount on the paystub.
|
| NewAccountsAvailableWebhook |
Fired when Plaid detects a new account for Items created or updated with [Account Select v2](https://plaid.com/docs/link/customization/#account-select).
|
| Numbers |
Account and bank identifier number data used to configure the test account.
|
| NumbersACH |
Identifying information for transferring money to or from a US account via ACH or wire transfer.
|
| NumbersACHNullable |
Identifying information for transferring money to or from a US account via ACH or wire transfer.
|
| NumbersBACS |
Identifying information for transferring money to or from a UK bank account via BACS.
|
| NumbersBACSNullable |
Identifying information for transferring money to or from a UK bank account via BACS.
|
| NumbersEFT |
Identifying information for transferring money to or from a Canadian bank account via EFT.
|
| NumbersEFTNullable |
Identifying information for transferring money to or from a Canadian bank account via EFT.
|
| NumbersIBANNullable |
International Bank Account Number (IBAN).
|
| NumbersInternational |
Identifying information for transferring money to or from an international bank account via wire transfer.
|
| NumbersInternationalIBAN |
Account numbers using the International Bank Account Number and BIC/SWIFT code format.
|
| NumbersInternationalNullable |
Identifying information for transferring money to or from an international bank account via wire transfer.
|
| Originator |
Originator and their status.
|
| OverrideAccounts |
Data to use to set values of test accounts.
|
| OverrideAccountType.Adapter | |
| Owner |
Data returned from the financial institution about the owner or owners of an account.
|
| OwnerOverride |
Data about the owner or owners of an account.
|
| OwnershipType.Adapter | |
| Parties |
A collection of objects that define specific parties to a deal.
|
| PartnerCustomerCreateRequest |
Request schema for `/partner/customer/create`.
|
| PartnerCustomerCreateResponse |
Response schema for `/partner/customer/create`.
|
| PartnerCustomerEnableRequest |
Request schema for `/partner/customer/enable`.
|
| PartnerCustomerEnableResponse |
Response schema for `/partner/customer/enable`.
|
| PartnerCustomerGetRequest |
Request schema for `/partner/customer/get`.
|
| PartnerCustomerGetResponse |
Response schema for `/partner/customer/get`.
|
| PartnerCustomerOAuthInstitutionsGetRequest |
Request schema for `/partner/customer/oauth_institutions/get`.
|
| PartnerCustomerOAuthInstitutionsGetResponse |
Response schema for `/partner/customer/oauth_institutions/get`.
|
| PartnerCustomerRemoveRequest |
Request schema for `/partner/customer/remove`.
|
| PartnerCustomerRemoveResponse |
Response schema for `/partner/customer/remove`.
|
| PartnerEndCustomer |
The details for an end customer.
|
| PartnerEndCustomerAddress |
The end customer's address.
|
| PartnerEndCustomerAssetsUnderManagement |
Assets under management for the given end customer.
|
| PartnerEndCustomerBillingContact |
The billing contact for the end customer.
|
| PartnerEndCustomerCustomerSupportInfo |
This information is public.
|
| PartnerEndCustomerFlowdownStatus.Adapter | |
| PartnerEndCustomerOAuthInstitution |
The OAuth registration information for an institution.
|
| PartnerEndCustomerOAuthInstitutionApplicationStatus.Adapter | |
| PartnerEndCustomerOAuthInstitutionEnvironments |
Registration statuses by environment.
|
| PartnerEndCustomerQuestionnaireStatus.Adapter | |
| PartnerEndCustomerSecrets |
The secrets for the newly created end customer in non-Production environments.
|
| PartnerEndCustomerStatus.Adapter | |
| PartnerEndCustomerTechnicalContact |
The technical contact for the end customer.
|
| PartnerEndCustomerWithSecrets |
The details for the newly created end customer, including secrets for non-Production environments.
|
| PartnerEndCustomerWithSecretsAllOf |
PartnerEndCustomerWithSecretsAllOf
|
| Party |
A collection of information about a single party to a transaction.
|
| PartyIndividual |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| PartyRoleType.Adapter | |
| Pay |
An object representing a monetary amount.
|
| PayFrequency |
The frequency of the pay period.
|
| PayFrequencyValue.Adapter | |
| PaymentAmount |
The amount and currency of a payment
|
| PaymentAmountCurrency.Adapter | |
| PaymentAmountNullable |
The amount and currency of a payment
|
| PaymentAmountRefunded |
The amount and currency of a payment
|
| PaymentAmountToRefund |
The amount and currency of a payment
|
| PaymentChannel.Adapter | |
| PaymentConsentMaxPaymentAmount |
Maximum amount of a single payment initiated using the payment consent.
|
| PaymentConsentPeriodicAlignment.Adapter | |
| PaymentConsentPeriodicAmount |
Defines consent payments limitations per period.
|
| PaymentConsentPeriodicAmountAmount |
Maximum cumulative amount for all payments in the specified interval.
|
| PaymentConsentPeriodicInterval.Adapter | |
| PaymentConsentValidDateTime |
Life span for the payment consent.
|
| PaymentInitiationAddress |
The optional address of the payment recipient.
|
| PaymentInitiationConsent |
PaymentInitiationConsent defines a payment initiation consent.
|
| PaymentInitiationConsentConstraints |
Limitations that will be applied to payments initiated using the payment consent.
|
| PaymentInitiationConsentCreateRequest |
PaymentInitiationConsentCreateRequest defines the request schema for `/payment_initiation/consent/create`
|
| PaymentInitiationConsentCreateResponse |
PaymentInitiationConsentCreateResponse defines the response schema for `/payment_initiation/consent/create`
|
| PaymentInitiationConsentGetRequest |
PaymentInitiationConsentGetRequest defines the request schema for `/payment_initiation/consent/get`
|
| PaymentInitiationConsentGetResponse |
PaymentInitiationConsentGetResponse defines the response schema for `/payment_initation/consent/get`
|
| PaymentInitiationConsentPaymentExecuteRequest |
PaymentInitiationConsentPaymentExecuteRequest defines the request schema for `/payment_initiation/consent/payment/execute`
|
| PaymentInitiationConsentPaymentExecuteResponse |
PaymentInitiationConsentPaymentExecuteResponse defines the response schema for `/payment_initiation/consent/payment/execute`
|
| PaymentInitiationConsentRevokeRequest |
PaymentInitiationConsentRevokeRequest defines the request schema for `/payment_initiation/consent/revoke`
|
| PaymentInitiationConsentRevokeResponse |
PaymentInitiationConsentRevokeResponse defines the response schema for `/payment_initation/consent/revoke`
|
| PaymentInitiationConsentScope.Adapter | |
| PaymentInitiationConsentStatus.Adapter | |
| PaymentInitiationMetadata |
Metadata that captures what specific payment configurations an institution supports when making Payment Initiation requests.
|
| PaymentInitiationOptionalRestrictionBacs |
An optional object used to restrict the accounts used for payments.
|
| PaymentInitiationPayment |
PaymentInitiationPayment defines a payment initiation payment
|
| PaymentInitiationPaymentCreateRequest |
PaymentInitiationPaymentCreateRequest defines the request schema for `/payment_initiation/payment/create`
|
| PaymentInitiationPaymentCreateResponse |
PaymentInitiationPaymentCreateResponse defines the response schema for `/payment_initiation/payment/create`
|
| PaymentInitiationPaymentCreateStatus.Adapter | |
| PaymentInitiationPaymentGetRequest |
PaymentInitiationPaymentGetRequest defines the request schema for `/payment_initiation/payment/get`
|
| PaymentInitiationPaymentGetResponse |
PaymentInitiationPaymentGetResponse defines the response schema for `/payment_initation/payment/get`
|
| PaymentInitiationPaymentListRequest |
PaymentInitiationPaymentListRequest defines the request schema for `/payment_initiation/payment/list`
|
| PaymentInitiationPaymentListResponse |
PaymentInitiationPaymentListResponse defines the response schema for `/payment_initiation/payment/list`
|
| PaymentInitiationPaymentReverseRequest |
PaymentInitiationPaymentReverseRequest defines the request schema for `/payment_initiation/payment/reverse`
|
| PaymentInitiationPaymentReverseResponse |
PaymentInitiationPaymentReverseResponse defines the response schema for `/payment_initation/payment/reverse`
|
| PaymentInitiationPaymentStatus.Adapter | |
| PaymentInitiationPaymentTokenCreateRequest |
PaymentInitiationPaymentTokenCreateRequest defines the request schema for `/payment_initiation/payment/token/create`
|
| PaymentInitiationPaymentTokenCreateResponse |
PaymentInitiationPaymentTokenCreateResponse defines the response schema for `/payment_initiation/payment/token/create`
|
| PaymentInitiationRecipient |
PaymentInitiationRecipient defines a payment initiation recipient
|
| PaymentInitiationRecipientCreateRequest |
PaymentInitiationRecipientCreateRequest defines the request schema for `/payment_initiation/recipient/create`
|
| PaymentInitiationRecipientCreateResponse |
PaymentInitiationRecipientCreateResponse defines the response schema for `/payment_initation/recipient/create`
|
| PaymentInitiationRecipientGetRequest |
PaymentInitiationRecipientGetRequest defines the request schema for `/payment_initiation/recipient/get`
|
| PaymentInitiationRecipientGetResponse |
PaymentInitiationRecipientGetResponse defines the response schema for `/payment_initiation/recipient/get`
|
| PaymentInitiationRecipientGetResponseAllOf |
PaymentInitiationRecipientGetResponseAllOf
|
| PaymentInitiationRecipientListRequest |
PaymentInitiationRecipientListRequest defines the request schema for `/payment_initiation/recipient/list`
|
| PaymentInitiationRecipientListResponse |
PaymentInitiationRecipientListResponse defines the response schema for `/payment_initiation/recipient/list`
|
| PaymentInitiationStandingOrderMetadata |
Metadata specifically related to valid Payment Initiation standing order configurations for the institution.
|
| PaymentMeta |
Transaction information specific to inter-bank transfers.
|
| PaymentProfileCreateRequest |
PaymentProfileCreateRequest defines the request schema for `/payment_profile/create`
|
| PaymentProfileCreateResponse |
PaymentProfileCreateResponse defines the response schema for `/payment_profile/create`
|
| PaymentProfileGetRequest |
PaymentProfileGetRequest defines the request schema for `/payment_profile/get`
|
| PaymentProfileGetResponse |
PaymentProfileGetResponse defines the response schema for `/payment_profile/get`
|
| PaymentProfileRemoveRequest |
PaymentProfileRemoveRequest defines the request schema for `/payment_profile/remove`
|
| PaymentProfileRemoveResponse |
PaymentProfileRemoveResponse defines the response schema for `/payment_profile/remove`
|
| PaymentProfileStatus.Adapter | |
| PaymentScheduleInterval.Adapter | |
| PaymentScheme.Adapter | |
| PaymentStatusUpdateWebhook |
Fired when the status of a payment has changed.
|
| PayPeriodDetails |
Details about the pay period.
|
| PayPeriodDetails.PayFrequencyEnum.Adapter | |
| PayrollIncomeAccountData |
An object containing account level data.
|
| PayrollIncomeObject |
An object representing payroll data.
|
| PayrollIncomeRateOfPay |
An object representing the rate at which an individual is paid.
|
| PayrollItem |
An object containing information about the payroll item.
|
| PayrollItemStatus |
Details about the status of the payroll item.
|
| PayrollRiskSignalsItem |
Object containing fraud risk data pertaining to the item linked as part of the verification
|
| Paystub |
An object representing data extracted from the end user's paystub.
|
| PaystubAddress |
Address on the paystub
|
| PaystubDeduction |
Deduction on the paystub
|
| PayStubDeductionsBreakdown |
An object representing the deduction line items for the pay period
|
| PayStubDeductionsTotal |
An object representing the total deductions for the pay period
|
| PaystubDetails |
An object representing details that can be found on the paystub.
|
| PayStubDistributionBreakdown |
Information about the accounts that the payment was distributed to.
|
| PayStubEarningsBreakdown |
An object representing the earnings line items for the pay period.
|
| PayStubEarningsTotal |
An object representing both the current pay period and year to date amount for an earning category.
|
| PaystubEmployer |
Information about the employer on the paystub
|
| PaystubOverride |
An object representing data from a paystub.
|
| PaystubOverrideEmployee |
The employee on the paystub.
|
| PaystubOverrideEmployeeAddress |
The address of the employee.
|
| PaystubOverrideEmployer |
The employer on the paystub.
|
| PaystubPayFrequency.Adapter | |
| PayStubPayPeriodDetails |
Details about the pay period.
|
| PayStubTaxpayerID |
Taxpayer ID of the individual receiving the paystub.
|
| PaystubYTDDetails |
The amount of income earned year to date, as based on paystub data.
|
| PendingExpirationWebhook |
Fired when an Item’s access consent is expiring in 7 days.
|
| PersonalFinanceCategory |
Information describing the intent of the transaction.
|
| PhoneNumber |
A phone number
|
| PhoneNumber.TypeEnum.Adapter | |
| PhoneNumberMatchScore |
Score found by matching phone number provided by the API with the phone number on the account at the financial institution.
|
| PhoneType.Adapter | |
| PhysicalDocumentCategory.Adapter | |
| PhysicalDocumentExtractedData |
Data extracted from a user-submitted document.
|
| PhysicalDocumentExtractedDataAnalysis |
Analysis of the data extracted from the submitted document.
|
| PhysicalDocumentImages |
URLs for downloading original and cropped images for this document submission.
|
| PlaidError |
We use standard HTTP response codes for success and failure notifications, and our errors are further classified by `error_type`.
|
| PlaidErrorType.Adapter | |
| PlatformIds |
An object containing a set of ids related to an employee
|
| POBoxStatus.Adapter | |
| ProcessorApexProcessorTokenCreateRequest |
ProcessorApexProcessorTokenCreateRequest defines the request schema for `/processor/apex/processor_token/create`
|
| ProcessorAuthGetRequest |
ProcessorAuthGetRequest defines the request schema for `/processor/auth/get`
|
| ProcessorAuthGetResponse |
ProcessorAuthGetResponse defines the response schema for `/processor/auth/get`
|
| ProcessorBalanceGetRequest |
ProcessorBalanceGetRequest defines the request schema for `/processor/balance/get`
|
| ProcessorBalanceGetRequestOptions |
An optional object to filter `/processor/balance/get` results.
|
| ProcessorBalanceGetResponse |
ProcessorBalanceGetResponse defines the response schema for `/processor/balance/get`
|
| ProcessorBankTransferCreateRequest |
Defines the request schema for `/processor/bank_transfer/create`
|
| ProcessorBankTransferCreateResponse |
Defines the response schema for `/processor/bank_transfer/create`
|
| ProcessorIdentityGetRequest |
ProcessorIdentityGetRequest defines the request schema for `/processor/identity/get`
|
| ProcessorIdentityGetResponse |
ProcessorIdentityGetResponse defines the response schema for `/processor/identity/get`
|
| ProcessorNumber |
An object containing identifying numbers used for making electronic transfers to and from the `account`.
|
| ProcessorStripeBankAccountTokenCreateRequest |
ProcessorStripeBankAccountTokenCreateRequest defines the request schema for `/processor/stripe/bank_account/create`
|
| ProcessorStripeBankAccountTokenCreateResponse |
ProcessorStripeBankAccountTokenCreateResponse defines the response schema for `/processor/stripe/bank_account/create`
|
| ProcessorTokenCreateRequest |
ProcessorTokenCreateRequest defines the request schema for `/processor/token/create`
|
| ProcessorTokenCreateRequest.ProcessorEnum.Adapter | |
| ProcessorTokenCreateResponse |
ProcessorTokenCreateResponse defines the response schema for `/processor/token/create` and `/processor/apex/processor_token/create`
|
| ProductAccess |
The product access being requested.
|
| Products.Adapter | |
| ProductStatus |
A representation of the status health of a request type.
|
| ProductStatus.StatusEnum.Adapter | |
| ProductStatusBreakdown |
A detailed breakdown of the institution's performance for a request type.
|
| ProductStatusBreakdown.RefreshIntervalEnum.Adapter | |
| ProgramNameSensitivity.Adapter | |
| ProjectedIncomeSummaryFieldNumber |
The employee's estimated annual salary, as derived from information reported on the paystub.
|
| PSLFStatus |
Information about the student's eligibility in the Public Service Loan Forgiveness program.
|
| RecaptchaRequiredError |
The request was flagged by Plaid's fraud system, and requires additional verification to ensure they are not a bot.
|
| RecipientBACS |
An object containing a BACS account number and sort code.
|
| RecipientBACSNullable |
An object containing a BACS account number and sort code.
|
| RecurringCancelledWebhook |
Fired when a recurring transfer is cancelled by Plaid.
|
| RecurringNewTransferWebhook |
Fired when a new transfer of a recurring transfer is originated.
|
| RecurringTransactionFrequency.Adapter | |
| RecurringTransactionsUpdateWebhook |
Fired when recurring transactions data is updated.
|
| RecurringTransfer |
Represents a recurring transfer within the Transfers API.
|
| RecurringTransferNullable |
Represents a recurring transfer within the Transfers API.
|
| RecurringTransferSkippedWebhook |
Fired when Plaid is unable to originate a new ACH transaction of the recurring transfer on the planned date.
|
| RemovedTransaction |
A representation of a removed transaction
|
| ReportingInformation |
Information about an report identifier and a report name.
|
| ReportType.Adapter | |
| RiskSignalDocumentReference |
Object containing metadata for the document
|
| Role |
ADocumentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| RoleDetail |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| Roles |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| SandboxBankTransferFireWebhookRequest |
Defines the request schema for `/sandbox/bank_transfer/fire_webhook`
|
| SandboxBankTransferFireWebhookResponse |
Defines the response schema for `/sandbox/bank_transfer/fire_webhook`
|
| SandboxBankTransferSimulateRequest |
Defines the request schema for `/sandbox/bank_transfer/simulate`
|
| SandboxBankTransferSimulateResponse |
Defines the response schema for `/sandbox/bank_transfer/simulate`
|
| SandboxIncomeFireWebhookRequest |
SandboxIncomeFireWebhookRequest defines the request schema for `/sandbox/income/fire_webhook`
|
| SandboxIncomeFireWebhookRequest.VerificationStatusEnum.Adapter | |
| SandboxIncomeFireWebhookResponse |
SandboxIncomeFireWebhookResponse defines the response schema for `/sandbox/income/fire_webhook`
|
| SandboxItemFireWebhookRequest |
SandboxItemFireWebhookRequest defines the request schema for `/sandbox/item/fire_webhook`
|
| SandboxItemFireWebhookRequest.WebhookCodeEnum.Adapter | |
| SandboxItemFireWebhookResponse |
SandboxItemFireWebhookResponse defines the response schema for `/sandbox/item/fire_webhook`
|
| SandboxItemResetLoginRequest |
SandboxItemResetLoginRequest defines the request schema for `/sandbox/item/reset_login`
|
| SandboxItemResetLoginResponse |
SandboxItemResetLoginResponse defines the response schema for `/sandbox/item/reset_login`
|
| SandboxItemSetVerificationStatusRequest |
SandboxItemSetVerificationStatusRequest defines the request schema for `/sandbox/item/set_verification_status`
|
| SandboxItemSetVerificationStatusRequest.VerificationStatusEnum.Adapter | |
| SandboxItemSetVerificationStatusResponse |
SandboxItemSetVerificationStatusResponse defines the response schema for `/sandbox/item/set_verification_status`
|
| SandboxOauthSelectAccountsRequest |
Defines the request schema for `sandbox/oauth/select_accounts`
|
| SandboxPaymentProfileResetLoginRequest |
SandboxPaymentProfileResetLoginRequest defines the request schema for `/sandbox/payment_profile/reset_login`
|
| SandboxPaymentProfileResetLoginResponse |
SandboxPaymentProfileResetLoginResponse defines the response schema for `/sandbox/payment_profile/reset_login`
|
| SandboxProcessorTokenCreateRequest |
SandboxProcessorTokenCreateRequest defines the request schema for `/sandbox/processor_token/create`
|
| SandboxProcessorTokenCreateRequestOptions |
An optional set of options to be used when configuring the Item.
|
| SandboxProcessorTokenCreateResponse |
SandboxProcessorTokenCreateResponse defines the response schema for `/sandbox/processor_token/create`
|
| SandboxPublicTokenCreateRequest |
SandboxPublicTokenCreateRequest defines the request schema for `/sandbox/public_token/create`
|
| SandboxPublicTokenCreateRequestIncomeVerificationBankIncome |
Specifies options for Bank Income.
|
| SandboxPublicTokenCreateRequestOptions |
An optional set of options to be used when configuring the Item.
|
| SandboxPublicTokenCreateRequestOptionsIncomeVerification |
A set of parameters for income verification options.
|
| SandboxPublicTokenCreateRequestOptionsTransactions |
An optional set of parameters corresponding to transactions options.
|
| SandboxPublicTokenCreateResponse |
SandboxPublicTokenCreateResponse defines the response schema for `/sandbox/public_token/create`
|
| SandboxTransferFireWebhookRequest |
Defines the request schema for `/sandbox/transfer/fire_webhook`
|
| SandboxTransferFireWebhookResponse |
Defines the response schema for `/sandbox/transfer/fire_webhook`
|
| SandboxTransferRepaymentSimulateRequest |
Defines the request schema for `/sandbox/transfer/repayment/simulate`
|
| SandboxTransferRepaymentSimulateResponse |
Defines the response schema for `/sandbox/transfer/repayment/simulate`
|
| SandboxTransferSimulateRequest |
Defines the request schema for `/sandbox/transfer/simulate`
|
| SandboxTransferSimulateResponse |
Defines the response schema for `/sandbox/transfer/simulate`
|
| SandboxTransferSweepSimulateRequest |
Defines the request schema for `/sandbox/transfer/sweep/simulate`
|
| SandboxTransferSweepSimulateResponse |
Defines the response schema for `/sandbox/transfer/sweep/simulate`
|
| SandboxTransferTestClockAdvanceRequest |
Defines the request schema for `/sandbox/transfer/test_clock/advance`
|
| SandboxTransferTestClockAdvanceResponse |
Defines the response schema for `/sandbox/transfer/test_clock/advance`
|
| SandboxTransferTestClockCreateRequest |
Defines the request schema for `/sandbox/transfer/test_clock/create`
|
| SandboxTransferTestClockCreateResponse |
Defines the response schema for `/sandbox/transfer/test_clock/create`
|
| SandboxTransferTestClockGetRequest |
Defines the request schema for `/sandbox/transfer/test_clock/get`
|
| SandboxTransferTestClockGetResponse |
Defines the response schema for `/sandbox/transfer/test_clock/get`
|
| SandboxTransferTestClockListRequest |
Defines the request schema for `/sandbox/transfer/test_clock/list`
|
| SandboxTransferTestClockListResponse |
Defines the response schema for `/sandbox/transfer/test_clock/list`
|
| Scopes |
The scopes object
|
| ScopesContext.Adapter | |
| ScopesNullable |
The scopes object
|
| ScreeningHitAnalysis |
Analysis information describing why a screening hit matched the provided user information
|
| ScreeningHitData |
Information associated with the watchlist hit
|
| ScreeningHitDateOfBirthItem |
Analyzed date of birth for the associated hit
|
| ScreeningHitDocumentsItems |
Analyzed document information for the associated hit
|
| ScreeningHitNamesItems |
Analyzed name information for the associated hit
|
| ScreeningStatusUpdatedWebhook |
Fired when an individual screening status has changed, which can occur manually via the dashboard or during ongoing monitoring.
|
| Security |
Contains details about a security
|
| SecurityOverride |
Specify the security associated with the holding or investment transaction.
|
| SenderBACSNullable |
An object containing a BACS account number and sort code.
|
| Service |
A collection of details related to a fulfillment service or product in terms of request, process and result.
|
| ServiceProductFulfillment |
A collection of details related to a fulfillment service or product in terms of request, process and result.
|
| ServiceProductFulfillmentDetail |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| ServiceProductFulfillmentIdentifier.Adapter | |
| ServicerAddressData |
The address of the student loan servicer.
|
| Services |
A collection of objects that describe requests and responses for services.
|
| SignalAddressData |
Data about the components comprising an address.
|
| SignalDecisionOutcome.Adapter | |
| SignalDecisionReportRequest |
SignalDecisionReportRequest defines the request schema for `/signal/decision/report`
|
| SignalDecisionReportResponse |
SignalDecisionReportResponse defines the response schema for `/signal/decision/report`
|
| SignalDevice |
Details about the end user's device
|
| SignalEvaluateCoreAttributes |
The core attributes object contains additional data that can be used to assess the ACH return risk.
|
| SignalEvaluateRequest |
SignalEvaluateRequest defines the request schema for `/signal/evaluate`
|
| SignalEvaluateResponse |
SignalEvaluateResponse defines the response schema for `/signal/income/evaluate`
|
| SignalPaymentMethod.Adapter | |
| SignalPersonName |
The user's legal name
|
| SignalPrepareRequest |
SignalPrepareRequest defines the request schema for `/signal/prepare`
|
| SignalPrepareResponse |
SignalPrepareResponse defines the response schema for `/signal/prepare`
|
| SignalReturnReportRequest |
SignalReturnReportRequest defines the request schema for `/signal/return/report`
|
| SignalReturnReportResponse |
SignalReturnReportResponse defines the response schema for `/signal/return/report`
|
| SignalScores |
Risk scoring details broken down by risk category.
|
| SignalUser |
Details about the end user initiating the transaction (i.e., the account holder).
|
| SimulatedTransferSweep |
A sweep returned from the `/sandbox/transfer/sweep/simulate` endpoint.
|
| SingleDocumentRiskSignal |
Object containing all risk signals and relevant metadata for a single document
|
| Source.Adapter | |
| StandaloneAccountType |
The schema below describes the various `types` and corresponding `subtypes` that Plaid recognizes and reports for financial institution accounts.
|
| StandaloneCurrencyCodeList |
The following currency codes are supported by Plaid.
|
| StandaloneInvestmentTransactionType |
Valid values for investment transaction types and subtypes.
|
| Status |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| Statuses |
A collection of STATUS containers.
|
| Strategy.Adapter | |
| StudentLoan |
Contains details about a student loan account
|
| StudentLoanRepaymentModel |
Student loan repayment information used to configure Sandbox test data for the Liabilities product
|
| StudentLoanStatus |
An object representing the status of the student loan
|
| StudentLoanStatus.TypeEnum.Adapter | |
| StudentRepaymentPlan |
An object representing the repayment plan for the student loan
|
| StudentRepaymentPlan.TypeEnum.Adapter | |
| SyncUpdatesAvailableWebhook |
Fired when an Item's transactions change.
|
| Taxform |
Data about an official document used to report the user's income to the IRS.
|
| TaxpayerID |
Taxpayer ID of the individual receiving the paystub.
|
| TaxpayerIdentifier |
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.
|
| TaxpayerIdentifiers |
The collection of TAXPAYER_IDENTIFICATION elements
|
| TaxpayerIdentifierType.Adapter | |
| Total |
An object representing both the current pay period and year to date amount for a category.
|
| TotalCanonicalDescription.Adapter | |
| Transaction |
A representation of a transaction
|
| Transaction.PaymentChannelEnum.Adapter | |
| Transaction.TransactionTypeEnum.Adapter | |
| TransactionAllOf |
TransactionAllOf
|
| TransactionAllOf.PaymentChannelEnum.Adapter | |
| TransactionBase |
A representation of a transaction
|
| TransactionBase.TransactionTypeEnum.Adapter | |
| TransactionCode.Adapter | |
| TransactionCounterparty |
The counterparty, such as the merchant or financial institution, is extracted by Plaid from the raw description.
|
| TransactionData |
Information about the matched direct deposit transaction used to verify a user's payroll information.
|
| TransactionOverride |
Data to populate as test transaction data.
|
| TransactionsCategoryRule |
A representation of a transactions category rule.
|
| TransactionsEnhanceGetRequest |
TransactionsEnhanceGetRequest defines the request schema for `/transactions/enhance`.
|
| TransactionsEnhanceGetResponse |
TransactionsEnhanceGetResponse defines the response schema for `/beta/transactions/v1/enhance`.
|
| TransactionsEnrichGetRequest |
TransactionsEnrichGetRequest defines the request schema for `/transactions/enrich`.
|
| TransactionsEnrichGetResponse |
TransactionsEnrichGetResponse defines the response schema for `/transactions/enrich`.
|
| TransactionsEnrichRequestOptions |
An optional object to be used with the request.
|
| TransactionsGetRequest |
TransactionsGetRequest defines the request schema for `/transactions/get`
|
| TransactionsGetRequestOptions |
An optional object to be used with the request.
|
| TransactionsGetResponse |
TransactionsGetResponse defines the response schema for `/transactions/get`
|
| TransactionsRecurringGetRequest |
TransactionsRecurringGetRequest defines the request schema for `/transactions/recurring/get`
|
| TransactionsRecurringGetRequestOptions |
An optional object to be used with the request.
|
| TransactionsRecurringGetResponse |
TransactionsRecurringGetResponse defines the response schema for `/transactions/recurring/get`
|
| TransactionsRefreshRequest |
TransactionsRefreshRequest defines the request schema for `/transactions/refresh`
|
| TransactionsRefreshResponse |
TransactionsRefreshResponse defines the response schema for `/transactions/refresh`
|
| TransactionsRemovedWebhook |
Fired when transaction(s) for an Item are deleted.
|
| TransactionsRuleDetails |
A representation of transactions rule details.
|
| TransactionsRuleField.Adapter | |
| TransactionsRulesCreateRequest |
TransactionsRulesCreateRequest defines the request schema for `beta/transactions/rules/v1/create`
|
| TransactionsRulesCreateResponse |
TransactionsRulesCreateResponse defines the response schema for `/beta/transactions/rules/v1/create`
|
| TransactionsRulesListRequest |
TransactionsRulesListRequest defines the request schema for `/beta/transactions/rules/v1/list`
|
| TransactionsRulesListResponse |
TransactionsRulesListResponse defines the response schema for `/beta/transactions/rules/v1/list`
|
| TransactionsRulesRemoveRequest |
TransactionsRulesRemoveRequest defines the request schema for `/beta/transactions/rules/v1/remove`
|
| TransactionsRulesRemoveResponse |
TransactionsRulesRemoveResponse defines the response schema for `/beta/transactions/rules/v1/remove`
|
| TransactionsRuleType.Adapter | |
| TransactionsSyncRequest |
TransactionsSyncRequest defines the request schema for `/transactions/sync`
|
| TransactionsSyncRequestOptions |
An optional object to be used with the request.
|
| TransactionsSyncResponse |
TransactionsSyncResponse defines the response schema for `/transactions/sync`
|
| TransactionStream |
A grouping of related transactions
|
| TransactionStreamAmount |
Object with data pertaining to an amount on the transaction stream.
|
| TransactionStreamStatus.Adapter | |
| Transfer |
Represents a transfer within the Transfers API.
|
| TransferAuthorization |
Contains the authorization decision for a proposed transfer
|
| TransferAuthorizationCreateRequest |
Defines the request schema for `/transfer/authorization/create`
|
| TransferAuthorizationCreateResponse |
Defines the response schema for `/transfer/authorization/create`
|
| TransferAuthorizationDecision.Adapter | |
| TransferAuthorizationDecisionRationale |
The rationale for Plaid's decision regarding a proposed transfer.
|
| TransferAuthorizationDecisionRationaleCode.Adapter | |
| TransferAuthorizationDevice |
Information about the device being used to initiate the authorization.
|
| TransferAuthorizationGuaranteeDecision.Adapter | |
| TransferAuthorizationGuaranteeDecisionRationale |
The rationale for Plaid's decision to not guarantee a transfer.
|
| TransferAuthorizationGuaranteeDecisionRationaleCode.Adapter | |
| TransferAuthorizationProposedTransfer |
Details regarding the proposed transfer.
|
| TransferAuthorizationUserInRequest |
The legal name and other information for the account holder.
|
| TransferCancelRequest |
Defines the request schema for `/transfer/cancel`
|
| TransferCancelResponse |
Defines the response schema for `/transfer/cancel`
|
| TransferCapabilitiesGetRequest |
Defines the request schema for `/transfer/capabilities/get`
|
| TransferCapabilitiesGetResponse |
Defines the response schema for `/transfer/capabilities/get`
|
| TransferCapabilitiesGetRTP |
Contains the supported service types in RTP
|
| TransferCreateRequest |
Defines the request schema for `/transfer/create`
|
| TransferCreateResponse |
Defines the response schema for `/transfer/create`
|
| TransferDevice |
Information about the device being used to initiate the authorization.
|
| TransferDiligenceStatus.Adapter | |
| TransferEvent |
Represents an event in the Transfers API.
|
| TransferEventListRequest |
Defines the request schema for `/transfer/event/list`
|
| TransferEventListResponse |
Defines the response schema for `/transfer/event/list`
|
| TransferEventListTransferType.Adapter | |
| TransferEventsUpdateWebhook |
Fired when new transfer events are available.
|
| TransferEventSyncRequest |
Defines the request schema for `/transfer/event/sync`
|
| TransferEventSyncResponse |
Defines the response schema for `/transfer/event/sync`
|
| TransferEventType.Adapter | |
| TransferFailure |
The failure reason if the event type for a transfer is `\"failed\"` or `\"returned\"`.
|
| TransferGetRequest |
Defines the request schema for `/transfer/get`
|
| TransferGetResponse |
Defines the response schema for `/transfer/get`
|
| TransferIntentAuthorizationDecision.Adapter | |
| TransferIntentCreate |
Represents a transfer intent within Transfer UI.
|
| TransferIntentCreateMode.Adapter | |
| TransferIntentCreateRequest |
Defines the request schema for `/transfer/intent/create`
|
| TransferIntentCreateResponse |
Defines the response schema for `/transfer/intent/create`
|
| TransferIntentGet |
Represents a transfer intent within Transfer UI.
|
| TransferIntentGetFailureReason |
The reason for a failed transfer intent.
|
| TransferIntentGetRequest |
Defines the request schema for `/transfer/intent/get`
|
| TransferIntentGetResponse |
Defines the response schema for `/transfer/intent/get`
|
| TransferIntentStatus.Adapter | |
| TransferListRequest |
Defines the request schema for `/transfer/list`
|
| TransferListResponse |
Defines the response schema for `/transfer/list`
|
| TransferMigrateAccountRequest |
Defines the request schema for `/transfer/migrate_account`
|
| TransferMigrateAccountResponse |
Defines the response schema for `/transfer/migrate_account`
|
| TransferNetwork.Adapter | |
| TransferOriginatorCreateRequest |
Defines the request schema for `/transfer/originator/create`
|
| TransferOriginatorCreateResponse |
Defines the response schema for `/transfer/originator/create`
|
| TransferOriginatorGetRequest |
Defines the request schema for `/transfer/originator/get`
|
| TransferOriginatorGetResponse |
Defines the response schema for `/transfer/originator/get`
|
| TransferOriginatorListRequest |
Defines the request schema for `/transfer/originator/list`
|
| TransferOriginatorListResponse |
Defines the response schema for `/transfer/originator/list`
|
| TransferQuestionnaireCreateRequest |
Defines the request schema for `/transfer/questionnaire/create`
|
| TransferQuestionnaireCreateResponse |
Defines the response schema for `/transfer/questionnaire/create`
|
| TransferRecurringCancelRequest |
Defines the request schema for `/transfer/recurring/cancel`
|
| TransferRecurringCancelResponse |
Defines the response schema for `/transfer/recurring/cancel`
|
| TransferRecurringCreateRequest |
Defines the request schema for `/transfer/recurring/create`
|
| TransferRecurringCreateResponse |
Defines the response schema for `/transfer/recurring/create`
|
| TransferRecurringGetRequest |
Defines the request schema for `/transfer/recurring/get`
|
| TransferRecurringGetResponse |
Defines the response schema for `/transfer/recurring/get`
|
| TransferRecurringListRequest |
Defines the request schema for `/transfer/recurring/list`
|
| TransferRecurringListResponse |
Defines the response schema for `/transfer/recurring/list`
|
| TransferRecurringSchedule |
The schedule that the recurring transfer will be executed on.
|
| TransferRecurringStatus.Adapter | |
| TransferRefund |
Represents a refund within the Transfers API.
|
| TransferRefundCancelRequest |
Defines the request schema for `/transfer/refund/cancel`
|
| TransferRefundCancelResponse |
Defines the response schema for `/transfer/refund/cancel`
|
| TransferRefundCreateRequest |
Defines the request schema for `/transfer/refund/create`
|
| TransferRefundCreateResponse |
Defines the response schema for `/transfer/refund/create`
|
| TransferRefundGetRequest |
Defines the request schema for `/transfer/refund/get`
|
| TransferRefundGetResponse |
Defines the response schema for `/transfer/refund/get`
|
| TransferRefundStatus.Adapter | |
| TransferRepayment |
A repayment is created automatically after one or more guaranteed transactions receive a return.
|
| TransferRepaymentListRequest |
Defines the request schema for `/transfer/repayment/list`
|
| TransferRepaymentListResponse |
Defines the response schema for `/transfer/repayments/list`
|
| TransferRepaymentReturn |
Represents a return on a Guaranteed ACH transfer that is included in the specified repayment.
|
| TransferRepaymentReturnListRequest |
Defines the request schema for `/transfer/repayment/return/list`
|
| TransferRepaymentReturnListResponse |
Defines the response schema for `/transfer/repayments/return/list`
|
| TransferScheduleIntervalUnit.Adapter | |
| TransferStatus.Adapter | |
| TransferSweep |
Describes a sweep of funds to / from the sweep account.
|
| TransferSweepGetRequest |
Defines the request schema for `/transfer/sweep/get`
|
| TransferSweepGetResponse |
Defines the response schema for `/transfer/sweep/get`
|
| TransferSweepListRequest |
Defines the request schema for `/transfer/sweep/list`
|
| TransferSweepListResponse |
Defines the response schema for `/transfer/sweep/list`
|
| TransferSweepStatus.Adapter | |
| TransferTestClock |
Defines the test clock for a transfer.
|
| TransferType.Adapter | |
| TransferUserAddressInRequest |
The address associated with the account holder.
|
| TransferUserAddressInResponse |
The address associated with the account holder.
|
| TransferUserInRequest |
The legal name and other information for the account holder.
|
| TransferUserInRequestDeprecated |
The legal name and other information for the account holder.
|
| TransferUserInResponse |
The legal name and other information for the account holder.
|
| UpdateEntityScreeningRequestSearchTerms |
Search terms for editing an entity watchlist screening
|
| UpdateIndividualScreeningRequestSearchTerms |
Search terms for editing an individual watchlist screening
|
| UserAddress |
Home address for the user.
|
| UserCreateRequest |
UserCreateRequest defines the request schema for `/user/create`
|
| UserCreateResponse |
UserCreateResponse defines the response schema for `/user/create`
|
| UserCustomPassword |
Custom test accounts are configured with a JSON configuration object formulated according to the schema below.
|
| UserIDNumber |
ID number submitted by the user, currently used only for the Identity Verification product.
|
| UserName |
The full name provided by the user.
|
| UserPermissionRevokedWebhook |
The `USER_PERMISSION_REVOKED` webhook is fired when an end user has used either the [my.plaid.com portal](https://my.plaid.com) or the financial institution’s consent portal to revoke the permission that they previously granted to access an Item.
|
| UserStatedIncomeSourceCategory.Adapter | |
| UserStatedIncomeSourceFrequency.Adapter | |
| UserStatedIncomeSourcePayType.Adapter | |
| ValidationSource |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| ValidationSources |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| VerificationExpiredWebhook |
Fired when an Item was not verified via automated micro-deposits after seven days since the automated micro-deposit was made.
|
| VerificationOfAsset |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| VerificationOfAssetResponse |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| VerificationRefreshStatus.Adapter | |
| VerificationStatus.Adapter | |
| W2 |
W2 is an object that represents income data taken from a W2 tax document.
|
| W2Box12 |
Data on the W2 Box 12
|
| W2StateAndLocalWages |
W2 state and local wages
|
| Wallet |
An object representing the e-wallet
|
| WalletBalance |
An object representing the e-wallet balance
|
| WalletCreateRequest |
WalletCreateRequest defines the request schema for `/wallet/create`
|
| WalletCreateResponse |
WalletCreateResponse defines the response schema for `/wallet/create`
|
| WalletGetRequest |
WalletGetRequest defines the request schema for `/wallet/get`
|
| WalletGetResponse |
WalletGetResponse defines the response schema for `/wallet/get`
|
| WalletISOCurrencyCode.Adapter | |
| WalletListRequest |
WalletListRequest defines the request schema for `/wallet/list`
|
| WalletListResponse |
WalletListResponse defines the response schema for `/wallet/list`
|
| WalletNumbers |
An object representing the e-wallet account numbers
|
| WalletTransaction |
The transaction details
|
| WalletTransaction.TypeEnum.Adapter | |
| WalletTransactionAmount |
The amount and currency of a transaction
|
| WalletTransactionCounterparty |
An object representing the e-wallet transaction's counterparty
|
| WalletTransactionCounterpartyBACS |
The account number and sort code of the counterparty's account
|
| WalletTransactionCounterpartyInternational |
International Bank Account Number for a Wallet Transaction
|
| WalletTransactionCounterpartyNumbers |
The counterparty's bank account numbers.
|
| WalletTransactionExecuteRequest |
WalletTransactionExecuteRequest defines the request schema for `/wallet/transaction/execute`
|
| WalletTransactionExecuteResponse |
WalletTransactionExecuteResponse defines the response schema for `/wallet/transaction/execute`
|
| WalletTransactionGetRequest |
WalletTransactionGetRequest defines the request schema for `/wallet/transaction/get`
|
| WalletTransactionGetResponse |
WalletTransactionGetResponse defines the response schema for `/wallet/transaction/get`
|
| WalletTransactionGetResponse.TypeEnum.Adapter | |
| WalletTransactionListRequest |
WalletTransactionListRequest defines the request schema for `/wallet/transaction/list`
|
| WalletTransactionListRequestOptions |
Additional wallet transaction options
|
| WalletTransactionListResponse |
WalletTransactionListResponse defines the response schema for `/wallet/transaction/list`
|
| WalletTransactionsListRequest |
WalletTransactionListRequest defines the request schema for `/wallet/transaction/list`
|
| WalletTransactionStatus.Adapter | |
| WalletTransactionStatusUpdateWebhook |
Fired when the status of a wallet transaction has changed.
|
| Warning |
It is possible for an Asset Report to be returned with missing account owner information.
|
| Warning.WarningCodeEnum.Adapter | |
| WatchlistScreeningAuditTrail |
Information about the last change made to the parent object specifying what caused the change as well as when it occurred.
|
| WatchlistScreeningDocument |
An official document, usually issued by a governing body or institution, with an associated identifier.
|
| WatchlistScreeningDocumentType.Adapter | |
| WatchlistScreeningEntityCreateRequest |
Request input for creating an entity screening review
|
| WatchlistScreeningEntityCreateResponse |
The entity screening object allows you to represent an entity in your system, update its profile, and search for it on various watchlists.
|
| WatchlistScreeningEntityGetRequest |
Request input for fetching an entity watchlist screening
|
| WatchlistScreeningEntityGetResponse |
The entity screening object allows you to represent an entity in your system, update its profile, and search for it on various watchlists.
|
| WatchlistScreeningEntityHistoryListRequest |
Request input for listing changes to entity watchlist screenings
|
| WatchlistScreeningEntityHistoryListResponse |
Paginated list of entity watchlist screenings
|
| WatchlistScreeningEntityHitListRequest |
Request input for listing hits for an entity watchlist screening
|
| WatchlistScreeningEntityHitListResponse |
Paginated list of entity watchlist screening hits
|
| WatchlistScreeningEntityListRequest |
Request input for listing entity watchlist screenings
|
| WatchlistScreeningEntityListResponse |
Paginated list of entity watchlist screenings
|
| WatchlistScreeningEntityProgramGetRequest |
Request input for fetching an entity watchlist program
|
| WatchlistScreeningEntityProgramGetResponse |
A program that configures the active lists, search parameters, and other behavior for initial and ongoing screening of entities.
|
| WatchlistScreeningEntityProgramListRequest |
Request input for listing entity watchlist screening programs
|
| WatchlistScreeningEntityProgramListResponse |
Paginated list of entity watchlist screening programs
|
| WatchlistScreeningEntityReviewCreateRequest |
Request input for creating a review for an entity screening
|
| WatchlistScreeningEntityReviewCreateResponse |
A review submitted by a team member for an entity watchlist screening.
|
| WatchlistScreeningEntityReviewListRequest |
Request input for listing reviews for an entity watchlist screening
|
| WatchlistScreeningEntityReviewListResponse |
Paginated list of entity watchlist screening reviews
|
| WatchlistScreeningEntityUpdateRequest |
Request input for editing an entity watchlist screening
|
| WatchlistScreeningEntityUpdateRequestResettableField.Adapter | |
| WatchlistScreeningEntityUpdateResponse |
The entity screening object allows you to represent an entity in your system, update its profile, and search for it on various watchlists.
|
| WatchlistScreeningHit |
Data from a government watchlist or PEP list that has been attached to the screening.
|
| WatchlistScreeningHitLocations |
Location information for the associated individual watchlist hit
|
| WatchlistScreeningHitStatus.Adapter | |
| WatchlistScreeningIndividual |
The screening object allows you to represent a customer in your system, update their profile, and search for them on various watchlists.
|
| WatchlistScreeningIndividualCreateRequest |
Request input for creating an individual watchlist screening
|
| WatchlistScreeningIndividualCreateResponse |
The screening object allows you to represent a customer in your system, update their profile, and search for them on various watchlists.
|
| WatchlistScreeningIndividualGetRequest |
Request input for fetching an individual watchlist screening
|
| WatchlistScreeningIndividualGetResponse |
The screening object allows you to represent a customer in your system, update their profile, and search for them on various watchlists.
|
| WatchlistScreeningIndividualHistoryListRequest |
Request input for listing changes to watchlist screenings for individuals
|
| WatchlistScreeningIndividualHistoryListResponse |
Paginated list of individual watchlist screenings.
|
| WatchlistScreeningIndividualHitListRequest |
Request input for listing hits for an individual watchlist screening
|
| WatchlistScreeningIndividualHitListResponse |
Paginated list of individual watchlist screening hits
|
| WatchlistScreeningIndividualListRequest |
Request input for listinging watchlist screenings for individuals
|
| WatchlistScreeningIndividualListResponse |
Paginated list of individual watchlist screenings.
|
| WatchlistScreeningIndividualProgramGetRequest |
Request input for fetching an individual watchlist program
|
| WatchlistScreeningIndividualProgramGetResponse |
A program that configures the active lists, search parameters, and other behavior for initial and ongoing screening of individuals.
|
| WatchlistScreeningIndividualProgramListRequest |
Request input for listing watchlist screening programs for individuals
|
| WatchlistScreeningIndividualProgramListResponse |
Paginated list of individual watchlist screening programs
|
| WatchlistScreeningIndividualReviewCreateRequest |
Request input for creating a screening review
|
| WatchlistScreeningIndividualReviewCreateResponse |
A review submitted by a team member for an individual watchlist screening.
|
| WatchlistScreeningIndividualReviewListRequest |
Request input for listing reviews for an individual watchlist screening
|
| WatchlistScreeningIndividualReviewListResponse |
Paginated list of screening reviews
|
| WatchlistScreeningIndividualUpdateRequest |
Request input for editing an individual watchlist screening
|
| WatchlistScreeningIndividualUpdateRequestResettableField.Adapter | |
| WatchlistScreeningIndividualUpdateResponse |
The screening object allows you to represent a customer in your system, update their profile, and search for them on various watchlists.
|
| WatchlistScreeningRequestSearchTerms |
Search inputs for creating a watchlist screening
|
| WatchlistScreeningReview |
A review submitted by a team member for an individual watchlist screening.
|
| WatchlistScreeningSearchTerms |
Search terms for creating an individual watchlist screening
|
| WatchlistScreeningStatus.Adapter | |
| WeakAliasDetermination.Adapter | |
| WebhookEnvironmentValues.Adapter | |
| WebhookType.Adapter | |
| WebhookUpdateAcknowledgedWebhook |
Fired when an Item's webhook is updated.
|
| WebhookVerificationKeyGetRequest |
WebhookVerificationKeyGetRequest defines the request schema for `/webhook_verification_key/get`
|
| WebhookVerificationKeyGetResponse |
WebhookVerificationKeyGetResponse defines the response schema for `/webhook_verification_key/get`
|
| YTDGrossIncomeSummaryFieldNumber |
Year-to-date pre-tax earnings, as reported on the paystub.
|
| YTDNetIncomeSummaryFieldNumber |
Year-to-date earnings after any tax withholdings, benefit payments or deductions, as reported on the paystub.
|
| Enum | Description |
|---|---|
| AccountAssets.VerificationStatusEnum |
The current verification status of an Auth Item initiated through Automated or Manual micro-deposits.
|
| AccountBase.VerificationStatusEnum |
The current verification status of an Auth Item initiated through Automated or Manual micro-deposits.
|
| AccountIdentity.VerificationStatusEnum |
The current verification status of an Auth Item initiated through Automated or Manual micro-deposits.
|
| AccountIdentityMatchScore.VerificationStatusEnum |
The current verification status of an Auth Item initiated through Automated or Manual micro-deposits.
|
| AccountSelectionCardinality |
The application requires that accounts be limited to a specific cardinality.
|
| AccountSubtype |
See the [Account type schema](https://plaid.com/docs/api/accounts/#account-type-schema) for a full listing of account types and corresponding subtypes.
|
| AccountType |
`investment:` Investment account.
|
| ACHClass |
Specifies the use case of the transfer.
|
| ActionState |
Enum representing the state of the action/activity.
|
| ActivityType |
Types of consent activities
|
| AddressPurposeLabel |
Field describing whether the associated address is being used for commercial or residential purposes.
|
| APR.AprTypeEnum |
The type of balance to which the APR applies.
|
| AssetReportTransaction.TransactionTypeEnum |
Please use the `payment_channel` field, `transaction_type` will be deprecated in the future.
|
| AssetTransactionCategoryType |
Asset Transaction Category Type Enumerated derived by Vendor.
|
| AssetTransactionType |
Asset Transaction Type.
|
| AssetType |
A value from a MISMO prescribed list that specifies financial assets in a mortgage loan transaction.
|
| BankTransferDirection |
Indicates the direction of the transfer: `outbound` for API-initiated transfers, or `inbound` for payments received by the FBO account.
|
| BankTransferEventListBankTransferType |
The type of bank transfer.
|
| BankTransferEventListDirection |
Indicates the direction of the transfer: `outbound`: for API-initiated transfers `inbound`: for payments received by the FBO account.
|
| BankTransferEventType |
The type of event that this bank transfer represents.
|
| BankTransferNetwork |
The network or rails used for the transfer.
|
| BankTransferStatus |
The status of the transfer.
|
| BankTransferType |
The type of bank transfer.
|
| CounterpartyType |
The counterparty type.
|
| CountryCode |
ISO-3166-1 alpha-2 country code standard.
|
| CreditAccountSubtype |
Valid account subtypes for credit accounts.
|
| CreditBankIncomeAccountType |
The account type.
|
| CreditBankIncomeCategory |
The income category.
|
| CreditBankIncomeErrorType |
A broad categorization of the error.
|
| CreditBankIncomePayFrequency |
The income pay frequency.
|
| CreditBankIncomeWarningCode |
The warning code identifies a specific kind of warning.
|
| CreditBankIncomeWarningType |
The warning type which will always be `BANK_INCOME_WARNING`.
|
| CreditPayStubPayBasisType |
The explicit pay basis on the paystub (if present).
|
| CreditSessionBankIncomeStatus |
The terminal status of the bank income verification.
|
| DashboardUserStatus |
The current status of the user.
|
| DepositoryAccountSubtype |
Valid account subtypes for depository accounts.
|
| DepositSwitchAltCreateRequest.CountryCodeEnum |
ISO-3166-1 alpha-2 country code standard.
|
| DepositSwitchCreateRequest.CountryCodeEnum |
ISO-3166-1 alpha-2 country code standard.
|
| DepositSwitchGetResponse.StateEnum |
The state, or status, of the deposit switch.
|
| DepositSwitchGetResponse.SwitchMethodEnum |
The method used to make the deposit switch.
|
| DepositSwitchTargetAccount.AccountSubtypeEnum |
The account subtype of the account, either `checking` or `savings`.
|
| DocType |
The type of document.
|
| DocumentAuthenticityMatchCode |
High level summary of whether the document in the provided image matches the formatting rules and security checks for the associated jurisdiction.
|
| DocumentDateOfBirthMatchCode |
A match summary describing the cross comparison between the subject's date of birth, extracted from the document image, and the date of birth they separately provided to the identity verification attempt.
|
| DocumentNameMatchCode |
A match summary describing the cross comparison between the subject's name, extracted from the document image, and the name they separately provided to identity verification attempt.
|
| DocumentStatus |
An outcome status for this specific document submission.
|
| EarningsBreakdownCanonicalDescription |
Commonly used term to describe the earning line item.
|
| Email.TypeEnum |
The type of email account as described by the financial institution.
|
| EmploymentVerificationStatus |
Current employment status.
|
| EnrichTransactionDirection |
The direction of the transaction from the perspective of the account holder: `OUTFLOW` - Includes outgoing transfers, purchases, and fees.
|
| EntityDocumentType |
The kind of official document represented by this object.
|
| EntityWatchlistCode |
Shorthand identifier for a specific screening list for entities.
|
| ExpirationDate |
A description of whether the associated document was expired when the verification was performed.
|
| FDXContentTypes |
Types of document formats.
|
| FDXHateoasLinkAction |
HTTP Method to use for the request
|
| FDXNotificationCategory |
Category of Notification
|
| FDXNotificationPayloadIdType |
Type of entity causing origination of a notification
|
| FDXNotificationPriority |
Priority of notification
|
| FDXNotificationSeverity |
Severity level of notification
|
| FDXNotificationType |
Type of Notification
|
| FDXPartyRegistry |
The registry containing the party’s registration with name and id
|
| FDXPartyType |
Identifies the type of a party
|
| Form1099Type |
Form 1099 Type
|
| FreddieReportType |
When set to VERIFICATION_OF_EMPLOYMENT and the Asset Report is added to an Audit Copy Token, the Asset Report will be retrieved by Freddie Mac in the Verification Of Employment (VOE) version instead of the default Verification Of Assets (VOA) version.
|
| IdentityUpdateTypes |
The possible types of identity data that may have changed.
|
| IdentityVerificationStatus |
The status of this Identity Verification attempt.
|
| IdentityVerificationStepStatus |
The status of a step in the identity verification process.
|
| IDNumberType |
A globally unique and human readable ID type, specific to the country and document category.
|
| ImageQuality |
A high level description of the quality of the image the user submitted.
|
| IncidentUpdate.StatusEnum |
The status of the incident.
|
| IncomeBreakdownType |
The type of income.
|
| IncomeVerificationPayrollFlowType |
Flow types to retrieve payroll income data
|
| IncomeVerificationPrecheckConfidence |
The confidence that Plaid can support the user in the digital income verification flow instead of requiring a manual paystub upload.
|
| IncomeVerificationSourceType |
The types of source income data that users should be able to share
|
| IndividualWatchlistCode |
Shorthand identifier for a specific screening list for individuals.
|
| InvestmentAccountSubtype |
Valid account subtypes for investment accounts.
|
| InvestmentTransactionSubtype |
For descriptions of possible transaction types and subtypes, see the [Investment transaction types schema](https://plaid.com/docs/api/accounts/#investment-transaction-types-schema).
|
| InvestmentTransactionType |
Value is one of the following: `buy`: Buying an investment `sell`: Selling an investment `cancel`: A cancellation of a pending transaction `cash`: Activity that modifies a cash position `fee`: A fee on the account `transfer`: Activity which modifies a position, but not through buy/sell activity e.g.
|
| IssuingCountry |
A binary match indicator specifying whether the country that issued the provided document matches the country that the user separately provided to Plaid.
|
| Item.UpdateTypeEnum |
Indicates whether an Item requires user interaction to be updated, which can be the case for Items with some forms of two-factor authentication.
|
| LinkDeliveryDeliveryMethod |
The delivery method to be used to deliver the Link Delivery URL.
|
| LinkDeliverySessionStatus |
The status of the given Link Delivery Session.
|
| LinkTokenCreateRequestAuth.FlowTypeEnum |
This field has been deprecated in favor of `auth_type_select_enabled`.
|
| LoanAccountSubtype |
Valid account subtypes for loan accounts.
|
| LoanIdentifierType |
A value from a MISMO prescribed list that specifies the type of loan identifier.
|
| MatchSummaryCode |
An enum indicating the match type between data provided by user and data checked against an external data source.
|
| OverrideAccountType |
`investment:` Investment account.
|
| OwnershipType |
How an asset is owned.
|
| PartnerEndCustomerFlowdownStatus |
The status of the addendum to the Plaid MSA (\"flowdown\") for the end customer.
|
| PartnerEndCustomerOAuthInstitutionApplicationStatus |
The registration status for the end customer's application.
|
| PartnerEndCustomerQuestionnaireStatus |
The status of the end customer's security questionnaire.
|
| PartnerEndCustomerStatus |
The status of the given end customer.
|
| PartyRoleType |
A value from a MISMO defined list that identifies the role that the party plays in the transaction.
|
| PayFrequencyValue |
The frequency of the pay period.
|
| PaymentAmountCurrency |
The ISO-4217 currency code of the payment.
|
| PaymentChannel |
The channel used to make a payment.
|
| PaymentConsentPeriodicAlignment |
Where the payment consent period should start.
|
| PaymentConsentPeriodicInterval |
Payment consent periodic interval.
|
| PaymentInitiationConsentScope |
Payment consent scope.
|
| PaymentInitiationConsentStatus |
The status of the payment consent.
|
| PaymentInitiationPaymentCreateStatus |
For a payment returned by this endpoint, there is only one possible value: `PAYMENT_STATUS_INPUT_NEEDED`: The initial phase of the payment
|
| PaymentInitiationPaymentStatus |
The status of the payment.
|
| PaymentProfileStatus |
The status of the given Payment Profile.
|
| PaymentScheduleInterval |
The frequency interval of the payment.
|
| PaymentScheme |
Payment scheme.
|
| PayPeriodDetails.PayFrequencyEnum |
The frequency at which an individual is paid.
|
| PaystubPayFrequency |
The frequency at which the employee is paid.
|
| PhoneNumber.TypeEnum |
The type of phone number.
|
| PhoneType |
An enum indicating whether a phone number is a phone line or a fax line.
|
| PhysicalDocumentCategory |
The type of identity document detected in the images provided.
|
| PlaidErrorType |
A broad categorization of the error.
|
| POBoxStatus |
Field describing whether the associated address is a post office box.
|
| ProcessorTokenCreateRequest.ProcessorEnum |
The processor you are integrating with.
|
| Products |
A list of products that an institution can support.
|
| ProductStatus.StatusEnum |
This field is deprecated in favor of the `breakdown` object, which provides more granular institution health data.
|
| ProductStatusBreakdown.RefreshIntervalEnum |
The `refresh_interval` may be `DELAYED` or `STOPPED` even when the success rate is high.
|
| ProgramNameSensitivity |
The valid name matching sensitivity configurations for a screening program.
|
| RecurringTransactionFrequency |
Describes the frequency of the transaction stream.
|
| ReportType |
The report type.
|
| SandboxIncomeFireWebhookRequest.VerificationStatusEnum |
`VERIFICATION_STATUS_PROCESSING_COMPLETE`: The income verification status processing has completed.
|
| SandboxItemFireWebhookRequest.WebhookCodeEnum |
The webhook codes that can be fired by this test endpoint.
|
| SandboxItemSetVerificationStatusRequest.VerificationStatusEnum |
The verification status to set the account to.
|
| ScopesContext |
An indicator for when scopes are being updated.
|
| ServiceProductFulfillmentIdentifier |
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
|
| SignalDecisionOutcome |
The payment decision from the risk assessment.
|
| SignalPaymentMethod |
The payment method to complete the transaction after the risk assessment.
|
| Source |
A type indicating whether a dashboard user, an API-based user, or Plaid last touched this object.
|
| Strategy |
An instruction specifying what steps the new Identity Verification attempt should require the user to complete: `reset` - Restart the user at the beginning of the session, regardless of whether they successfully completed part of their previous session.
|
| StudentLoanStatus.TypeEnum |
The status type of the student loan
|
| StudentRepaymentPlan.TypeEnum |
The type of the repayment plan.
|
| TaxpayerIdentifierType |
A value from a MISMO prescribed list that classifies identification numbers used by the Internal Revenue Service (IRS) in the administration of tax laws.
|
| TotalCanonicalDescription |
Commonly used term to describe the line item.
|
| Transaction.PaymentChannelEnum |
The channel used to make a payment.
|
| Transaction.TransactionTypeEnum |
Please use the `payment_channel` field, `transaction_type` will be deprecated in the future.
|
| TransactionAllOf.PaymentChannelEnum |
The channel used to make a payment.
|
| TransactionBase.TransactionTypeEnum |
Please use the `payment_channel` field, `transaction_type` will be deprecated in the future.
|
| TransactionCode |
An identifier classifying the transaction type.
|
| TransactionsRuleField |
Transaction field for which the rule is defined.
|
| TransactionsRuleType |
Transaction rule's match type.
|
| TransactionStreamStatus |
The current status of the transaction stream.
|
| TransferAuthorizationDecision |
A decision regarding the proposed transfer.
|
| TransferAuthorizationDecisionRationaleCode |
A code representing the rationale for approving or declining the proposed transfer.
|
| TransferAuthorizationGuaranteeDecision |
Indicates whether the transfer is guaranteed by Plaid (Guarantee customers only).
|
| TransferAuthorizationGuaranteeDecisionRationaleCode |
A code representing the reason Plaid declined to guarantee this transfer: `RETURN_BANK`: The risk of a bank-initiated return (for example, an R01/NSF) is too high to guarantee this transfer.
|
| TransferDiligenceStatus |
Originator’s diligence status.
|
| TransferEventListTransferType |
The type of transfer.
|
| TransferEventType |
The type of event that this transfer represents.
|
| TransferIntentAuthorizationDecision |
A decision regarding the proposed transfer.
|
| TransferIntentCreateMode |
The direction of the flow of transfer funds.
|
| TransferIntentStatus |
The status of the transfer intent.
|
| TransferNetwork |
The network or rails used for the transfer.
|
| TransferRecurringStatus |
The status of the recurring transfer.
|
| TransferRefundStatus |
The status of the refund.
|
| TransferScheduleIntervalUnit |
The unit of the recurring interval.
|
| TransferStatus |
The status of the transfer.
|
| TransferSweepStatus |
The status of the sweep for the transfer.
|
| TransferType |
The type of transfer.
|
| UserStatedIncomeSourceCategory |
The income category for a specified income source
|
| UserStatedIncomeSourceFrequency |
The pay frequency of a specified income source
|
| UserStatedIncomeSourcePayType |
The pay type - `GROSS`, `NET`, or `UNKNOWN` for a specified income source
|
| VerificationRefreshStatus |
The verification refresh status.
|
| VerificationStatus |
The verification status.
|
| WalletISOCurrencyCode |
An ISO-4217 currency code, used with e-wallets and transactions.
|
| WalletTransaction.TypeEnum |
The type of the transaction.
|
| WalletTransactionGetResponse.TypeEnum |
The type of the transaction.
|
| WalletTransactionStatus |
The status of the transaction.
|
| Warning.WarningCodeEnum |
The warning code identifies a specific kind of warning.
|
| WatchlistScreeningDocumentType |
The kind of official document represented by this object.
|
| WatchlistScreeningEntityUpdateRequestResettableField |
The name of a field that can be reset back to null
|
| WatchlistScreeningHitStatus |
The current state of review.
|
| WatchlistScreeningIndividualUpdateRequestResettableField |
The name of a field that can be reset back to null
|
| WatchlistScreeningStatus |
A status enum indicating whether a screening is still pending review, has been rejected, or has been cleared.
|
| WeakAliasDetermination |
Names that are explicitly marked as low quality either by their `source` list, or by `plaid` by a series of additional checks done by Plaid.
|
| WebhookEnvironmentValues |
The Plaid environment the webhook was sent from
|
| WebhookType |
The webhook types that can be fired by this test endpoint.
|
Copyright © 2017–2023 Plaid Inc.. All rights reserved.