OpenAPI generated code at 2025-02-07T17:51:41Z

2020-09-14.yml

@@ -6,7 +6,7 @@ servers:
   url: https://sandbox.plaid.com
 info:
   title: The Plaid API
-  version: 2020-09-14_1.614.1
+  version: 2020-09-14_1.617.1
   description: The Plaid REST API. Please see https://plaid.com/docs/api for more details.
   contact:
     name: Plaid Developer Team
@@ -20600,8 +20600,7 @@ components:
           format: date
           description: |-
             To be provided in the format "yyyy-mm-dd".
-            This field is required for any clients who became Plaid Check customers on or after Oct 1, 2024.
-            This field will be required for all Plaid Check customers as of Feb 1, 2025.
+            This field is required for all Plaid Check customers.
         primary_address:
           $ref: '#/components/schemas/AddressData'
       required:
@@ -21449,6 +21448,12 @@ components:
           $ref: '#/components/schemas/InvestmentsAuthGetNumbers'
         data_sources:
           $ref: '#/components/schemas/InvestmentsAuthDataSources'
+        account_details_401k:
+          type: array
+          x-hidden-from-docs: true
+          description: Additional information for accounts of 401k subtype.
+          items:
+            $ref: '#/components/schemas/InvestmentsAuthAccountDetails401k'
         item:
           $ref: '#/components/schemas/Item'
         request_id:
@@ -22273,6 +22278,17 @@ components:
           minimum: 1
           maximum: 730
           default: 90
+    LinkTokenCashflowReport:
+      x-hidden-from-docs: true
+      description: Configuration parameters for the Cashflow Report product. Currently in closed beta.
+      type: object
+      properties:
+        days_requested:
+          description: 'Number of days of transaction history to request in the Cashflow Report product. '
+          type: integer
+          minimum: 1
+          maximum: 730
+          default: 365
     LinkTokenCreateHostedLink:
       description: Configuration parameters for Hosted Link. To enable the session for Hosted Link, send this object in the request. It can be empty.
       additionalProperties: true
@@ -23116,7 +23132,7 @@ components:
         expiration:
           type: string
           format: date-time
-          description: The expiration date for the `link_token`, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format. By default, a `link_token` created to generate a `public_token` that will be exchanged for a new `access_token` expires after 4 hours, and a `link_token` created for an existing Item (such as when updating an existing `access_token` by launching Link in update mode) expires after 30 minutes. If using [Hosted Link](https://plaid.com/docs/link/hosted-link/), the `link_token` will expire at the same time as the Hosted Link URL, and you can customize the duration using the `hosted_link.url_lifetime_seconds` option in the request. If using Link Delivery (beta), the `link_token` will expire by default after 24 hours if sent via SMS and after 7 days if sent via email.
+          description: The expiration date and time for the `link_token`, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format. By default, a `link_token` created to generate a `public_token` that will be exchanged for a new `access_token` expires after 4 hours, and a `link_token` created for an existing Item (such as when updating an existing `access_token` by launching Link in update mode) expires after 30 minutes. If using [Hosted Link](https://plaid.com/docs/link/hosted-link/), the `link_token` will expire at the same time as the Hosted Link URL, and you can customize the duration using the `hosted_link.url_lifetime_seconds` option in the request. If using Link Delivery (beta), the `link_token` will expire by default after 24 hours if sent via SMS and after 7 days if sent via email. If using Identity Verification, Link token expiration will not be enforced; an Identity Verification Link session can be created with an expired Link token.
         request_id:
           $ref: '#/components/schemas/RequestID'
         hosted_link_url:
@@ -24453,6 +24469,72 @@ components:
           type: array
           items:
             type: string
+    InvestmentsAuthAccountDetails401k:
+      type: object
+      additionalProperties: true
+      description: Additional account fee and contribution information for 401k type accounts.
+      properties:
+        account_id:
+          type: string
+          description: The ID of the 401k account.
+        fee_details:
+          $ref: '#/components/schemas/InvestmentsAuth401kFeeDetails'
+        contribution_details:
+          $ref: '#/components/schemas/InvestmentsAuth401kContributionDetails'
+    InvestmentsAuth401kFeeDetails:
+      type: object
+      additionalProperties: true
+      description: Object containing information on account fee transactions for the 401k account.
+      properties:
+        account_fee_count_12m:
+          type: integer
+          description: Number of account fee transactions on this account, for the past 12 months.
+        account_fee_amount_12m:
+          type: number
+          format: float
+          description: Sum of account fee transactions on this account, for the past 12 months.
+      required:
+      - account_fee_count_12m
+      - account_fee_amount_12m
+    InvestmentsAuth401kContributionDetails:
+      type: object
+      additionalProperties: true
+      description: Object containing information on contribution transactions for the 401k account.
+      properties:
+        last_contribution_transactions:
+          type: array
+          description: A list of the most recent contribution transactions for the 401k account. Includes all contributions made on the same day.
+          items:
+            $ref: '#/components/schemas/InvestmentTransaction'
+        contribution_count_1m:
+          type: integer
+          description: Number of contribution transactions on this account, for the past month.
+        contribution_amount_1m:
+          type: number
+          format: float
+          description: Sum of the contribution transactions on this account, for the past month.
+        contribution_count_6m:
+          type: integer
+          description: Number of contribution transactions on this account, for the past 6 months.
+        contribution_amount_6m:
+          type: number
+          format: float
+          description: Sum of the contribution transactions on this account, for the past 6 months.
+        contribution_count_12m:
+          type: integer
+          description: Number of contribution transactions on this account, for the past 12 months.
+        contribution_amount_12m:
+          type: number
+          format: float
+          description: Sum of the contribution transactions on this account, for the past 12 months.
+      required:
+      - last_contribution_transactions
+      - contribution_count_1m
+      - contribution_amount_1m
+      - contribution_count_6m
+      - contribution_amount_6m
+      - contribution_count_12m
+      - contribution_amount_12m
     InvestmentsAuthDataSources:
       title: InvestmentsAuthDataSources
       type: object
@@ -41890,6 +41972,8 @@ components:
           description: |-
             A reference for the transaction. This must be an alphanumeric string with 6 to 18 characters and must not contain any special characters or spaces.
             Ensure that the `reference` field is unique for each transaction.
+        originating_fund_source:
+          $ref: '#/components/schemas/OriginatingFundSource'
       required:
       - idempotency_key
       - wallet_id
@@ -41967,6 +42051,30 @@ components:
       - iso_currency_code
       - value
       description: The amount and currency of a transaction
+    OriginatingFundSource:
+      type: object
+      title: OriginatingFundSource
+      nullable: true
+      description: The original source of the funds. This field is required by local regulation for certain businesses (e.g. money remittance) to send payouts to recipients in the EU and UK.
+      required:
+      - full_name
+      - address
+      - account_number
+      - bic
+      properties:
+        full_name:
+          type: string
+          description: The full name associated with the source of the funds.
+        address:
+          $ref: '#/components/schemas/PaymentInitiationAddress'
+        account_number:
+          type: string
+          description: The account number from which the funds are sourced.
+        bic:
+          type: string
+          description: The Business Identifier Code, also known as SWIFT code, for this bank account.
+          minLength: 8
+          maxLength: 11
     WalletTransactionExecuteResponse:
       type: object
       additionalProperties: true
@@ -45620,7 +45728,7 @@ components:
         client_user_id:
           type: string
           nullable: true
-          description: An identifier you determine and submit for the user.
+          description: An identifier you determine and submit for the user. If using the Credit Dashboard, Customers should pass in the `user_token` created in `/user/create`.
         first_name:
           type: string
           nullable: true
@@ -46626,47 +46734,29 @@ components:
         average_days_between_transactions:
           type: number
           description: Average number of days between sequential transactions
-        longest_gap_between_transactions:
-          type: array
-          description: Deprecated; use `longest_gaps_between_transactions` instead. Longest gap between sequential transactions
-          deprecated: true
-          items:
-            $ref: '#/components/schemas/BaseReportLongestGapInsights'
         longest_gaps_between_transactions:
           type: array
-          description: Customers must transition from `longest_gap_between_transactions` by January 31st 2025. Longest gap between sequential transactions in a time period. This array can include multiple time periods.
+          description: Longest gap between sequential transactions in a time period. This array can include multiple time periods.
           items:
             $ref: '#/components/schemas/BaseReportLongestGapInsights'
         number_of_inflows:
           type: array
           description: The number of debits into the account. This array will be empty for non-depository accounts.
           items:
             $ref: '#/components/schemas/BaseReportNumberFlowInsights'
-        average_inflow_amount:
-          type: array
-          description: Deprecated; use `average_inflow_amounts` instead. Average amount of debit transactions into the account. This array will be empty for non-depository accounts. This field only takes into account USD transactions from the account.
-          deprecated: true
-          items:
-            $ref: '#/components/schemas/BaseReportAverageFlowInsights'
         average_inflow_amounts:
           type: array
-          description: Customers must transition from `average_inflow_amount` by January 31st 2025. Average amount of debit transactions into the account in a time period. This array will be empty for non-depository accounts. This field only takes into account USD transactions from the account.
+          description: Average amount of debit transactions into the account in a time period. This array will be empty for non-depository accounts. This field only takes into account USD transactions from the account.
           items:
             $ref: '#/components/schemas/BaseReportAverageFlowInsights'
         number_of_outflows:
           type: array
           description: The number of outflows from the account. This array will be empty for non-depository accounts.
           items:
             $ref: '#/components/schemas/BaseReportNumberFlowInsights'
-        average_outflow_amount:
-          type: array
-          description: Deprecated; use `average_outflow_amounts` instead. Average amount of transactions out of the account. This array will be empty for non-depository accounts. This field only takes into account USD transactions from the account.
-          deprecated: true
-          items:
-            $ref: '#/components/schemas/BaseReportAverageFlowInsights'
         average_outflow_amounts:
           type: array
-          description: Customers must transition from `average_outflow_amount` by January 31st 2025. Average amount of transactions out of the account in a time period. This array will be empty for non-depository accounts. This field only takes into account USD transactions from the account.
+          description: Average amount of transactions out of the account in a time period. This array will be empty for non-depository accounts. This field only takes into account USD transactions from the account.
           items:
             $ref: '#/components/schemas/BaseReportAverageFlowInsights'
         number_of_days_no_transactions:
@@ -53622,7 +53712,7 @@ components:
           description: The minimum number of days of data required for the report to be successfully generated.
         products:
           type: array
-          description: Specifies a list of products that will be eagerly generated when creating the report. These products will be made available before a success webhook is sent. Use this option if you know which products you want in the report up-front, in order to optimize latency. The `cra_base_report` product will always be generated and needs not be specified here.
+          description: Specifies a list of products that will be eagerly generated when creating the report. These products will be made available before a success webhook is sent. Use this option to minimize response latency for product `/get` endpoints.
           nullable: true
           minItems: 1
           items:
@@ -57690,3 +57780,11 @@ components:
           $ref: '#/components/schemas/RequestID'
       required:
       - request_id
+    VerifyAPIToken:
+      title: VerifyAPIToken
+      type: string
+      description: The customer's Plaid Verify API Token. The `verify_api_token` is required and may be provided either in the `VERIFY-API-TOKEN` header or as part of a request body.
+    VerifyClientSessionStartData:
+      title: VerifyClientSessionStartData
+      type: string
+      description: The initial data collected by the Plaid.JS SDK when a Verify client session is started.