Plaid Plaid API
The Plaid API from Plaid — 256 operation(s) for plaid.
Plaid Plaid API is published by Plaid on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Plaid. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 265 operations across 265 paths, and defines 1517 schemas. It is described by OpenAPI 3.2.0, at version 2020-09-14_1.517.0.
Requests are made against 3 base URLs: https://production.plaid.com, https://development.plaid.com, https://sandbox.plaid.com.
265 operations
265 paths
1517 schemas
265 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Plaid Plaid API declares
3 security schemes
for authenticating requests.
An API key is passed in the header as PLAID-CLIENT-ID (clientId).
An API key is passed in the header as PLAID-SECRET (secret).
An API key is passed in the header as Plaid-Version (plaidVersion).
By default, every request must be authenticated.
Paths & Operations 265
Across 265 paths, the API surfaces 265 operations — 265 POST. Each is listed below with its method, path, parameters, and response codes.
Plaid 265
POST
/accounts/get
Plaid Retrieve accounts
POST
/accounts/balance/get
Plaid Retrieve real-time balance data
POST
/item/application/list
Plaid List a user’s connected applications
POST
/item/application/unlink
Plaid Unlink a user’s connected application
POST
/item/application/scopes/update
Plaid Update the scopes of access for a particular application
POST
/application/get
Retrieve information about a Plaid application
POST
/asset_report/create
Plaid Create an Asset Report
POST
/asset_report/get
Plaid Retrieve an Asset Report
POST
/asset_report/pdf/get
Plaid Retrieve a PDF Asset Report
POST
/asset_report/refresh
Plaid Refresh an Asset Report
POST
/asset_report/filter
Plaid Filter Asset Report
POST
/asset_report/remove
Plaid Delete an Asset Report
POST
/asset_report/audit_copy/create
Plaid Create Asset Report Audit Copy
POST
/asset_report/audit_copy/get
Plaid Retrieve an Asset Report Audit Copy
POST
/asset_report/audit_copy/remove
Plaid Remove Asset Report Audit Copy
POST
/credit/asset_report/freddie_mac/get
Plaid Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint.
POST
/auth/get
Plaid Retrieve auth data
POST
/processor/auth/get
Plaid Retrieve Auth data
POST
/investments/auth/get
Plaid Get data needed to authorize an investments transfer
POST
/processor/bank_transfer/create
Plaid Create a bank transfer as a processor
POST
/bank_transfer/get
Plaid Retrieve a bank transfer
POST
/bank_transfer/create
Plaid Create a bank transfer
POST
/bank_transfer/list
Plaid List bank transfers
POST
/bank_transfer/cancel
Plaid Cancel a bank transfer
POST
/bank_transfer/event/list
Plaid List bank transfer events
POST
/bank_transfer/event/sync
Plaid Sync bank transfer events
POST
/bank_transfer/sweep/get
Plaid Retrieve a sweep
POST
/bank_transfer/sweep/list
Plaid List sweeps
POST
/bank_transfer/balance/get
Plaid Get balance of your Bank Transfer account
POST
/bank_transfer/migrate_account
Plaid Migrate account into Bank Transfers
POST
/sandbox/bank_transfer/simulate
Plaid Simulate a bank transfer event in Sandbox
POST
/sandbox/bank_transfer/fire_webhook
Plaid Manually fire a Bank Transfer webhook
POST
/beacon/account_risk/v1/evaluate
Plaid Evaluate risk of a bank account
POST
/beacon/user/create
Plaid Create a Beacon User
POST
/beacon/user/get
Plaid Get a Beacon User
POST
/beacon/user/review
Plaid Review a Beacon User
POST
/beacon/report/create
Plaid Create a Beacon Report
POST
/beacon/report/list
Plaid List Beacon Reports for a Beacon User
POST
/beacon/report_syndication/list
Plaid List Beacon Report Syndications for a Beacon User
POST
/beacon/report/get
Plaid Get a Beacon Report
POST
/beacon/report_syndication/get
Plaid Get a Beacon Report Syndication
POST
/beacon/user/update
Plaid Update the identity data of a Beacon User
POST
/beacon/duplicate/get
Plaid Get a Beacon Duplicate
POST
/beacon/user/history/list
Plaid List a Beacon User's history
POST
/beta/credit/v1/bank_employment/get
Plaid Retrieve information from the bank accounts used for employment verification
POST
/beta/transactions/v1/enhance
Plaid enhance locally-held transaction data
POST
/beta/transactions/rules/v1/create
Plaid Create transaction category rule
POST
/beta/transactions/rules/v1/list
Plaid Return a list of rules created for the Item associated with the access token.
POST
/beta/transactions/rules/v1/remove
Plaid Remove transaction rule
POST
/beta/transactions/user_insights/v1/get
Plaid Obtain user insights based on transactions sent through /transactions/enrich
POST
/categories/get
Plaid Get categories
POST
/cra/base_report/get
Plaid Retrieve a Base Report
POST
/cra/base_report/create
Plaid Create a Base Report
POST
/cra/bank_income/get
Plaid Retrieve information from the bank accounts used for income verification
POST
/cra/bank_income/create
Plaid Create a CRA report for income verification
POST
/cra/partner_insights/get
Plaid Retrieve cash flow insights from the bank accounts used for income verification
POST
/cra/loans/applications/register
Plaid Register loan applications and decisions.
POST
/cra/loans/register
Plaid Register a list of loans to their applicants.
POST
/cra/loans/update
Plaid Updates loan data.
POST
/cra/loans/unregister
Plaid Unregister a list of loans.
POST
/credit/audit_copy_token/update
Plaid Update an Audit Copy Token
POST
/credit/sessions/get
Plaid Retrieve Link sessions for your user
POST
/credit/audit_copy_token/create
Plaid Create Asset or Income Report Audit Copy Token
POST
/credit/audit_copy_token/remove
Plaid Remove an Audit Copy token
POST
/credit/freddie_mac/reports/get
Plaid Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available. Only Freddie Mac can use this endpoi…
POST
/credit/bank_income/get
Plaid Retrieve information from the bank accounts used for income verification
POST
/credit/bank_income/pdf/get
Plaid Retrieve information from the bank accounts used for income verification in PDF format
POST
/credit/bank_income/refresh
Plaid Refresh a user's bank income information
POST
/credit/bank_income/webhook/update
Plaid Subscribe and unsubscribe to proactive notifications for a user's income profile
POST
/credit/payroll_income/parsing_config/update
Plaid Update the parsing configuration for a document income verification
POST
/credit/bank_statements/uploads/get
Plaid Retrieve data for a user's uploaded bank statements
POST
/credit/payroll_income/get
Plaid Retrieve a user's payroll information
POST
/credit/payroll_income/risk_signals/get
Plaid Retrieve fraud insights for a user's manually uploaded document(s).
POST
/credit/payroll_income/precheckdeprecated
Plaid Check income verification eligibility and optimize conversion
POST
/credit/employment/get
Plaid Retrieve a summary of an individual's employment information
POST
/credit/payroll_income/refresh
Plaid Refresh a digital payroll income verification
POST
/credit/relay/create
Plaid Create a relay token to share an Asset Report with a partner client
POST
/credit/relay/get
Plaid Retrieve the reports associated with a relay token that was shared with you
POST
/credit/relay/pdf/get
Plaid Retrieve the pdf reports associated with a relay token that was shared with you (beta)
POST
/credit/relay/refresh
Plaid Refresh a report of a relay token
POST
/credit/relay/remove
Plaid Remove relay token
POST
/dashboard_user/get
Plaid Retrieve a dashboard user
POST
/dashboard_user/list
Plaid List dashboard users
POST
/deposit_switch/create
Plaid Create a deposit switch
POST
/deposit_switch/token/create
Plaid Create a deposit switch token
POST
/deposit_switch/get
Plaid Retrieve a deposit switch
POST
/deposit_switch/alt/create
Create a deposit switch without using Plaid Exchange
POST
/employers/search
Plaid Search employer database
POST
/fdx/notifications
Plaid Webhook receiver for fdx notifications
POST
/identity/get
Plaid Retrieve identity data
POST
/identity/documents/uploads/get
Plaid Returns uploaded document identity
POST
/identity/match
Plaid Retrieve identity match score
POST
/identity/refresh
Plaid Refresh identity data
POST
/processor/identity/get
Plaid Retrieve Identity data
POST
/processor/identity/match
Plaid Retrieve identity match score
POST
/identity_verification/create
Plaid Create a new Identity Verification
POST
/identity_verification/get
Plaid Retrieve Identity Verification
POST
/identity_verification/list
Plaid List Identity Verifications
POST
/identity_verification/retry
Plaid Retry an Identity Verification
POST
/identity_verification/autofill/create
Plaid Create autofill for an Identity Verification
POST
/income/verification/createdeprecated
Plaid (Deprecated) Create an income verification instance
POST
/income/verification/paystubs/getdeprecated
Plaid (Deprecated) Retrieve information from the paystubs used for income verification
POST
/income/verification/documents/downloaddeprecated
Plaid (Deprecated) Download the original documents used for income verification
POST
/income/verification/taxforms/getdeprecated
Plaid (Deprecated) Retrieve information from the tax documents used for income verification
POST
/income/verification/precheckdeprecated
Plaid (Deprecated) Check digital income verification eligibility and optimize conversion
POST
/sandbox/income/fire_webhook
Plaid Manually fire an Income webhook
POST
/institutions/get
Plaid Get details of all supported institutions
POST
/institutions/search
Plaid Search institutions
POST
/institutions/get_by_id
Plaid Get details of an institution
POST
/investments/holdings/get
Plaid Get Investment holdings
POST
/investments/transactions/get
Plaid Get investment transactions
POST
/investments/refresh
Plaid Refresh investment data
POST
/item/activity/list
Plaid List a historical log of user consent events
POST
/item/get
Plaid Retrieve an Item
POST
/item/remove
Plaid Remove an Item
POST
/sandbox/item/fire_webhook
Plaid Fire a test webhook
POST
/item/webhook/update
Plaid Update Webhook URL
POST
/item/access_token/invalidate
Plaid Invalidate accesstoken
POST
/sandbox/item/reset_login
Plaid Force a Sandbox Item into an error state
POST
/sandbox/item/set_verification_status
Plaid Set verification status for Sandbox account
POST
/item/public_token/exchange
Plaid Exchange public token for an access token
POST
/item/public_token/create
Plaid Create public token
POST
/item/import
Plaid Import Item
POST
/processor/liabilities/get
Plaid Retrieve Liabilities data
POST
/liabilities/get
Plaid Retrieve Liabilities data
POST
/link/profile/eligibility/check
Plaid Check profile eligibility
POST
/link/token/create
Plaid Create Link Token
POST
/link/token/get
Plaid Get Link Token
POST
/link/oauth/correlation_id/exchange
Plaid Exchange the Link Correlation Id for a Link Token
POST
/link_delivery/create
Plaid Create Hosted Link session
POST
/link_delivery/get
Plaid Get Hosted Link session
POST
/consumer_report/pdf/get
Plaid Retrieve a PDF Reports
POST
/statements/list
Plaid Retrieve a list of all statements associated with an item.
POST
/statements/download
Plaid Retrieve a single statement.
POST
/statements/refresh
Plaid Refresh statements data.
POST
/profile/get
Plaid Retrieve a Profile
POST
/transactions/get
Plaid Get transaction data
POST
/transactions/refresh
Plaid Refresh transaction data
POST
/transactions/recurring/get
Plaid Fetch recurring transaction streams
POST
/transactions/sync
Plaid Get incremental transaction updates on an Item
POST
/transactions/enrich
Plaid Enrich locally-held transaction data
POST
/sandbox/processor_token/create
Plaid Create a test Item and processor token
POST
/sandbox/public_token/create
Plaid Create a test Item
POST
/watchlist_screening/entity/create
Plaid Create a watchlist screening for an entity
POST
/watchlist_screening/entity/get
Plaid Get an entity screening
POST
/watchlist_screening/entity/history/list
Plaid List history for entity watchlist screenings
POST
/watchlist_screening/entity/hit/list
Plaid List hits for entity watchlist screenings
POST
/watchlist_screening/entity/list
Plaid List entity watchlist screenings
POST
/watchlist_screening/entity/program/get
Plaid Get entity watchlist screening program
POST
/watchlist_screening/entity/program/list
Plaid List entity watchlist screening programs
POST
/watchlist_screening/entity/review/create
Plaid Create a review for an entity watchlist screening
POST
/watchlist_screening/entity/review/list
Plaid List reviews for entity watchlist screenings
POST
/watchlist_screening/entity/update
Plaid Update an entity screening
POST
/watchlist_screening/individual/create
Plaid Create a watchlist screening for a person
POST
/watchlist_screening/individual/get
Plaid Retrieve an individual watchlist screening
POST
/watchlist_screening/individual/history/list
Plaid List history for individual watchlist screenings
POST
/watchlist_screening/individual/hit/list
Plaid List hits for individual watchlist screening
POST
/watchlist_screening/individual/list
Plaid List Individual Watchlist Screenings
POST
/watchlist_screening/individual/program/get
Plaid Get individual watchlist screening program
POST
/watchlist_screening/individual/program/list
Plaid List individual watchlist screening programs
POST
/watchlist_screening/individual/review/create
Plaid Create a review for an individual watchlist screening
POST
/watchlist_screening/individual/review/list
Plaid List reviews for individual watchlist screenings
POST
/watchlist_screening/individual/update
Plaid Update individual watchlist screening
POST
/processor/account/get
Plaid Retrieve the account associated with a processor token
POST
/processor/transactions/get
Plaid Get transaction data
POST
/processor/transactions/sync
Plaid Get incremental transaction updates on a processor token
POST
/processor/transactions/refresh
Plaid Refresh transaction data
POST
/processor/transactions/recurring/get
Plaid Fetch recurring transaction streams
POST
/processor/signal/evaluate
Plaid Evaluate a planned ACH transaction
POST
/processor/signal/decision/report
Plaid Report whether you initiated an ACH transaction
POST
/processor/signal/return/report
Plaid Report a return for an ACH transaction
POST
/processor/signal/prepare
Plaid Opt-in a processor token to Signal
POST
/processor/balance/get
Plaid Retrieve Balance data
POST
/webhook_verification_key/get
Plaid Get webhook verification key
POST
/payment_initiation/recipient/create
Plaid Create payment recipient
POST
/payment_initiation/payment/reverse
Plaid Reverse an existing payment
POST
/payment_initiation/recipient/get
Plaid Get payment recipient
POST
/payment_initiation/recipient/list
Plaid List payment recipients
POST
/payment_initiation/payment/create
Plaid Create a payment
POST
/payment_initiation/payment/token/createdeprecated
Plaid Create payment token
POST
/payment_initiation/consent/create
Plaid Create payment consent
POST
/payment_initiation/consent/get
Plaid Get payment consent
POST
/payment_initiation/consent/revoke
Plaid Revoke payment consent
POST
/payment_initiation/consent/payment/execute
Plaid Execute a single payment using consent
POST
/user/create
Plaid Create user
POST
/user/update
Plaid Update user information
POST
/payment_initiation/payment/get
Plaid Get payment details
POST
/payment_initiation/payment/list
Plaid List payments
POST
/processor/token/create
Plaid Create processor token
POST
/processor/token/permissions/set
Plaid Control a processor's access to products
POST
/processor/token/permissions/get
Plaid Get a processor token's product permissions
POST
/processor/token/webhook/update
Plaid Update a processor token's webhook URL
POST
/processor/stripe/bank_account_token/create
Plaid Create Stripe bank account token
POST
/processor/apex/processor_token/create
Plaid Create Apex bank account token
POST
/transfer/get
Plaid Retrieve a transfer
POST
/transfer/recurring/get
Plaid Retrieve a recurring transfer
POST
/transfer/authorization/create
Plaid Create a transfer authorization
POST
/transfer/authorization/cancel
Plaid Cancel a transfer authorization
POST
/transfer/balance/getdeprecated
(Deprecated) Retrieve a balance held with Plaid
POST
/transfer/capabilities/get
Plaid Get RTP eligibility information of a transfer
POST
/transfer/configuration/get
Plaid Get transfer product configuration
POST
/transfer/ledger/get
Retrieve Plaid Ledger balance
POST
/transfer/ledger/distribute
Plaid Move available balance between the ledgers of the platform and one of its originators
POST
/transfer/ledger/deposit
Deposit funds into a Plaid Ledger balance
POST
/transfer/ledger/withdraw
Withdraw funds from a Plaid Ledger balance
POST
/transfer/originator/funding_account/update
Plaid Update the funding account associated with the originator
POST
/transfer/metrics/get
Plaid Get transfer product usage metrics
POST
/transfer/create
Plaid Create a transfer
POST
/transfer/recurring/create
Plaid Create a recurring transfer
POST
/transfer/list
Plaid List transfers
POST
/transfer/recurring/list
Plaid List recurring transfers
POST
/transfer/cancel
Plaid Cancel a transfer
POST
/transfer/recurring/cancel
Plaid Cancel a recurring transfer.
POST
/transfer/event/list
Plaid List transfer events
POST
/transfer/event/sync
Plaid Sync transfer events
POST
/transfer/sweep/get
Plaid Retrieve a sweep
POST
/transfer/sweep/list
Plaid List sweeps
POST
/transfer/migrate_account
Plaid Migrate account into Transfers
POST
/transfer/intent/create
Plaid Create a transfer intent object to invoke the Transfer UI
POST
/transfer/intent/get
Plaid Retrieve more information about a transfer intent
POST
/transfer/repayment/list
Plaid Lists historical repayments
POST
/transfer/repayment/return/list
Plaid List the returns included in a repayment
POST
/transfer/originator/create
Plaid Create a new originator
POST
/transfer/questionnaire/create
Generate a Plaid-hosted onboarding UI URL.
POST
/transfer/diligence/submit
Plaid Submit transfer diligence on behalf of the originator
POST
/transfer/diligence/document/upload
Plaid Upload transfer diligence document on behalf of the originator
POST
/transfer/originator/get
Plaid Get status of an originator's onboarding
POST
/transfer/originator/list
Plaid Get status of all originators' onboarding
POST
/transfer/refund/create
Plaid Create a refund
POST
/transfer/refund/get
Plaid Retrieve a refund
POST
/transfer/refund/cancel
Plaid Cancel a refund
POST
/sandbox/transfer/sweep/simulate
Plaid Simulate creating a sweep
POST
/sandbox/transfer/simulate
Plaid Simulate a transfer event in Sandbox
POST
/sandbox/transfer/refund/simulate
Plaid Simulate a refund event in Sandbox
POST
/sandbox/transfer/ledger/simulate_available
Plaid Simulate converting pending balance to available balance
POST
/sandbox/transfer/ledger/deposit/simulate
Plaid Simulate a ledger deposit event in Sandbox
POST
/sandbox/transfer/ledger/withdraw/simulate
Plaid Simulate a ledger withdraw event in Sandbox
POST
/sandbox/transfer/repayment/simulate
Plaid Trigger the creation of a repayment
POST
/sandbox/transfer/fire_webhook
Plaid Manually fire a Transfer webhook
POST
/sandbox/transfer/test_clock/create
Plaid Create a test clock
POST
/sandbox/transfer/test_clock/advance
Plaid Advance a test clock
POST
/sandbox/transfer/test_clock/get
Plaid Get a test clock
POST
/sandbox/transfer/test_clock/list
Plaid List test clocks
POST
/sandbox/payment_profile/reset_logindeprecated
Plaid Reset the login of a Payment Profile
POST
/employment/verification/getdeprecated
Plaid (Deprecated) Retrieve a summary of an individual's employment information
POST
/sandbox/bank_income/fire_webhook
Plaid Manually fire a bank income webhook in sandbox
POST
/sandbox/oauth/select_accounts
Plaid Save the selected accounts when connecting to the Platypus Oauth institution
POST
/signal/evaluate
Plaid Evaluate a planned ACH transaction
POST
/signal/decision/report
Plaid Report whether you initiated an ACH transaction
POST
/signal/return/report
Plaid Report a return for an ACH transaction
POST
/signal/prepare
Plaid Opt-in an Item to Signal
POST
/wallet/create
Plaid Create an e-wallet
POST
/wallet/get
Plaid Fetch an e-wallet
POST
/wallet/list
Plaid Fetch a list of e-wallets
POST
/wallet/transaction/execute
Plaid Execute a transaction using an e-wallet
POST
/wallet/transaction/get
Plaid Fetch an e-wallet transaction
POST
/wallet/transaction/list
Plaid List e-wallet transactions
POST
/payment_profile/createdeprecated
Plaid Create payment profile
POST
/payment_profile/getdeprecated
Plaid Get payment profile
POST
/payment_profile/removedeprecated
Plaid Remove payment profile
POST
/partner/customer/create
Creates a new end customer for a Plaid reseller.
POST
/partner/customer/get
Returns a Plaid reseller's end customer.
POST
/partner/customer/enable
Enables a Plaid reseller's end customer in the Production environment.
POST
/partner/customer/remove
Removes a Plaid reseller's end customer.
POST
/partner/customer/oauth_institutions/get
Plaid Returns OAuth-institution registration information for a given end customer.
Schemas 1517
The contract defines 1517 schemas that model the data the API accepts and returns. The most detailed are SignalEvaluateCoreAttributes (80 properties), Credit1099 (52 properties), LinkTokenCreateRequest (42 properties), Transfer (31 properties). Each schema is shown below with its type and property counts.
PlaidError
objectnull
Errors are identified by errorcode and categorized by errortype. Use these in preference to HTTP status codes to identify and handle specific errors. HTTP stat…
9 properties
4 required
AccountsGetResponse
object
AccountsGetResponse defines the response schema for /accounts/get and /accounts/balance/get.
4 properties
3 required
ApplicationGetResponse
object
ApplicationGetResponse defines the response schema for /application/get
2 properties
2 required
ItemApplicationScopesUpdateResponse
object
ItemApplicationScopesUpdateResponse defines the response schema for /item/application/scopes/update
1 property
1 required
ItemApplicationUnlinkResponse
object
ItemApplicationUnlinkResponse defines the response schema for /item/application/unlink
1 property
1 required
ItemApplicationListResponse
object
Describes the connected application for a particular end user.
2 properties
1 required
AssetReportFilterResponse
object
AssetReportFilterResponse defines the response schema for /assetreport/filter
3 properties
3 required
AssetReportAuditCopyCreateResponse
object
AssetReportAuditCopyCreateResponse defines the response schema for /assetreport/auditcopy/get
2 properties
2 required
AssetReportCreateResponse
object
AssetReportCreateResponse defines the response schema for /assetreport/create
3 properties
3 required
AssetReportGetResponse
object
AssetReportGetResponse defines the response schema for /assetreport/get
3 properties
3 required
AssetReportAuditCopyRemoveResponse
object
AssetReportAuditCopyRemoveResponse defines the response schema for /assetreport/auditcopy/remove
2 properties
2 required
AssetReportRefreshResponse
object
AssetReportRefreshResponse defines the response schema for /assetreport/refresh
3 properties
3 required
AssetReportFreddieGetResponse
object
AssetReportFreddieGetResponse defines the response schema for /assetreport/get
3 properties
3 required
AssetReportRemoveResponse
object
AssetReportRemoveResponse defines the response schema for /assetreport/remove
2 properties
2 required
InvestmentsAuthGetResponse
object
InvestmentsAuthGetResponse defines the response schema for /investments/auth/get
7 properties
7 required
AuthGetResponse
object
AuthGetResponse defines the response schema for /auth/get
4 properties
4 required
ProcessorAuthGetResponse
object
ProcessorAuthGetResponse defines the response schema for /processor/auth/get
3 properties
3 required
BankTransferGetResponse
object
Defines the response schema for /banktransfer/get
2 properties
2 required
ProcessorBankTransferCreateResponse
object
Defines the response schema for /processor/banktransfer/create
2 properties
2 required
BankTransferMigrateAccountResponse
object
Defines the response schema for /banktransfer/migrateaccount
3 properties
3 required
BankTransferListResponse
object
Defines the response schema for /banktransfer/list
2 properties
2 required
BankTransferSweepListResponse
object
BankTransferSweepListResponse defines the response schema for /banktransfer/sweep/list
2 properties
2 required
BankTransferEventSyncResponse
object
Defines the response schema for /banktransfer/event/sync
2 properties
2 required
BankTransferCancelResponse
object
Defines the response schema for /banktransfer/cancel
1 property
1 required
BankTransferBalanceGetResponse
object
Defines the response schema for /banktransfer/balance/get
3 properties
3 required
SandboxBankTransferSimulateResponse
object
Defines the response schema for /sandbox/banktransfer/simulate
1 property
1 required
SandboxBankTransferFireWebhookResponse
object
Defines the response schema for /sandbox/banktransfer/firewebhook
1 property
1 required
BankTransferCreateResponse
object
Defines the response schema for /banktransfer/create
2 properties
2 required
BankTransferEventListResponse
object
Defines the response schema for /banktransfer/event/list
2 properties
2 required
BankTransferSweepGetResponse
object
BankTransferSweepGetResponse defines the response schema for /banktransfer/sweep/get
2 properties
2 required
BeaconReportSyndicationGetResponse
object
A Beacon Report Syndication represents a Beacon Report created either by your organization or another Beacon customer that matches a specific Beacon User you'v…
4 properties
4 required
BeaconReportSyndicationListResponse
object
The response schema for /beacon/reportsyndication/list
3 properties
3 required
BeaconUserUpdateResponse
object
A Beacon User represents an end user that has been scanned against the Beacon Network.
10 properties
10 required
BeaconAccountRiskEvaluateResponse
object
BeaconAccountRiskEvaluateResponse defines the response schema for /beacon/accountrisk/v1/evaluate
2 properties
2 required
BeaconReportCreateResponse
object
A Beacon Report describes the type of fraud committed by a user as well as the date the fraud was committed and the total amount of money lost due to the fraud…
8 properties
8 required
BeaconReportGetResponse
object
A Beacon Report describes the type of fraud committed by a user as well as the date the fraud was committed and the total amount of money lost due to the fraud…
8 properties
8 required
BeaconDuplicateGetResponse
object
A Beacon Duplicate represents a pair of matching Beacon Users and an analysis of the fields they matched on.
5 properties
5 required
BeaconUserCreateResponse
object
A Beacon User represents an end user that has been scanned against the Beacon Network.
10 properties
10 required
BeaconUserGetResponse
object
A Beacon User represents an end user that has been scanned against the Beacon Network.
10 properties
10 required
BeaconReportListResponse
object
The response schema for /beacon/report/list
3 properties
3 required
BeaconUserHistoryListResponse
object
The response schema for /beacon/user/history/list
3 properties
3 required
CreditBankEmploymentGetResponse
object
CreditBankEmploymentGetResponse defines the response schema for /beta/credit/v1/bankemployment/get.
2 properties
2 required
TransactionsEnhanceGetResponse
object
TransactionsEnhanceGetResponse defines the response schema for /beta/transactions/v1/enhance.
1 property
1 required
TransactionsRulesCreateResponse
object
TransactionsRulesCreateResponse defines the response schema for /beta/transactions/rules/v1/create
2 properties
2 required
TransactionsRulesRemoveResponse
object
TransactionsRulesRemoveResponse defines the response schema for /beta/transactions/rules/v1/remove
1 property
1 required
TransactionsUserInsightsGetResponse
object
TransactionsUserInsightsGetResponse defines the response schema for /beta/transactions/userinsights/v1/get.
4 properties
1 required
TransactionsRulesListResponse
object
TransactionsRulesListResponse defines the response schema for /beta/transactions/rules/v1/list
2 properties
2 required
CategoriesGetResponse
object
CategoriesGetResponse defines the response schema for /categories/get
2 properties
2 required
CraPartnerInsightsGetResponse
object
CraPartnerInsightsGetResponse defines the response schema for /cra/partnerinsights/get.
2 properties
1 required
CraLoanUnregisterResponse
object
CraLoanUnregisterResponse defines the response schema for /cra/loans/unregister.
1 property
1 required
CraLoansApplicationsRegisterResponse
object
CraLoansApplicationsRegisterResponse defines the response schema for /cra/loans/applications/register.
1 property
1 required
CraBankIncomeCreateResponse
object
CraBankIncomeCreateRequest defines the response schema for /cra/bankincome/create.
1 property
BaseReportCreateResponse
object
BaseReportCreateResponse defines the response schema for cra/basereport/create
1 property
1 required
BaseReportGetResponse
object
BaseReportGetResponse defines the response schema for /cra/basereport/get
3 properties
2 required
CraLoansUpdateResponse
object
CraLoansUpdateResponse defines the response schema for /cra/loans/update.
1 property
1 required
CraLoansRegisterResponse
object
CraLoansRegisterResponse defines the response schema for /cra/loans/register.
1 property
1 required
CraBankIncomeGetResponse
object
CraBankIncomeGetResponse defines the response schema for /cra/bankincome/get.
2 properties
1 required
CreditSessionsGetResponse
object
CreditSessionsGetResponse defines the response schema for /credit/sessions/get
2 properties
1 required
CreditPayrollIncomeParsingConfigUpdateResponse
object
CreditPayrollIncomeParsingConfigUpdateResponse defines the response schema for /credit/payrollincome/documents/update.
1 property
1 required
CreditRelayRefreshResponse
object
CreditRelayRefreshResponse defines the response schema for /credit/relay/refresh
3 properties
2 required
CreditBankIncomeRefreshResponse
object
CreditBankIncomeRefreshResponse defines the response schema for /credit/bankincome/refresh.
1 property
1 required
CreditPayrollIncomeGetResponse
object
Defines the response body for /credit/payrollincome/get.
3 properties
2 required
CreditAuditCopyTokenRemoveResponse
object
CreditAuditCopyTokenRemoveResponse defines the response schema for /credit/auditcopytoken/remove
2 properties
2 required
CreditAuditCopyTokenUpdateResponse
object
CreditAuditCopyTokenUpdateResponse defines the response schema for /credit/auditcopytoken/update
2 properties
2 required
CreditBankIncomeGetResponse
object
CreditBankIncomeGetResponse defines the response schema for /credit/bankincome/get
2 properties
1 required
CreditRelayRemoveResponse
object
CreditRelayRemoveResponse defines the response schema for /credit/relay/remove
2 properties
2 required
CreditBankStatementsUploadsGetResponse
object
CreditBankStatementsUploadsGetResponse defines the response schema for /credit/bankstatements/uploads/get
2 properties
2 required
CreditEmploymentGetResponse
object
CreditEmploymentGetResponse defines the response schema for /credit/employment/get.
2 properties
2 required
CreditFreddieMacReportsGetResponse
object
CreditFreddieMacReportsGetResponse defines the response schema for /credit/freddiemac/reports/get
3 properties
3 required
CreditPayrollIncomeRiskSignalsGetResponse
object
CreditPayrollIncomeRiskSignalsGetRequest defines the response schema for /credit/payrollincome/risksignals/get
3 properties
2 required
CreditAuditCopyTokenCreateResponse
object
CreditAuditCopyTokenCreateResponse defines the response schema for /credit/auditcopytoken/get
2 properties
2 required
CreditPayrollIncomePrecheckResponse
object
Defines the response schema for /credit/payrollincome/precheck.
2 properties
2 required
CreditBankIncomeWebhookUpdateResponse
object
CreditBankIncomeWebhookUpdateResponse defines the response schema for /credit/bankincome/webhook/update.
1 property
1 required
CreditRelayCreateResponse
object
CreditRelayCreateResponse defines the response schema for /credit/relay/create
2 properties
2 required
CreditPayrollIncomeRefreshResponse
object
CreditPayrollIncomeRefreshResponse defines the response schema for /credit/payrollincome/refresh
2 properties
2 required
DashboardUserListResponse
object
Paginated list of dashboard users
3 properties
3 required
DashboardUserGetResponse
object
Account information associated with a team member with access to the Plaid dashboard.
5 properties
5 required
DepositSwitchGetResponse
object
DepositSwitchGetResponse defines the response schema for /depositswitch/get
16 properties
11 required
DepositSwitchTokenCreateResponse
object
DepositSwitchTokenCreateResponse defines the response schema for /depositswitch/token/create
3 properties
3 required
DepositSwitchCreateResponse
object
DepositSwitchCreateResponse defines the response schema for /depositswitch/create
2 properties
2 required
DepositSwitchAltCreateResponse
object
DepositSwitchAltCreateResponse defines the response schema for /depositswitch/alt/create
2 properties
2 required
EmployersSearchResponse
object
EmployersSearchResponse defines the response schema for /employers/search.
2 properties
2 required
ProcessorIdentityMatchResponse
object
ProcessorIdentityMatchResponse defines the response schema for /processor/identity/match
2 properties
2 required
ProcessorIdentityGetResponse
object
ProcessorIdentityGetResponse defines the response schema for /processor/identity/get
2 properties
2 required
IdentityRefreshResponse
object
IdentityRefreshResponse defines the response schema for /identity/refresh
1 property
1 required
IdentityGetResponse
object
IdentityGetResponse defines the response schema for /identity/get
3 properties
3 required
IdentityMatchResponse
object
IdentityMatchResponse defines the response schema for /identity/match
3 properties
3 required
IdentityDocumentsUploadsGetResponse
object
IdentityDocumentsUploadsGetResponse defines the response schema for /identity/documents/uploads/get
3 properties
3 required
IdentityVerificationAutofillCreateResponse
object
Autofill represents unverified customer information. This needs to be confirmed by the customer before using.
3 properties
3 required
IdentityVerificationCreateResponse
object
A identity verification attempt represents a customer's attempt to verify their identity, reflecting the required steps for completing the session, the results…
17 properties
17 required
IdentityVerificationListResponse
object
Paginated list of Plaid sessions.
3 properties
3 required
IdentityVerificationRetryResponse
object
A identity verification attempt represents a customer's attempt to verify their identity, reflecting the required steps for completing the session, the results…
17 properties
17 required
IdentityVerificationGetResponse
object
A identity verification attempt represents a customer's attempt to verify their identity, reflecting the required steps for completing the session, the results…
17 properties
17 required
SandboxIncomeFireWebhookResponse
object
SandboxIncomeFireWebhookResponse defines the response schema for /sandbox/income/firewebhook
1 property
1 required
IncomeVerificationPaystubsGetResponse
object
IncomeVerificationPaystubsGetResponse defines the response schema for /income/verification/paystubs/get.
4 properties
2 required
IncomeVerificationTaxformsGetResponse
object
IncomeVerificationTaxformsGetResponse defines the response schema for /income/verification/taxforms/get
4 properties
2 required
IncomeVerificationPrecheckResponse
object
IncomeVerificationPrecheckResponse defines the response schema for /income/verification/precheck.
3 properties
3 required
IncomeVerificationCreateResponse
object
IncomeVerificationCreateResponse defines the response schema for /income/verification/create.
2 properties
2 required
InstitutionsGetByIdResponse
object
InstitutionsGetByIdResponse defines the response schema for /institutions/getbyid
2 properties
2 required
InstitutionsSearchResponse
object
InstitutionsSearchResponse defines the response schema for /institutions/search
2 properties
2 required
InstitutionsGetResponse
object
InstitutionsGetResponse defines the response schema for /institutions/get
3 properties
3 required
InvestmentsHoldingsGetResponse
object
InvestmentsHoldingsGetResponse defines the response schema for /investments/holdings/get
6 properties
5 required
InvestmentsRefreshResponse
object
InvestmentsRefreshResponse defines the response schema for /investments/refresh
1 property
1 required
InvestmentsTransactionsGetResponse
object
InvestmentsTransactionsGetResponse defines the response schema for /investments/transactions/get
7 properties
6 required
ItemPublicTokenExchangeResponse
object
ItemPublicTokenExchangeResponse defines the response schema for /item/publictoken/exchange
3 properties
3 required
ItemRemoveResponse
object
ItemRemoveResponse defines the response schema for /item/remove
1 property
1 required
SandboxItemResetLoginResponse
object
SandboxItemResetLoginResponse defines the response schema for /sandbox/item/resetlogin
2 properties
2 required
ItemActivityListResponse
object
Describes a historical log of user consent events.
4 properties
3 required
ItemImportResponse
object
ItemImportResponse defines the response schema for /item/import
2 properties
2 required
ItemPublicTokenCreateResponse
object
ItemPublicTokenCreateResponse defines the response schema for /item/publictoken/create
3 properties
2 required
ItemAccessTokenInvalidateResponse
object
ItemAccessTokenInvalidateResponse defines the response schema for /item/accesstoken/invalidate
2 properties
2 required
SandboxItemFireWebhookResponse
object
SandboxItemFireWebhookResponse defines the response schema for /sandbox/item/firewebhook
2 properties
2 required
SandboxItemSetVerificationStatusResponse
object
SandboxItemSetVerificationStatusResponse defines the response schema for /sandbox/item/setverificationstatus
1 property
1 required
ItemGetResponse
object
ItemGetResponse defines the response schema for /item/get and /item/webhook/update
3 properties
2 required
ItemWebhookUpdateResponse
object
ItemWebhookUpdateResponse defines the response schema for /item/webhook/update
2 properties
2 required
LiabilitiesGetResponse
object
LiabilitiesGetResponse defines the response schema for /liabilities/get
4 properties
4 required
ProcessorLiabilitiesGetResponse
object
ProcessorLiabilitiesGetResponse defines the response schema for /processor/liabilities/get
3 properties
3 required
LinkTokenGetResponse
object
LinkTokenGetResponse defines the response schema for /link/token/get
6 properties
5 required
LinkProfileEligibilityCheckResponse
object
LinkProfileEligibilityCheckResponse defines the response schema for /link/profile/eligibility/check
2 properties
2 required
LinkTokenCreateResponse
object
LinkTokenCreateResponse defines the response schema for /link/token/create
4 properties
3 required
LinkOAuthCorrelationIdExchangeResponse
object
LinkOAuthCorrelationIdExchangeResponse defines the response schema for /link/oauth/correlationid/exchange
2 properties
2 required
LinkDeliveryCreateResponse
object
LinkDeliveryCreateResponse defines the response schema for /linkdelivery/create
3 properties
3 required
LinkDeliveryGetResponse
object
LinkDeliveryGetRequest defines the response schema for /linkdelivery/get
6 properties
3 required
Services
object
A collection of objects that describe requests and responses for services.
1 property
1 required
CategoriesGetRequest
object
CategoriesGetRequest defines the request schema for /categories/get
LinkTokenCreateRequestTransfer
object
Specifies options for initializing Link for use with the Transfer product.
2 properties
SandboxPublicTokenCreateRequestOptionsTransactions
object
An optional set of parameters corresponding to transactions options.
3 properties
IndividualWatchlistProgram
object
A program that configures the active lists, search parameters, and other behavior for initial and ongoing screening of individuals.
8 properties
8 required
CreditFreddieMacVerificationOfAssetResponse
object
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
1 property
1 required
SandboxIncomeFireWebhookRequest
object
SandboxIncomeFireWebhookRequest defines the request schema for /sandbox/income/firewebhook
7 properties
3 required
PaymentInitiationPaymentListRequest
object
PaymentInitiationPaymentListRequest defines the request schema for /paymentinitiation/payment/list
5 properties
AssetHolder
object
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
1 property
1 required
ProcessorSignalPrepareResponse
object
ProcessorSignalPrepareResponse defines the response schema for /processor/signal/prepare
1 property
1 required
SandboxItemResetLoginRequest
object
SandboxItemResetLoginRequest defines the request schema for /sandbox/item/resetlogin
3 properties
1 required
BankTransferUser
object
The legal name and other information for the account holder.
3 properties
1 required
NumbersEFTNullable
Identifying information for transferring money to or from a Canadian bank account via EFT.
SandboxItemFireWebhookRequest
object
SandboxItemFireWebhookRequest defines the request schema for /sandbox/item/firewebhook
5 properties
2 required
StreetNullable
stringnull
The primary street portion of an address. If an address is provided, this field will always be filled. A string with at least one non-whitespace alphabetical c…
TransferNetworkTraceID
stringnull
The trace identifier for the transfer based on its network. This will only be set after the transfer has posted. For ach or same-day-ach transfers, this is the…
WalletTransaction
object
The transaction details
12 properties
9 required
TransactionsCategoryRule
object
A representation of a transactions category rule.
5 properties
SandboxTransferFireWebhookResponse
object
Defines the response schema for /sandbox/transfer/firewebhook
1 property
1 required
ServiceProductFulfillmentIdentifier
string
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
PartnerEndCustomerQuestionnaireStatus
string
The status of the end customer's security questionnaire.
TransferIntentAuthorizationDecision
stringnull
A decision regarding the proposed transfer. APPROVED – The proposed transfer has received the end user's consent and has been approved for processing by Plaid.…
W2
object
W2 is an object that represents income data taken from a W2 tax document.
21 properties
CRALoansRegisterRequest
object
CraLoansRegisterRequest defines the request schema for /cra/loans/register
3 properties
1 required
UserAddress
objectnull
Home address for the user. Supported values are: not provided, address with only country code or full address. For more context on this field, see [Input Valid…
6 properties
1 required
PaymentConsentValidDateTime
objectnull
Life span for the payment consent. After the to date the payment consent expires and can no longer be used for payment initiation.
2 properties
ReportType
string
The report type. It can be asset. Income report types are not yet supported.
RiskCheckSyntheticIdentity
objectnull
Field containing the data used in determining the outcome of the synthetic identity risk check. Contains the following fields: score - A score from 0 to 100 in…
1 property
1 required
AssetReportFreddieGetRequest
object
AssetReportFreddieGetRequest defines the request schema for credit/assetreport/freddiemac/get
3 properties
1 required
WalletGetResponse
object
WalletGetResponse defines the response schema for /wallet/get
3 required
PaystubPayFrequency
stringnull
The frequency at which the employee is paid. Possible values: MONTHLY, BI-WEEKLY, WEEKLY, SEMI-MONTHLY.
CraLoanApplicationID
string
A unique identifier for the loan application. Personally identifiable information, such as an email address or phone number, should not be used in the applicat…
IdentityVerificationUserPhoneNumber
stringnull
A phone number in E.164 format.
TransferRecurringCancelRequest
object
Defines the request schema for /transfer/recurring/cancel
3 properties
1 required
CreditBankStatementUploadItem
object
An object containing information about the bank statement upload Item.
4 properties
4 required
InvestmentsAuthGetRequestOptions
object
An optional object to filter /investments/auth/get results.
1 property
ClientProvidedEnrichedTransaction
object
A client-provided transaction that Plaid has enriched.
10 properties
5 required
WatchlistScreeningEntityGetResponse
object
The entity screening object allows you to represent an entity in your system, update its profile, and search for it on various watchlists. Note: Rejected entit…
7 properties
7 required
APR
object
Information about the APR on the account.
4 properties
4 required
PreviousIdentityVerificationAttemptID
stringnull
The ID for the Identity Verification preceding this session. This field will only be filled if the current Identity Verification is a retry of a previous attem…
TransferCapabilitiesGetRTP
object
Contains the supported service types in RTP
1 property
BaseReportAccountBalances
object
Base Report information about an account's balances
CraLoansUnregisterRequest
object
CraLoansUnregisterRequest defines the request schema for /cra/loans/unregister
3 properties
1 required
SandboxPublicTokenCreateRequestIncomeVerificationBankIncome
object
Specifies options for Bank Income. This field is required if incomeverification is included in the initialproducts array and bank is specified in incomesourcet…
1 property
MatchSummaryCode
string
An enum indicating the match type between data provided by user and data checked against an external data source. match indicates that the provided input data…
PaymentProfileCreateRequest
object
PaymentProfileCreateRequest defines the request schema for /paymentprofile/create
2 properties
BeaconReportType
string
The type of Beacon Report. firstparty: If this is the same individual as the one who submitted the KYC. stolen: If this is a different individual from the one…
Service
object
A collection of details related to a fulfillment service or product in terms of request, process and result.
2 properties
2 required
CreditBankIncomeAccountType
string
The account type. This will always be depository.
ExternalPaymentScheduleGet
The schedule that the payment will be executed on. If a schedule is provided, the payment is automatically set up as a standing order. If no schedule is specif…
5 required
PayPeriodDetailsPayFrequency
stringnull
The frequency at which an individual is paid.
Address
object
A physical mailing address.
2 properties
1 required
TransferIntentCreateMode
string
The direction of the flow of transfer funds. PAYMENT: Transfers funds from an end user's account to your business account. DISBURSEMENT: Transfers funds from y…
PrismInsights
objectnull
The data from the Insights product returned by Prism.
2 properties
1 required
ReviewComment
stringnull
A comment submitted by a team member as part of reviewing a watchlist screening.
TransactionsRulesCreateRequest
object
TransactionsRulesCreateRequest defines the request schema for beta/transactions/rules/v1/create
5 properties
3 required
TransferRefund
object
Represents a refund within the Transfers API.
7 properties
6 required
LiabilitiesGetRequestOptions
object
An optional object to filter /liabilities/get results. If provided, options cannot be null.
1 property
VerificationOfAssetResponse
object
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
1 property
1 required
StudentLoanStatus
object
An object representing the status of the student loan
2 properties
2 required
FDXNotificationPriority
string
Priority of notification
CreditRelayPDFGetRequest
object
CreditRelayPDFGetRequest defines the request schema for /credit/relay/pdf/get
4 properties
2 required
CreditBankIncomeWarningType
string
The warning type which will always be BANKINCOMEWARNING.
APIClientID
string
Your Plaid API clientid. The clientid is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.
TransactionsSyncResponse
object
TransactionsSyncResponse defines the response schema for /transactions/sync
8 properties
8 required
BankTransferDirection
stringnull
Indicates the direction of the transfer: outbound for API-initiated transfers, or inbound for payments received by the FBO account.
WalletStatus
string
The status of the wallet. UNKNOWN: The wallet status is unknown. ACTIVE: The wallet is active and ready to send money to and receive money from. CLOSED: The wa…
SandboxItemSetVerificationStatusRequest
object
SandboxItemSetVerificationStatusRequest defines the request schema for /sandbox/item/setverificationstatus
5 properties
3 required
RiskCheckEmail
objectnull
Result summary object specifying values for email attributes of risk check.
10 properties
10 required
ReportingInformation
object
Information about an report identifier and a report name.
1 property
1 required
SandboxTransferSweepSimulateRequest
object
Defines the request schema for /sandbox/transfer/sweep/simulate
3 properties
LinkTokenCreateRequestUser
object
An object specifying information about the end user who will be linking their account.
11 properties
1 required
RiskSignalDocumentReference
object
Object containing metadata for the document
3 properties
IdentityVerificationRetryRequestStepsObject
objectnull
Instructions for the custom retry strategy specifying which steps should be required or skipped. Note: This field must be provided when the retry strategy is c…
4 properties
4 required
SignalScores
object
Risk scoring details broken down by risk category.
2 properties
WatchlistScreeningHitStatus
string
The current state of review. All watchlist screening hits begin in a pendingreview state but can be changed by creating a review. When a hit is in the pendingr…
TransferDiligenceSubmitRequest
object
Defines the request schema for /transfer/diligence/submit
4 properties
2 required
TaxpayerIdentifiers
object
The collection of TAXPAYERIDENTIFICATION elements
1 property
1 required
StatementsDownloadRequest
object
StatementsDownloadRequest defines the request schema for /statements/download
4 properties
2 required
LinkTokenCreateRequestCreditPartnerInsights
object
Specifies options for initializing Link for use with the Credit Partner Insights product.
2 properties
ItemImportRequestOptions
object
An optional object to configure /item/import request.
1 property
WalletTransactionGetRequest
object
WalletTransactionGetRequest defines the request schema for /wallet/transaction/get
3 properties
1 required
CreditSessionDocumentIncomeResult
objectnull
The details of a document income verification in Link
4 properties
4 required
CreditPayStubEmployee
object
Data about the employee.
4 properties
4 required
ProcessorTokenPermissionsSetRequest
object
ProcessorTokenPermissionsSetRequest defines the request schema for /processor/token/permissions/set
4 properties
2 required
StatementsListRequest
object
StatementsListRequest defines the request schema for /statements/list
3 properties
1 required
BankTransferEventListDirection
stringnull
Indicates the direction of the transfer: outbound: for API-initiated transfers inbound: for payments received by the FBO account.
TransferRefundCancelRequest
object
Defines the request schema for /transfer/refund/cancel
3 properties
1 required
PaymentInitiationPaymentCreateStatus
string
For a payment returned by this endpoint, there is only one possible value: PAYMENTSTATUSINPUTNEEDED: The initial phase of the payment
TransferConfigurationGetRequest
object
Defines the request schema for /transfer/configuration/get
3 properties
WalletNumbers
object
An object representing the e-wallet account numbers
2 properties
AssetTransactionDescription
object
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
1 property
1 required
ProcessorTransactionsGetRequestOptions
object
An optional object to be used with the request. If specified, options must not be null.
6 properties
PaymentInitiationConsent
object
PaymentInitiationConsent defines a payment initiation consent.
7 properties
7 required
TransactionsEnrichResponse
object
TransactionsEnrichResponse defines the response schema for /transactions/enrich.
2 properties
1 required
WatchlistScreeningEntityHistoryListRequest
object
Request input for listing changes to entity watchlist screenings
4 properties
1 required
WatchlistScreeningIndividualHitListRequest
object
Request input for listing hits for an individual watchlist screening
4 properties
1 required
PartyRoleType
string
A value from a MISMO defined list that identifies the role that the party plays in the transaction. Parties may be either a person or legal entity. A party may…
IdentityVerificationGetRequest
object
Request input for fetching an Identity Verification
3 properties
1 required
TransferRefundAmount
string
The amount of the refund (decimal string with two digits of precision e.g. "10.00").
SandboxPublicTokenCreateRequestOptions
object
An optional set of options to be used when configuring the Item. If specified, must not be null.
6 properties
WatchlistScreeningEntityReviewListResponse
object
Paginated list of entity watchlist screening reviews
3 properties
3 required
DistributionBreakdown
object
Information about the accounts that the payment was distributed to.
8 properties
TransferRepaymentListResponse
object
Defines the response schema for /transfer/repayments/list
2 properties
2 required
IdentityVerificationUserData
object
The identity data that was either collected from the user or provided via API in order to perform an Identity Verification.
7 properties
6 required
SandboxBankTransferSimulateRequest
object
Defines the request schema for /sandbox/banktransfer/simulate
5 properties
2 required
BankTransferBalance
object
Information about the balance of a bank transfer
2 properties
2 required
UpdateIndividualScreeningRequestSearchTerms
objectnull
Search terms for editing an individual watchlist screening
5 properties
IdentityDocumentUploadRiskSignal
object
Risk signals tied to the document
4 properties
TransferUserInRequest
object
The legal name and other information for the account holder.
4 properties
1 required
TransactionCounterparty
object
The counterparty, such as the merchant or financial institution, is extracted by Plaid from the raw description.
6 properties
4 required
SandboxBankIncomeFireWebhookRequest
object
SandboxBankIncomeFireWebhookRequest defines the request schema for /sandbox/bankincome/firewebhook
5 properties
2 required
TransferDiligenceSubmitResponse
object
Defines the response schema for /transfer/diligence/submit
1 property
1 required
PaymentInitiationPaymentCreateResponse
object
PaymentInitiationPaymentCreateResponse defines the response schema for /paymentinitiation/payment/create
3 properties
3 required
TransferCancelResponse
object
Defines the response schema for /transfer/cancel
1 property
1 required
ProcessorToken
string
The processor token obtained from the Plaid integration partner. Processor tokens are in the format: processor- -
IncomeVerificationPrecheckRequest
object
IncomeVerificationPrecheckRequest defines the request schema for /income/verification/precheck
8 properties
IncomeVerificationPrecheckPayrollInstitution
objectnull
Information about the end user's payroll institution
1 property
GivenNameField
string
A string with at least one non-whitespace character, with a max length of 100 characters.
TransferSweepAmount
stringnull
A signed amount of how much was swept or returnswept for this transfer (decimal string with two digits of precision e.g. "-5.50").
WatchlistScreeningIndividualIDNullable
stringnull
ID of the associated screening.
NameMatchScore
objectnull
Score found by matching name provided by the API with the name on the account at the financial institution. If the account contains multiple owners, the maximu…
4 properties
TransferAuthorizationDecisionRationale
objectnull
The rationale for Plaid's decision regarding a proposed transfer. It is always set for declined decisions, and may or may not be null for approved decisions.
2 properties
2 required
BeaconReportSyndicationGetRequest
object
Request input for getting a Beacon Report Syndication
3 properties
1 required
CreditPayStubAddress
object
Address on the pay stub.
5 properties
5 required
OwnershipType
stringnull
How an asset is owned. association: Ownership by a corporation, partnership, or unincorporated association, including for-profit and not-for-profit organizatio…
CreditSessionPayrollIncomeResult
object
The details of a digital payroll income verification in Link
4 properties
BankTransferEventListBankTransferType
stringnull
The type of bank transfer. This will be either debit or credit. A debit indicates a transfer of money into your origination account; a credit indicates a trans…
TransferStatus
string
The status of the transfer. pending: A new transfer was created; it is in the pending state. posted: The transfer has been successfully submitted to the paymen…
CreditPayrollIncomeGetRequestOptions
object
An optional object for /credit/payrollincome/get request options.
1 property
BeaconAccountRiskEvaluateAccountAttributes
object
The attributes object contains data that can be used to assess account risk. Examples of data include: dayssincefirstplaidconnection: The number of days since…
28 properties
WatchlistScreeningIndividualHistoryListResponse
object
Paginated list of individual watchlist screenings.
3 properties
3 required
TransferLedgerBalance
object
Information about the balance of the ledger held with Plaid.
2 properties
2 required
PaymentInitiationConsentCreateResponse
object
PaymentInitiationConsentCreateResponse defines the response schema for /paymentinitiation/consent/create
3 properties
3 required
TransferOriginatorListRequest
object
Defines the request schema for /transfer/originator/list
4 properties
BaseReportTransaction
object
A transaction on the Base Report
15 properties
6 required
FraudAmount
objectnull
The amount and currency of the fraud or attempted fraud. fraudamount should be omitted to indicate an unknown fraud amount.
2 properties
2 required
CreditPayStubDeductions
object
An object with the deduction information found on a pay stub.
2 properties
2 required
SandboxOverrideUsername
stringnull
Test username to use for the creation of the Sandbox Item. Default value is usergood.
DetectedAccount
object
A possible account detected to be associated with a transaction user.
8 properties
5 required
ItemPublicTokenExchangeRequest
object
ItemPublicTokenExchangeRequest defines the request schema for /item/publictoken/exchange
3 properties
1 required
W2Box12
object
Data on the W2 Box 12
2 properties
TransferFundingAccountIDResponseNullable
stringnull
The id of the associated funding account, available in the Plaid Dashboard. If present, this indicates which of your business checking accounts will be credite…
TransferScheduleIntervalCount
integer
The number of recurring intervalunits between originations. The recurring interval (before holiday adjustment) is calculated by multiplying intervalunit and in…
Loan
object
Information specific to a mortgage loan agreement between one or more borrowers and a mortgage lender.
1 property
1 required
RecipientBACSNullable
An object containing a BACS account number and sort code. If an IBAN is not provided or if this recipient needs to accept domestic GBP-denominated payments, BA…
City
string
City from the end user's address. A string with at least one non-whitespace alphabetical character, with a max length of 100 characters."
HealthIncident
object
A status health incident
4 properties
3 required
LinkTokenGetRequest
object
LinkTokenGetRequest defines the request schema for /link/token/get
3 properties
1 required
CreditEmployerVerification
object
An object containing employer data.
1 property
1 required
TransferRepaymentReturn
object
Represents a return on a Guaranteed ACH transfer that is included in the specified repayment.
4 properties
4 required
WatchlistScreeningIndividualUpdateRequestResettableField
string
The name of a field that can be reset back to null
TransferRefundID
string
Plaid’s unique identifier for a refund.
FDXHateoasLinkAction
string
HTTP Method to use for the request
InvestmentsTransactionsGetRequestOptions
object
An optional object to filter /investments/transactions/get results. If provided, must be non-null.
4 properties
WatchlistScreeningHitID
string
ID of the associated screening hit.
TransferQuestionnaireCreateResponse
object
Defines the response schema for /transfer/questionnaire/create
2 properties
2 required
TransferRepaymentReturnListRequest
object
Defines the request schema for /transfer/repayment/return/list
5 properties
1 required
WalletCreateRequest
object
WalletCreateRequest defines the request schema for /wallet/create
3 properties
1 required
LinkDeliveryRecipient
object
Metadata related to the recipient. If the information required to populate this field is not available, leave it blank.
2 properties
WatchlistScreeningIndividualHitListResponse
object
Paginated list of individual watchlist screening hits
3 properties
3 required
LinkEventMetadata
object
Metadata about an event that occured while the user was going through Link
15 properties
1 required
APISecret
string
Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.
TransferAuthorizationGuaranteeDecisionRationaleCode
string
A code representing the reason Plaid declined to guarantee this transfer: RETURNBANK: The risk of a bank-initiated return (for example, an R01/NSF) is too high…
SandboxPublicTokenCreateRequestOptionsStatements
objectnull
An optional set of parameters corresponding to statements options.
2 properties
2 required
AssetReportAddOns
string
A list of add-ons that should be included in the Asset Report. fastassets: When Fast Assets is requested, Plaid will create two versions of the Asset Report: t…
PaymentInitiationPaymentGetResponse
PaymentInitiationPaymentGetResponse defines the response schema for /paymentinitation/payment/get
9 required
IncomeVerificationTaxformsGetRequest
object
IncomeVerificationTaxformsGetRequest defines the request schema for /income/verification/taxforms/get
4 properties
PaymentInitiationPaymentTokenCreateResponse
object
PaymentInitiationPaymentTokenCreateResponse defines the response schema for /paymentinitiation/payment/token/create
3 properties
3 required
CreditFilter
object
A filter to apply to credit-type accounts
1 property
1 required
PartnerCustomerEnableResponse
object
Response schema for /partner/customer/enable.
2 properties
Cause
object
An error object and associated itemid used to identify a specific Item and error when a batch operation operating on multiple Items has encountered an error in…
5 required
BeaconUserStatus
string
A status of a Beacon User. rejected: The Beacon User has been rejected for fraud. Users can be automatically or manually rejected. pendingreview: The Beacon Us…
EmploymentVerificationStatus
stringnull
Current employment status.
PaymentAmount
object
The amount and currency of a payment
2 properties
2 required
PaymentInitiationPaymentGetRequest
object
PaymentInitiationPaymentGetRequest defines the request schema for /paymentinitiation/payment/get
3 properties
1 required
ConsumerReportPermissiblePurpose
string
This enum describes the reason a consumer report is created for ACCOUNTREVIEWCREDIT: In connection with a consumer credit transaction for the review or collect…
Owner
object
Data returned from the financial institution about the owner or owners of an account. Only the names array must be non-empty.
5 properties
4 required
ProcessorTransactionsGetRequest
object
ProcessorTransactionsGetRequest defines the request schema for /processor/transactions/get
6 properties
3 required
AssetReportFilterRequest
object
AssetReportFilterRequest defines the request schema for /assetreport/filter
4 properties
2 required
ProductStatusBreakdown
object
A detailed breakdown of the institution's performance for a request type. The values for success, errorplaid, and errorinstitution sum to 1. The time range use…
4 properties
3 required
PhoneNumber
object
A phone number
3 properties
3 required
CreditBankIncomeTransaction
object
The transactions data for the end user's income source(s).
9 properties
ProcessorStripeBankAccountTokenCreateRequest
object
ProcessorStripeBankAccountTokenCreateRequest defines the request schema for /processor/stripe/bankaccount/create
4 properties
2 required
PartnerCustomerRemoveRequest
object
Request schema for /partner/customer/remove.
3 properties
1 required
MortgageInterestRate
object
Object containing metadata about the interest rate for the mortgage.
2 properties
2 required
RiskCheckEmailDomainIsCustom
string
Indicates whether the email address domain is custom if known, i.e. a company domain and not free or disposable.
AssetType
string
A value from a MISMO prescribed list that specifies financial assets in a mortgage loan transaction. Assets may be either liquid or fixed and are associated wi…
JWKPublicKey
object
A JSON Web Key (JWK) that can be used in conjunction with [JWT libraries](https://jwt.io/libraries-io) to verify Plaid webhooks
9 properties
9 required
URL
string
An 'http' or 'https' URL (must begin with either of those).
PayStubEarningsBreakdown
object
An object representing the earnings line items for the pay period.
8 properties
8 required
ProcessorStripeBankAccountTokenCreateResponse
object
ProcessorStripeBankAccountTokenCreateResponse defines the response schema for /processor/stripe/bankaccount/create
2 properties
2 required
ConsumerReportUserIdentity
objectnull
ConsumerReportUserIdentity defines the user identity data collected for consumer report purpose. This field is required to be set if you later use the created…
5 properties
5 required
CreditBankEmployer
object
Object containing employer data.
1 property
1 required
ISOCurrencyCode
string
An ISO-4217 currency code.
BeaconReportIDNullable
stringnull
ID of the associated Beacon Report.
PartnerEndCustomerBillingContact
object
The billing contact for the end customer. Defaults to partner's billing contact if omitted.
3 properties
CreditSession
object
Metadata and results for a Link session
4 properties
SandboxTransferTestClockCreateRequest
object
Defines the request schema for /sandbox/transfer/testclock/create
3 properties
WalletTransactionAmount
object
The amount and currency of a transaction
2 properties
2 required
RiskCheckPhone
objectnull
Result summary object specifying values for phone attributes of risk check.
1 property
1 required
EntityScreeningHitDocumentsItems
object
Analyzed documents for the associated hit
2 properties
PaymentAmountRefunded
The amount and currency of a payment
PaymentConsentPeriodicInterval
string
Payment consent periodic interval.
AssetReportAccountBalance
object
A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by /accounts/balance/get.
7 properties
6 required
TransferRefundCreateResponse
object
Defines the response schema for /transfer/refund/create
2 properties
2 required
IdentityMatchUser
object
The user's legal name, phone number, email address and address used to perform fuzzy match. If Financial Account Matching is enabled in the Identity Verificati…
4 properties
TransferUserInRequestDeprecated
objectnull
The legal name and other information for the account holder.
4 properties
UTCOffset
stringnull
UTC offset of the timezone associated with the IP address.
CraBankIncomeCreateRequest
object
CraBankIncomeCreateRequest defines the request schema for /cra/bankincome/create.
6 properties
BankTransferBalanceGetRequest
object
Defines the request schema for /banktransfer/balance/get
3 properties
CreditBankIncomeWebhookUpdateRequest
object
CreditBankIncomeWebhookUpdateRequest defines the request schema for /credit/bankincome/webhook/update.
4 properties
2 required
SignalAddressData
objectnull
Data about the components comprising an address.
5 properties
SelfieStatus
string
An outcome status for this specific selfie. Distinct from the overall selfiecheck.status that summarizes the verification outcome from one or more selfies.
AssetOwners
object
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
1 property
1 required
BankIncomeRefreshCompleteResult
string
The result of the bank income refresh report generation SUCCESS: The refreshed report was successfully generated and can be retrieved via /credit/bankincome/ge…
ProgramNameSensitivity
string
The valid name matching sensitivity configurations for a screening program. Note that while certain matching techniques may be more prevalent on less strict se…
WalletTransactionCounterpartyBACS
The account number and sort code of the counterparty's account
TransferRecurringStatus
string
The status of the recurring transfer. active: The recurring transfer is currently active. cancelled: The recurring transfer was cancelled by the client or Plai…
PayStubEarningsBreakdownCanonicalDescription
stringnull
Commonly used term to describe the earning line item.
ItemApplicationScopesUpdateRequest
object
ItemApplicationScopesUpdateRequest defines the request schema for /item/application/scopes/update
7 properties
4 required
PaymentInitiationStandingOrderMetadata
objectnull
Metadata specifically related to valid Payment Initiation standing order configurations for the institution.
3 properties
3 required
BankTransferCreateRequest
object
Defines the request schema for /banktransfer/create
15 properties
9 required
TransferRefundGetRequest
object
Defines the request schema for /transfer/refund/get
3 properties
1 required
IdentityVerificationCreateRequestUser
objectnull
User information collected outside of Link, most likely via your own onboarding process. Each of the following identity fields are optional: emailaddress phone…
7 properties
IdentityVerificationAutofillAddress
objectnull
Even if an address has been autofilled, some fields may be null depending on the region's addressing system. For example: Addresses from the United Kingdom wil…
8 properties
8 required
Taxform
object
Data about an official document used to report the user's income to the IRS.
3 properties
1 required
DashboardUserListRequest
object
Request input for listing dashboard users
3 properties
TransactionsRecurringGetRequest
object
TransactionsRecurringGetRequest defines the request schema for /transactions/recurring/get
5 properties
1 required
LinkSessionSuccess
objectnull
An object representing an [onSuccess](https://plaid.com/docs/link/web/onsuccess) callback from Link.
2 properties
2 required
KYCCheckIDNumberSummary
object
Result summary object specifying how the idnumber field matched.
1 property
1 required
PartnerCustomerRemoveResponse
object
Response schema for /partner/customer/remove.
1 property
DocumentImage__Face
stringnull
Temporary URL that expires after 60 seconds for downloading a crop of just the user's face from the document image. Might be null if the document does not cont…
LinkEvent
object
An event that occurred while the user was going through Link
4 properties
4 required
TransferExpectedSweepSettlementScheduleItem
object
Defines an expected sweep date and amount.
2 properties
2 required
IncomeVerificationPrecheckEmployerAddress
objectnull
The address of the employer
TransferIDForRefund
string
The ID of the transfer to refund.
WatchlistScreeningEntityUpdateRequestResettableFieldList
arraynull
A list of fields to reset back to null
TransferBalanceGetResponse
object
Defines the response schema for /transfer/balance/get
2 properties
2 required
IdentityVerificationTemplateReference
object
The resource ID and version number of the template configuring the behavior of a given Identity Verification.
2 properties
2 required
PartnerEndCustomerSecrets
object
The secrets for the newly created end customer in non-Production environments.
2 properties
SignalDevice
object
Details about the end user's device. When calling /signal/evaluate or /signal/processor/evaluate, this field is optional, but strongly recommended to increase…
2 properties
PaymentInitiationConsentConstraints
object
Limitations that will be applied to payments initiated using the payment consent.
3 properties
2 required
InvestmentAccountSubtypes
array
An array of account subtypes to display in Link. If not specified, all account subtypes will be shown. For a full list of valid types and subtypes, see the [Ac…
PSLFStatus
object
Information about the student's eligibility in the Public Service Loan Forgiveness program. This is only returned if the institution is FedLoan (ins116527).
3 properties
3 required
TransferTestClockID
string
Plaid’s unique identifier for a test clock.
TransferIntentStatus
string
The status of the transfer intent. PENDING: The transfer intent is pending. SUCCEEDED: The transfer intent was successfully created. FAILED: The transfer inten…
CraLoanPaymentSchedule
string
The frequency of a loan's payment schedule. BIWEEKLY represents one payment every two weeks.
TransactionsRuleField
string
Transaction field for which the rule is defined.
Wallet
object
An object representing the e-wallet
5 properties
4 required
IdentityVerificationListRequest
object
Request input for listing Identity Verifications
5 properties
2 required
PhysicalDocumentIDNumber
stringnull
Alpha-numeric ID number extracted via OCR from the user's document image.
ProcessorSignalReturnReportRequest
object
ProcessorSignalReturnReportRequest defines the request schema for /processor/signal/return/report
6 properties
3 required
TransactionsRulesRemoveRequest
object
TransactionsRulesRemoveRequest defines the request schema for /beta/transactions/rules/v1/remove
4 properties
2 required
CountryCode
string
ISO-3166-1 alpha-2 country code standard.
CreditBankEmploymentWarningType
string
The warning type which will always be BANKEMPLOYMENTWARNING.
TransferOriginatorCreateResponse
object
Defines the response schema for /transfer/originator/create
3 properties
3 required
CraLoanStatusHistoryUpdate
object
Contains the status and date of an update to the loan.
2 properties
2 required
TransactionCode
stringnull
An identifier classifying the transaction type. This field is only populated for European institutions. For institutions in the US and Canada, this field is se…
ItemApplicationUnlinkRequest
object
ItemApplicationUnlinkRequest defines the request schema for /item/application/unlink/
4 properties
2 required
ProcessorTransactionsSyncRequest
object
ProcessorTransactionsSyncRequest defines the request schema for /processor/transactions/sync
6 properties
1 required
SourceUID
stringnull
The identifier provided by the source sanction or watchlist. When one is not provided by the source, this is null.
TransferRecurringSchedule
object
The schedule that the recurring transfer will be executed on.
5 properties
4 required
CreditFreddieMacReportsGetRequest
object
CreditFreddieMacReportsGetRequest defines the request schema for credit/assetreport/freddiemac/get
3 properties
1 required
AssetTransactionCategoryType
stringnull
Asset Transaction Category Type Enumerated derived by Vendor.
PartnerEndCustomerAddress
object
The end customer's address.
5 properties
BeaconUserGetRequest
object
Request input for fetching a Beacon User
3 properties
1 required
WatchlistScreeningReview
object
A review submitted by a team member for an individual watchlist screening. A review can be either a comment on the current screening state, actions taken again…
5 properties
5 required
TransferLedgerGetRequest
object
Defines the request schema for /transfer/ledger/get
3 properties
PartyIndividual
object
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
1 property
1 required
AuthMetadata
objectnull
Metadata that captures information about the Auth features of an institution.
1 property
1 required
AssetReportAuditCopyGetRequest
object
AssetReportAuditCopyGetRequest defines the request schema for /assetreport/auditcopy/get
3 properties
1 required
HistoricalBalance
object
An object representing a balance held by an account in the past
4 properties
4 required
ProcessorSignalDecisionReportRequest
object
ProcessorSignalDecisionReportRequest defines the request schema for /processor/signal/decision/report
9 properties
3 required
PersonalFinanceCategory
objectnull
Information describing the intent of the transaction. Most relevant for personal finance use cases, but not limited to such use cases. See the [taxonomy CSV fi…
3 properties
2 required
SignalPrepareRequest
object
SignalPrepareRequest defines the request schema for /signal/prepare
3 properties
1 required
TransferQuestionnaireCreateRequest
object
Defines the request schema for /transfer/questionnaire/create
4 properties
2 required
RemovedTransaction
object
A representation of a removed transaction
2 properties
2 required
MultiDocumentRiskSignal
object
Object containing risk signals and relevant metadata for a set of uploaded documents
2 properties
2 required
TransferAuthorizationRiskLevel
stringnull
Comprises five risk categories (high risk, medium-high risk, medium risk, medium-low risk, low risk) based on the probability of return
TransferListRequest
object
Defines the request schema for /transfer/list
9 properties
TransferOriginatorGetResponse
object
Defines the response schema for /transfer/originator/get
2 properties
2 required
CreditPayrollIncomeRefreshRequestOptions
object
An optional object for /credit/payrollincome/refresh request options.
2 properties
TransferNetwork
string
The network or rails used for the transfer. For transfers submitted as ach, the next-day cutoff is 5:30 PM Eastern Time. For transfers submitted as same-day-ac…
SignalUser
object
Details about the end user initiating the transaction (i.e., the account holder). When calling /signal/evaluate or /signal/processor/evaluate, this field is op…
4 properties
CreditRelayRefreshRequest
object
CreditRelayRefreshRequest defines the request schema for /credit/relay/refresh
5 properties
2 required
LinkTokenCreateIdentity
object
Identity object used to specify document upload
2 properties
ItemId
string
The itemid of the Item associated with this webhook, warning, or error
BeaconReportGetRequest
object
Request input for getting a Beacon Report
3 properties
1 required
TransferOriginatorGetRequest
object
Defines the request schema for /transfer/originator/get
3 properties
1 required
LinkSessionExitMetadata
objectnull
Displayed if a user exits Link without successfully linking an Item.
4 properties
TransferEventType
string
The type of event that this transfer represents. Event types with prefix sweep represents events for Plaid Ledger sweeps. pending: A new transfer was created;…
AssetReportTokenNullable
string
A token that can be provided to endpoints such as /assetreport/get or /assetreport/pdf/get to fetch or update an Asset Report.
BankTransferMetadata
objectnull
The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply: The JSON values must be Strings (no nes…
CreditBankStatementUploadObject
object
An object containing data that has been parsed from a user-uploaded bank statement.
4 properties
4 required
HostedLinkCompletionRedirectURI
string
URI that Hosted Link will redirect to upon completion of the Link flow. This will only occur in Hosted Link sessions, not in other implementation methods.
TransferOriginatorFundingAccountUpdateRequest
object
Defines the request schema for /transfer/originator/fundingaccount/update
4 properties
2 required
AssetReportInvestments
object
A transaction within an investment account.
15 properties
15 required
BeaconReportListRequest
object
Request input for listing Beacon Reports
4 properties
1 required
Asset
object
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
5 properties
5 required
GenericScreeningHitLocationItems
object
Analyzed location information for the associated hit
2 properties
CreditPayStubNetPay
object
An object representing information about the net pay amount on the pay stub.
5 properties
5 required
WatchlistScreeningIndividualListResponse
object
Paginated list of individual watchlist screenings.
3 properties
3 required
EnrichTransactionDirection
string
The direction of the transaction from the perspective of the account holder: OUTFLOW - Includes outgoing transfers, purchases, and fees. (Typically represented…
IPAddress
stringnull
An IPv4 or IPV6 address.
TotalCanonicalDescription
stringnull
Commonly used term to describe the line item.
Strategy
string
An instruction specifying what steps the new Identity Verification attempt should require the user to complete: reset - Restart the user at the beginning of th…
SandboxTransferLedgerSimulateAvailableRequest
object
Defines the request schema for /sandbox/transfer/ledger/simulateavailable
3 properties
PartnerCustomerOAuthInstitutionsGetResponse
object
Response schema for /partner/customer/oauthinstitutions/get.
4 properties
DocumentRiskSignalsObject
object
Object containing fraud risk data for a set of income documents.
3 properties
3 required
CategoryInsightDetails
object
Insights object for categories.
5 properties
4 required
ClientProvidedTransaction
object
A client-provided transaction for Plaid to enrich.
12 properties
5 required
Scopes
object
The scopes object
3 properties
FDXFiAttribute
object
Financial Institution provider-specific attribute
2 properties
2 required
WalletTransactionCounterpartyNumbers
object
The counterparty's bank account numbers. Exactly one of IBAN or BACS data is required.
2 properties
BeaconReportCreateRequest
object
Request input for creating a Beacon Report
6 properties
3 required
EntityWatchlistScreeningSearchTerms
object
Search terms associated with an entity used for searching against watchlists
8 properties
8 required
CreditAuditCopyTokenCreateRequest
object
CreditAuditCopyTokenCreateRequest defines the request schema for /credit/auditcopytoken/create
3 properties
1 required
InvestmentsAuthGetNumbers
object
Identifying information for transferring holdings to an investments account.
2 properties
TransferDebitUsageConfiguration
objectnull
Specifies the originator's expected usage of debits. For all dollar amounts, use a decimal string with two digits of precision e.g. "10.00". This field is requ…
5 properties
5 required
IdentityDocumentUploadMetadata
object
In closed beta. Object representing metadata pertaining to the document.
5 properties
CreditFreddieMacLoans
object
A collection of loans that are part of a single deal.
1 property
1 required
TransferSweepListResponse
object
Defines the response schema for /transfer/sweep/list
2 properties
2 required
ConsentPaymentIdempotencyKey
string
A random key provided by the client, per unique consent payment. Maximum of 128 characters. The API supports idempotency for safely retrying requests without a…
LedgerDepositIdempotencyKey
string
A unique key provided by the client, per unique ledger deposit. Maximum of 50 characters. The API supports idempotency for safely retrying the request without…
ProcessorLiabilitiesGetRequest
object
ProcessorLiabilitiesGetRequest defines the request schema for /processor/liabilities/get
3 properties
1 required
SandboxTransferLedgerSimulateAvailableResponse
object
Defines the response schema for /sandbox/transfer/ledger/simulateavailable
1 property
1 required
CreditEmploymentItem
object
The object containing employment items.
3 properties
2 required
DocumentRiskSignal
objectnull
Details about a certain reason as to why a document could potentially be fraudulent.
8 properties
8 required
ISO8601Date
string
A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).
LinkSessionItemAddResult
object
The details of an Item add in Link.
3 properties
3 required
CustomerInitiatedRiskTier
integer
A tier corresponding to the projected likelihood that the transaction, if initiated, will be subject to a return. In the customerinitiatedreturnrisk object, th…
AssetReportUser
object
The user object allows you to provide additional information about the user to be appended to the Asset Report. All fields are optional. The firstname, lastnam…
7 properties
RecurringFrequency
stringnull
Describes the frequency of the transaction stream. WEEKLY: Assigned to a transaction stream that occurs approximately every week. BIWEEKLY: Assigned to a trans…
AssetReportPDFGetResponse
string
AssetReportPDFGetResponse defines the response schema for /assetreport/pdf/get
Security
object
Contains details about a security
18 properties
17 required
Warning
object
It is possible for an Asset Report to be returned with missing account owner information. In such cases, the Asset Report will contain warning data in the resp…
3 properties
3 required
CreditBankIncomePDFGetResponse
string
CreditBankIncomePDFGetResponse defines the response schema for /credit/bankincome/pdf/get
PaymentInitiationRecipientListRequest
object
PaymentInitiationRecipientListRequest defines the request schema for /paymentinitiation/recipient/list
2 properties
EntityScreeningHitNames
object
Name information for the associated entity watchlist hit
3 properties
3 required
EntityScreeningHitAnalysis
object
Analysis information describing why a screening hit matched the provided entity information
7 properties
1 required
BaseReportGetRequest
object
BaseReportGetRequest defines the request schema for /cra/basereport/get
3 properties
1 required
Credit1099
object
An object representing an end user's 1099 tax form
52 properties
1 required
TransferMigrateAccountRequest
object
Defines the request schema for /transfer/migrateaccount
6 properties
3 required
CraLoanApplicationDecision
string
The decision of the loan application.
EntityWatchlistScreening
object
The entity screening object allows you to represent an entity in your system, update its profile, and search for it on various watchlists. Note: Rejected entit…
6 properties
6 required
WebhookVerificationKeyGetResponse
object
WebhookVerificationKeyGetResponse defines the response schema for /webhookverificationkey/get
2 properties
2 required
BeaconAccountRiskEvaluateAccount
object
An account in the /beacon/accountrisk/v1/evaluate response.
4 properties
AccountIdentity
Identity information about an account
ProfileIdentityName
objectnull
ProfileIdentityName defines the user's first name and last name.
2 properties
LinkTokenCreateHostedLink
object
Configuration parameters for Hosted Link. To request access to Hosted Link, contact your account manager.
4 properties
WatchlistScreeningEntityCreateResponse
object
The entity screening object allows you to represent an entity in your system, update its profile, and search for it on various watchlists. Note: Rejected entit…
7 properties
7 required
BeaconAccountRiskEvaluateRequest
object
BeaconAccountRiskEvaluateRequest defines the request schema for /v1/beacon/accountrisk/risk/evaluate
9 properties
Credit1099Payer
object
An object representing a payer used by 1099-MISC tax documents.
4 properties
LinkDeliveryOptions
object
Optional metadata related to the Hosted Link session
1 property
SignalReturnReportResponse
object
SignalReturnReportResponse defines the response schema for /signal/return/report
1 property
1 required
EmploymentVerification
object
An object containing proof of employment data for an individual
6 properties
TransferEventListResponse
object
Defines the response schema for /transfer/event/list
3 properties
3 required
IdentityMatchRequestOptions
object
An optional object to filter /identity/match results
1 property
ProcessorSignalEvaluateResponse
object
ProcessorSignalEvaluateResponse defines the response schema for /processor/signal/evaluate
4 properties
2 required
WalletCreateResponse
object
WalletCreateResponse defines the response schema for /wallet/create
3 required
PaymentInitiationRecipientGetResponse
PaymentInitiationRecipientGetResponse defines the response schema for /paymentinitiation/recipient/get
3 required
CreditBankStatementUploadBankAccountPeriod
object
An object containing data on the overall period of the statement.
4 properties
4 required
LinkTokenCreateRequestStatements
object
Specifies options for initializing Link for use with the Statements product. This field is required for the statements product.
2 properties
2 required
CraPartnerInsights
object
The partner insights report of the bank data for an end user.
4 properties
TransferDiligenceStatus
string
Originator’s diligence status.
TransactionsSyncRequestOptions
object
An optional object to be used with the request. If specified, options must not be null.
4 properties
InternalUID
string
A universal identifier for a watchlist individual that is stable across searches and updates.
ItemAccessTokenInvalidateRequest
object
ItemAccessTokenInvalidateRequest defines the request schema for /item/accesstoken/invalidate
3 properties
1 required
CreditBankStatementUploadAccountOwnerAddress
object
Address on the uploaded bank statement
5 properties
5 required
CreditEmploymentEmployeeType
stringnull
The type of employment for the individual. "FULLTIME": A full-time employee. "PARTTIME": A part-time employee. "CONTRACTOR": An employee typically hired extern…
DocumentRiskSignalInstitutionMetadata
objectnull
An object which contains additional metadata about the institution used to compute the verification attribute
1 property
1 required
CraBankIncomeWarningCode
string
The warning code identifies a specific kind of warning. IDENTITYUNAVAILABLE: Unable to extract identity for the Item TRANSACTIONSUNAVAILABLE: Unable to extract…
AssetReport
object
An object representing an Asset Report
6 properties
6 required
ItemStatusInvestments
objectnull
Information about the last successful and failed investments update for the Item.
2 properties
IncomeVerificationDocParsingConfig
string
Analysis options to enable for document parsing
CreditFreddieMacIndividualName
object
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
3 properties
3 required
AssetReportCreateRequestOptions
object
An optional object to filter /assetreport/create results. If provided, must be non-null. The optional user object is required for the report to be eligible for…
6 properties
TransferIntentGetRequest
object
Defines the request schema for /transfer/intent/get
3 properties
1 required
IdentityDocument
object
Document object with metadata of the document uploaded
2 properties
PaymentConsentPeriodicAmountAmount
Maximum cumulative amount for all payments in the specified interval.
OmittableTransferType
string
The type of transfer. Valid values are debit or credit. A debit indicates a transfer of money into the origination account; a credit indicates a transfer of mo…
AssetTransactionType
string
Asset Transaction Type.
PaymentInitiationConsentScope
string
Payment consent scope. Defines possible directions for payments made with the given consent. METOME: Allows moving money between accounts owned by the same use…
ConsumerReportPDFGetRequest
object
ConsumerReportPDFGetRequest defines the request schema for /consumerreport/pdf/get
3 properties
1 required
PlatformIds
object
An object containing a set of ids related to an employee
3 properties
IdentityDocumentUpload
object
Document object with metadata of the uploaded document
3 properties
IncomeVerificationSourceType
string
The types of source income data that users should be able to share
PaymentInitiationPaymentCreateRequest
object
PaymentInitiationPaymentCreateRequest defines the request schema for /paymentinitiation/payment/create
7 properties
3 required
WatchlistScreeningIndividualReviewListRequest
object
Request input for listing reviews for an individual watchlist screening
4 properties
1 required
CraLoansApplicationsRegisterRequest
object
CraLoansApplicationsRegisterRequest defines the request schema for /cra/loans/applications/register.
3 properties
1 required
CraLoanClosedStatus
object
Contains the status and date information of the loan when unregistering.
2 properties
2 required
SignalPersonName
objectnull
The user's legal name
5 properties
CreditBankIncomeHistoricalSummary
object
The end user's monthly summary for the income source(s).
7 properties
WatchlistScreeningIndividualHistoryListRequest
object
Request input for listing changes to watchlist screenings for individuals
4 properties
1 required
LinkDeliveryGetRequest
object
LinkDeliveryGetRequest defines the request schema for /linkdelivery/get
3 properties
1 required
CreditFreddieMacVerificationOfAsset
object
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
3 properties
3 required
EntityScreeningHitEmailsItems
object
Analyzed emails for the associated hit
2 properties
AddressData
object
Data about the components comprising an address.
5 properties
5 required
TransferSweepStatus
stringnull
The status of the sweep for the transfer. unswept: The transfer hasn't been swept yet. swept: The transfer was swept to the sweep account. sweptsettled: Credit…
CreditPlatformIds
object
The object containing a set of ids related to an employee.
3 properties
3 required
TaxpayerID
object
Taxpayer ID of the individual receiving the paystub.
3 properties
AssetReportTransactionType
string
digital: transactions that took place online. place: transactions that were made at a physical location. special: transactions that relate to banks, e.g. fees…
Status
object
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
2 properties
2 required
EmailAddressMatchScore
objectnull
Score found by matching email provided by the API with the email on the account at the financial institution. 100 is a perfect match and 0 is a no match. If th…
1 property
Category
object
Information describing a transaction category
3 properties
3 required
KYCCheckDateOfBirthSummary
object
Result summary object specifying how the dateofbirth field matched.
1 property
1 required
BeaconUserUpdateRequest
object
Request input for updating the identity data of a Beacon User.
4 properties
2 required
AccountsBalanceGetResponsePaymentRiskAssessment
objectnull
This object provides detailed risk assessment for the requested transaction
6 properties
RiskReason
object
This object includes a code and description to describe medium risk transactions and above on /accounts/balance/get.
2 properties
IncomeBreakdown
object
An object representing a breakdown of the different income types on the paystub.
4 properties
4 required
RequestID
string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
WatchlistScreeningEntityReviewCreateRequest
object
Request input for creating a review for an entity screening
6 properties
3 required
WalletTransactionExecuteResponse
object
WalletTransactionExecuteResponse defines the response schema for /wallet/transaction/execute
3 properties
3 required
ItemImportRequestUserAuth
object
Object of user ID and auth token pair, permitting Plaid to aggregate a user’s accounts
2 properties
2 required
TransferRecurringCancelResponse
object
Defines the response schema for /transfer/recurring/cancel
1 property
1 required
PaymentConsentMaxPaymentAmount
Maximum amount of a single payment initiated using the payment consent.
SandboxPublicTokenCreateResponse
object
SandboxPublicTokenCreateResponse defines the response schema for /sandbox/publictoken/create
2 properties
2 required
IncomeVerificationPrecheckConfidence
string
The confidence that Plaid can support the user in the digital income verification flow instead of requiring a manual paystub upload. One of the following: "HIG…
SandboxTransferRepaymentSimulateRequest
object
Defines the request schema for /sandbox/transfer/repayment/simulate
2 properties
CraLoanType
string
The type of loan the user applied for.
CreditFreddieMacServices
object
A collection of objects that describe requests and responses for services.
1 property
1 required
OptionContract
objectnull
Details about the option security. For the Sandbox environment, this data is currently only available if the item is using a custom configuration object, and t…
4 properties
4 required
CraBankIncomeHistoricalSummary
object
The end user's monthly summary for the income source(s).
4 properties
TransferUserInResponse
object
The legal name and other information for the account holder.
4 properties
4 required
BeaconAuditTrailSource
string
A type indicating what caused a resource to be changed or updated. dashboard - The resource was created or updated by a member of your team via the Plaid dashb…
PaystubEmployer
object
Information about the employer on the paystub
2 properties
1 required
AssetTransactionDetail
object
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
9 properties
9 required
TransferRecurringIdempotencyKey
string
A random key provided by the client, per unique recurring transfer. Maximum of 50 characters. The API supports idempotency for safely retrying requests without…
CreditPayStub
object
An object representing an end user's pay stub.
8 properties
8 required
AssetReportRefreshRequestOptions
object
An optional object to filter /assetreport/refresh results. If provided, cannot be null. If not specified, the options from the original call to /assetreport/cr…
3 properties
LinkTokenCreateRequestIdentityVerification
object
Specifies option for initializing Link for use with the Identity Verification product.
3 properties
1 required
IdentityVerificationConsent
boolean
A flag specifying whether the end user has already agreed to a privacy policy specifying that their data will be shared with Plaid for verification purposes. I…
BeaconAuditTrail
object
Information about the last change made to the parent object specifying what caused the change as well as when it occurred.
3 properties
3 required
IdentityVerificationDocumentISO8601DateOfBirth
stringnull
A date extracted from the document in the format YYYY-MM-DD (RFC 3339 Section 5.6).
TransferOriginatorListResponse
object
Defines the response schema for /transfer/originator/list
2 properties
2 required
UserStatedIncomeSourcePayType
string
The pay type - GROSS, NET, or UNKNOWN for a specified income source
IdentityDocumentMetadata
object
In closed beta. Object representing metadata pertaining to the document.
3 properties
AssetTransaction
object
An object representing...
2 properties
2 required
RecurringTransactions
object
Insights object for recurring transactions for /beta/transactions/userinsights/v1/get endpoint
2 properties
2 required
LinkTokenCreateRequestUpdate
object
Specifies options for initializing Link for [update mode](https://plaid.com/docs/link/update-mode).
1 property
DepositoryAccountSubtypes
array
An array of account subtypes to display in Link. If not specified, all account subtypes will be shown. For a full list of valid types and subtypes, see the [Ac…
PhysicalDocumentImages
object
URLs for downloading original and cropped images for this document submission. The URLs are designed to only allow downloading, not hot linking, so the URL wil…
5 properties
5 required
TransferAuthorizationCancelRequest
object
Defines the request schema for /transfer/authorization/cancel
3 properties
1 required
PayrollRiskSignalsItem
object
Object containing fraud risk data pertaining to the Item linked as part of the verification.
2 properties
2 required
TransferBalance
object
Information about the balance held with Plaid.
3 properties
2 required
LinkSessionExit
objectnull
An object representing an [onExit](https://plaid.com/docs/link/web/onexit) callback from Link.
2 properties
2 required
WatchlistScreeningStatus
string
A status enum indicating whether a screening is still pending review, has been rejected, or has been cleared.
TransferLedgerGetResponse
object
Defines the response schema for /transfer/ledger/get
2 properties
2 required
AccountAccess
object
Allow or disallow product access by account. Unlisted (e.g. missing) accounts will be considered newaccounts.
3 properties
1 required
TransferDiligenceDocumentUploadRequest
object
Defines the request schema for /transfer/diligence/document/upload
3 properties
3 required
ItemStatusLastWebhook
objectnull
Information about the last webhook fired for the Item.
2 properties
WatchlistScreeningEntityHistoryListResponse
object
Paginated list of entity watchlist screenings
3 properties
3 required
LinkTokenGetMetadataResponse
object
An object specifying the arguments originally provided to the /link/token/create call.
9 properties
6 required
NumbersACH
object
Identifying information for transferring money to or from a US account via ACH or wire transfer.
6 properties
4 required
WatchlistScreeningEntityHitListRequest
object
Request input for listing hits for an entity watchlist screening
4 properties
1 required
UserStatedIncomeSourceCategory
string
The income category for a specified income source
IDNumberValue
string
Value of identity document value typed in by user. Alpha-numeric, with all formatting characters stripped. For specific format requirements by ID type, see [Hy…
CreditBankIncomePDFGetRequest
object
CreditBankIncomePDFGetRequest defines the request schema for /credit/bankincome/pdf/get
3 properties
1 required
EntityWatchlistSearchTerms
object
Search inputs for creating an entity watchlist screening
7 properties
2 required
TransferGetRequest
object
Defines the request schema for /transfer/get
4 properties
1 required
SandboxTransferSweepSimulateResponse
object
Defines the response schema for /sandbox/transfer/sweep/simulate
2 properties
1 required
BaseReportWarningCode
string
The warning code identifies a specific kind of warning. OWNERSUNAVAILABLE indicates that account-owner information is not available. TRANSACTIONSUNAVAILABLE in…
ProcessorSignalReturnReportResponse
object
ProcessorSignalReturnReportResponse defines the response schema for /processor/signal/return/report
1 property
1 required
PaymentProfileRemoveRequest
object
PaymentProfileRemoveRequest defines the request schema for /paymentprofile/remove
3 properties
1 required
PartnerEndCustomerCustomerSupportInfo
object
This information is public. Users of your app will see this information when managing connections between your app and their bank accounts in Plaid Portal. Def…
4 properties
TransferAuthorizationGuaranteeDecision
stringnull
Indicates whether the transfer is guaranteed by Plaid (Guarantee customers only). This field will contain either GUARANTEED or NOTGUARANTEED indicating whether…
IdentityDocumentUploadRiskSummary
object
Risk summary of an uploaded document
1 property
POBoxStatus
string
Field describing whether the associated address is a post office box. Will be yes when a P.O. box is detected, no when Plaid confirmed the address is not a P.O…
SandboxProcessorTokenCreateResponse
object
SandboxProcessorTokenCreateResponse defines the response schema for /sandbox/processortoken/create
2 properties
2 required
CreditBankIncomeCause
object
An error object and associated itemid used to identify a specific Item and error when a batch operation operating on multiple Items has encountered an error in…
5 properties
5 required
WatchlistScreeningIndividualProgramGetResponse
object
A program that configures the active lists, search parameters, and other behavior for initial and ongoing screening of individuals.
9 properties
9 required
CreditBankIncomeRefreshRequestOptions
object
An optional object for /credit/bankincome/refresh request options.
1 property
PaymentInitiationConsentRevokeResponse
object
PaymentInitiationConsentRevokeResponse defines the response schema for /paymentinitation/consent/revoke
1 property
ProcessorTransactionsRecurringGetResponse
object
ProcessorTransactionsRecurringGetResponse defines the response schema for /processor/transactions/recurring/get
4 properties
4 required
WatchlistScreeningEntityProgramGetResponse
object
A program that configures the active lists, search parameters, and other behavior for initial and ongoing screening of entities.
9 properties
9 required
WalletListRequest
object
WalletListRequest defines the request schema for /wallet/list
5 properties
RiskCheckEmailTopLevelDomainIsSuspicious
string
Indicates whether the email address top level domain, which is the last part of the domain, is fraudulent or risky if known. In most cases, a suspicious top le…
MerchantInsights
object
Insights into a user’s top merchants.
8 properties
7 required
WatchlistScreeningIndividualListRequest
object
Request input for listinging watchlist screenings for individuals
7 properties
1 required
Role
object
ADocumentation not found in the MISMO model viewer and not provided by Freddie Mac.
1 property
1 required
IdentityVerificationStepStatus
string
The status of a step in the Identity Verification process.
LinkSessionPayrollIncomeResult
object
The details of a digital payroll income verification in Link.
3 properties
3 required
TransferAuthorizationGuaranteeDecisionRationale
objectnull
The rationale for Plaid's decision to not guarantee a transfer. Will be null unless guaranteedecision is NOTGUARANTEED.
2 properties
2 required
IdentityDocumentsUploadsGetRequestOptions
object
An optional object to filter /identity/documents/uploads/get results.
1 property
TransferACHNetwork
string
The ACH networks used for the funds flow. For requests submitted as either ach or same-day-ach the cutoff for same-day is 3:30 PM Eastern Time and the cutoff f…
TransferCapabilitiesGetResponse
object
Defines the response schema for /transfer/capabilities/get
2 properties
2 required
CreditFreddieMacAssets
object
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
1 property
1 required
LinkSessionSuccessMetadataInstitution
objectnull
An institution object. If the Item was created via Same-Day or Instant micro-deposit verification, will be null.
2 properties
RiskCheckEmailDomainIsFreeProvider
string
Indicates whether the email address domain is a free provider such as Gmail or Hotmail if known.
CreditPayrollIncomeRiskSignalsGetRequest
object
CreditPayrollIncomeRiskSignalsGetRequest defines the request schema for /credit/payrollincome/risksignals/get
3 properties
CreditFreddieMacParty
object
A collection of information about a single party to a transaction. Included direct participants like the borrower and seller as well as indirect participants s…
3 properties
3 required
TransferCreateIdempotencyKey
string
Deprecated. authorizationid is now used as idempotency instead. A random key provided by the client, per unique transfer. Maximum of 50 characters. The API sup…
OtherAccountSubtype
string
Valid account subtypes for other accounts. For a list containing descriptions of each subtype, see [Account schemas](https://plaid.com/docs/api/accounts/Standa…
DocumentRiskSummary
object
A summary across all risk signals associated with a document
1 property
1 required
AddressPurposeLabel
string
Field describing whether the associated address is being used for commercial or residential purposes. Note: This value will be nodata when Plaid does not have…
AccountVerificationInsights
object
Insights from performing database verification for the account.
3 properties
2 required
SandboxTransferFireWebhookRequest
object
Defines the request schema for /sandbox/transfer/firewebhook
3 properties
1 required
PaymentInitiationConsentRevokeRequest
object
PaymentInitiationConsentRevokeRequest defines the request schema for /paymentinitiation/consent/revoke
3 properties
1 required
ServiceProductFulfillment
object
A collection of details related to a fulfillment service or product in terms of request, process and result.
1 property
1 required
TransferIntentCreate
object
Represents a transfer intent within Transfer UI.
15 properties
10 required
StudentRepaymentPlan
object
An object representing the repayment plan for the student loan
2 properties
2 required
EmploymentSourceType
string
The types of source employment data that users should be able to share
URLNullable
stringnull
An 'http' or 'https' URL (must begin with either of those).
PrismCashScore
objectnull
The data from the Cash Score product returned by Prism.
4 properties
2 required
TransactionsGetRequestOptions
object
An optional object to be used with the request. If specified, options must not be null.
8 properties
NumbersATON
object
Identifying information for transferring holdings to an investments account via ATON.
2 properties
2 required
EntityScreeningHitsPhoneNumberItems
object
Analyzed phone numbers for the associated hit
2 properties
InvestmentsTransactionsGetRequest
object
InvestmentsTransactionsGetRequest defines the request schema for /investments/transactions/get
6 properties
3 required
CraLoanRegister
object
Contains loan data to register.
8 properties
6 required
IncomeVerificationPayrollFlowType
string
Flow types to retrieve payroll income data
EntityWatchlistScreeningReviewID
string
ID of the associated entity review.
InstitutionsSearchPaymentInitiationOptions
objectnull
Additional options that will be used to filter institutions by various Payment Initiation configurations.
2 properties
PaymentInitiationRecipientGetRequest
object
PaymentInitiationRecipientGetRequest defines the request schema for /paymentinitiation/recipient/get
3 properties
1 required
CreditPayrollIncomePrecheckRequest
object
Defines the request schema for /credit/payrollincome/precheck.
7 properties
ProcessorTransactionsRefreshRequest
object
ProcessorTransactionsRefreshRequest defines the request schema for /processor/transactions/refresh
3 properties
1 required
BankTransferStatus
string
The status of the transfer.
ProcessorTokenPermissionsGetResponse
object
ProcessorTokenPermissionsGetResponse defines the response schema for /processor/token/permissions/get
2 properties
2 required
EntityWatchlistScreeningID
string
ID of the associated entity screening.
TransferRefundStatus
string
The status of the refund. pending: A new refund was created; it is in the pending state. posted: The refund has been successfully submitted to the payment netw…
TransferCreditUsageConfiguration
objectnull
Specifies the originator's expected usage of credits. For all dollar amounts, use a decimal string with two digits of precision e.g. "10.00". This field is req…
5 properties
5 required
TransferMetricsGetRequest
object
Defines the request schema for /transfer/metrics/get
3 properties
WalletTransactionFailureReason
stringnull
The error code of a failed transaction. Error codes include: EXTERNALSYSTEM: The transaction was declined by an external system. EXPIRED: The transaction reque…
TransactionsRecurringGetRequestOptions
object
An optional object to be used with the request. If specified, options must not be null.
1 property
NumbersACHNullable
Identifying information for transferring money to or from a US account via ACH or wire transfer.
WatchlistScreeningEntityUpdateRequestResettableField
string
The name of a field that can be reset back to null
TransferLedgerFundingAccountIDRequest
stringnull
Specify which funding account linked to this Plaid Ledger to use. Customers can find a list of fundingaccountids in the Accounts page of your Plaid Dashboard,…
TransactionsGetRequest
object
TransactionsGetRequest defines the request schema for /transactions/get
6 properties
3 required
TransferType
string
The type of transfer. This will be either debit or credit. A debit indicates a transfer of money into the origination account; a credit indicates a transfer of…
GenericCountryCodeNullable
stringnull
Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.
ProxyType
stringnull
An enum indicating whether a network proxy is present and if so what type it is. nonedetected indicates the user is not on a detectable proxy network. tor indi…
PayStubDistributionBreakdown
object
Information about the accounts that the payment was distributed to.
7 properties
7 required
IssuingCountry
string
A binary match indicator specifying whether the country that issued the provided document matches the country that the user separately provided to Plaid. Note:…
CraLoanOpenedStatus
object
Contains the status and date information of the loan when registering.
2 properties
2 required
AssetReportId
string
A unique ID identifying an Asset Report. Like all Plaid identifiers, this ID is case sensitive.
BaseReportNumberFlowInsights
object
The number of credits or debits out of the account. This field will only added for depository accounts
3 properties
EntityScreeningHitUrls
object
URLs associated with the entity screening hit
1 property
1 required
RiskCheckBehaviorBotDetectedLabel
string
Field describing the outcome of a bot detection behavior risk check. yes indicates that automated activity was detected. no indicates that automated activity w…
BankTransferEventType
string
The type of event that this bank transfer represents. pending: A new transfer was created; it is in the pending state. cancelled: The transfer was cancelled by…
InvestmentAccountSubtype
string
Valid account subtypes for investment accounts. For a list containing descriptions of each subtype, see [Account schemas](https://plaid.com/docs/api/accounts/S…
SandboxBankIncomeWebhookFireRequestWebhookFields
object
Optional fields which will be populated in the simulated webhook
2 properties
1 required
BeaconUserRequestAddress
objectnull
Home address for the associated user. For more context on this field, see [Input Validation by Country](https://plaid.com/docs/identity-verification/hybrid-inp…
6 properties
3 required
CreditBankIncomeErrorType
string
A broad categorization of the error. Safe for programmatic use.
CreditAmountWithCurrency
object
This contains an amount, denominated in the currency specified by either isocurrencycode or unofficialcurrencycode
3 properties
LoanIdentifierType
stringnull
A value from a MISMO prescribed list that specifies the type of loan identifier.
ConsumerReportPDFGetResponse
string
ConsumerReportPDFGetResponse defines the response schema for /consumerreport/pdf/get
AssetReportTransaction
object
A transaction on the asset report
21 properties
8 required
AssetHolderName
object
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
1 property
1 required
SandboxBankTransferFireWebhookRequest
object
Defines the request schema for /sandbox/banktransfer/firewebhook
3 properties
1 required
SandboxTransferRepaymentSimulateResponse
object
Defines the response schema for /sandbox/transfer/repayment/simulate
1 property
1 required
PaymentScheme
stringnull
Payment scheme. If not specified - the default in the region will be used (e.g. SEPACREDITTRANSFER for EU). Using unsupported values will result in a failed pa…
IdentityVerificationDocumentRegion
stringnull
An ISO 3166-2 subdivision code extracted from the document. Related terms would be "state", "province", "prefecture", "zone", "subdivision", etc.
PayStubDeductionsTotal
object
An object representing the total deductions for the pay period
4 properties
4 required
BankTransferCancelRequest
object
Defines the request schema for /banktransfer/cancel
3 properties
1 required
CreditBankIncomeWarningCode
string
The warning code identifies a specific kind of warning. IDENTITYUNAVAILABLE: Unable to extract identity for the Item TRANSACTIONSUNAVAILABLE: Unable to extract…
PaymentInitiationConsentGetRequest
object
PaymentInitiationConsentGetRequest defines the request schema for /paymentinitiation/consent/get
3 properties
1 required
TransactionStreamStatus
string
The current status of the transaction stream. MATURE: A MATURE recurring stream should have at least 3 transactions and happen on a regular cadence (For Annual…
TransferMigratedFundingAccountIDRequest
stringnull
Specify the account used to fund the transfer. Should be specified if using legacy funding methods only. If using Plaid Ledger, leave this field blank. Custome…
SignalEvaluateRequest
object
SignalEvaluateRequest defines the request schema for /signal/evaluate
13 properties
4 required
ClientUserID
string
A unique ID that identifies the end user in your system. This ID can also be used to associate user-specific data from other Plaid products. Financial Account…
CreditAccountSubtypes
array
An array of account subtypes to display in Link. If not specified, all account subtypes will be shown. For a full list of valid types and subtypes, see the [Ac…
LinkSessionSuccessMetadataTransferStatus
stringnull
The status of a transfer. Returned only when [Transfer UI](/docs/transfer/using-transfer-ui) is implemented. - COMPLETE – The transfer was completed. - INCOMPL…
SignalDecisionReportRequest
object
SignalDecisionReportRequest defines the request schema for /signal/decision/report
8 properties
2 required
FDXNotificationType
string
Type of Notification
PhoneType
string
An enum indicating whether a phone number is a phone line or a fax line.
SignalPrepareResponse
object
SignalPrepareResponse defines the response schema for /signal/prepare
1 property
1 required
DepositSwitchAltCreateRequest
object
DepositSwitchAltCreateRequest defines the request schema for /depositswitch/alt/create
6 properties
2 required
CreditBankEmploymentReport
object
The report of the Bank Employment data for an end user.
5 properties
5 required
ProcessorIdentityMatchRequest
object
ProcessorIdentityMatchRequest defines the request schema for /processor/identity/match
4 properties
1 required
BaseReportAverageMonthlyBalances
object
Average balance in dollar amount per month
3 properties
TransferSweepGetRequest
object
Defines the request schema for /transfer/sweep/get
3 properties
1 required
OtherAccountSubtypes
array
An array of account subtypes to display in Link. If not specified, all account subtypes will be shown. For a full list of valid types and subtypes, see the [Ac…
WatchlistScreeningEntityReviewCreateResponse
object
A review submitted by a team member for an entity watchlist screening. A review can be either a comment on the current screening state, actions taken against h…
6 properties
6 required
SelfieCheckStatus
string
The outcome status for the associated Identity Verification attempt's selfiecheck step. This field will always have the same value as steps.selfiecheck.
CraLoanID
string
A unique identifier for the loan. Personally identifiable information, such as an email address or phone number, should not be used in the loanid.
TransferRefundFailure
objectnull
The failure reason if the event type for a refund is "failed" or "returned". Null value otherwise.
2 properties
CustomerInitiatedReturnRisk
object
The object contains a risk score and a risk tier that evaluate the transaction return risk of an unauthorized debit. Common return codes in this category inclu…
2 properties
2 required
IndividualWatchlistCode
string
Shorthand identifier for a specific screening list for individuals. AUCON: Australia Department of Foreign Affairs and Trade Consolidated List CACON: Governmen…
BeaconUserHistoryListRequest
object
Request input for listing the history of a Beacon User
4 properties
1 required
CreditPayStubEmployer
object
Information about the employer on the pay stub.
2 properties
2 required
BaseReportId
string
A unique ID identifying an Base Report. Like all Plaid identifiers, this ID is case sensitive.
TransferIntentCreateRequest
object
Defines the request schema for /transfer/intent/create
14 properties
4 required
ProfileIdentity
objectnull
ProfileIdentity defines the identity data permissioned by the end user during the authorization flow.
7 properties
WatchlistScreeningHitLocations
object
Location information for the associated individual watchlist hit
2 properties
2 required
RiskCheckDetails
objectnull
Additional information for the riskcheck step.
6 properties
6 required
ExternalPaymentRefundDetails
objectnull
Details about external payment refund
3 properties
3 required
FDXNotificationPayload
object
Custom key-value pairs payload for a notification
3 properties
SandboxOauthSelectAccountsResponse
object
Defines the response schema for /sandbox/oauth/selectaccounts
TransferLedgerWithdrawResponse
object
Defines the response schema for /transfer/ledger/withdraw
2 properties
2 required
WatchlistScreeningEntityListResponse
object
Paginated list of entity watchlist screenings
3 properties
3 required
SelfieCapture
object
The image or video capture of a selfie. Only one of image or video URL will be populated per selfie.
2 properties
2 required
ItemRemoveRequest
object
ItemRemoveRequest defines the request schema for /item/remove
3 properties
1 required
ProductStatus
objectnull
A representation of the status health of a request type. Auth requests, Balance requests, Identity requests, Investments requests, Liabilities requests, Transa…
3 properties
3 required
SweepDescription
stringnull
The description of the deposit that will be passed to the receiving bank (up to 10 characters). Note that banks utilize this field differently, and may or may…
EntityScreeningHitData
object
Information associated with the entity watchlist hit
6 properties
TransferAuthorizationDevice
object
Information about the device being used to initiate the authorization. These fields are not currently incorporated into the risk check.
2 properties
OtherFilter
object
A filter to apply to other-type accounts
1 property
1 required
PaymentInitiationRecipientCreateRequest
object
PaymentInitiationRecipientCreateRequest defines the request schema for /paymentinitiation/recipient/create
6 properties
1 required
TransferRefundCancelResponse
object
Defines the response schema for /transfer/refund/cancel
1 property
1 required
FDXHateoasLink
object
REST application constraint (Hypermedia As The Engine Of Application State)
4 properties
1 required
NumbersInternationalIBAN
objectnull
Account numbers using the International Bank Account Number and BIC/SWIFT code format.
2 properties
2 required
LiabilitiesObject
object
An object containing liability accounts
3 properties
3 required
ScopesContext
string
An indicator for when scopes are being updated. When scopes are updated via enrollment (i.e. OAuth), the partner must send ENROLLMENT. When scopes are updated…
SandboxTransferTestClockListRequest
object
Defines the request schema for /sandbox/transfer/testclock/list
6 properties
EntityWatchlistScreeningName
string
The name of the organization being screened.
PartnerCustomerCreateResponse
object
Response schema for /partner/customer/create.
2 properties
ProductAccess
object
The product access being requested. Used to or disallow product access across all accounts. If unset, defaults to all products allowed.
9 properties
Application
object
Metadata about the application
13 properties
13 required
TransferID
string
Plaid’s unique identifier for a transfer.
LastDataAccessTimes
object
Describes the last time each datatype was accessed by an application.
9 properties
9 required
Deductions
object
An object with the deduction information found on a paystub.
4 properties
2 required
TransactionsRuleType
string
Transaction rule's match type. For TRANSACTIONID field, EXACTMATCH is available. Matches are case sensitive.
ProcessorAuthGetRequest
object
ProcessorAuthGetRequest defines the request schema for /processor/auth/get
3 properties
1 required
TransferRepaymentReturnListResponse
object
Defines the response schema for /transfer/repayments/return/list
2 properties
2 required
LinkSessionExitMetadataInstitution
objectnull
An institution object. If the Item was created via Same-Day or Instant micro-deposit verification, will be null.
2 properties
TransferEventListTransferType
stringnull
The type of transfer. This will be either debit or credit. A debit indicates a transfer of money into your origination account; a credit indicates a transfer o…
PayStubEarningsTotal
object
An object representing both the current pay period and year to date amount for an earning category.
5 properties
5 required
PostalCode
stringnull
The postal code for the associated address. Between 2 and 10 alphanumeric characters. For US-based addresses this must be 5 numeric digits.
BeaconReportSyndicationID
string
ID of the associated Beacon Report Syndication.
LoanAccountSubtype
string
Valid account subtypes for loan accounts. For a list containing descriptions of each subtype, see [Account schemas](https://plaid.com/docs/api/accounts/Standal…
Recurrence
objectnull
Insights relating to expenses and deposits that are predicted to occur on a scheduled basis, such as biweekly, monthly, or annually. Common examples include lo…
2 properties
Source
string
A type indicating whether a dashboard user, an API-based user, or Plaid last touched this object.
StatementsDownloadResponse
string
StatementsDownloadResponse defines the response schema for /statements/download. The response will contain a Plaid-Content-Hash header containing a SHA 256 che…
DocType
string
The type of document. DOCUMENTTYPEPAYSTUB: A paystub. DOCUMENTTYPEBANKSTATEMENT: A bank statement. DOCUMENTTYPEUSTAXW2: A W-2 wage and tax statement provided b…
NumbersBACSNullable
Identifying information for transferring money to or from a UK bank account via BACS.
ProfileIdentityAddress
objectnull
ProfileIdentityAddress defines the user's address.
6 properties
AddressDataNullableNoRequiredFields
Data about the components comprising an address.
StudentLoan
object
Contains details about a student loan account
24 properties
24 required
CreditAuditCopyTokenRemoveRequest
object
CreditAuditCopyTokenRemoveRequest defines the request schema for /credit/auditcopytoken/remove
3 properties
1 required
SenderBACSNullable
An object containing a BACS account number and sort code. If an IBAN is not provided or if this recipient needs to accept domestic GBP-denominated payments, BA…
ExternalPaymentScheduleRequest
The schedule that the payment will be executed on. If a schedule is provided, the payment is automatically set up as a standing order. If no schedule is specif…
3 required
SweepTrigger
stringnull
The trigger of the sweep "manual" - The sweep is created manually by the customer "incoming" - The sweep is created by incoming funds flow (e.g. Incoming Wire)…
IdentityVerificationRequestUser
objectnull
User information collected outside of Link, most likely via your own onboarding process. Each of the following identity fields are optional: emailaddress phone…
6 properties
CreditW2
object
W2 is an object that represents income data taken from a W2 tax document.
23 properties
23 required
CraLoanUserToken
string
The user token for the user associated with the loan.
TransferAuthorizationProposedTransfer
object
Details regarding the proposed transfer.
12 properties
9 required
Pay
object
An object representing a monetary amount.
2 properties
PayStubTaxpayerID
object
Taxpayer ID of the individual receiving the paystub.
2 properties
2 required
VerificationOfAsset
object
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
3 properties
3 required
LinkSessionExitDeprecated
objectnull
An object representing an [onExit](https://plaid.com/docs/link/web/onexit) callback from Link.
2 properties
2 required
Activity
object
Describes a consent activity.
7 properties
5 required
IdentityVerificationTemplateVersion
integer
Version of the associated Identity Verification template.
DocumentaryVerification
objectnull
Data, images, analysis, and results from the documentaryverification step. This field will be null unless steps.documentaryverification has reached a terminal…
2 properties
2 required
BankInitiatedReturnRisk
object
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…
2 properties
2 required
PartnerCustomerOAuthInstitutionsGetRequest
object
Request schema for /partner/customer/oauthinstitutions/get.
3 properties
1 required
IncomeBreakdownType
stringnull
The type of income. Possible values include: "regular": regular income "overtime": overtime income "bonus": bonus income
DeprecatedClientUserID
stringnull
Specifying user.clientuserid is deprecated. Please provide clientuserid at the root level instead.
AssetReportToken
string
A token that can be provided to endpoints such as /assetreport/get or /assetreport/pdf/get to fetch or update an Asset Report.
PaymentInitiationPaymentListResponse
object
PaymentInitiationPaymentListResponse defines the response schema for /paymentinitiation/payment/list
3 properties
3 required
ItemStatusTransactions
objectnull
Information about the last successful and failed transactions update for the Item.
2 properties
SignalWarning
object
Conveys information about the errors causing missing or stale bank data used to construct the /signal/evaluate scores and response
3 properties
TransferAuthorizationUserInRequest
object
The legal name and other information for the account holder. The user.legalname field is required. Other fields are not currently used and are present to suppo…
4 properties
1 required
AssetReportFreddie
object
An object representing an Asset Report with Freddie Mac schema.
3 properties
3 required
StatementsAccount
object
Account associated with the Item.
7 properties
7 required
InvestmentTransactionSubtype
string
For descriptions of possible transaction types and subtypes, see the [Investment transaction types schema](https://plaid.com/docs/api/accounts/investment-trans…
PaymentInitiationPaymentStatus
string
The status of the payment. PAYMENTSTATUSINPUTNEEDED: This is the initial state of all payments. It indicates that the payment is waiting on user input to conti…
Party
object
A collection of information about a single party to a transaction. Included direct participants like the borrower and seller as well as indirect participants s…
3 properties
3 required
TransferAuthorizationPaymentRisk
objectnull
This object includes the scores and risk level. This response is offered as an add-on to /transfer/authorization/create. To request access to these fields plea…
4 properties
4 required
SandboxTransferLedgerWithdrawSimulateRequest
object
Defines the request schema for /sandbox/transfer/ledger/withdraw/simulate
5 properties
2 required
SignalDecisionReportResponse
object
SignalDecisionReportResponse defines the response schema for /signal/decision/report
1 property
1 required
InstitutionsGetRequest
object
InstitutionsGetRequest defines the request schema for /institutions/get
6 properties
3 required
SweepStatus
stringnull
The status of a sweep transfer "pending" - The sweep is currently pending "posted" - The sweep has been posted "settled" - The sweep has settled "returned" - T…
TransferOriginatorDiligence
object
The diligence information for the originator.
8 properties
6 required
WatchlistScreeningEntityProgramGetRequest
object
Request input for fetching an entity watchlist program
3 properties
1 required
BankTransferSweepListRequest
object
BankTransferSweepListRequest defines the request schema for /banktransfer/sweep/list
6 properties
LinkOAuthCorrelationIdExchangeRequest
object
LinkOAuthCorrelationIdExchangeRequest defines the request schema for /link/oauth/correlationid/exchange
3 properties
1 required
PaymentProfileStatus
string
The status of the given Payment Profile. READY: This Payment Profile is ready to be used to create transfers using /transfer/authorization/create and /transfer…
CreditBankStatementUploadBankAccount
object
An object containing data about a user's bank account related to an uploaded bank statement.
7 properties
7 required
IdentityVerificationAutofillStatus
string
A status enum indicating whether autofill succeeded or failed.
BankTransferID
string
Plaid’s unique identifier for a bank transfer.
WatchlistScreeningDocumentValueNullable
stringnull
The numeric or alphanumeric identifier associated with this document.
LinkSessionResults
objectnull
The set of results for a Link session.
4 properties
CreditBankIncomeCategory
string
The income category. Note that the CASH value has been deprecated and is used only for existing legacy implementations. It has been replaced by the new categor…
PayStubDeductionsBreakdown
object
An object representing the deduction line items for the pay period
5 properties
5 required
DocumentAnalysis
object
High level descriptions of how the associated document was processed. If a document fails verification, the details in the analysis object should help clarify…
3 properties
3 required
BeaconReportSyndicationListRequest
object
Request input for listing Beacon Report Syndications
4 properties
1 required
LoanAccountSubtypes
array
An array of account subtypes to display in Link. If not specified, all account subtypes will be shown. For a full list of valid types and subtypes, see the [Ac…
WalletGetRequest
object
WalletGetRequest defines the request schema for /wallet/get
3 properties
1 required
BaseReportTransactionType
stringnull
digital: transactions that took place online. place: transactions that were made at a physical location. special: transactions that relate to banks, e.g. fees…
PayrollItem
object
An object containing information about the payroll item.
7 properties
7 required
DepositSwitchAddressData
object
The user's address.
5 properties
5 required
BeaconUserAddress
object
Even if an address has been collected, some fields may be null depending on the region's addressing system. For example: Addresses from the United Kingdom will…
6 properties
6 required
UpdatedAtTimestamp
string
An ISO8601 formatted timestamp. This field indicates the last time the resource was modified.
BeaconUserData
object
A Beacon User's data and resulting analysis when checked against duplicate records and the Beacon Fraud Network.
7 properties
7 required
LinkTokenAccountFilters
object
By default, Link will provide limited account filtering: it will only display Institutions that are compatible with all products supplied in the products param…
5 properties
CityNullable
stringnull
City from the end user's address. A string with at least one non-whitespace alphabetical character, with a max length of 100 characters."
CreditBankStatementsUploadsGetRequest
object
CreditBankStatementsUploadsGetRequest defines the request schema for /credit/bankstatements/uploads/get
4 properties
1 required
CreditBankStatementUploadAccountOwner
object
An object containing data about the owner of the bank account for the uploaded bank statement.
2 properties
2 required
BankTransferSweep
object
BankTransferSweep describes a sweep transfer.
4 properties
4 required
TransferSweepListRequest
object
Defines the request schema for /transfer/sweep/list
12 properties
WatchlistScreeningEntityProgramListRequest
object
Request input for listing entity watchlist screening programs
3 properties
BaseReportCreateRequest
object
BaseReportCreateRequest defines the request schema for /cra/basereport/create
6 properties
4 required
WatchlistScreeningRequestSearchTerms
object
Search inputs for creating a watchlist screening
5 properties
2 required
WatchlistScreeningEntityCreateRequest
object
Request input for creating an entity screening review
4 properties
1 required
PartnerEndCustomer
object
The details for an end customer.
3 properties
SandboxTransferRefundSimulateResponse
object
Defines the response schema for /sandbox/transfer/refund/simulate
1 property
1 required
PayrollItemStatus
objectnull
Details about the status of the payroll item.
1 property
AccountVerificationInsightsPreviousReturns
object
Information about known ACH returns for the account and routing number.
1 property
1 required
BalancePlusAttributes
object
Contains additional data that can be used to assess the ACH return risk. Examples of data include: dayssincefirstplaidconnection: The number of days since the…
27 properties
WatchlistScreeningIndividualProgramListResponse
object
Paginated list of individual watchlist screening programs
3 properties
3 required
IncomeVerificationCreateRequestOptions
object
Optional arguments for /income/verification/create
1 property
CraBankIncomeCause
object
An error object and associated itemid used to identify a specific Item and error when a batch operation operating on multiple Items has encountered an error in…
4 properties
4 required
Parties
object
A collection of objects that define specific parties to a deal. This includes the direct participating parties, such as borrower and seller and the indirect pa…
1 property
1 required
DateRange
object
A date range with a start and end date
2 properties
2 required
ProcessorBalanceGetResponse
object
ProcessorBalanceGetResponse defines the response schema for /processor/balance/get
2 properties
2 required
LinkTokenCreateInstitutionData
object
A map containing data used to highlight institutions in Link.
1 property
Total
object
An object representing both the current pay period and year to date amount for a category.
4 properties
AuthGetNumbers
object
An object containing identifying numbers used for making electronic transfers to and from the accounts. The identifying number type (ACH, EFT, IBAN, or BACS) u…
4 properties
4 required
BeaconUserIDNumber
objectnull
The ID number associated with a Beacon User.
2 properties
2 required
IdentityGetRequestOptions
object
An optional object to filter /identity/get results.
1 property
WatchlistScreeningIndividualGetResponse
object
The screening object allows you to represent a customer in your system, update their profile, and search for them on various watchlists. Note: Rejected custome…
7 properties
7 required
ClientUserIDNullable
stringnull
A unique ID that identifies the end user in your system. This ID can also be used to associate user-specific data from other Plaid products. Financial Account…
UserDataOverview
object
metadata for the set of insights provided in TransactionsUserInsightsGetResponse
6 properties
4 required
PaymentInitiationPayment
object
PaymentInitiationPayment defines a payment initiation payment
18 properties
8 required
DepositSwitchTargetAccount
object
The deposit switch destination account
4 properties
4 required
TransferIntentCreateResponse
object
Defines the response schema for /transfer/intent/create
2 properties
2 required
Item
object
Metadata about the Item.
10 properties
7 required
DashboardUserIDNullable
stringnull
ID of the associated user.
SandboxPublicTokenCreateRequestOptionsIncomeVerification
object
A set of parameters for income verification options. This field is required if incomeverification is included in the initialproducts array.
2 properties
TransferAuthorizationCreateRequest
object
Defines the request schema for /transfer/authorization/create
22 properties
6 required
BankTransferAccessToken
string
The Plaid accesstoken for the account that will be debited or credited.
SandboxProcessorTokenCreateRequest
object
SandboxProcessorTokenCreateRequest defines the request schema for /sandbox/processortoken/create
4 properties
1 required
RecurringTransferNullable
object
Represents a recurring transfer within the Transfers API.
UserIDNumber
objectnull
ID number submitted by the user, currently used only for the Identity Verification product. If the user has not submitted this data yet, this field will be nul…
2 properties
2 required
WatchlistScreeningIndividualGetRequest
object
Request input for fetching an individual watchlist screening
3 properties
1 required
BaseReportAccount
object
Base Report information about an account
12 properties
10 required
InstitutionsSearchRequestOptions
object
An optional object to filter /institutions/search results.
5 properties
DepositSwitchTokenCreateRequest
object
DepositSwitchTokenCreateRequest defines the request schema for /depositswitch/token/create
3 properties
1 required
SelfieCaptureImageURL
stringnull
Temporary URL for downloading an image selfie capture.
DeductionsTotal
object
An object representing the total deductions for the pay period
4 properties
CreditBankIncomeGetRequestOptions
object
An optional object for /credit/bankincome/get request options.
1 property
Enrichments
object
A grouping of the Plaid produced transaction enrichment fields.
14 properties
9 required
WatchlistScreeningReviewID
string
ID of the associated review.
RiskCheckLinkedService
string
An enum indicating the type of a linked service. Note that adultsites refers' to explicit video content, and includes a number of related services.
TransferAuthorizationIdempotencyKey
stringnull
A random key provided by the client, per unique authorization, which expires after 48 hours. Maximum of 50 characters. The API supports idempotency for safely…
WalletTransactionStatus
string
The status of the transaction. AUTHORISING: The transaction is being processed for validation and compliance. INITIATED: The transaction has been initiated and…
LinkTokenCreateRequestIncomeVerificationBankIncome
object
Specifies options for initializing Link for use with Bank Income. This field is required if incomeverification is included in the products array and bank is sp…
2 properties
1 required
TransferWireDetails
objectnull
Information specific to wire transfers.
1 property
DocumentDateOfBirthMatchCode
string
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 p…
BankTransferEventListRequest
object
Defines the request schema for /banktransfer/event/list
12 properties
CraLoanApplication
object
Contains loan application data.
6 properties
4 required
TransferCapabilitiesGetRequest
object
Defines the request schema for /transfer/capabilities/get
5 properties
2 required
RecurringInsightsStream
object
Insights object for recurring transactions streams.
15 properties
4 required
DocumentaryVerificationDocument
object
Images, extracted data, and analysis from a user's identity document
6 properties
6 required
Timestamp
string
An ISO8601 formatted timestamp.
ActionState
string
Enum representing the state of the action/activity.
CreditRelayRemoveRequest
object
CreditRelayRemoveRequest defines the request schema for /credit/relay/remove
3 properties
1 required
DocumentImage__Front
stringnull
Temporary URL that expires after 60 seconds for downloading the uncropped original image of the front of the document.
EntityWatchlistProgramID
string
ID of the associated entity program.
EntityScreeningHitEmails
object
Email address information for the associated entity watchlist hit
1 property
1 required
TransferEventSyncResponse
object
Defines the response schema for /transfer/event/sync
3 properties
3 required
CraLoanRegisterApplication
object
Contains loan application data to register.
2 properties
CreditPayrollIncomeParsingConfigUpdateRequest
object
CreditPayrollIncomeParsingConfigUpdateRequest defines the request schema for /credit/payrollincome/documents/update.
5 properties
2 required
TransferOriginatorClientID
stringnull
Client ID of the customer that owns the Ledger balance. This is so Plaid knows which of your customers to payout or collect funds. Only applicable for [Platfor…
AccountVerificationInsightsNetworkStatus
object
Status information about the account and routing number in the Plaid network.
2 properties
2 required
BaseReportWarning
object
It is possible for an Base Report to be returned with missing account owner information. In such cases, the Base Report will contain warning data in the respon…
3 properties
3 required
EarningsBreakdownCanonicalDescription
stringnull
Commonly used term to describe the earning line item.
NetPay
object
An object representing information about the net pay amount on the paystub.
6 properties
IncomeVerificationPrecheckUser
objectnull
Information about the user whose eligibility is being evaluated.
4 properties
NumbersInternationalNullable
Identifying information for transferring money to or from an international bank account via wire transfer.
PhysicalDocumentCategory
string
The type of identity document detected in the images provided. Will always be one of the following values: driverslicense - A driver's license issued by the as…
CreditFreddieMacLoanIdentifiers
object
Collection of current and previous identifiers for this loan.
1 property
1 required
WalletISOCurrencyCode
string
An ISO-4217 currency code, used with e-wallets and transactions.
TransferRecurringGetResponse
object
Defines the response schema for /transfer/recurring/get
2 properties
2 required
TransferTestClock
object
Defines the test clock for a transfer.
2 properties
2 required
SandboxTransferLedgerDepositSimulateResponse
object
Defines the response schema for /sandbox/transfer/ledger/deposit/simulate
1 property
1 required
WalletTransactionListRequest
object
WalletTransactionListRequest defines the request schema for /wallet/transaction/list
6 properties
1 required
SandboxTransferLedgerWithdrawSimulateResponse
object
Defines the response schema for /sandbox/transfer/ledger/withdraw/simulate
1 property
1 required
CreditEmploymentGetRequest
object
CreditEmploymentGetRequest defines the request schema for /credit/employment/get.
3 properties
1 required
EntityWatchlistScreeningProgramName
string
A name for the entity program to define its purpose. For example, "High Risk Organizations" or "Applicants".
EmploymentVerificationGetResponse
object
EmploymentVerificationGetResponse defines the response schema for /employment/verification/get.
2 properties
2 required
WatchlistScreeningIndividualReviewCreateResponse
object
A review submitted by a team member for an individual watchlist screening. A review can be either a comment on the current screening state, actions taken again…
6 properties
6 required
CraBankIncomeTransaction
object
The transactions data for the end user's income source(s).
9 properties
LinkTokenCreateRequestPaymentInitiation
object
Specifies options for initializing Link for use with the Payment Initiation (Europe) product. This field is required if paymentinitiation is included in the pr…
2 properties
WatchlistScreeningIndividual
object
The screening object allows you to represent a customer in your system, update their profile, and search for them on various watchlists. Note: Rejected custome…
6 properties
6 required
IdentityRefreshRequest
object
IdentityRefreshRequest defines the request schema for /identity/refresh
3 properties
1 required
TransferLedgerWithdrawRequest
object
Defines the request schema for /transfer/ledger/withdraw
8 properties
3 required
PartnerEndCustomerFlowdownStatus
string
The status of the addendum to the Plaid MSA ("flowdown") for the end customer.
InvestmentsRefreshRequest
object
InvestmentsRefreshRequest defines the request schema for /investments/refresh
3 properties
1 required
LinkProfileEligibilityCheckRequest
object
LinkProfileEligibilityCheckRequest defines the request schema for /link/profile/eligibility/check
4 properties
2 required
ProcessorAccountGetResponse
object
ProcessorAccountGetResponse defines the response schema for /processor/account/get
3 properties
3 required
CraBankIncomeSource
object
Detailed information for the income source.
17 properties
1 required
PartnerEndCustomerStatus
string
The status of the given end customer. UNDERREVIEW: The end customer has been created and enabled in the non-Production environments. The end customer must be m…
IndividualScreeningHitNames
object
Name information for the associated individual watchlist hit
3 properties
3 required
SandboxTransferTestClockListResponse
object
Defines the response schema for /sandbox/transfer/testclock/list
2 properties
2 required
WatchlistProgramID
string
ID of the associated program.
WatchlistScreeningEntityUpdateRequest
object
Request input for editing an entity watchlist screening
8 properties
1 required
CategoryInsights
object
Insights on a user's top personal finance categories.
2 properties
SignalDecisionOutcome
stringnull
The payment decision from the risk assessment. APPROVE: approve the transaction without requiring further actions from your customers. For example, use this fi…
DocumentAuthenticityMatchCode
string
High level summary of whether the document in the provided image matches the formatting rules and security checks for the associated jurisdiction. For example,…
NumbersEFT
object
Identifying information for transferring money to or from a Canadian bank account via EFT.
4 properties
4 required
CraPartnerInsightsGetRequest
object
CraPartnerInsightsGetRequest defines the request schema for /cra/partnerinsights/get.
3 properties
BeaconMatchSummaryAnalysis
object
Analysis of which fields matched between one Beacon User and another.
7 properties
7 required
MatchSummary
object
Summary object reflecting the match result of the associated data
1 property
1 required
TransactionStreamAmount
object
Object with data pertaining to an amount on the transaction stream.
3 properties
LinkTokenInvestmentsAuth
object
Configuration parameters for the Investments Auth Product
2 properties
CreditCardLiability
object
An object representing a credit card account.
9 properties
9 required
AssetDetail
object
Details about an asset.
10 properties
10 required
WebhookType
string
The webhook types that can be fired by this test endpoint.
BeaconUserPhoneNumber
stringnull
A phone number in E.164 format.
PaymentInitiationPaymentTokenCreateRequest
object
PaymentInitiationPaymentTokenCreateRequest defines the request schema for /paymentinitiation/payment/token/create
3 properties
1 required
TransferAuthorizationDecision
string
A decision regarding the proposed transfer. approved – The proposed transfer has received the end user's consent and has been approved for processing by Plaid.…
CreditBankIncomeSource
object
Detailed information for the income source.
10 properties
TransferLedgerDepositRequest
object
Defines the request schema for /transfer/ledger/deposit
8 properties
3 required
RiskCheckBehavior
objectnull
Result summary object specifying values for behavior attributes of risk check, when available.
3 properties
3 required
UserCreateRequest
object
UserCreateRequest defines the request schema for /user/create
4 properties
1 required
SandboxBankIncomeWebhookFireRequestWebhookCode
string
The webhook codes this endpoint can be used to test
SandboxTransferTestClockAdvanceRequest
object
Defines the request schema for /sandbox/transfer/testclock/advance
4 properties
2 required
TransferRepaymentListRequest
object
Defines the request schema for /transfer/repayment/list
6 properties
ApplicationID
string
This field will map to the application ID that is returned from /item/application/list, or provided to the institution in an oauth redirect.
PaymentConsentPeriodicAlignment
string
Where the payment consent period should start. CALENDAR: line up with a calendar. CONSENT: on the date of consent creation.
CraBankIncomeAccount
object
The Item's bank accounts that have the selected data.
6 properties
6 required
ProcessorBalanceGetRequest
object
ProcessorBalanceGetRequest defines the request schema for /processor/balance/get
4 properties
1 required
FDXNotificationPayloadIdType
string
Type of entity causing origination of a notification
TransferSweepGetResponse
object
Defines the response schema for /transfer/sweep/get
2 properties
2 required
CraPartnerInsightsPrism
object
The Prism insights for the user.
4 properties
1 required
LedgerWithdrawIdempotencyKey
string
A unique key provided by the client, per unique ledger withdraw. Maximum of 50 characters. The API supports idempotency for safely retrying the request without…
ItemWebhookUpdateRequest
object
ItemWebhookUpdateRequest defines the request schema for /item/webhook/update
4 properties
1 required
AssetReportAuditCopyCreateRequest
object
AssetReportAuditCopyCreateRequest defines the request schema for /assetreport/auditcopy/get
4 properties
1 required
CounterpartyType
string
The counterparty type. merchant: a provider of goods or services for purchase financialinstitution: a financial entity (bank, credit union, BNPL, fintech) paym…
MinLastUpdatedDatetime
string
Timestamp in [ISO 8601](https://wikipedia.org/wiki/ISO8601) format (YYYY-MM-DDTHH:mm:ssZ) indicating the oldest acceptable balance when making a request to /ac…
ExpirationDate
string
A description of whether the associated document was expired when the verification was performed. Note: In the case where an expiration date is not present on…
CraPartnerInsightsItemAccount
object
Account data corresponding to the item from which Partner Insights were generated from
6 properties
6 required
BankTransferAmount
string
The amount of the bank transfer (decimal string with two digits of precision e.g. "10.00").
TransactionsRecurringGetResponse
object
TransactionsRecurringGetResponse defines the response schema for /transactions/recurring/get
4 properties
4 required
LinkSessionSuccessMetadata
objectnull
Displayed once a user has successfully linked their Item.
4 properties
PaymentInitiationOptionalRestrictionBacs
An optional object used to restrict the accounts used for payments. If provided, the end user will be able to send payments only from the specified bank accoun…
IndividualWatchlistScreeningProgramName
string
A name for the program to define its purpose. For example, "High Risk Individuals", "US Cardholders", or "Applicants".
ItemApplicationListRequest
object
Request to list connected applications for a user.
3 properties
TransferEventSyncRequest
object
Defines the request schema for /transfer/event/sync
4 properties
1 required
TransactionsRuleDetails
object
A representation of transactions rule details.
3 properties
3 required
SandboxTransferTestClockCreateResponse
object
Defines the response schema for /sandbox/transfer/testclock/create
2 properties
2 required
CreditSessionResults
object
The set of results for a Link session.
5 properties
Credit1099Filer
object
An object representing a filer used by 1099-K tax documents.
4 properties
CraLoanUpdate
object
Contains loan data to update.
3 properties
WatchlistScreeningDocumentType
string
The kind of official document represented by this object. birthcertificate - A certificate of birth driverslicense - A license to operate a motor vehicle immig…
CreditEmploymentVerification
object
The object containing proof of employment data for an individual.
9 properties
9 required
LinkTokenCreateRequestDepositSwitch
object
Specifies options for initializing Link for use with the Deposit Switch (beta) product. This field is required if depositswitch is included in the products arr…
1 property
1 required
PaymentInitiationAddress
objectnull
The optional address of the payment recipient's bank account. Required by most institutions outside of the UK.
4 properties
4 required
InvestmentFilter
object
A filter to apply to investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier).
1 property
1 required
AccountProductAccess
object
Allow the application to access specific products on this account
3 properties
Street2
stringnull
Extra street information, like an apartment or suite number. If provided, a string with at least one non-whitespace character, with a max length of 20 characte…
BankTransferEventSyncRequest
object
Defines the request schema for /banktransfer/event/sync
4 properties
1 required
PaystubDetails
object
An object representing details that can be found on the paystub.
5 properties
AccountsBalanceGetRequest
object
AccountsBalanceGetRequest defines the request schema for /accounts/balance/get
5 properties
1 required
LoanIdentifier
object
The information used to identify this loan by various parties to the transaction or other organizations.
2 properties
2 required
BankInitiatedRiskTier
integer
In the bankinitiatedreturnrisk object, there are eight risk tiers corresponding to the scores: 1: Predicted bank-initiated return incidence rate between 0.0% -…
BeaconUserUpdateRequestData
object
A subset of a Beacon User's data which is used to patch the existing identity data associated with a Beacon User. At least one field must be provided,.
7 properties
ScreeningHitDateOfBirthItem
object
Analyzed date of birth for the associated hit
2 properties
Counterparty
object
The counterparty, such as the merchant or financial institution, is extracted by Plaid from the raw description.
7 properties
5 required
PaymentInitiationRecipientCreateResponse
object
PaymentInitiationRecipientCreateResponse defines the response schema for /paymentinitation/recipient/create
2 properties
2 required
ProcessorApexProcessorTokenCreateRequest
object
ProcessorApexProcessorTokenCreateRequest defines the request schema for /processor/apex/processortoken/create
4 properties
2 required
TransactionsSyncRequest
object
TransactionsSyncRequest defines the request schema for /transactions/sync
6 properties
1 required
DetailedOriginator
object
Originator and their status.
3 properties
3 required
ItemActivityListRequest
object
Request to list a historical log of user consent events.
5 properties
TransferRecurringListResponse
object
Defines the response schema for /transfer/recurring/list
2 properties
2 required
TransferAuthorizationDecisionRationaleCode
string
A code representing the rationale for approving or declining the proposed transfer. If the rationalecode is null, the transfer passed the authorization check.…
StatementsRefreshRequest
object
StatementsRefreshRequest defines the request schema for /statements/refresh
5 properties
3 required
TransferRefundIdempotencyKey
string
A random key provided by the client, per unique refund. Maximum of 50 characters. The API supports idempotency for safely retrying requests without accidentall…
AssetOwner
object
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
1 property
1 required
Holding
object
A securities holding at an institution.
12 properties
8 required
WalletPaymentScheme
stringnull
The payment scheme used to execute this transaction. This is present only for transaction types PAYOUT and REFUND. FASTERPAYMENTS: The standard payment scheme…
StatementsStatement
object
A statement's metadata associated with an account
3 properties
3 required
CreditSessionBankEmploymentStatus
string
Status of the Bank Employment Link session. APPROVED: User has approved and verified their employment. NOEMPLOYMENTSFOUND: We attempted, but were unable to fin…
PartnerEndCustomerTechnicalContact
object
The technical contact for the end customer. Defaults to partner's technical contact if omitted.
3 properties
IdentityVerificationStatus
string
The status of this Identity Verification attempt. active - The Identity Verification attempt is incomplete. The user may have completed part of the session, bu…
ScreeningHitNamesItems
object
Analyzed name information for the associated hit
2 properties
PaymentInitiationConsentPaymentExecuteRequest
object
PaymentInitiationConsentPaymentExecuteRequest defines the request schema for /paymentinitiation/consent/payment/execute
7 properties
3 required
EntityScreeningHitNamesItems
object
Analyzed names for the associated hit
2 properties
SandboxTransferLedgerDepositSimulateRequest
object
Defines the request schema for /sandbox/transfer/ledger/deposit/simulate
5 properties
2 required
CreditBankIncomeWarning
object
The warning associated with the data that was unavailable for the Bank Income Report.
3 properties
EarningsBreakdown
object
An object representing the earnings line items for the pay period.
8 properties
TransferRepayment
object
A repayment is created automatically after one or more guaranteed transactions receive a return. If there are multiple eligible returns in a day, they are batc…
4 properties
4 required
RecipientBACS
objectnull
An object containing a BACS account number and sort code. If an IBAN is not provided or if you need to accept domestic GBP-denominated payments, BACS data is r…
2 properties
FDXPartyType
string
Identifies the type of a party
TransferRecurringListRequest
object
Defines the request schema for /transfer/recurring/list
7 properties
WalletTransactionGetResponse
object
WalletTransactionGetResponse defines the response schema for /wallet/transaction/get
8 required
AuthGetRequestOptions
object
An optional object to filter /auth/get results.
1 property
EmployerVerification
object
An object containing employer data.
1 property
WatchlistScreeningPhoneNumber
string
A phone number in E.164 format.
PaymentMeta
object
Transaction information specific to inter-bank transfers. If the transaction was not an inter-bank transfer, all fields will be null. If the transactions objec…
8 properties
8 required
TransferBalanceGetRequest
object
Defines the request schema for /transfer/balance/get
4 properties
FDXTimestamp
string
ISO 8601 date-time in format 'YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm]' according to [IETF RFC3339](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.htmlanc…
BeaconMatchSummaryCode
string
An enum indicating the match type between two Beacon Users. match indicates that the provided input data was a strong match against the other Beacon User. part…
IdentityVerificationResponseUserName
objectnull
The full name provided by the user. If the user has not submitted their name, this field will be null. Otherwise, both fields are guaranteed to be filled.
2 properties
2 required
PhysicalDocumentExtractedData
objectnull
Data extracted from a user-submitted document.
7 properties
7 required
IncomeVerificationPrecheckMilitaryInfo
objectnull
Data about military info in the income verification precheck.
2 properties
BeaconReportID
string
ID of the associated Beacon Report.
TransferFacilitatorFee
string
The amount to deduct from transfer.amount and distribute to the platform’s Ledger balance as a facilitator fee (decimal string with two digits of precision e.g…
LinkTokenCreateRequestUserStatedIncomeSource
object
Specifies user stated income sources for the Income product
6 properties
BeaconUserReviewRequest
object
Request input for updating the status of a Beacon User
4 properties
2 required
PhysicalDocumentExtractedDataAnalysis
objectnull
Analysis of the data extracted from the submitted document.
4 properties
4 required
PartnerCustomerEnableRequest
object
Request schema for /partner/customer/enable.
3 properties
1 required
TransactionsUpdateStatus
string
A description of the update status for transaction pulls of an Item. TRANSACTIONSUPDATESTATUSUNKNOWN: Unable to fetch transactions update status for Item. NOTR…
BeaconProgramID
string
ID of the associated Beacon Program.
CreditUnofficialCurrencyCode
stringnull
The unofficial currency code associated with the amount or balance. Always null if isocurrencycode is non-null. Unofficial currency codes are used for currenci…
BeaconUser
object
A Beacon User represents an end user that has been scanned against the Beacon Network.
9 properties
9 required
CraBankIncome
object
The report of the Bank Income data for an end user.
6 properties
TransferUserAddressInRequest
object
The address associated with the account holder.
5 properties
LinkSessionBankIncomeResult
object
The details of a bank income verification in Link.
3 properties
3 required
EntityDocumentType
string
The kind of official document represented by this object. bik - Russian bank code businessnumber - A number that uniquely identifies the business within a cate…
RecurringTransfer
object
Represents a recurring transfer within the Transfers API.
17 properties
15 required
AssetReportRefreshAssetReportToken
string
The assetreporttoken returned by the original call to /assetreport/create
EntityWatchlistScreeningHitID
string
ID of the associated entity screening hit.
TransferSweepID
string
Plaid’s unique identifier for a sweep.
AccountAssets
object
Asset information about an account
15 properties
11 required
PartnerCustomerGetResponse
object
Response schema for /partner/customer/get.
2 properties
EntityWatchlistScreeningHit
object
Data from a government watchlist that has been attached to the screening.
10 properties
8 required
RiskSignalDocumentStatus
string
Status of a document for risk signal analysis
WatchlistScreeningDocument
object
An official document, usually issued by a governing body or institution, with an associated identifier.
2 properties
2 required
CreditSessionError
object
The details of a Link error.
4 properties
PhoneNumberMatchScore
objectnull
Score found by matching phone number provided by the API with the phone number on the account at the financial institution. 100 is a perfect match and 0 is a n…
1 property
AccountIdentityDocumentUpload
Identity information about an account
WatchlistScreeningIndividualCreateRequest
object
Request input for creating an individual watchlist screening
4 properties
1 required
SandboxTransferTestClockGetRequest
object
Defines the request schema for /sandbox/transfer/testclock/get
3 properties
1 required
TransactionsGetResponse
object
TransactionsGetResponse defines the response schema for /transactions/get
5 properties
5 required
IdentityVerificationUserAddress
objectnull
Even if an address has been collected, some fields may be null depending on the region's addressing system. For example: Addresses from the United Kingdom will…
6 properties
6 required
ProfileGetRequest
object
ProfileGetRequest defines the request schema for /profile/get
3 properties
3 required
SelfieAnalysisDocumentComparison
string
Information about the comparison between the selfie and the document (if documentary verification also ran).
TransferRecurringGetRequest
object
Defines the request schema for /transfer/recurring/get
3 properties
1 required
EmploymentVerificationGetRequest
object
EmploymentVerificationGetRequest defines the request schema for /employment/verification/get.
3 properties
1 required
SignalScore
integer
A score from 1-99 that indicates the transaction return risk: a higher risk score suggests a higher return likelihood.
CreditFreddieMacVerificationOfAssetsDeal
object
An object representing an Asset Report with Freddie Mac schema.
3 properties
3 required
ProcessorSignalDecisionReportResponse
object
ProcessorSignalDecisionReportResponse defines the response schema for /processor/signal/decision/report
1 property
1 required
AssetReportGetRequestOptions
object
An optional object to filter or add data to /assetreport/get results. If provided, must be non-null.
1 property
SandboxPaymentProfileResetLoginRequest
object
SandboxPaymentProfileResetLoginRequest defines the request schema for /sandbox/paymentprofile/resetlogin
3 properties
1 required
TransferCancelRequest
object
Defines the request schema for /transfer/cancel
4 properties
1 required
ProcessorBankTransferCreateRequest
object
Defines the request schema for /processor/banktransfer/create
14 properties
8 required
ActivityType
string
Types of consent activities
ApplicationGetRequest
object
ApplicationGetRequest defines the schema for /application/get
3 properties
3 required
WatchlistScreeningIndividualUpdateRequest
object
Request input for editing an individual watchlist screening
8 properties
1 required
PaymentProfileCreateResponse
object
PaymentProfileCreateResponse defines the response schema for /paymentprofile/create
2 properties
2 required
LinkTokenCreateRequestAuth
object
Specifies options for initializing Link for use with the Auth product. This field can be used to enable or disable extended Auth flows for the resulting Link s…
10 properties
PrismInsightsResult
object
The Insights Result object is a map of cash flow attributes, where the key is a string, and the value is a float or string.
Roles
object
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
1 property
1 required
SandboxProcessorTokenCreateRequestOptions
object
An optional set of options to be used when configuring the Item. If specified, must not be null.
2 properties
CreditBankStatementsUploadsGetRequestOptions
object
An optional object for /credit/bankstatements/uploads/get request options.
1 property
TransferIntentCreateNetwork
string
The network or rails used for the transfer. Defaults to same-day-ach. For transfers submitted as ach, the next-day cutoff is 5:30 PM Eastern Time. For transfer…
PartnerEndCustomerOAuthInstitutionEnvironments
object
Registration statuses by environment.
2 properties
SandboxOverridePassword
stringnull
Test password to use for the creation of the Sandbox Item. Default value is passgood.
InvestmentTransaction
object
A transaction within an investment account.
14 properties
13 required
LinkTokenCreateCardSwitch
object
A map containing data to pass in for the Card Switch flow.
1 property
1 required
SandboxBankIncomeFireWebhookResponse
object
SandboxBankIncomeFireWebhookResponse defines the response schema for /sandbox/bankincome/firewebhook
1 property
1 required
DeductionsBreakdown
object
An object representing the deduction line items for the pay period
5 properties
CreditFreddieMacService
object
A collection of details related to a fulfillment service or product in terms of request, process and result.
2 properties
2 required
BeaconDuplicateID
string
ID of the associated Beacon Duplicate.
LinkTokenCreateRequestIncomeVerificationPayrollIncome
object
Specifies options for initializing Link for use with Payroll Income (including Document Income). Further customization options for Document Income, such as cus…
4 properties
CreditFreddieMacAssetTransactions
object
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
1 property
1 required
ProcessorTransactionsSyncResponse
object
ProcessorTransactionsSyncResponse defines the response schema for /processor/transactions/sync
8 properties
8 required
LinkDeliveryCreateRequest
object
LinkDeliveryCreateRequest defines the request schema for /linkdelivery/create
4 properties
1 required
AccountBase
object
A single account at a financial institution.
10 properties
7 required
FinancialInstitutionInsights
object
Insights surrounding external financial institution counterparties associated with a user.
4 properties
3 required
ClientProvidedTransactionLocation
object
A representation of where a transaction took place. Use this field to pass in structured location information you may have about your transactions. Providing l…
5 properties
DashboardUserGetRequest
object
Request input for fetching a dashboard user
3 properties
1 required
RiskCheckDevice
object
Result summary object specifying values for device attributes of risk check.
3 properties
3 required
CreditPayrollIncomeGetRequest
object
CreditPayrollIncomeGetRequest defines the request schema for /credit/payrollincome/get.
4 properties
PayrollIncomeRateOfPay
object
An object representing the rate at which an individual is paid.
2 properties
PayPeriodDetails
object
Details about the pay period.
8 properties
PayrollIncomeAccountData
objectnull
An object containing account level data.
3 properties
3 required
ProcessorSignalEvaluateRequest
object
ProcessorSignalEvaluateRequest defines the request schema for /processor/signal/evaluate
11 properties
3 required
IdempotencyFlag
booleannull
An optional flag specifying how you would like Plaid to handle attempts to create an Identity Verification when an Identity Verification already exists for the…
TransferRefundCreateRequest
object
Defines the request schema for /transfer/refund/create
5 properties
3 required
Employee
object
Data about the employee.
4 properties
2 required
CreditDocumentMetadata
object
Object representing metadata pertaining to the document.
5 properties
4 required
PaymentChannel
string
The channel used to make a payment. online: transactions that took place online. in store: transactions that were made at a physical location. other: transacti…
WatchlistScreeningIndividualUpdateResponse
object
The screening object allows you to represent a customer in your system, update their profile, and search for them on various watchlists. Note: Rejected custome…
7 properties
7 required
TransferEventListRequest
object
Defines the request schema for /transfer/event/list
14 properties
IncomeVerificationPaystubsGetRequest
object
IncomeVerificationPaystubsGetRequest defines the request schema for /income/verification/paystubs/get.
4 properties
SelfieCaptureVideoURL
stringnull
Temporary URL for downloading a video selfie capture.
BeaconUserName
object
The full name for a given Beacon User.
2 properties
2 required
CreditBankEmployment
object
Detailed information for the bank employment.
5 properties
5 required
TransferBalanceType
string
The type of balance. prefundedrtpcredits - Your prefunded RTP credit balance with Plaid prefundedachcredits - Your prefunded ACH credit balance with Plaid
PaymentInitiationPaymentReverseRequest
object
PaymentInitiationPaymentReverseRequest defines the request schema for /paymentinitiation/payment/reverse
8 properties
3 required
IncomeVerificationDocumentsDownloadRequest
object
IncomeVerificationDocumentsDownloadRequest defines the request schema for /income/verification/documents/download.
5 properties
IdentityVerificationRequestUserName
objectnull
You can use this field to pre-populate the user's legal name; if it is provided here, they will not be prompted to enter their name in the identity verificatio…
2 properties
2 required
ImageQuality
string
A high level description of the quality of the image the user submitted. For example, an image that is blurry, distorted by glare from a nearby light source, o…
WatchlistScreeningEntityHitListResponse
object
Paginated list of entity watchlist screening hits
3 properties
3 required
IdentityGetRequest
object
IdentityGetRequest defines the request schema for /identity/get
4 properties
1 required
BankTransferGetRequest
object
Defines the request schema for /banktransfer/get
3 properties
1 required
ConnectedApplication
object
Describes the connected application for a particular end user.
8 properties
3 required
AssetReportRefreshRequest
object
AssetReportRefreshRequest defines the request schema for /assetreport/refresh
5 properties
1 required
IDNumberType
string
A globally unique and human readable ID type, specific to the country and document category. For more context on this field, see [Hybrid Input Validation](http…
SignalReturnReportRequest
object
SignalReturnReportRequest defines the request schema for /signal/return/report
5 properties
2 required
SelfieCheckSelfie
object
Captures and analysis from a user's selfie.
4 properties
4 required
Loans
object
A collection of loans that are part of a single deal.
1 property
1 required
WatchlistScreeningIndividualCreateResponse
object
The screening object allows you to represent a customer in your system, update their profile, and search for them on various watchlists. Note: Rejected custome…
7 properties
7 required
UserUpdateRequest
object
UserUpdateRequest defines the request schema for /user/update
4 properties
1 required
UserStatedIncomeSourceFrequency
string
The pay frequency of a specified income source
PaymentInitiationRecipient
object
PaymentInitiationRecipient defines a payment initiation recipient
5 properties
2 required
BeaconUserNameNullable
objectnull
The full name for a given Beacon User.
2 properties
2 required
CreditFreddieMacAssetTransaction
object
An object representing...
2 properties
2 required
CreditEmploymentVerificationStatus
stringnull
Current employment status.
EmployersSearchRequest
object
EmployersSearchRequest defines the request schema for /employers/search.
4 properties
2 required
PaymentInitiationMaximumPaymentAmount
object
A mapping of currency to maximum payment amount (denominated in the smallest unit of currency) supported by the institution. Example: {"GBP": "10000"}
TransferAuthorization
object
Contains the authorization decision for a proposed transfer.
8 properties
8 required
CreditIsoCurrencyCode
stringnull
The ISO 4217 currency code of the amount or balance.
BaseReportAccountInsights
object
Calculated insights derived from transaction-level data.
10 properties
AuthGetRequest
object
AuthGetRequest defines the request schema for /auth/get
4 properties
1 required
BankTransferFailure
objectnull
The failure reason if the type of this transfer is "failed" or "reversed". Null value otherwise.
2 properties
TransferIntentGetFailureReason
objectnull
The reason for a failed transfer intent. Returned only if the transfer intent status is failed. Null otherwise.
3 properties
IdentityVerificationDocumentAddressResponse
objectnull
The address extracted from the document. The address must at least contain the following fields to be a valid address: street, city, country. If any are missin…
5 properties
5 required
WalletTransactionListResponse
object
WalletTransactionListResponse defines the response schema for /wallet/transaction/list
3 properties
2 required
ItemPublicTokenCreateRequest
object
ItemPublicTokenCreateRequest defines the request schema for /item/publictoken/create
3 properties
1 required
VirtualTime
string
The virtual timestamp on the test clock. This will be of the form 2006-01-02T15:04:05Z.
TransactionsRulesListRequest
object
TransactionsRulesListRequest defines the request schema for /beta/transactions/rules/v1/list
3 properties
1 required
RiskCheckEmailDomainIsDisposable
string
Indicates whether the email domain is listed as disposable if known. Disposable domains are often used to create email addresses that are part of a fake set of…
AccountFiltersResponse
object
The accountfilters specified in the original call to /link/token/create.
4 properties
InstitutionSupportedNetworks
object
Contains the RTP network and types supported by the linked Item's institution.
1 property
1 required
CraBankIncomeGetRequest
object
CraBankIncomeGetRequest defines the request schema for /cra/bankincome/get.
3 properties
WatchlistScreeningIndividualName
string
The legal name of the individual being screened.
Products
string
A list of products that an institution can support. All Items must be initialized with at least one product. The Balance product is always available and does n…
CreditRelayCreateRequest
object
CreditRelayCreateRequest defines the request schema for /credit/relay/create
5 properties
2 required
InvestmentTransactionType
string
Value is one of the following: buy: Buying an investment sell: Selling an investment cancel: A cancellation of a pending transaction cash: Activity that modifi…
PaymentInitiationConsentGetResponse
object
PaymentInitiationConsentGetResponse defines the response schema for /paymentinitation/consent/get
1 required
TransferDocumentPurpose
string
Specifies the purpose of the uploaded file. "DUEDILIGENCE" - The transfer due diligence document of the originator.
RiskProfile
objectnull
Details about the transaction result after evaluated by the requested risk profile. If a riskprofilekey is not provided, this field will be omitted. This featu…
2 properties
TransferSweepIDNullable
stringnull
Plaid’s unique identifier for a sweep.
BeaconReportSyndication
object
A Beacon Report Syndication represents a Beacon Report created either by your organization or another Beacon customer that matches a specific Beacon User you'v…
3 properties
3 required
InvestmentsAuthOwner
object
Information on the ownership of an investments account
2 properties
CreditACHClass
string
Specifies the use case of the transfer. Required for transfers on an ACH network. "ccd" - Corporate Credit or Debit - fund transfer between two corporate bank…
TransferRecurringCreateResponse
object
Defines the response schema for /transfer/recurring/create
4 properties
2 required
IdentityVerification
object
A identity verification attempt represents a customer's attempt to verify their identity, reflecting the required steps for completing the session, the results…
16 properties
16 required
DocumentImage__CroppedFront
stringnull
Temporary URL that expires after 60 seconds for downloading a cropped image containing just the front of the document.
UserToken
string
The user token associated with the User data is being requested for.
CreditSessionItemAddResult
object
The details of an Item add in Link.
3 properties
CreditRelayPDFGetResponse
string
CreditRelayPDFGetResponse defines the response schema for /credit/relay/pdf/get
ProcessorTokenWebhookUpdateRequest
object
ProcessorTokenWebhookUpdateRequest defines the request schema for /processor/token/webhook/update
4 properties
2 required
TransferCreateResponse
object
Defines the response schema for /transfer/create
2 properties
2 required
PartnerEndCustomerOAuthInstitutionApplicationStatus
string
The registration status for the end customer's application.
CreditSessionBankEmploymentResult
object
The details of a bank employment verification in Link.
3 properties
ServicerAddressData
object
The address of the student loan servicer. This is generally the remittance address to which payments should be sent.
5 properties
5 required
InstitutionsGetByIdRequest
object
InstitutionsGetByIdRequest defines the request schema for /institutions/getbyid
5 properties
2 required
IncomeVerificationPrecheckEmployer
objectnull
Information about the end user's employer
4 properties
TransferAuthorizationCreateResponse
object
Defines the response schema for /transfer/authorization/create
2 properties
2 required
AssetTransactions
object
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
1 property
1 required
RiskCheckEmailIsDeliverableStatus
string
SMTP-MX check to confirm the email address exists if known.
LinkTokenTransactions
object
Configuration parameters for the Transactions product
1 property
TransactionsEnhanceGetRequest
object
TransactionsEnhanceGetRequest defines the request schema for /transactions/enhance.
4 properties
2 required
NumbersInternational
object
Identifying information for transferring money to or from an international bank account via wire transfer.
3 properties
3 required
IdentityVerificationID
string
ID of the associated Identity Verification attempt.
BeaconAccountRiskEvaluateEvaluationReason
string
Description of the reason you want to evaluate risk. ONBOARDING: user links a first bank account as part of the onboarding flow of your platform. NEWACCOUNT: u…
DashboardUserID
string
ID of the associated user.
TransferAuthorizationCancelResponse
object
Defines the response schema for /transfer/authorization/cancel
1 property
1 required
CraBankIncomeBonusType
stringnull
The type of bonus that this transaction represents, if it is a bonus BONUSINCLUDED: Bonus is included in this transaction along with the normal pay BONUSONLY:…
LinkTokenCreateRequestBaseReport
object
Specifies options for initializing Link for use with the Base Report product. This field is required if assets is included in the products array and the client…
2 properties
1 required
FDXNotificationSeverity
string
Severity level of notification
LinkTokenCreateRequestEmploymentBankIncome
object
Specifies options for initializing Link for use with Bank Employment. This field is required if employment is included in the products array and bank is specif…
1 property
1 required
CreditBankEmploymentItem
object
The details and metadata for an end user's Item.
6 properties
6 required
Street
string
The primary street portion of an address. If an address is provided, this field will always be filled. A string with at least one non-whitespace alphabetical c…
UpdateEntityScreeningRequestSearchTerms
objectnull
Search terms for editing an entity watchlist screening
7 properties
1 required
BankTransferEvent
object
Represents an event in the Bank Transfers API.
11 properties
11 required
WatchlistScreeningIndividualID
string
ID of the associated screening.
KYCCheckDetails
objectnull
Additional information for the kyccheck step. This field will be null unless steps.kyccheck has reached a terminal state of either success or failed.
6 properties
6 required
DepositSwitchTargetUser
object
The deposit switch target user
6 properties
4 required
PaymentInitiationConsentCreateRequest
object
PaymentInitiationConsentCreateRequest defines the request schema for /paymentinitiation/consent/create
7 properties
4 required
AccessTokenNullable
stringnull
The access token associated with the Item data is being requested for.
UserId
string
The Plaid userid of the User associated with this webhook, warning, or error.
TransferMetricsGetResponse
object
Defines the response schema for /transfer/metrics/get
7 properties
7 required
PaymentInitiationPaymentReverseResponse
object
PaymentInitiationPaymentReverseResponse defines the response schema for /paymentinitation/payment/reverse
3 properties
3 required
AccessToken
string
The access token associated with the Item data is being requested for.
TransferDevice
object
Information about the device being used to initiate the authorization.
2 properties
2 required
DocumentImage__Back
stringnull
Temporary URL that expires after 60 seconds for downloading the original image of the back of the document. Might be null if the back of the document was not c…
LoanFilter
object
A filter to apply to loan-type accounts
1 property
1 required
PaymentInitiationMetadata
objectnull
Metadata that captures what specific payment configurations an institution supports when making Payment Initiation requests.
6 properties
6 required
PaymentProfileToken
string
A payment profile token associated with the Payment Profile data that is being requested.
BeaconUserID
string
ID of the associated Beacon User.
AccountType
string
investment: Investment account. In API versions 2018-05-22 and earlier, this type is called brokerage instead. credit: Credit card depository: Depository accou…
AccountsGetRequest
object
AccountsGetRequest defines the request schema for /accounts/get
4 properties
1 required
IdentityVerificationTemplateID
string
ID of the associated Identity Verification template.
TimestampNullable
stringnull
An ISO8601 formatted timestamp.
FDXPartyRegistry
string
The registry containing the party’s registration with name and id
NumbersBACS
object
Identifying information for transferring money to or from a UK bank account via BACS.
3 properties
3 required
ProfileGetResponse
object
ProfileGetResponse defines the response schema for /profile/get
3 properties
3 required
TransferFundingAccountIDResponse
string
The id of the funding account to use, available in the Plaid Dashboard. This determines which of your business checking accounts will be credited or debited.
DocumentMetadata
object
An object representing metadata from the end user's uploaded document.
4 properties
IdentityVerificationCreateRequest
object
Request schema for '/identityverification/create'
8 properties
3 required
TransferSweep
object
Describes a sweep of funds to / from the sweep account. A sweep is associated with many sweep events (events of type swept or returnswept) which can be retriev…
10 properties
6 required
PrismFirstDetect
objectnull
The data from the Firstdetect product returned by Prism.
4 properties
2 required
PlaidErrorType
string
A broad categorization of the error. Safe for programmatic use.
W2StateAndLocalWages
object
W2 state and local wages
7 properties
PaystubYTDDetails
object
The amount of income earned year to date, as based on paystub data.
2 properties
WeakAliasDetermination
string
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. Plaid does not ever su…
AccountsBalanceGetRequestPaymentDetails
objectnull
An optional object containing payment details. If set, a payment risk assessment is performed and returned as AccountsBalanceGetResponsePaymentRiskAssessment.
5 properties
AssetReportRemoveRequest
object
AssetReportRemoveRequest defines the request schema for /assetreport/remove
3 properties
1 required
TransactionStream
object
A grouping of related transactions
17 properties
15 required
TransferCreditFundsSource
stringnull
This field is now deprecated. You may ignore it for transfers created on and after 12/01/2023. Specifies the source of funds for the transfer. Only valid for c…
SingleDocumentRiskSignal
object
Object containing all risk signals and relevant metadata for a single document
3 properties
3 required
PartnerEndCustomerOAuthInstitution
object
The OAuth registration information for an institution.
5 properties
WalletTransactionCounterpartyInternational
objectnull
International Bank Account Number for a Wallet Transaction
1 property
TransferAmount
string
The amount of the transfer (decimal string with two digits of precision e.g. "10.00"). When calling /transfer/authorization/create, specify the maximum amount…
ItemStatusNullable
Information about the last successful and failed transactions update for the Item.
SandboxTransferRefundSimulateRequest
object
Defines the request schema for /sandbox/transfer/refund/simulate
6 properties
2 required
ProcessorTokenWebhookUpdateResponse
object
ProcessorTokenWebhookUpdateResponse defines the response schema for /processor/token/webhook/update
1 property
1 required
AccountBalance
object
A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by /accounts/balance/get.
6 properties
5 required
FDXContentTypes
string
Types of document formats. (Suggested values)
LinkDeliveryDeliveryMethod
string
The delivery method to be used to deliver the Hosted Link session URL. SMS: The URL will be delivered through SMS EMAIL: The URL will be delivered through email
ValidationSources
object
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
1 property
1 required
LinkDeliverySessionStatus
string
The status of the given Hosted Link session. CREATED: The session is created but not yet accessed by the user OPENED: The session is opened by the user but not…
LinkDeliveryCommunicationMethod
object
The communication method containing both the type and address to send the URL.
2 properties
AccountIdentityMatchScore
Identity match scores for an account
SignalEvaluateCoreAttributes
object
The core attributes object contains additional data that can be used to assess the ACH return risk. Examples of data include: dayssincefirstplaidconnection: Th…
80 properties
WalletTransactionExecuteRequest
object
WalletTransactionExecuteRequest defines the request schema for /wallet/transaction/execute
7 properties
5 required
IdentityVerificationStepSummary
object
Each step will be one of the following values: active - This step is the user's current step. They are either in the process of completing this step, or they r…
7 properties
7 required
CraLoanPaymentHistory
object
Contains the payment information for a loan payment period.
5 properties
3 required
WatchlistScreeningIndividualProgramGetRequest
object
Request input for fetching an individual watchlist program
3 properties
1 required
TransferLedgerDistributeRequest
object
Defines the request schema for /transfer/ledger/distribute
7 properties
4 required
ItemGetRequest
object
ItemGetRequest defines the request schema for /item/get
3 properties
1 required
ScopesState
string
When scopes are updated during enrollment, this field must be populated with the state sent to the partner in the OAuth Login URI. This field is required when…
DepositSwitchCreateRequest
object
DepositSwitchCreateRequest defines the request schema for /depositswitch/create
6 properties
2 required
MortgageLiability
object
Contains details about a mortgage account.
20 properties
20 required
ProcessorTransactionsRefreshResponse
object
ProcessorTransactionsRefreshResponse defines the response schema for /processor/transactions/refresh
1 property
1 required
Originator
object
Originator and their status.
2 properties
2 required
ProgramArchived
boolean
Archived programs are read-only and cannot screen new customers nor participate in ongoing monitoring.
WatchlistScreeningIndividualReviewCreateRequest
object
Request input for creating a screening review
6 properties
3 required
CreditPayStubPayBasisType
string
The explicit pay basis on the paystub (if present).
TransactionsEnrichRequest
object
TransactionsEnrichRequest defines the request schema for /transactions/enrich.
5 properties
2 required
TransferIntentGetResponse
object
Defines the response schema for /transfer/intent/get
2 properties
2 required
BankTransferListRequest
object
Defines the request schema for /banktransfer/list
8 properties
HostedLinkURLLifetimeSeconds
integer
How many seconds the link will be valid for. Must be positive. Cannot be longer than 21 days. The default lifetime is 4 hours.
PaymentProfileGetRequest
object
PaymentProfileGetRequest defines the request schema for /paymentprofile/get
3 properties
1 required
ScreeningHitDocumentsItems
object
Analyzed document information for the associated hit
2 properties
BeaconDuplicateGetRequest
object
Request input for getting a Beacon Duplicate
3 properties
1 required
CreditPayStubEarnings
object
An object representing both a breakdown of earnings on a pay stub and the total earnings.
2 properties
2 required
TransferEvent
object
Represents an event in the Transfers API.
14 properties
11 required
BaseReport
object
An object representing a Base Report
5 properties
4 required
CreditBankIncomeAccount
object
The Item's bank accounts that have the selected data.
7 properties
7 required
CraLoanStatus
string
The status of the loan.
EntityWatchlistCode
string
Shorthand identifier for a specific screening list for entities. AUCON: Australia Department of Foreign Affairs and Trade Consolidated List CACON: Government o…
TransferLedgerDepositResponse
object
Defines the response schema for /transfer/ledger/deposit
2 properties
2 required
CraPredictionInterval
object
The object containing prediction interval data.
3 properties
AddressMatchScore
objectnull
Score found by matching address provided by the API with the address on the account at the financial institution. The score can range from 0 to 100 where 100 i…
2 properties
ProcessorTransactionsRecurringGetRequest
object
ProcessorTransactionsRecurringGetRequest defines the request schema for /processor/transactions/recurring/get
4 properties
1 required
IdentityVerificationDocumentStreet
string
The full street address extracted from the document.
CreditBankEmploymentWarning
object
The warning associated with the data that was unavailable for the Bank Employment Report.
3 properties
3 required
AssetReportAuditCopyRemoveRequest
object
AssetReportAuditCopyRemoveRequest defines the request schema for /assetreport/auditcopy/remove
3 properties
1 required
DepositSwitchCreateRequestOptions
object
Options to configure the /depositswitch/create request. If provided, cannot be null.
2 properties
Employer
object
Data about the employer.
4 properties
4 required
Enhancements
object
A grouping of the Plaid produced transaction enhancement fields.
11 properties
4 required
TransferConfigurationGetResponse
object
Defines the response schema for /transfer/configuration/get
10 properties
10 required
TransactionsUserInsightsGetRequest
object
TransactionsUserInsightsGetRequest defines the request schema for /beta/transactions/userinsights/v1/get.
3 properties
1 required
BeaconReportSyndicationAnalysis
object
Analysis of which fields matched between the originally reported Beacon User and the Beacon User that the report was syndicated to.
7 properties
7 required
TransferLedgerDistributeResponse
object
Defines the response schema for /transfer/ledger/distribute
1 property
1 required
SandboxTransferSimulateRequest
object
Defines the request schema for /sandbox/transfer/simulate
6 properties
2 required
CreditAccountSubtype
string
Valid account subtypes for credit accounts. For a list containing descriptions of each subtype, see [Account schemas](https://plaid.com/docs/api/accounts/Stand…
LinkTokenCreateRequest
object
LinkTokenCreateRequest defines the request schema for /link/token/create
42 properties
4 required
BeaconReport
object
A Beacon Report describes the type of fraud committed by a user as well as the date the fraud was committed and the total amount of money lost due to the fraud…
7 properties
7 required
CraLoansUpdateRequest
object
CraLoansUpdateRequest defines the request schema for /cra/loans/update
3 properties
1 required
TransferPaymentProfileToken
string
The payment profile token associated with the Payment Profile that will be debited or credited. Required if not using accesstoken.
BaseReportItem
object
A representation of an Item within a Base Report.
4 properties
4 required
EmploymentDetails
object
An object representing employment details found on a paystub.
2 properties
IdentityVerificationDocumentPostalCode
stringnull
The postal code extracted from the document. Between 2 and 10 alphanumeric characters. For US-based addresses this must be 5 numeric digits.
WatchlistScreeningSearchTerms
object
Search terms for creating an individual watchlist screening
6 properties
6 required
LinkTokenInvestments
object
Configuration parameters for the Investments product
2 properties
PaymentInitiationConsentPaymentExecuteResponse
object
PaymentInitiationConsentPaymentExecuteResponse defines the response schema for /paymentinitiation/consent/payment/execute
3 properties
3 required
WatchlistScreeningAuditTrail
object
Information about the last change made to the parent object specifying what caused the change as well as when it occurred.
3 properties
3 required
BankTransferNetwork
string
The network or rails used for the transfer. Valid options are ach, same-day-ach, or wire.
FDXNotification
object
Provides the base fields of a notification. Clients will read the type property to determine the expected notification payload
10 properties
5 required
BankTransferSweepGetRequest
object
Defines the request schema for /banktransfer/sweep/get
3 properties
1 required
TaxpayerIdentifier
object
Information about the Taxpayer identification values assigned to the individual or legal entity.Information about the Taxpayer identification values assigned t…
2 properties
2 required
CounterpartyInsights
object
Insights around a user's counterparties
2 properties
ProcessorTokenPermissionsGetRequest
object
ProcessorTokenPermissionsGetRequest defines the request schema for /processor/token/permissions/get
3 properties
1 required
AddressDataNotRequired
object
Data about the components comprising an address.
5 properties
ProcessorTokenPermissionsSetResponse
object
ProcessorTokenPermissionsSetResponse defines the response schema for /processor/token/permissions/set
1 property
1 required
ProcessorTransactionsGetResponse
object
ProcessorTransactionsGetResponse defines the response schema for /processor/transactions/get
4 properties
4 required
PaymentAmountCurrency
string
The ISO-4217 currency code of the payment. For standing orders and payment consents, "GBP" must be used. For Poland, Denmark, Sweden and Norway, only the local…
PaymentAmountToRefund
The amount and currency of a payment
TransferMigrateAccountResponse
object
Defines the response schema for /transfer/migrateaccount
3 properties
3 required
CraPartnerInsightsItem
object
The details and metadata for an end user's Item.
4 properties
PaymentProfileGetResponse
object
PaymentProfileGetResponse defines the response schema for /paymentprofile/get
5 properties
5 required
DocumentNameMatchCode
string
A match summary describing the cross comparison between the subject's name, extracted from the document image, and the name they separately provided to identit…
CreditSessionsGetRequest
object
CreditSessionsGetRequest defines the request schema for /credit/sessions/get
3 properties
1 required
WatchlistScreeningIndividualProgramListRequest
object
Request input for listing watchlist screening programs for individuals
3 properties
WatchlistScreeningEntityGetRequest
object
Request input for fetching an entity watchlist screening
3 properties
1 required
PaymentInitiationRecipientListResponse
object
PaymentInitiationRecipientListResponse defines the response schema for /paymentinitiation/recipient/list
2 properties
2 required
PaymentAmountNullable
objectnull
The amount and currency of a payment
2 properties
2 required
EntityWatchlistScreeningReview
object
A review submitted by a team member for an entity watchlist screening. A review can be either a comment on the current screening state, actions taken against h…
5 properties
5 required
BeaconAccountRiskEvaluateRequestOptions
object
An optional object to filter /beacon/accountrisk/v1/evaluate results to a subset of the accounts on the linked Item.
1 property
ProcessorBalanceGetRequestOptions
object
Optional parameters to /processor/balance/get.
1 property
OriginatorExpectedTransferFrequency
string
The originator's expected transfer frequency.
BeaconUserRequestData
object
A Beacon User's data which is used to check against duplicate records and the Beacon Fraud Network.
7 properties
2 required
CreditPayrollIncomeRefreshStatus
string
The verification refresh status. One of the following: "USERPRESENCEREQUIRED" User presence is required to refresh an income verification. "SUCCESSFUL" The inc…
EarningsTotal
object
An object representing both the current pay period and year to date amount for an earning category.
7 properties
FDXParty
object
FDX Participant - an entity or person that is a part of a FDX API transaction
7 properties
2 required
InvestmentsHoldingsGetRequest
object
InvestmentsHoldingsGetRequest defines the request schema for /investments/holdings/get
4 properties
1 required
ScopesNullable
The scopes object
PayrollIncomeObject
object
An object representing payroll data.
4 properties
4 required
IdentityVerificationAutofillUserData
objectnull
User information that was autofilled. All this information should be confirmed by the user before using.
3 properties
3 required
CreditBankStatementUploadTransaction
object
An object containing data about a transaction appearing on a user-uploaded bank statement.
4 properties
4 required
AccountsBalanceGetRequestOptions
object
Optional parameters to /accounts/balance/get.
2 properties
BaseReportAverageFlowInsights
object
Average dollar amount of credit or debit transactions out of the account. This field will only added for depository accounts
3 properties
InstitutionsGetRequestOptions
object
An optional object to filter /institutions/get results.
6 properties
WatchlistScreeningIndividualReviewListResponse
object
Paginated list of screening reviews
3 properties
3 required
HostedLinkDeliveryMethod
string
How Plaid should deliver the Plaid Link session to the customer. Only available to customers enabled for Link Delivery (beta). To request Link Delivery access,…
EntityScreeningHitUrlsItems
object
Analyzed URLs for the associated hit
2 properties
FDXNotificationCategory
string
Category of Notification
CreditFreddieMacLoan
object
Information specific to a mortgage loan agreement between one or more borrowers and a mortgage lender.
2 properties
2 required
IdentityMatchRequest
object
IdentityMatchRequest defines the request schema for /identity/match
5 properties
1 required
RecurringTransferID
string
Plaid’s unique identifier for a recurring transfer.
Email
object
An object representing an email address
3 properties
3 required
CreditBankIncomeSummary
object
Summary for bank income across all income sources and items (max history of 730 days).
10 properties
PartnerCustomerGetRequest
object
Request schema for /partner/customer/get.
3 properties
1 required
ExternalPaymentScheduleBase
objectnull
The schedule that the payment will be executed on. If a schedule is provided, the payment is automatically set up as a standing order. If no schedule is specif…
5 properties
AuthSupportedMethods
objectnull
Metadata specifically related to which auth methods an institution supports.
4 properties
4 required
RiskCheckStolenIdentity
objectnull
Field containing the data used in determining the outcome of the stolen identity risk check. Contains the following fields: score - A score from 0 to 100 indic…
1 property
1 required
WalletListResponse
object
WalletListResponse defines the response schema for /wallet/list
3 properties
2 required
SignalPaymentMethod
stringnull
The payment method to complete the transaction after the risk assessment. It may be different from the default payment method. SAMEDAYACH: Same Day ACH by NACH…
CreditCategory
objectnull
Information describing the intent of the transaction. Most relevant for credit use cases, but not limited to such use cases. See the [taxonomy csv file](https:…
2 properties
2 required
UserUpdateResponse
object
UserUpdateResponse defines the response schema for /user/update
1 property
1 required
TransferAccountID
string
The Plaid accountid corresponding to the end-user account that will be debited or credited.
BeaconUserCreateRequest
object
Request input for creating a Beacon User. The primary use for this endpoint is to add a new end user to Beacon for fraud and duplicate scanning. Some fields ar…
5 properties
3 required
WalletTransactionIdempotencyKey
string
A random key provided by the client, per unique wallet transaction. Maximum of 128 characters. The API supports idempotency for safely retrying requests withou…
PartnerEndCustomerWithSecrets
object
The details for the newly created end customer, including secrets for non-Production environments.
EntityScreeningHitPhoneNumbers
object
Phone number information associated with the entity screening hit
2 properties
2 required
NumbersIBAN
string
International Bank Account Number (IBAN).
TransferAccessToken
string
The Plaid accesstoken for the account that will be debited or credited.
DashboardUserStatus
string
The current status of the user.
SandboxPaymentProfileResetLoginResponse
object
SandboxPaymentProfileResetLoginResponse defines the response schema for /sandbox/paymentprofile/resetlogin
2 properties
2 required
TransferLedgerSweepSimulateEventType
string
The asynchronous event to be simulated. May be: posted, settled, failed, or returned. An error will be returned if the event type is incompatible with the curr…
PaymentScheduleInterval
string
The frequency interval of the payment.
TaxpayerIdentifierType
stringnull
A value from a MISMO prescribed list that classifies identification numbers used by the Internal Revenue Service (IRS) in the administration of tax laws. A Soc…
TransferOriginatorCreateRequest
object
Defines the request schema for /transfer/originator/create
3 properties
1 required
Location
object
A representation of where a transaction took place
8 properties
8 required
PayStubPayPeriodDetails
object
Details about the pay period.
10 properties
9 required
WatchlistScreeningPhoneNumberNullable
stringnull
A phone number in E.164 format.
TransferFundingAccount
object
The originator's funding account, linked with Plaid Link or /transfer/migrateaccount.
2 properties
2 required
AccountProductAccessNullable
Allow the application to access specific products on this account
IncomeVerificationCreateRequest
object
IncomeVerificationCreateRequest defines the request schema for /income/verification/create
5 properties
1 required
ProcessorTokenCreateRequest
object
ProcessorTokenCreateRequest defines the request schema for /processor/token/create
5 properties
3 required
TransferDiligenceDocumentUploadResponse
object
Defines the response schema for /transfer/diligence/document/upload
1 property
1 required
Form1099Type
string
Form 1099 Type
AccountVerificationInsightsAccountNumberFormat
string
Indicator of account number format validity for institution. valid: indicates that the account number has a correct format for the institution. invalid: indica…
ClientProvidedEnhancedTransaction
object
A client-provided transaction that Plaid has enhanced.
5 properties
5 required
LinkProfileEligibilityCheckUser
object
An object specifying information about the end user who will be sharing their profile in this Link session
1 property
1 required
KYCCheckAddressSummary
object
Result summary object specifying how the address field matched.
3 properties
3 required
TransferAuthorizationID
string
Plaid’s unique identifier for a transfer authorization.
ProcessorTokenCreateResponse
object
ProcessorTokenCreateResponse defines the response schema for /processor/token/create and /processor/apex/processortoken/create
2 properties
2 required
EntityWatchlistProgram
object
A program that configures the active lists, search parameters, and other behavior for initial and ongoing screening of entities.
8 properties
8 required
WatchlistScreeningDocumentValue
string
The numeric or alphanumeric identifier associated with this document.
ProcessorIdentityGetRequest
object
ProcessorIdentityGetRequest defines the request schema for /processor/identity/get
3 properties
1 required
WatchlistScreeningEntityReviewListRequest
object
Request input for listing reviews for an entity watchlist screening
4 properties
1 required
IndividualName
object
Parent container for name that allows for choice group between parsed and unparsed containers.Parent container for name that allows for choice group between pa…
2 properties
2 required
PaymentProfileRemoveResponse
object
PaymentProfileRemoveResponse defines the response schema for /paymentprofile/remove
1 property
1 required
TransferFailure
objectnull
The failure reason if the event type for a transfer is "failed" or "returned". Null value otherwise.
2 properties
InstitutionsGetByIdRequestOptions
object
Specifies optional parameters for /institutions/getbyid. If provided, must not be null.
4 properties
CreditFreddieMacParties
object
A collection of objects that define specific parties to a deal. This includes the direct participating parties, such as borrower and seller and the indirect pa…
1 property
1 required
CraBankIncomeItem
object
The details and metadata for an end user's Item.
5 properties
2 required
AccountsGetRequestOptions
object
An optional object to filter /accounts/get results.
1 property
EntityDocument
object
An official document, usually issued by a governing body or institution, with an associated identifier.
2 properties
2 required
Transfer
object
Represents a transfer within the Transfers API.
31 properties
24 required
CraLoanStatusEffectiveDate
string
The effective date for the status of the loan. The date should be in ISO 8601 format (YYYY-MM-DD).
SandboxPublicTokenCreateRequest
object
SandboxPublicTokenCreateRequest defines the request schema for /sandbox/publictoken/create
6 properties
2 required
PaymentInitiationConsentStatus
string
The status of the payment consent. UNAUTHORISED: Consent created, but requires user authorisation. REJECTED: Consent authorisation was rejected by the user and…
TransactionsRefreshRequest
object
TransactionsRefreshRequest defines the request schema for /transactions/refresh
3 properties
1 required
WatchlistScreeningEntityUpdateResponse
object
The entity screening object allows you to represent an entity in your system, update its profile, and search for it on various watchlists. Note: Rejected entit…
7 properties
7 required
WatchlistScreeningIndividualUpdateRequestResettableFieldList
arraynull
A list of fields to reset back to null
FamilyNameField
string
A string with at least one non-whitespace character, with a max length of 100 characters.
ISO8601DateNullable
stringnull
A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).
LoanIdentifiers
object
Collection of current and previous identifiers for this loan.
1 property
1 required
BankTransfer
object
Represents a bank transfer within the Bank Transfers API.
17 properties
17 required
TransferOriginatorFundingAccountUpdateResponse
object
Defines the response schema for /transfer/originator/fundingaccount/update
1 property
1 required
CreditBankIncomeRefreshRequest
object
CreditBankIncomeRefreshRequest defines the request schema for /credit/bankincome/refresh.
4 properties
1 required
CreditPayrollIncomeRefreshRequest
object
CreditPayrollIncomeRefreshRequest defines the request schema for /credit/payrollincome/refresh
4 properties
1 required
IncidentUpdate
object
An update on the health incident
3 properties
Earnings
object
An object representing both a breakdown of earnings on a paystub and the total earnings.
4 properties
CreditSessionBankIncomeResult
object
The details of a bank income verification in Link
3 properties
LiabilitiesGetRequest
object
LiabilitiesGetRequest defines the request schema for /liabilities/get
4 properties
1 required
DocumentStatus
string
An outcome status for this specific document submission. Distinct from the overall documentaryverification.status that summarizes the verification outcome from…
Transaction
A representation of a transaction
PartnerCustomerCreateRequest
object
Request schema for /partner/customer/create.
18 properties
7 required
SandboxTransferTestClockAdvanceResponse
object
Defines the response schema for /sandbox/transfer/testclock/advance
1 property
1 required
CreditSessionBankIncomeStatus
string
Status of the Bank Income Link session. APPROVED: User has approved and verified their income NODEPOSITSFOUND: We attempted, but were unable to find any income…
BeaconUserRequestAddressNullable
objectnull
Home address for the associated user. For more context on this field, see [Input Validation by Country](https://plaid.com/docs/identity-verification/hybrid-inp…
6 properties
3 required
CreditFreddieMacReportingInformation
object
Information about an report identifier and a report name.
4 properties
1 required
NumbersACATS
object
Identifying information for transferring holdings to an investments account via ACATS.
3 properties
3 required
WalletTransactionCounterparty
object
An object representing the e-wallet transaction's counterparty
4 properties
2 required
ExternalPaymentInitiationConsentOptions
objectnull
Additional payment consent options
3 properties
AssetReportGetRequest
object
AssetReportGetRequest defines the request schema for /assetreport/get
7 properties
DashboardUser
object
Account information associated with a team member with access to the Plaid dashboard.
4 properties
4 required
CraBankIncomeEmployer
object
The object containing employer data.
1 property
1 required
TransferRecurringNetwork
string
Networks eligible for recurring transfers.
StatementsRefreshResponse
object
StatementsRefreshResponse defines the response schema for /statements/refresh
1 property
1 required
KYCCheckNameSummary
object
Result summary object specifying how the name field matched.
1 property
1 required
TransferOriginatorAddress
object
The originator's address.
5 properties
5 required
Assets
object
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
1 property
1 required
LinkTokenEUConfig
object
Configuration parameters for EU flows
1 property
Statuses
object
A collection of STATUS containers.
1 property
1 required
RiskCheckBehaviorUserInteractionsLabel
string
Field describing the overall user interaction signals of a behavior risk check. This value represents how familiar the user is with the personal data they prov…
TransferCreateRequest
object
Defines the request schema for /transfer/create
17 properties
4 required
ClientProvidedRawTransaction
object
A client-provided transaction for Plaid to enhance.
4 properties
4 required
MortgagePropertyAddress
object
Object containing fields describing property address.
5 properties
5 required
AddressDataNullable
Data about the components comprising an address.
SandboxOauthSelectAccountsRequest
object
Defines the request schema for sandbox/oauth/selectaccounts
2 properties
2 required
TransactionBase
object
A representation of a transaction
20 properties
7 required
TransactionsEnrichRequestOptions
object
An optional object to be used with the request.
1 property
PaystubAddress
object
Address on the paystub
8 properties
SimulatedTransferSweep
object
A sweep returned from the /sandbox/transfer/sweep/simulate endpoint. Can be null if there are no transfers to include in a sweep.
IdentityVerificationAutofillCreateRequest
object
Request input to autofill an Identity Verification
3 properties
1 required
CraBankIncomeSummary
object
Summary for bank income across all income sources and items (max history of 730 days).
13 properties
WatchlistScreeningEntityListRequest
object
Request input for listing entity watchlist screenings
7 properties
1 required
InstitutionsSearchRequest
object
InstitutionsSearchRequest defines the request schema for /institutions/search
6 properties
2 required
BeaconUserRevision
object
A Beacon User Revision identifies a Beacon User at some point in its revision history.
2 properties
2 required
ACHClass
string
Specifies the use case of the transfer. Required for transfers on an ACH network. Codes supported for credits: ccd, ppd Codes supported for debits: ccd, tel, w…
TransferRefundGetResponse
object
Defines the response schema for /transfer/refund/get
2 properties
2 required
SandboxIncomeWebhookFireRequestWebhookCode
string
The webhook codes that can be fired by this test endpoint.
SelfieCheck
objectnull
Additional information for the selfiecheck step. This field will be null unless steps.selfiecheck has reached a terminal state of either success or failed.
2 properties
2 required
CreditBankEmploymentGetRequest
object
CreditBankEmploymentGetRequest defines the request schema for /beta/credit/v1/bankemployment/get.
3 properties
1 required
ProcessorAccountGetRequest
object
ProcessorAccountGetRequest defines the request schema for /processor/account/get
3 properties
1 required
WalletBalance
object
An object representing the e-wallet balance
3 properties
3 required
DepositoryAccountSubtype
string
Valid account subtypes for depository accounts. For a list containing descriptions of each subtype, see [Account schemas](https://plaid.com/docs/api/accounts/S…
WebhookVerificationKeyGetRequest
object
WebhookVerificationKeyGetRequest defines the request schema for /webhookverificationkey/get
3 properties
1 required
SelfieAnalysis
object
High level descriptions of how the associated selfie was processed. If a selfie fails verification, the details in the analysis object should help clarify why…
1 property
1 required
CreditDocumentType
stringnull
The type of document. PAYSTUB: A paystub. BANKSTATEMENT: A bank statement. USTAXW2: A W-2 wage and tax statement provided by a US employer reflecting wages ear…
TransferGetResponse
object
Defines the response schema for /transfer/get
2 properties
2 required
EmailAddressNullable
stringnull
A valid email address.
HostedLinkIsMobileApp
boolean
This indicates whether the client is opening hosted Link in a mobile app in an out of process web view (OOPWV) (i.e., an AsWebAuthenticationSession / SFSafariV…
DepositoryFilter
object
A filter to apply to depository-type accounts
1 property
1 required
SandboxTransferSimulateResponse
object
Defines the response schema for /sandbox/transfer/simulate
1 property
1 required
TransactionsRefreshResponse
object
TransactionsRefreshResponse defines the response schema for /transactions/refresh
1 property
1 required
RiskCheckIdentityAbuseSignals
objectnull
Result summary object capturing abuse signals related to identity abuse, e.g. stolen and synthetic identity fraud. These attributes are only available for US i…
2 properties
2 required
EmailAddress
string
A valid email address.
Institution
object
Details relating to a specific financial institution
13 properties
6 required
GenericCountryCode
string
Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.
InstitutionStatus
objectnull
The status of an institution is determined by the health of its Item logins, Transactions updates, Investments updates, Liabilities updates, Auth requests, Bal…
9 properties
PaymentConsentPeriodicAmount
object
Defines consent payments limitations per period.
3 properties
3 required
CreditBankIncome
object
The report of the Bank Income data for an end user.
6 properties
UserCreateResponse
object
UserCreateResponse defines the response schema for /user/create
3 properties
3 required
TransferIntentGet
object
Represents a transfer intent within Transfer UI.
21 properties
16 required
ItemImportRequest
object
ItemImportRequest defines the request schema for /item/import
5 properties
2 required
AssetReportItem
object
A representation of an Item within an Asset Report.
5 properties
5 required
PartnerEndCustomerAssetsUnderManagement
object
Assets under management for the given end customer. Required for end customers with monthly service commitments.
2 properties
2 required
InvestmentsAuthGetRequest
object
InvestmentsAuthGetRequest defines the request schema for /investments/auth/get
4 properties
1 required
Cursor
stringnull
An identifier that determines which page of results you receive.
IdentityVerificationRetryRequest
object
Request input for retrying an identity verification attempt
7 properties
3 required
SignalEvaluateResponse
object
SignalEvaluateResponse defines the response schema for /signal/income/evaluate
5 properties
3 required
WatchlistScreeningEntityProgramListResponse
object
Paginated list of entity watchlist screening programs
3 properties
3 required
BankTransferType
string
The type of bank transfer. This will be either debit or credit. A debit indicates a transfer of money into the origination account; a credit indicates a transf…
TransferMetadata
objectnull
The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply: The JSON values must be Strings (no nes…
IncomeVerificationPrecheckEmployerAddressData
object
Data about the components comprising an address.
5 properties
TransferRecurringCreateRequest
object
Defines the request schema for /transfer/recurring/create
17 properties
9 required
CreditFreddieMacAsset
object
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
5 properties
5 required
IdentityVerificationDocumentCountryCode
string
Valid, capitalized, two-letter ISO code representing the country extracted from the document. Must be in ISO 3166-1 alpha-2 form.
CreditBankIncomeItem
object
The details and metadata for an end user's Item.
6 properties
BeaconReportSyndicationOriginalReport
object
A subset of information from a Beacon Report that has been syndicated to a matching Beacon User in your program. The id field in the response is the ID of the…
4 properties
4 required
LinkTokenGetSessionsResponse
object
An object containing information about a link session. Session data will be provided for up to six hours after the session has ended.
8 properties
1 required
TransferScheduleIntervalUnit
string
The unit of the recurring interval.
CraBankIncomeWarning
object
The warning associated with the data that was unavailable for the Bank Income Report.
3 properties
BankTransferMigrateAccountRequest
object
Defines the request schema for /banktransfer/migrateaccount
6 properties
3 required
PrismCashScoreMetadata
object
An object containing metadata about the provided transactions.
10 properties
10 required
Paystub
object
An object representing data extracted from the end user's paystub.
11 properties
7 required
TransferUserAddressInResponse
objectnull
The address associated with the account holder.
5 properties
5 required
ValidationSource
object
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
2 properties
2 required
CreditBankIncomePayFrequency
string
The income pay frequency.
LinkSessionSuccessMetadataAccount
object
An account attached to the connected Item.
7 properties
CreditBankIncomeGetRequest
object
CreditBankIncomeGetRequest defines the request schema for /credit/bankincome/get.
4 properties
WalletTransactionListRequestOptions
objectnull
Additional wallet transaction options
2 properties
Credit1099Recipient
object
An object representing a recipient used in both 1099-K and 1099-MISC tax documents.
6 properties
IdentityDocumentsUploadsGetRequest
object
IdentityDocumentsUploadsGetRequest defines the request schema for /identity/documents/uploads/get
4 properties
1 required
AssetReportPDFGetRequestOptions
object
An optional object to filter or add data to /assetreport/get results. If provided, must be non-null.
1 property
Region
stringnull
An ISO 3166-2 subdivision code. Related terms would be "state", "province", "prefecture", "zone", "subdivision", etc.
PrismProduct
string
The prism products that can be returned by the Plaid API
BankTransferIdempotencyKey
string
A random key provided by the client, per unique bank transfer. Maximum of 50 characters. The API supports idempotency for safely retrying requests without acci…
ItemStatus
objectnull
An object with information about the status of the Item.
3 properties
LinkTokenCreateRequestIncomeVerification
object
Specifies options for initializing Link for use with the Income product. This field is required if incomeverification is included in the products array.
7 properties
SandboxTransferTestClockGetResponse
object
Defines the response schema for /sandbox/transfer/testclock/get
2 properties
2 required
ShareableURL
stringnull
A shareable URL that can be sent directly to the user to complete verification
CraLoanUnregister
object
Contains loan data for the loan being unregistered.
2 properties
2 required
ProfileItem
object
ProfileItem defines an Item created during a profile authorization session.
2 properties
StatementsListResponse
object
StatementsListResponse defines the response schema for /statements/list
5 properties
5 required
ProcessorNumber
object
An object containing identifying numbers used for making electronic transfers to and from the account. The identifying number type (ACH, EFT, IBAN, or BACS) us…
4 properties
IdentityVerificationDocumentCity
string
City extracted from the document.
ExternalPaymentOptions
objectnull
Additional payment options
4 properties
KYCCheckPhoneSummary
object
Result summary object specifying how the phone field matched.
2 properties
2 required
CreditRelayGetRequest
object
CreditRelayGetRequest defines the request schema for /credit/relay/get
5 properties
2 required
CreditFreddieMacPartyIndividual
object
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
1 property
1 required
BaseReportLongestGapInsights
object
Largest number of days between sequential transactions per calendar month
3 properties
DocumentImage__CroppedBack
stringnull
Temporary URL that expires after 60 seconds for downloading a cropped image containing just the back of the document. Might be null if the back of the document…
RoleDetail
object
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
1 property
1 required
WatchlistScreeningHit
object
Data from a government watchlist or PEP list that has been attached to the screening.
10 properties
8 required
ProcessorSignalPrepareRequest
object
ProcessorSignalPrepareRequest defines the request schema for /processor/signal/prepare
3 properties
1 required
AssetReportCreateRequest
object
AssetReportCreateRequest defines the request schema for /assetreport/create
5 properties
1 required
InvestmentHoldingsGetRequestOptions
object
An optional object to filter /investments/holdings/get results. If provided, must not be null.
1 property
AssetReportPDFGetRequest
object
AssetReportPDFGetRequest defines the request schema for /assetreport/pdf/get
4 properties
1 required
LedgerDistributeIdempotencyKey
string
A unique key provided by the client, per unique ledger distribute. Maximum of 50 characters. The API supports idempotency for safely retrying the request witho…
AccountSubtype
stringnull
See the [Account type schema](https://plaid.com/docs/api/accounts/account-type-schema) for a full listing of account types and corresponding subtypes.
RiskCheckBehaviorFraudRingDetectedLabel
string
Field describing the outcome of a fraud ring behavior risk check. yes indicates that fraud ring activity was detected. no indicates that fraud ring activity wa…
IdentityDocumentUploadRiskInsights
object
In closed beta. Object representing fraud risk data of the document
2 properties
DepositSwitchGetRequest
object
DepositSwitchGetRequest defines the request schema for /depositswitch/get
3 properties
1 required
RecurringTransactionFrequency
string
Describes the frequency of the transaction stream. WEEKLY: Assigned to a transaction stream that occurs approximately every week. BIWEEKLY: Assigned to a trans…
ScreeningHitData
object
Information associated with the watchlist hit
4 properties
ScreeningHitAnalysis
object
Analysis information describing why a screening hit matched the provided user information
5 properties
1 required
TransferListResponse
object
Defines the response schema for /transfer/list
2 properties
2 required
LinkTokenCreateRequestEmployment
object
Specifies options for initializing Link for use with the Employment product. This field is required if employment is included in the products array.
2 properties
CreditAuditCopyTokenUpdateRequest
object
CreditAuditCopyTokenUpdateRequest defines the request schema for /credit/auditcopytoken/update
4 properties
2 required
ServiceProductFulfillmentDetail
object
Documentation not found in the MISMO model viewer and not provided by Freddie Mac.
2 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
#Plaid
Where this information came from
This is an independent, third-party profile of Plaid Plaid API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.