Plaid changelog

• Added the LOGIN_REPAIRED webhook. This webhook will fire when an Item's status transitions from ITEM_LOGIN_REQUIRED to a healthy state, without the user having used the update mode flow in your app.

• Added Update Mode Product Validations (beta). Update Mode Product Validations (UMPV) allows you to validate that a user going through update mode at an OAuth instutition has selected the appropriate authorizations to enable Auth and/or Identity. If they do not select the correct options, they will be prompted to update their selections.

• Added Optional Products. If a product is specified in the optional_products field when calling /link/token/create, the product will be added to the Item if possible. However, if the product cannot be added to the Item -- for example, because the Item is not supported by the institution, the user did not grant the correct OAuth permissions, or because of an institution connectivity error for that product -- Item creation will still succeed with the other products specified.

• Added institution_not_supported as a potential Link session exit metadata status.

  For Auth:

• Added Instant Micro-Deposits, allowing end users to verify their accounts in seconds, using micro-deposits sent over RTP or FedNow rails. Instant Micro-Deposits can be used as a faster alternative to Same-Day Micro-Deposits at supported institutions.

  For Assets:

• Deprecated report_type field used in /asset_report/create, and replaced it with verification_report_type. This change was made to avoid confusion with the existing report_type field used to by the PRODUCT_READY webhook to distinguish between Fast Asset Reports and Full Asset Reports.

For Signal:

• Launched the Signal Dashboard to help customers monitor return rates and tune Signal risk score thresholds.

For Transfer:

• Launched Transfer from beta to Early Availability (EA) status.
• Added support for FedNow payments, which can be accessed by specifying rtp as the payment network.
• Added Plaid Ledger. Your Plaid Ledger allows you to maintain a funds balance with Plaid, which can be used to fund payouts over FedNow and RTP rails. You can use APIs to move money in and our of your Ledger.
• Removed Payment Profiles; access tokens are now the only supported mechanisms for connecting accounts on Transfer.
• Removed beacon_id, as it was used only to support Guarantee. Guarantee is no longer offered and will be replaced by a more sophisticated set of risk management tools within Transfer.

For Income:

• Updated API docs to reflect "NOT LISTED" as a potential value for marital_status.

For Statements (beta):

• Released Statements in beta. Statements allows you to retrieve an exact PDF copy of a customer's statement at supported institutions.

For Enrich:

• Added frequency field to recurring transactions to indicate the recurrence frequency.

For Identity Verification:

• Added area_code match status to the responses of the /identity_verification/get and /identity_verification/list endpoints.

For Income:

• Added a number of new categories for Payroll Income canonical_description field: ALLOWANCE, BEREAVEMENT, HOLIDAY_PAY, JURY_DUTY, LEAVE, LONG_TERM_DISABILITY_PAY, MILITARY_PAY, PER_DIEM, REFERRAL_BONUS, REIMBURSEMENTS, RETENTION_BONUS, RETROACTIVE_PAY, SEVERANCE_PAY, SHIFT_DIFFERENTIAL, SHORT_TERM_DISABILITY_PAY, SICK_PAY, SIGNING_BONUS, and TIPS_INCOME. Also made null a valid value.
• Added status field to /credit/payroll_income/risk_signals/get to show the status of evaluated documents.
• Added payroll_income.parsing_config to /link/token/create to expose configuration options for risk signal evaluation.

For Liabilities:

• Added saving on a valuable education (SAVE) as a student loan repayment plan type.

For Signal:

• Added the ability to change an initiated status reported via /signal/decision/report. Previously, attempting to change the status of a reported decision that was originally reported as initiated would result in an INVALID_FIELD error; now it is allowed.

For Transfer:

• Added failure_reason to refund objects to indicate why a Transfer refund failed.

For Virtual Accounts:

• Added failure_reason to /wallet/transaction/get and /wallet/transaction/list endpoints to indicate why a wallet transaction failed.

• Added /processor/token/webhook/update endpoint to allow customers using processor partners to update the webhook endpoint associated with a processor token.

For Assets:

• Made asset_report_token optional in /asset_report/get request to support future development of Asset Reports based on other types of tokens.

For Investments:

• Added the async_update option for /investments/transactions/get, along with an accompanying HISTORICAL_UPDATE webhook. If async_update is enabled, the initial call to /investments/transactions/get for an Item will be made as an async call with a webhook, similar to /transactions/get.

For Enrich:

• Added confidence_level to counterparty and personal_finance_category fields.

For Identity Verification:

• Added date_of_birth and address fields to documentary_verification.documents[].extracted_data in the response of all Identity Verification endpoints.
• Mark all region and postal_code fields as nullable, to better support countries that do not use these fields.

For Transfer:

• Added transfer_id and status filters to /transfer/sweep/list request.
• Added status field to the sweep object.

• Added the required_if_supported_products field to /link/token/create. When using multiple Plaid products, you can use this field to specify products that must be enabled when the user's institution and account type support them, while still allowing users to add Items if the institution or linked account doesn't support these products. If a product in this field cannot be enabled at a compatible institution (for example, because the user failed to grant the required OAuth permissions, generating an ACCESS_NOT_GRANTED error), the Item will not be created, and the user will be prompted to try again in the Link flow.

• Changed the behavior of the oauth field on the institution object. Previously, oauth would be true only if all Items at an institution used OAuth connections. Now, oauth is true if any Items at an institution use OAuth connections.

• Changed the behavior of the account_selection_enabled flag in /link/token/create. To improve conversion, at institutions that provide OAuth account selection flows, this flag will be overridden and treated as though it were always true. For other institutions, the flag behavior is unchanged.

For Auth:

• Added the ability to customize Same-day Microdeposit flows via the new reroute_to_credentials option in /link/token/create. Using this field, you can detect whether a user is attempting to use Same-day Microdeposits to add an institution that is supported via a direct Plaid connection, and optionally either require or recommend that they use a direct connection instead.

For Enrich:

• Added income_source enum to counterparty_type field.

For Identity Verification:

• Added the ability to prefill user data when retrying a verification by providing a user object to /identity_verification/retry.
• Added client_user_id field to /identity_verification/create. It is recommended to use this field instead of user.client_user_id, although both fields are supported.

For Income:

• Added num_bank_statements_uploaded to document_income_results object in /credit/sessions/get.

For Signal:

• Removed the maximum length constraint for client_user_id when calling /signal/evaluate or /processor/signal/evaluate.

For Transfer:

• Added the ability to specify a test_clock_id when calling /sandbox/transfer/sweep/simulate or /sandbox/transfer/simulate. If provided, the simulated action will take place at the virtual_time of the given test clock.
• Made the virtual_time field optional when calling /sandbox/transfer/test_clock/create. If a time is not provided, the current time will be used.
• Updated the sweep_id format to be either a UUID or an 8-character hexadecimal string.
• Made next_origination_date nullable in the recurring transfer object.

For Virtual Accounts:

• Added address and date of birth to /wallet/transaction/execute.
• Added payment scheme (scheme) to /wallet/transaction/get and /wallet/transaction/list.

For Assets:

• Added support for ASSETS: PRODUCT_READY and ASSETS: ERROR webhooks to /sandbox/item/fire_webhook

For Identity:

• Added is_business_name_detected to the /identity/match endpoint

For Identity Verification:

• Added the selfie_check field to the Income Verification object, to report the status of a selfie check.

For Document Income:

• Added the INCOME_VERIFICATION_RISK_SIGNALS webhook to indicate when /credit/payroll_income/risk_signals/get is ready to be called.

For Transfers:

• Increased the maximum length of the description field in /transfer/create to 15 characters.
• Added the /transfer/balance/get endpoint.
• To support prefunded credit processing, added the credit_funds_source field to distinguish between credits based on sweeps, RTP credit balances, and ACH credit balances, and made the funding_account_id field nullable.

For Processor partners:

• Added /processor/token/permissions/set and /processor/token/permissions/get endpoints.
• Added /processor/identity/match endpoint to allow Processor partners to support the new beta Identity Match feature.

For Signal:

• Added a warnings object to the /processor/signal/evaluate response.

For Income:

• Added STARTED and INTERNAL_ERROR statuses to /credit/sessions/get.

For Document Income:

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

For Identity Verification:

• Documented several fields in the user object of /link/token/create as being officially supported methods of pre-filling user data in Link for the Identity Verification flow, as an alternative to /identity_verification/create. (While this worked in the past, it was not previously an officially supported or documented flow.) As part of this change, un-deprecated the user.date_of_birth field.

For Enrich:

• Added recurrence and is_recurring fields to /transactions/enrich.

• To maximize conversion, updated Link to use a pop-up window for OAuth authentication rather than redirects on non-webview mobile web flows.
• Clarified that continue(from:) is no longer required for iOS OAuth integrations using Plaid's iOS and React Native iOS SDKs.
• Updated error codes for most RATE_LIMIT errors to be specific to the endpoint for which they apply.

For Auth:

• Changed the Link UI for Instant Match and Automated Micro-deposits flows to increase conversion by reducing the number of screens in the flow and removing unnecessary input fields. No developer action is required as a result of this change.

For Transactions:

• Added ANNUALLY as a possible frequency for recurring transactions in /transactions/recurring/get.

For Identity:

• Added /identity/match (beta) to simplify the process of using Identity for account ownership verification. /identity/match allows you to send user information such as name, address, email, and phone number, and returns a match score indicating how closely that data matches information on file with the financial institution, so that you no longer have to implement similarity matching logic on your own. /identity/match is currently in closed beta; to request access, contact your Account Manager or contact Sales.

For Identity Verification:

• Added risk_check object to Identity Verification API responses to provide more detail about the factors that influenced the risk check result.

For Assets:

• Released Fast Assets functionality to General Availability (GA). With Fast Assets, you can create a Fast Asset Report with partial information (current balance and identity data) in about half the time as a Full Asset Report, then request the Full Asset Report later. Fast Assets is available free of charge to all Assets customers. For more information, see the Assets API reference.
• Added the optional days_to_include field to /asset_report/get requests. This field allows you to optionally reduce the number of days displayed in an Asset Report, to improve usability for human reviewers.
• Added Freddie Mac as an audit copy token partner with auditor_id: freddie_mac.
• Added credit_category (beta) to transactions data returned by Asset Reports with Insights, describing the category of the transaction. Access to this field is in closed beta; to request access, contact your Account Manager.

For Income:

• Added support for bank_employment_results data to /credit/sessions/get. Employment functionality is currently in closed beta; for more details, contact your Account Manager.

For Signal:

• Added warnings field to /signal/evaluate response.

For Virtual Accounts:

• Added transaction_id to the Payment Initiation PAYMENT_STATUS_UPDATE webhook. This field will be present only when a payment was initiated using Virtual Accounts.
• Added payment_id and wallet_id to the WALLET_TRANSACTION_STATUS_UPDATE webhook.

• Added the persistent_account_id field (beta) to the account object. The persistent_account_id field identifies an account across multiple instances of the same Item, for use with Chase Items only, to simplify the management of Chase duplicate Item behavior. Access to this field is currently in closed beta; for more details, contact your Account Manager.

For Assets:

• Beginning March 31, 2023, Assets will be updated to return investment, instead of brokerage, as the account type for investment accounts. brokerage may still be returned as an account sub-type under the investment account type.

For Income:

• Added employment value to the products array for /link/token/create. Employment functionality is currently in closed beta; for more details, contact your account manager.

For Identity Verification:

• Added redacted_at field in Identity Verification response and Documentary Verification Document component.

For Transfer:

• Added the ability to specify a payment network (either ach or same-day-ach) when calling /transfer/intent/create.

For reseller partners:

• Added income_verification and employment as supported products for /partner/customer/create. Employment functionality is currently in closed beta.
• Added the ability to specify redirect_uris to /partner/customer/create.

For Virtual Accounts:

• Increased the minimum length of the reference field for /wallet/transaction/execute to 6 characters.
• To improve usability, added wallet_id field to /wallet/transaction/get and /wallet/transaction/list responses and to the WALLET_TRANSACTION_STATUS_UPDATE webhook.

For Payment Initiation:

• Increased the minimum length of the reference field for /payment_initiation/payment/reverse to 6 characters.
• To improve usability, added transaction_id field to the PAYMENT_STATUS_UPDATE webhook. This field will be populated when the payment status is PAYMENT_STATUS_SETTLED.
• Removed the deprecated options.wallet_id field from /payment_initiation/payment/create and /payment_initiation/consent/create.

For Signal:

• Added signal to the products array. For most current Signal customers, Signal is automatically enabled for all of their Items; over time, Signal will be moving to a model similar to Plaid's other products, in which customers instead initialize an Item with signal by adding signal to the products array when calling /link/token/create.

• Released Plaid React Native SDK 9.0.0 and Plaid iOS SDK 4.1.0. All iOS integrations must upgrade to these SDKs by June 30, 2023 in order to maintain support for Chase OAuth flows on iOS. Any integrations using webviews will also be required to update their webview handlers by June 30, 2023. For more details on required webview updates, see the OAuth Guide.
• Released improvements to the Returning User Experience (RUX): removing the requirement to provide a verified time for phone numbers and email addresses, making RUX flows available for more products, and adding Institution Boosting, which automatically surfaces institutions a user has previously linked to Plaid in the Link flow. Enabling RUX can increase conversion by 8% or more. For more details on how to enable RUX, see Returning User Experience documentation.

For Auth:

• Updated Same-Day Micro-deposits to make a single one-cent micro-deposit, which will not be reversed, rather than multiple micro-deposits. This change will reduce costs and decrease the incentive for micro-deposit fraud. No changes are required on the part of developers to support this change. This change will automatically be rolled out to customers over the next several months.

For Transfer:

• Added expected_settlement_date field to the Transfer object.
• Added funding_account_id field to clarify which account is used to fund a transfer. This field replaces the older origination_account_id.

For Virtual Accounts:

• Added status field to Wallet schema.

For Partners:

• Added PARTNER_END_CUSTOMER_OAUTH_STATUS_UPDATED webhook.

For Auth:

• Announced upcoming Instant Match automatic enrollment to existing customers who have not yet been enabled for Instant Match by default. Instant Match is a higher-converting experience for Link that expands Auth coverage to more end users. All customers will be enabled for Instant Match by default unless they opt-out by January 19, 2023, which they can do by contacting their Account Manager.

For Assets:

• Released relay tokens to beta, along with associated endpoints /credit/relay/create, /credit/relay/get, /credit/relay/refresh, and /credit/relay/remove. Relay tokens support sharing of Asset Reports with customers' authorized service providers, such as underwriters.

For Income:

• For /credit/bank_income/get, deprecated amount, iso_currency_code, and unofficial_currency_code at top levels in response in favor of new total_amounts field. This change enables more accurate reporting of income for users with income in multiple different currencies.
• Added new possible values to rate_of_pay field returned by /credit/payroll_income/get: WEEKLY, BI_WEEKLY, MONTHLY, SEMI_MONTHLY, DAILY, and COMMISSION.
• Added new pay_basis field to the response of /credit/payroll_income/get.

For Virtual Accounts:

• Added FUNDS_SWEEP as a possible transaction type.

For Transfer:

• Added /transfer/capabilities/get endpoint to provide information about which Items support Real Time Payments (RTP)
• Added endpoints /transfer/originator/get, /transfer/originator/list, /transfer/originator/create, and /transfer/questionnaire/create to support marketplaces and reseller partners in creating and managing transfer originators.
• Added the ability to create and manage recurring transfers. API changes include the new endpoints /transfer_recurring/create, /transfer/recurring/cancel, /transfer/recurring/get, and /transfer/recurring/list, as well as the new webhooks RECURRING_NEW_TRANSFER, RECURRING_TRANSFER_SKIPPED, and RECURRING_CANCELLED, and the test endpoints /sandbox/transfer/test_clock/create, /sandbox/transfer/test_clock/advance, /sandbox/transfer/test_clock/get, and /sandbox/transfer/test_clock/list.

For Enrich:

• Released Enrich to Early Availability. Enrich access is now available by default in Sandbox. For details on requesting access to use Enrich with real data, see the Enrich documentation.
• Added support for legacy categories, using categories from /categories/get, in addition to the newer personal_finance_category schema.
• Renamed counterparty type delivery_marketplace to marketplace and added counterparty type payment_terminal.

For the Reseller Partner API:

• Added /partner/customer/oauth_institutions/get endpoint to provide OAuth-institution registration information to Reseller Partners.

• Released Signal to general availability. Signal uses machine learning techniques to evaluate a proposed ACH transaction and determine the likelihood that the transaction will be reversed. It also provides fields and insights that you can incorporate into your own data models. By using the Signal API, you can release funds earlier to optimize your user experience while managing the risk of ACH returns.

For Auth:

• Enabled Instant Match by default for most existing customers.

For Investments:

• Notified customers that customers must hold a CGS (CUSIP Global Services) license to obtain CUSIP and ISIN data. Beginning in mid-September 2023, customers who do not have a record of this license with Plaid will receive null data in these fields. To maintain access to these fields, contact your Plaid Account Manager or investments-vendors@plaid.com.

For Payment Initiation:

• Added the ability to initiate partial refunds by specifying an amount when calling /payment_initiation/payment/reverse. As part of this change, added amount_refunded field to /payment_initiation/payment/get and /payment_initiation/payment/list.
• Added support for local payment schemes for all supported currencies (previously, only EUR and GBP local payment schemes been supported), and added the enum values LOCAL_DEFAULT and LOCAL_INSTANT to represent them. In the UK, the FASTER_PAYMENTS enum value has been replaced by LOCAL_DEFAULT.
• Removed support for currencies CHF and CZK.

For Virtual Accounts:

• For improved consistency, renamed /wallet/transactions/list to /wallet/transaction/list.
• For clarity, renamed start_date to start_time in the /wallet/transaction/list response to reflect that the field is a date-time.

For Transfer:

• Made account_id nullable in the responses for /transfer/authorization/create and /transfer/create.
• Added deleted_at field to /payment_profile/get response.
• Added refunds field to the transfer object.
• Added refund_id to the transfer event object.

For Reseller Partners:

• Added the /partner/customer/remove endpoint to disable customers who have not yet been enabled in Production.

• Added support for additional Link display languages: Danish, German, Estonian, Italian, Latvian, Lithuanian, Norwegian, Polish, Romanian, and Swedish.
• Added support for additional countries: Denmark, Estonia, Latvia, Lithuania, Poland, Norway, and Sweden.
• Added support for USER_INPUT_TIMEOUT as a value for force_error in the Sandbox custom user schema.

For Auth:

• Enabled Instant Match by default for all new customers.

For Investments:

• Added non-custodial wallet to account subtypes.
• Added trade investment transaction subtype as a subtype of transfer investment transaction type

For Income:

• To improve reliability and developer ease of use, modified the multi-Item Link flow for Bank Income to use the new /credit/sessions/get endpoint rather than relying on Link events.
• Added Bank Income status USER_REPORTED_NO_INCOME.
• Added Income support to /sandbox/public_token/create.
• Deprecated VERIFICATION_STATUS_PENDING_APPROVAL.
• Established a 128 character limit for the client_user_id field in the /user/create request.
• Added institution_name and institution_id fields to /credit/payroll_income/get response.

For Virtual Accounts:

• Added options.start_time and options.end_time to /wallet/transaction/list request.
• Added last_status_update and payment_id field to wallet transactions.

For Payment Initiation:

• Added transaction_id field to the payment object.

For Transfer (beta):

• Added support for RTP networks
• Added decision rationale code PAYMENT_PROFILE_LOGIN_REQUIRED and the ability to update a Payment Profile via update mode. Also added /sandbox/payment_profile/reset_login to test this new update mode flow in Sandbox.
• To improve consistency, renamed LOGIN_REQUIRED decision rationale to ITEM_LOGIN_REQUIRED.
• Deprecated origination_account_id from /transfer/authorization/create endpoint.
• Added new originator_client_id field to support Third-Party Senders (TPS).

For Wallet Onboard (beta):

• Released Wallet Onboard to beta.

For Partner Resellers:

• Added Partner reseller endpoints to improve the experience of onboarding new customers for delegated diligence partners.

• Added the ability to simulate the USER_INPUT_TIMEOUT error in Sandbox.
• Added the ability to specify account mask when using custom Sandbox users.

For Investments:

• Added support for crypto wallet investment account subtype non-custodial wallet and crypto trade investment transaction type.
• Made institution_price_as_of nullable.

For Transfer (beta):

• Added support for client-side beacons. A beacon is now required when using Guarantee with web checkout flows.
• Removed the idempotency_key from the /transfer/authorization/create response.
• Added settled and swept_settled transfer events and event statuses.
• Added standard_return_window and unauthorized_return_window fields to the Transfer object.

For Payment Initiation:

• Added AUTHORISING wallet status.
• Added recipient_id to the /wallet/create, /wallet/get, and /wallet/list responses.

For Assets:

• Added days_to_include and options to /asset_report/get request.

• Released Identity Verification and Monitor to General Availability (GA).

• Added issuing_region as a field in the extracted data for Identity Verification documents

• Extended support for Android Link SDK versions prior to 3.5.0, iOS Link SDK versions prior to 2.2.2, and Link React Native SDK versions prior to 7.1.1. Previously, these SDK versions had been scheduled to be sunset on November 1, 2022. The sunset has been canceled and Plaid will now continue to support these versions past November 2022. We still recommend you use the latest SDK versions.

For Payment Initiation:

• Added support for virtual accounts.
• Added support for additional currencies PLN, SEK, DKK, NOK, CHF, and CZK.
• Added PAYMENT_STATUS_SETTLED payment status.

For Income:

• Removed verification fields from /credit/payroll_income/get and /income/verification/paystubs/get
• Removed pull_id field from /credit/payroll_income/get
• Added payroll institution to /credit/income/precheck

For /link/token/create user object:

• Deprecated the unused fields ssn, date_of_birth, and legal_name.
• Added the name, address, and id_number parameters to support Identity Verification.

For Payment Initiation:

• Added bin as a field under institution_metadata for /link/token/create.

For Income:

• Add stated_income_sources as a field under income_verification for /link/token/create.
• Add 1099 data to /credit/payroll_income/get response.
• Deprecate paystubs.verification in /credit/payroll_income/get response.

For Transfer:

• Add payment_profile_id to /transfer/authorization/create, /transfer/create, and /link/token/create and make account_number and access_token optional for /transfer/authorization/create and /transfer/create. These changes will support forthcoming Transfer functionality.
• Add user_present a required field for /transfer/authorization/create when using Guarantee (beta)
• Deprecated the no-longer-used swept and reverse_swept statuses.