openapi.yaml

openapi: 3.0.0
info:
  contact:
    name: Plaid Developer Team
    url: https://plaid.com
  description: The Plaid REST API. Please see https://plaid.com/docs/api for more
    details.
  termsOfService: https://plaid.com/legal/
  title: The Plaid API
  version: 2020-09-14_1.8.0
servers:
- description: Production
  url: https://production.plaid.com
- description: Development
  url: https://development.plaid.com
- description: Sandbox
  url: https://sandbox.plaid.com
security:
- clientId: []
  secret: []
  plaidVersion: []
tags:
- description: The Plaid API
  name: plaid
paths:
  /item/get:
    post:
      description: Returns information about the status of an Item.
      externalDocs:
        url: /api/items/#itemget
      operationId: itemGet
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ItemGetRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    item:
                      available_products:
                      - balance
                      - auth
                      billed_products:
                      - identity
                      - transactions
                      error: null
                      institution_id: ins_109508
                      item_id: Ed6bjNrDLJfGvZWwnkQlfxwoNz54B5C97ejBr
                      update_type: background
                      webhook: https://plaid.com/example/hook
                      consent_expiration_time: null
                    status:
                      transactions:
                        last_successful_update: 2019-02-15T15:52:39
                        last_failed_update: 2019-01-22T04:32:00
                      last_webhook:
                        sent_at: 2019-02-15T15:53:00
                        code_sent: DEFAULT_UPDATE
                    request_id: m8MDnv9okwxFNBV
              schema:
                $ref: '#/components/schemas/ItemGetResponse'
          description: success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Error response.
      summary: Retrieve an Item
      tags:
      - plaid
  /auth/get:
    post:
      description: |-
        The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available.

        Note: This request may take some time to complete if `auth` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.
      externalDocs:
        url: /api/products/#authget
      operationId: authGet
      requestBody:
        content:
          application/json:
            examples: {}
            schema:
              $ref: '#/components/schemas/AuthGetRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    accounts:
                    - account_id: vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D
                      balances:
                        available: 100
                        current: 110
                        limit: null
                        iso_currency_code: USD
                        unofficial_currency_code: null
                      mask: "9606"
                      name: Plaid Checking
                      official_name: Plaid Gold Checking
                      subtype: checking
                      type: depository
                    numbers:
                      ach:
                      - account: "9900009606"
                        account_id: vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D
                        routing: "011401533"
                        wire_routing: "021000021"
                      eft:
                      - account: "111122223333"
                        account_id: vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D
                        institution: "021"
                        branch: "01140"
                      international:
                      - account_id: vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D
                        bic: NWBKGB21
                        iban: GB29NWBK60161331926819
                      bacs:
                      - account: "31926819"
                        account_id: vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D
                        sort_code: "601613"
                    item:
                      available_products:
                      - balance
                      - identity
                      - payment_initiation
                      - transactions
                      billed_products:
                      - assets
                      - auth
                      consent_expiration_time: null
                      error: null
                      institution_id: ins_117650
                      item_id: DWVAAPWq4RHGlEaNyGKRTAnPLaEmo8Cvq7na6
                      update_type: background
                      webhook: https://www.genericwebhookurl.com/webhook
                    request_id: m8MDnv9okwxFNBV
              schema:
                $ref: '#/components/schemas/AuthGetResponse'
          description: success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Default error
      summary: Retrieve auth data
      tags:
      - plaid
  /transactions/get:
    post:
      description: |-
        The `/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (the list of loan-type accounts supported is the same as for Liabilities; for details, see the `/liabilities/get` endpoint). For transaction history from investments accounts, use the [Investments endpoint](/docs/api/products#investments) instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available.

        Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift.  Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/transactions/get`.  For more details, see [Pending and posted transactions](/docs/transactions/transactions-data/#pending-and-posted-transactions).

        Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `offset` parameters in conjunction with the `total_transactions` response body field to fetch all available transactions.

        Note that data may not be immediately available to `/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/transactions/get`, if it wasn't. To be alerted when transaction data is ready to be fetched, listen for the [`INITIAL_UPDATE`](/docs/api/webhooks#transactions-initial_update) and [`HISTORICAL_UPDATE`](/docs/api/webhooks#transactions-historical_update) webhooks. If no transaction history is ready when `/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error.
      externalDocs:
        url: /api/products/#transactionsget
      operationId: transactionsGet
      requestBody:
        content:
          application/json:
            examples: {}
            schema:
              $ref: '#/components/schemas/TransactionsGetRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    accounts:
                    - account_id: BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp
                      balances:
                        available: 110
                        current: 110
                        iso_currency_code: USD
                        limit: null
                        unofficial_currency_code: null
                      mask: "0000"
                      name: Plaid Checking
                      official_name: Plaid Gold Standard 0% Interest Checking
                      subtype: checking
                      type: depository
                    transactions:
                    - account_id: BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp
                      amount: 2307.21
                      iso_currency_code: USD
                      unofficial_currency_code: null
                      category:
                      - Shops
                      - Computers and Electronics
                      category_id: "19013000"
                      date: 2017-01-29
                      datetime: null
                      authorized_date: 2017-01-27
                      authorized_datetime: null
                      location:
                        address: 300 Post St
                        city: San Francisco
                        region: CA
                        postal_code: "94108"
                        country: US
                        lat: 40.740352
                        lon: -74.001761
                        store_number: "1235"
                      name: Apple Store
                      merchant_name: Apple
                      payment_meta:
                        by_order_of: null
                        payee: null
                        payer: null
                        payment_method: null
                        payment_processor: null
                        ppd_id: null
                        reason: null
                        reference_number: null
                      payment_channel: in store
                      pending: false
                      pending_transaction_id: null
                      account_owner: null
                      transaction_id: lPNjeW1nR6CDn5okmGQ6hEpMo4lLNoSrzqDje
                      transaction_code: null
                      transaction_type: place
                    item:
                      available_products:
                      - balance
                      - identity
                      - investments
                      billed_products:
                      - assets
                      - auth
                      - liabilities
                      - transactions
                      consent_expiration_time: null
                      error: null
                      institution_id: ins_3
                      item_id: eVBnVMp7zdTJLkRNr33Rs6zr7KNJqBFL9DrE6
                      update_type: background
                      webhook: https://www.genericwebhookurl.com/webhook
                    total_transactions: 1
                    request_id: 45QSn
              schema:
                $ref: '#/components/schemas/TransactionsGetResponse'
          description: OK
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Error response
      summary: Get transaction data
      tags:
      - plaid
  /transactions/sync:
    post:
      description: |-
        This endpoint replaces `/transactions/get` and its associated webhooks for most common use-cases.

        The `/transactions/sync` endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/transactions/sync` provides the same functionality as `/transactions/get` and can be used instead of `/transactions/get` to simplify the process of tracking transactions updates.

        This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead.

        Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API.

        In the first call to `/transactions/sync` for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as "adds"), which then generates a `next_cursor` for that Item. In subsequent calls, send the `next_cursor` to receive only the changes that have occurred since the previous call.

        Due to the potentially large number of transactions associated with an Item, results are paginated. The `has_more` field specifies if additional calls are necessary to fetch all available transaction updates.

        Whenever new or updated transaction data becomes available, `/transactions/sync` will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/transactions/refresh` endpoint.

        Note that for newly created Items, data may not be immediately available to `/transactions/sync`. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available.

        To be alerted when new data is available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransactionsSyncRequest'
            examples: {}
      tags:
      - plaid
      summary: Get incremental transaction updates on an Item
      externalDocs:
        url: /api/products/transactions/#transactionssync
      operationId: transactionsSync
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionsSyncResponse'
              examples:
                example-1:
                  value:
                    added:
                    - account_id: BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp
                      amount: 2307.21
                      iso_currency_code: USD
                      unofficial_currency_code: null
                      category:
                      - Shops
                      - Computers and Electronics
                      category_id: "19013000"
                      check_number: null
                      date: "2022-02-03"
                      datetime: "2022-02-03T11:00:00Z"
                      authorized_date: "2022-02-03"
                      authorized_datetime: "2022-02-03T10:34:50Z"
                      location:
                        address: 300 Post St
                        city: San Francisco
                        region: CA
                        postal_code: "94108"
                        country: US
                        lat: 40.740352
                        lon: -74.001761
                        store_number: "1235"
                      name: Apple Store
                      merchant_name: Apple
                      payment_meta:
                        by_order_of: null
                        payee: null
                        payer: null
                        payment_method: null
                        payment_processor: null
                        ppd_id: null
                        reason: null
                        reference_number: null
                      payment_channel: in store
                      pending: false
                      pending_transaction_id: null
                      account_owner: null
                      transaction_id: lPNjeW1nR6CDn5okmGQ6hEpMo4lLNoSrzqDje
                      transaction_code: null
                    modified:
                    - account_id: BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp
                      amount: 98.05
                      iso_currency_code: USD
                      unofficial_currency_code: null
                      category:
                      - Service
                      - Utilities
                      - Electric
                      category_id: "18068005"
                      check_number: null
                      date: "2022-02-28"
                      datetime: "2022-02-28T11:00:00Z"
                      authorized_date: "2022-02-28"
                      authorized_datetime: "2022-02-28T10:34:50Z"
                      location:
                        address: null
                        city: null
                        region: null
                        postal_code: null
                        country: null
                        lat: null
                        lon: null
                        store_number: null
                      name: ConEd Bill Payment
                      merchant_name: ConEd
                      payment_meta:
                        by_order_of: null
                        payee: null
                        payer: null
                        payment_method: null
                        payment_processor: null
                        ppd_id: null
                        reason: null
                        reference_number: null
                      payment_channel: online
                      pending: false
                      pending_transaction_id: null
                      account_owner: null
                      transaction_id: yhnUVvtcGGcCKU0bcz8PDQr5ZUxUXebUvbKC0
                      transaction_code: null
                    removed:
                    - transaction_id: CmdQTNgems8BT1B7ibkoUXVPyAeehT3Tmzk0l
                    next_cursor: tVUUL15lYQN5rBnfDIc1I8xudpGdIlw9nsgeXWvhOfkECvUeR663i3Dt1uf/94S8ASkitgLcIiOSqNwzzp+bh89kirazha5vuZHBb2ZA5NtCDkkV
                    has_more: false
                    request_id: 45QSn
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Error response
  /transactions/refresh:
    post:
      description: |-
        `/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: [`TRANSACTIONS_REMOVED`](/docs/api/webhooks#deleted-transactions-detected) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](/docs/api/webhooks#transactions-default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/transactions/get`.

        Access to `/transactions/refresh` in Production is specific to certain pricing plans. If you cannot access `/transactions/refresh` in Production, [contact Sales](https://www.plaid.com/contact) for assistance.
      externalDocs:
        url: /api/products/#transactionsrefresh
      operationId: transactionsRefresh
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransactionsRefreshRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    request_id: 1vwmF5TBQwiqfwP
              schema:
                $ref: '#/components/schemas/TransactionsRefreshResponse'
          description: OK
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Error response
      summary: Refresh transaction data
      tags:
      - plaid
  /institutions/get:
    post:
      description: |-
        Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated.

        This data changes frequently. If you store it locally on your system, be sure to update it regularly.
      externalDocs:
        url: /api/institutions/#institutionsget
      operationId: institutionsGet
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstitutionsGetRequest'
          application/xml:
            schema:
              properties: {}
              type: object
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    institutions:
                    - country_codes:
                      - US
                      institution_id: ins_1
                      name: Bank of America
                      oauth: false
                      products:
                      - assets
                      - auth
                      - balance
                      - transactions
                      - identity
                      - liabilities
                      routing_numbers:
                      - "011000138"
                      - "011200365"
                      - "011400495"
                      - "011500010"
                      - "011900254"
                      - "021000322"
                      - "021200339"
                      - "026009593"
                      - "031202084"
                      - "051000017"
                      - "052001633"
                      - "053000196"
                      - "053904483"
                      - "054001204"
                      - "061000052"
                      - "063100277"
                      - "064000020"
                      - "071214579"
                      - "072000805"
                      - "073000176"
                      - "081000032"
                      - "081904808"
                      - "082000073"
                      - "101100045"
                      - "103000017"
                      - "107000327"
                      - "111000025"
                      - "121000358"
                      - "122101706"
                      - "122400724"
                      - "123103716"
                      - "125000024"
                      - "323070380"
                    request_id: tbFyCEqkU774ZGG
                    total: 11384
              schema:
                $ref: '#/components/schemas/InstitutionsGetResponse'
          description: OK
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Error response
      summary: Get details of all supported institutions
      tags:
      - plaid
  /institutions/search:
    post:
      description: Returns a JSON response containing details for institutions that
        match the query parameters, up to a maximum of ten institutions per query.
      externalDocs:
        url: /api/institutions/#institutionssearch
      operationId: institutionsSearch
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstitutionsSearchRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    institutions:
                    - country_codes:
                      - US
                      institution_id: ins_118923
                      name: Red Platypus Bank - Red Platypus Bank
                      oauth: false
                      products:
                      - assets
                      - auth
                      - balance
                      - transactions
                      - identity
                      routing_numbers: []
                    request_id: Ggmk0enW4smO2Tp
              schema:
                $ref: '#/components/schemas/InstitutionsSearchResponse'
          description: OK
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Error response
      summary: Search institutions
      tags:
      - plaid
  /institutions/get_by_id:
    post:
      description: Returns a JSON response containing details on a specified financial
        institution currently supported by Plaid.
      externalDocs:
        url: /api/institutions/#institutionsget_by_id
      operationId: institutionsGetById
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstitutionsGetByIdRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    institution:
                      country_codes:
                      - US
                      institution_id: ins_109512
                      name: Houndstooth Bank
                      products:
                      - auth
                      - balance
                      - identity
                      - transactions
                      routing_numbers:
                      - "110000000"
                      oauth: false
                      status:
                        item_logins:
                          status: HEALTHY
                          last_status_change: 2019-02-15T15:53:00Z
                          breakdown:
                            success: 0.9
                            error_plaid: 0.01
                            error_institution: 0.09
                        transactions_updates:
                          status: HEALTHY
                          last_status_change: 2019-02-12T08:22:00Z
                          breakdown:
                            success: 0.95
                            error_plaid: 0.02
                            error_institution: 0.03
                            refresh_interval: NORMAL
                        auth:
                          status: HEALTHY
                          last_status_change: 2019-02-15T15:53:00Z
                          breakdown:
                            success: 0.91
                            error_plaid: 0.01
                            error_institution: 0.08
                        balance:
                          status: HEALTHY
                          last_status_change: 2019-02-15T15:53:00Z
                          breakdown:
                            success: 0.89
                            error_plaid: 0.02
                            error_institution: 0.09
                        identity:
                          status: DEGRADED
                          last_status_change: 2019-02-15T15:50:00Z
                          breakdown:
                            success: 0.42
                            error_plaid: 0.08
                            error_institution: 0.5
                        investments_updates:
                          status: HEALTHY
                          last_status_change: 2019-02-12T08:22:00Z
                          breakdown:
                            success: 0.95
                            error_plaid: 0.02
                            error_institution: 0.03
                            refresh_interval: NORMAL
                        primary_color: '#004966'
                        url: https://plaid.com
                        logo: null
                    request_id: m8MDnv9okwxFNBV
              schema:
                $ref: '#/components/schemas/InstitutionsGetByIdResponse'
          description: OK
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Error response
      summary: Get details of an institution
      tags:
      - plaid
  /item/remove:
    post:
      description: |-
        The `/item/remove`  endpoint allows you to remove an Item. Once removed, the `access_token`  associated with the Item is no longer valid and cannot be used to access any data that was associated with the Item.

        Note that in the Development environment, issuing an `/item/remove`  request will not decrement your live credential count.
      externalDocs:
        url: /api/items/#itemremove
      operationId: itemRemove
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ItemRemoveRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    request_id: m8MDnv9okwxFNBV
              schema:
                $ref: '#/components/schemas/ItemRemoveResponse'
          description: success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Error response.
      summary: Remove an Item
      tags:
      - plaid
  /accounts/get:
    post:
      description: The `/accounts/get`  endpoint can be used to retrieve information
        for any linked Item. Note that some information is nullable. Plaid will only
        return active bank accounts, i.e. accounts that are not closed and are capable
        of carrying a balance.
      externalDocs:
        url: /api/accounts/#accountsget
      operationId: accountsGet
      requestBody:
        content:
          application/json:
            examples:
              example-1:
                value:
                  client_id: string
                  secret: string
                  access_token: string
                  options:
                    account_ids:
                    - string
            schema:
              $ref: '#/components/schemas/AccountsGetRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    accounts:
                    - account_id: blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo
                      balances:
                        available: 100
                        current: 110
                        iso_currency_code: USD
                        limit: null
                        unofficial_currency_code: null
                      mask: "0000"
                      name: Plaid Checking
                      official_name: Plaid Gold Standard 0% Interest Checking
                      subtype: checking
                      type: depository
                    - account_id: 6PdjjRP6LmugpBy5NgQvUqpRXMWxzktg3rwrk
                      balances:
                        available: null
                        current: 23631.9805
                        iso_currency_code: USD
                        limit: null
                        unofficial_currency_code: null
                      mask: "6666"
                      name: Plaid 401k
                      official_name: null
                      subtype: 401k
                      type: investment
                    - account_id: XMBvvyMGQ1UoLbKByoMqH3nXMj84ALSdE5B58
                      balances:
                        available: null
                        current: 65262
                        iso_currency_code: USD
                        limit: null
                        unofficial_currency_code: null
                      mask: "7777"
                      name: Plaid Student Loan
                      official_name: null
                      subtype: student
                      type: loan
                    item:
                      available_products:
                      - balance
                      - identity
                      - payment_initiation
                      - transactions
                      billed_products:
                      - assets
                      - auth
                      consent_expiration_time: null
                      error: null
                      institution_id: ins_117650
                      item_id: DWVAAPWq4RHGlEaNyGKRTAnPLaEmo8Cvq7na6
                      update_type: background
                      webhook: https://www.genericwebhookurl.com/webhook
                    request_id: bkVE1BHWMAZ9Rnr
              schema:
                $ref: '#/components/schemas/AccountsGetResponse'
          description: success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Error response.
      summary: Retrieve accounts
      tags:
      - plaid
  /categories/get:
    post:
      description: Send a request to the `/categories/get`  endpoint to get detailed
        information on categories returned by Plaid. This endpoint does not require
        authentication.
      externalDocs:
        url: /api/products/#categoriesget
      operationId: categoriesGet
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CategoriesGetRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    categories:
                    - category_id: "10000000"
                      group: special
                      hierarchy:
                      - Bank Fees
                    - category_id: "10001000"
                      group: special
                      hierarchy:
                      - Bank Fees
                      - Overdraft
                    - category_id: "12001000"
                      group: place
                      hierarchy:
                      - Community
                      - Animal Shelter
                    request_id: ixTBLZGvhD4NnmB
              schema:
                $ref: '#/components/schemas/CategoriesGetResponse'
          description: success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Error response.
      security: []
      summary: Get Categories
      tags:
      - plaid
  /sandbox/processor_token/create:
    post:
      description: Use the `/sandbox/processor_token/create` endpoint to create a
        valid `processor_token` for an arbitrary institution ID and test credentials.
        The created `processor_token` corresponds to a new Sandbox Item. You can then
        use this `processor_token` with the `/processor/` API endpoints in Sandbox.
        You can also use `/sandbox/processor_token/create` with the [`user_custom`
        test username](/docs/sandbox/user-custom) to generate a test account with
        custom data.
      externalDocs:
        url: /api/sandbox/#sandboxprocessor_tokencreate
      operationId: sandboxProcessorTokenCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SandboxProcessorTokenCreateRequest'
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    processor_token: processor-sandbox-b0e2c4ee-a763-4df5-bfe9-46a46bce993d
                    request_id: Aim3b
              schema:
                $ref: '#/components/schemas/SandboxProcessorTokenCreateResponse'
          description: OK
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Error response.
      summary: Create a test Item and processor token
      tags:
      - plaid
  /sandbox/public_token/create:
    post:
      description: Use the `/sandbox/public_token/create`  endpoint to create a valid
        `public_token`  for an arbitrary institution ID, initial products, and test
        credentials. The created `public_token` maps to a new Sandbox Item. You can
        then call `/item/public_token/exchange` to exchange the `public_token` for
        an `access_token` and perform all API actions. `/sandbox/public_token/create`
        can also be used with the [`user_custom` test username](/docs/sandbox/user-custom)
        to generate a test account with custom data.
      externalDocs:
        url: /api/sandbox/#sandboxpublic_tokencreate
      operationId: sandboxPublicTokenCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SandboxPublicTokenCreateRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    public_token: public-sandbox-b0e2c4ee-a763-4df5-bfe9-46a46bce993d
                    request_id: Aim3b
              schema:
                $ref: '#/components/schemas/SandboxPublicTokenCreateResponse'
          description: success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Error response.
      summary: Create a test Item
      tags:
      - plaid
  /sandbox/item/fire_webhook:
    post:
      description: The `/sandbox/item/fire_webhook` endpoint is used to test that
        code correctly handles webhooks. Calling this endpoint triggers a Transactions
        `DEFAULT_UPDATE` webhook to be fired for a given Sandbox Item. If the Item
        does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will
        result.
      externalDocs:
        url: /api/sandbox/#sandboxitemfire_webhook
      operationId: sandboxItemFireWebhook
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SandboxItemFireWebhookRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    webhook_fired: true
                    request_id: 1vwmF5TBQwiqfwP
              schema:
                $ref: '#/components/schemas/SandboxItemFireWebhookResponse'
          description: success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Error response.
      summary: Fire a test webhook
      tags:
      - plaid
  /accounts/balance/get:
    post:
      description: The `/accounts/balance/get` endpoint returns the real-time balance
        for each of an Item's accounts. While other endpoints may return a balance
        object, only `/accounts/balance/get` forces the available and current balance
        fields to be refreshed rather than cached. This endpoint can be used for existing
        Items that were added via any of Plaid’s other products. This endpoint can
        be used as long as Link has been initialized with any other product, `balance`
        itself is not a product that can be used to initialize Link.
      externalDocs:
        url: /api/products/#accountsbalanceget
      operationId: accountsBalanceGet
      requestBody:
        content:
          application/json:
            examples:
              example-1:
                value:
                  access_token: string
                  secret: string
                  client_id: string
                  options:
                    account_ids:
                    - string
            schema:
              $ref: '#/components/schemas/AccountsBalanceGetRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    accounts:
                    - account_id: BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp
                      balances:
                        available: 100
                        current: 110
                        iso_currency_code: USD
                        limit: null
                        unofficial_currency_code: null
                      mask: "0000"
                      name: Plaid Checking
                      official_name: Plaid Gold Standard 0% Interest Checking
                      subtype: checking
                      type: depository
                    - account_id: dVzbVMLjrxTnLjX4G66XUp5GLklm4oiZy88yK
                      balances:
                        available: null
                        current: 410
                        iso_currency_code: USD
                        limit: 2000
                        unofficial_currency_code: null
                      mask: "3333"
                      name: Plaid Credit Card
                      official_name: Plaid Diamond 12.5% APR Interest Credit Card
                      subtype: credit card
                      type: credit
                    - account_id: Pp1Vpkl9w8sajvK6oEEKtr7vZxBnGpf7LxxLE
                      balances:
                        available: null
                        current: 65262
                        iso_currency_code: USD
                        limit: null
                        unofficial_currency_code: null
                      mask: "7777"
                      name: Plaid Student Loan
                      official_name: null
                      subtype: student
                      type: loan
                    item:
                      available_products:
                      - balance
                      - identity
                      - investments
                      billed_products:
                      - assets
                      - auth
                      - liabilities
                      - transactions
                      consent_expiration_time: null
                      error: null
                      institution_id: ins_3
                      item_id: eVBnVMp7zdTJLkRNr33Rs6zr7KNJqBFL9DrE6
                      update_type: background
                      webhook: https://www.genericwebhookurl.com/webhook
                    request_id: qk5Bxes3gDfv4F2
              schema:
                $ref: '#/components/schemas/AccountsGetResponse'
          description: OK
      summary: Retrieve real-time balance data
      tags:
      - plaid
  /identity/get:
    post:
      description: |-
        The `/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. Only name data is guaranteed to be returned; other fields will be empty arrays if not provided by the institution.

        Note: This request may take some time to complete if identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.
      externalDocs:
        url: /api/products/#identityget
      operationId: identityGet
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentityGetRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    accounts:
                    - account_id: BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp
                      balances:
                        available: 100
                        current: 110
                        iso_currency_code: USD
                        limit: null
                        unofficial_currency_code: null
                      mask: "0000"
                      name: Plaid Checking
                      official_name: Plaid Gold Standard 0% Interest Checking
                      owners:
                      - addresses:
                        - data:
                            city: Malakoff
                            country: US
                            postal_code: "14236"
                            region: NY
                            street: 2992 Cameron Road
                          primary: true
                        - data:
                            city: San Matias
                            country: US
                            postal_code: 93405-2255
                            region: CA
                            street: 2493 Leisure Lane
                          primary: false
                        emails:
                        - data: accountholder0@example.com
                          primary: true
                          type: primary
                        - data: accountholder1@example.com
                          primary: false
                          type: secondary
                        - data: extraordinarily.long.email.username.123456@reallylonghostname.com
                          primary: false
                          type: other
                        names:
                        - Alberta Bobbeth Charleson
                        phone_numbers:
                        - data: "1112223333"
                          primary: false
                          type: home
                        - data: "1112224444"
                          primary: false
                          type: work
                        - data: "1112225555"
                          primary: false
                          type: mobile
                      subtype: checking
                      type: depository
                    - account_id: 3gE5gnRzNyfXpBK5wEEKcymJ5albGVUqg77gr
                      balances:
                        available: 200
                        current: 210
                        iso_currency_code: USD
                        limit: null
                        unofficial_currency_code: null
                      mask: "1111"
                      name: Plaid Saving
                      official_name: Plaid Silver Standard 0.1% Interest Saving
                      owners:
                      - addresses:
                        - data:
                            city: Malakoff
                            country: US
                            postal_code: "14236"
                            region: NY
                            street: 2992 Cameron Road
                          primary: true
                        - data:
                            city: San Matias
                            country: US
                            postal_code: 93405-2255
                            region: CA
                            street: 2493 Leisure Lane
                          primary: false
                        emails:
                        - data: accountholder0@example.com
                          primary: true
                          type: primary
                        - data: accountholder1@example.com
                          primary: false
                          type: secondary
                        - data: extraordinarily.long.email.username.123456@reallylonghostname.com
                          primary: false
                          type: other
                        names:
                        - Alberta Bobbeth Charleson
                        phone_numbers:
                        - data: "1112223333"
                          primary: false
                          type: home
                        - data: "1112224444"
                          primary: false
                          type: work
                        - data: "1112225555"
                          primary: false
                          type: mobile
                      subtype: savings
                      type: depository
                    item:
                      available_products:
                      - balance
                      - investments
                      billed_products:
                      - assets
                      - auth
                      - identity
                      - liabilities
                      - transactions
                      consent_expiration_time: null
                      error: null
                      institution_id: ins_3
                      item_id: eVBnVMp7zdTJLkRNr33Rs6zr7KNJqBFL9DrE6
                      update_type: background
                      webhook: https://www.genericwebhookurl.com/webhook
                    request_id: 3nARps6TOYtbACO
              schema:
                $ref: '#/components/schemas/IdentityGetResponse'
          description: OK
      summary: Retrieve identity data
      tags:
      - plaid
  /processor/auth/get:
    post:
      description: The `/processor/auth/get` endpoint returns the bank account and
        bank identification number (such as the routing number, for US accounts),
        for a checking or savings account that's associated with a given `processor_token`.
        The endpoint also returns high-level account data and balances when available.
      externalDocs:
        url: /api/processors/#processorauthget
      operationId: processorAuthGet
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProcessorAuthGetRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    account:
                      account_id: QKKzevvp33HxPWpoqn6rI13BxW4awNSjnw4xv
                      balances:
                        available: 100
                        current: 110
                        limit: null
                      mask: "0000"
                      name: Plaid Checking
                      official_name: Plaid Gold Checking
                      subtype: checking
                      type: depository
                    numbers:
                      ach:
                        account: "9900009606"
                        account_id: vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D
                        routing: "011401533"
                        wire_routing: "021000021"
                      eft:
                        account: "111122223333"
                        account_id: vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D
                        institution: "021"
                        branch: "01140"
                      international:
                        account_id: vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D
                        bic: NWBKGB21
                        iban: GB29NWBK60161331926819
                      bacs:
                        account: "31926819"
                        account_id: vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D
                        sort_code: "601613"
                    request_id: 1zlMf
              schema:
                $ref: '#/components/schemas/ProcessorAuthGetResponse'
          description: success
      summary: Retrieve Auth data
      tags:
      - plaid
  /processor/identity/get:
    post:
      description: The `/processor/identity/get` endpoint allows you to retrieve various
        account holder information on file with the financial institution, including
        names, emails, phone numbers, and addresses.
      externalDocs:
        url: /api/processors/#processoridentityget
      operationId: processorIdentityGet
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProcessorIdentityGetRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    account:
                      account_id: XMGPJy4q1gsQoKd5z9R3tK8kJ9EWL8SdkgKMq
                      balances:
                        available: 100
                        current: 110
                        iso_currency_code: USD
                        limit: null
                        unofficial_currency_code: null
                      mask: "0000"
                      name: Plaid Checking
                      official_name: Plaid Gold Standard 0% Interest Checking
                      owners:
                      - addresses:
                        - data:
                            city: Malakoff
                            country: US
                            postal_code: "14236"
                            region: NY
                            street: 2992 Cameron Road
                          primary: true
                        - data:
                            city: San Matias
                            country: US
                            postal_code: 93405-2255
                            region: CA
                            street: 2493 Leisure Lane
                          primary: false
                        emails:
                        - data: accountholder0@example.com
                          primary: true
                          type: primary
                        - data: accountholder1@example.com
                          primary: false
                          type: secondary
                        - data: extraordinarily.long.email.username.123456@reallylonghostname.com
                          primary: false
                          type: other
                        names:
                        - Alberta Bobbeth Charleson
                        phone_numbers:
                        - data: "1112223333"
                          primary: false
                          type: home
                        - data: "1112224444"
                          primary: false
                          type: work
                        - data: "1112225555"
                          primary: false
                          type: mobile1
                      subtype: checking
                      type: depository
                    request_id: eOPkBl6t33veI2J
              schema:
                $ref: '#/components/schemas/ProcessorIdentityGetResponse'
          description: OK
      summary: Retrieve Identity data
      tags:
      - plaid
  /processor/balance/get:
    post:
      description: 'The `/processor/balance/get` endpoint returns the real-time balance
        for each of an Item''s accounts. While other endpoints may return a balance
        object, only `/processor/balance/get` forces the available and current balance
        fields to be refreshed rather than cached. '
      externalDocs:
        url: /api/processors/#processorbalanceget
      operationId: processorBalanceGet
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProcessorBalanceGetRequest'
        description: |-
          The `/processor/balance/get` endpoint returns the real-time balance for the account associated with a given `processor_token`.

          The current balance is the total amount of funds in the account. The available balance is the current balance less any outstanding holds or debits that have not yet posted to the account.

          Note that not all institutions calculate the available balance. In the event that available balance is unavailable from the institution, Plaid will return an available balance value of `null`.
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    account:
                      account_id: QKKzevvp33HxPWpoqn6rI13BxW4awNSjnw4xv
                      balances:
                        available: 100
                        current: 110
                        limit: null
                      mask: "0000"
                      name: Plaid Checking
                      official_name: Plaid Gold Checking
                      subtype: checking
                      type: depository
                    request_id: 1zlMf
              schema:
                $ref: '#/components/schemas/ProcessorBalanceGetResponse'
          description: OK
      summary: Retrieve Balance data
      tags:
      - plaid
  /item/webhook/update:
    post:
      description: The POST `/item/webhook/update` allows you to update the webhook
        URL associated with an Item. This request triggers a [`WEBHOOK_UPDATE_ACKNOWLEDGED`](/docs/api/webhooks/#item-webhook-url-updated)
        webhook to the newly specified webhook URL.
      externalDocs:
        url: /api/items/#itemwebhookupdate
      operationId: itemWebhookUpdate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ItemWebhookUpdateRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    item:
                      available_products:
                      - balance
                      - identity
                      - payment_initiation
                      - transactions
                      billed_products:
                      - assets
                      - auth
                      consent_expiration_time: null
                      error: null
                      institution_id: ins_117650
                      item_id: DWVAAPWq4RHGlEaNyGKRTAnPLaEmo8Cvq7na6
                      update_type: background
                      webhook: https://www.genericwebhookurl.com/webhook
                    request_id: vYK11LNTfRoAMbj
              schema:
                $ref: '#/components/schemas/ItemWebhookUpdateResponse'
          description: OK
      summary: Update Webhook URL
      tags:
      - plaid
  /item/access_token/invalidate:
    post:
      description: |
        By default, the `access_token` associated with an Item does not expire and should be stored in a persistent, secure manner.

        You can use the `/item/access_token/invalidate` endpoint to rotate the `access_token` associated with an Item. The endpoint returns a new `access_token` and immediately invalidates the previous `access_token`.
      externalDocs:
        url: /api/tokens/#itemaccess_tokeninvalidate
      operationId: itemAccessTokenInvalidate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ItemAccessTokenInvalidateRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    new_access_token: access-sandbox-8ab976e6-64bc-4b38-98f7-731e7a349970
                    request_id: m8MDnv9okwxFNBV
              schema:
                $ref: '#/components/schemas/ItemAccessTokenInvalidateResponse'
          description: OK
      summary: Invalidate access_token
      tags:
      - plaid
  /webhook_verification_key/get:
    post:
      description: |-
        Plaid signs all outgoing webhooks and provides JSON Web Tokens (JWTs) so that you can verify the authenticity of any incoming webhooks to your application. A message signature is included in the `Plaid-Verification` header.

        The `/webhook_verification_key/get` endpoint provides a JSON Web Key (JWK) that can be used to verify a JWT.
      externalDocs:
        url: /api/webhook-verification/#webhook_verification_keyget
      operationId: webhookVerificationKeyGet
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookVerificationKeyGetRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    key:
                      alg: ES256
                      created_at: 1560466150
                      crv: P-256
                      expired_at: null
                      kid: bfbd5111-8e33-4643-8ced-b2e642a72f3c
                      kty: EC
                      use: sig
                      x: hKXLGIjWvCBv-cP5euCTxl8g9GLG9zHo_3pO5NN1DwQ
                      y: shhexqPB7YffGn6fR6h2UhTSuCtPmfzQJ6ENVIoO4Ys
                    request_id: RZ6Omi1bzzwDaLo
              schema:
                $ref: '#/components/schemas/WebhookVerificationKeyGetResponse'
          description: OK
      summary: Get webhook verification key
      tags:
      - plaid
  /liabilities/get:
    post:
      description: |-
        The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type `credit` with account subtype `credit card` or `paypal`, and account type `loan` with account subtype `student` or `mortgage`. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the `account_filter` parameter when [creating a Link token](/docs/api/tokens/#linktokencreate).

        The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling `/liabilities/get`.

        Note: This request may take some time to complete if `liabilities` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the additional data.
      externalDocs:
        url: /api/products/#liabilitiesget
      operationId: liabilitiesGet
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LiabilitiesGetRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    accounts:
                    - account_id: BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp
                      balances:
                        available: 100
                        current: 110
                        iso_currency_code: USD
                        limit: null
                        unofficial_currency_code: null
                      mask: "0000"
                      name: Plaid Checking
                      official_name: Plaid Gold Standard 0% Interest Checking
                      subtype: checking
                      type: depository
                    - account_id: dVzbVMLjrxTnLjX4G66XUp5GLklm4oiZy88yK
                      balances:
                        available: null
                        current: 410
                        iso_currency_code: USD
                        limit: 2000
                        unofficial_currency_code: null
                      mask: "3333"
                      name: Plaid Credit Card
                      official_name: Plaid Diamond 12.5% APR Interest Credit Card
                      subtype: credit card
                      type: credit
                    - account_id: Pp1Vpkl9w8sajvK6oEEKtr7vZxBnGpf7LxxLE
                      balances:
                        available: null
                        current: 65262
                        iso_currency_code: USD
                        limit: null
                        unofficial_currency_code: null
                      mask: "7777"
                      name: Plaid Student Loan
                      official_name: null
                      subtype: student
                      type: loan
                    - account_id: BxBXxLj1m4HMXBm9WZJyUg9XLd4rKEhw8Pb1J
                      balances:
                        available: null
                        current: 56302.06
                        iso_currency_code: USD
                        limit: null
                        unofficial_currency_code: null
                      mask: "8888"
                      name: Plaid Mortgage
                      official_name: null
                      subtype: mortgage
                      type: loan
                    item:
                      available_products:
                      - balance
                      - investments
                      billed_products:
                      - assets
                      - auth
                      - identity
                      - liabilities
                      - transactions
                      consent_expiration_time: null
                      error: null
                      institution_id: ins_3
                      item_id: eVBnVMp7zdTJLkRNr33Rs6zr7KNJqBFL9DrE6
                      update_type: background
                      webhook: https://www.genericwebhookurl.com/webhook
                    liabilities:
                      credit:
                      - account_id: dVzbVMLjrxTnLjX4G66XUp5GLklm4oiZy88yK
                        aprs:
                        - apr_percentage: 15.24
                          apr_type: balance_transfer_apr
                          balance_subject_to_apr: 1562.32
                          interest_charge_amount: 130.22
                        - apr_percentage: 27.95
                          apr_type: cash_apr
                          balance_subject_to_apr: 56.22
                          interest_charge_amount: 14.81
                        - apr_percentage: 12.5
                          apr_type: purchase_apr
                          balance_subject_to_apr: 157.01
                          interest_charge_amount: 25.66
                        - apr_percentage: 0
                          apr_type: special
                          balance_subject_to_apr: 1000
                          interest_charge_amount: 0
                        is_overdue: false
                        last_payment_amount: 168.25
                        last_payment_date: 2019-05-22
                        last_statement_balance: 1708.77
                        last_statement_issue_date: 2019-05-28
                        minimum_payment_amount: 20
                        next_payment_due_date: 2020-05-28
                      mortgage:
                      - account_id: BxBXxLj1m4HMXBm9WZJyUg9XLd4rKEhw8Pb1J
                        account_number: "3120194154"
                        current_late_fee: 25
                        escrow_balance: 3141.54
                        has_pmi: true
                        has_prepayment_penalty: true
                        interest_rate:
                          percentage: 3.99
                          type: fixed
                        last_payment_amount: 3141.54
                        last_payment_date: 2019-08-01
                        loan_term: 30 year
                        loan_type_description: conventional
                        maturity_date: 2045-07-31
                        next_monthly_payment: 3141.54
                        next_payment_due_date: 2019-11-15
                        origination_date: 2015-08-01
                        origination_principal_amount: 425000
                        past_due_amount: 2304
                        property_address:
                          city: Malakoff
                          country: US
                          postal_code: "14236"
                          region: NY
                          street: 2992 Cameron Road
                        ytd_interest_paid: 12300.4
                        ytd_principal_paid: 12340.5
                      student:
                      - account_id: Pp1Vpkl9w8sajvK6oEEKtr7vZxBnGpf7LxxLE
                        account_number: "4277075694"
                        disbursement_dates:
                        - 2002-08-28
                        expected_payoff_date: 2032-07-28
                        guarantor: DEPT OF ED
                        interest_rate_percentage: 5.25
                        is_overdue: false
                        last_payment_amount: 138.05
                        last_payment_date: 2019-04-22
                        last_statement_balance: 138.05
                        last_statement_issue_date: 2019-04-28
                        loan_name: Consolidation
                        loan_status:
                          end_date: 2032-07-28
                          type: repayment
                        minimum_payment_amount: 25
                        next_payment_due_date: 2019-05-28
                        origination_date: 2002-08-28
                        origination_principal_amount: 25000
                        outstanding_interest_amount: 6227.36
                        payment_reference_number: "4277075694"
                        pslf_status:
                          estimated_eligibility_date: 2021-01-01
                          payments_made: 200
                          payments_remaining: 160
                        repayment_plan:
                          description: Standard Repayment
                          type: standard
                        sequence_number: "1"
                        servicer_address:
                          city: San Matias
                          country: US
                          postal_code: "99415"
                          region: CA
                          street: 123 Relaxation Road
                        ytd_interest_paid: 280.55
                        ytd_principal_paid: 271.65
                    request_id: dTnnm60WgKGLnKL
              schema:
                $ref: '#/components/schemas/LiabilitiesGetResponse'
          description: OK
      summary: Retrieve Liabilities data
      tags:
      - plaid
  /payment_initiation/recipient/create:
    post:
      description: |
        Create a payment recipient for payment initiation.  The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA).  For a standing order (recurring) payment, the recipient must be in the UK.

        The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same `recipient_id`.

        In the Sandbox environment, you can use the `/payment_initiation/recipient/create` endpoint to generate recipients. Programmatic recipient creation in the Development and Production environments can be done after approval by Plaid's Compliance team. [Contact Sales](https://plaid.com/contact/)for approval.
      externalDocs:
        url: /api/products/#payment_initiationrecipientcreate
      operationId: paymentInitiationRecipientCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentInitiationRecipientCreateRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    recipient_id: recipient-id-sandbox-9b6b4679-914b-445b-9450-efbdb80296f6
                    request_id: 4zlKapIkTm8p5KM
              schema:
                $ref: '#/components/schemas/PaymentInitiationRecipientCreateResponse'
          description: OK
      summary: Create payment recipient
      tags:
      - plaid
  /payment_initiation/recipient/get:
    post:
      description: Get details about a payment recipient you have previously created.
      externalDocs:
        url: /api/products/#payment_initiationrecipientget
      operationId: paymentInitiationRecipientGet
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentInitiationRecipientGetRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    recipient_id: recipient-id-sandbox-9b6b4679-914b-445b-9450-efbdb80296f6
                    name: Wonder Wallet
                    iban: GB29NWBK60161331926819
                    address:
                      street:
                      - 96 Guild Street
                      - 9th Floor
                      city: London
                      postal_code: SE14 8JW
                      country: GB
                    request_id: 4zlKapIkTm8p5KM
              schema:
                $ref: '#/components/schemas/PaymentInitiationRecipientGetResponse'
          description: OK
      summary: Get payment recipient
      tags:
      - plaid
  /payment_initiation/recipient/list:
    post:
      description: The `/payment_initiation/recipient/list` endpoint list the payment
        recipients that you have previously created.
      externalDocs:
        url: /api/products/#payment_initiationrecipientlist
      operationId: paymentInitiationRecipientList
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentInitiationRecipientListRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    recipients:
                    - recipient_id: recipient-id-sandbox-9b6b4679-914b-445b-9450-efbdb80296f6
                      name: Wonder Wallet
                      iban: GB29NWBK60161331926819
                      address:
                        street:
                        - 96 Guild Street
                        - 9th Floor
                        city: London
                        postal_code: SE14 8JW
                        country: GB
                    request_id: 4zlKapIkTm8p5KM
              schema:
                $ref: '#/components/schemas/PaymentInitiationRecipientListResponse'
          description: OK
      summary: List payment recipients
      tags:
      - plaid
  /payment_initiation/payment/create:
    post:
      description: |-
        After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient.  Payments can be one-time or standing order (recurring) and can be denominated in either EUR or GBP.  If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer and GBP-denominated payments will be sent via the Faster Payments network, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer will typically arrive in one business day.

        Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments will continue indefinitely and cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am.

        In the Development environment, payments must be below 5 GBP / EUR. For details on any payment limits in Production, contact your Plaid Account Manager.
      externalDocs:
        url: /api/products/#payment_initiationpaymentcreate
      operationId: paymentInitiationPaymentCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentInitiationPaymentCreateRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    payment_id: payment-id-sandbox-feca8a7a-5591-4aef-9297-f3062bb735d3
                    status: PAYMENT_STATUS_INPUT_NEEDED
                    request_id: 4ciYVmesrySiUAB
              schema:
                $ref: '#/components/schemas/PaymentInitiationPaymentCreateResponse'
          description: OK
      summary: Create a payment
      tags:
      - plaid
  /payment_initiation/payment/token/create:
    post:
      deprecated: true
      description: |-
        The `/payment_initiation/payment/token/create` endpoint has been deprecated. New Plaid customers will be unable to use this endpoint, and existing customers are encouraged to migrate to the newer, `link_token`-based flow. The recommended flow is to provide the `payment_id` to `/link/token/create`, which returns a `link_token` used to initialize Link.

        The `/payment_initiation/payment/token/create` is used to create a `payment_token`, which can then be used in Link initialization to enter a payment initiation flow. You can only use a `payment_token` once. If this attempt fails, the end user aborts the flow, or the token expires, you will need to create a new payment token. Creating a new payment token does not require end user input.
      externalDocs:
        url: /link/maintain-legacy-integration/#creating-a-payment-token
      operationId: createPaymentToken
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentInitiationPaymentTokenCreateRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    payment_token: payment-token-sandbox-feca8a7a-5591-4aef-9297-f3062bb735d3
                    payment_token_expiration_time: 2020-01-01T00:00:00Z
                    request_id: 4ciYVmesrySiUAB
              schema:
                $ref: '#/components/schemas/PaymentInitiationPaymentTokenCreateResponse'
          description: OK
      summary: Create payment token
      tags:
      - plaid
  /sandbox/item/reset_login:
    post:
      description: |-
        `/sandbox/item/reset_login/` forces an Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [update mode](/docs/link/update-mode) flow in the Sandbox environment.  After calling `/sandbox/item/reset_login`, You can then use Plaid Link update mode to restore the Item to a good state. An `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this endpoint, if one is associated with the Item.


        In the Sandbox, Items will transition to an `ITEM_LOGIN_REQUIRED` error state automatically after 30 days, even if this endpoint is not called.
      externalDocs:
        url: /api/sandbox/#sandboxitemreset_login
      operationId: sandboxItemResetLogin
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SandboxItemResetLoginRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    reset_login: true
                    request_id: m8MDnv9okwxFNBV
              schema:
                $ref: '#/components/schemas/SandboxItemResetLoginResponse'
          description: OK
      summary: Force a Sandbox Item into an error state
      tags:
      - plaid
  /sandbox/item/set_verification_status:
    post:
      description: |-
        The `/sandbox/item/set_verification_status` endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow.

        Note that not all Plaid developer accounts are enabled for micro-deposit based verification by default. Your account must be enabled for this feature in order to test it in Sandbox. To enable this features or check your status, contact your account manager or [submit a product access Support ticket](https://dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access).

        For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](/docs/auth/coverage/testing#).
      externalDocs:
        url: /api/sandbox/#sandboxitemset_verification_status
      operationId: sandboxItemSetVerificationStatus
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SandboxItemSetVerificationStatusRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    request_id: 1vwmF5TBQwiqfwP
              schema:
                $ref: '#/components/schemas/SandboxItemSetVerificationStatusResponse'
          description: OK
      summary: Set verification status for Sandbox account
      tags:
      - plaid
  /item/public_token/exchange:
    post:
      description: |-
        Exchange a Link `public_token` for an API `access_token`. Link hands off the `public_token` client-side via the `onSuccess` callback once a user has successfully created an Item. The `public_token` is ephemeral and expires after 30 minutes.

        The response also includes an `item_id` that should be stored with the `access_token`. The `item_id` is used to identify an Item in a webhook. The `item_id` can also be retrieved by making an `/item/get` request.
      externalDocs:
        url: /api/tokens/#itempublic_tokenexchange
      operationId: itemPublicTokenExchange
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ItemPublicTokenExchangeRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    access_token: access-sandbox-de3ce8ef-33f8-452c-a685-8671031fc0f6
                    item_id: M5eVJqLnv3tbzdngLDp9FL5OlDNxlNhlE55op
                    request_id: Aim3b
              schema:
                $ref: '#/components/schemas/ItemPublicTokenExchangeResponse'
          description: OK
      summary: Exchange public token for an access token
      tags:
      - plaid
  /item/public_token/create:
    post:
      description: |-
        Note: As of July 2020, the `/item/public_token/create` endpoint is deprecated. Instead, use `/link/token/create` with an `access_token` to create a Link token for use with [update mode](/docs/link/update-mode).

        If you need your user to take action to restore or resolve an error associated with an Item, generate a public token with the `/item/public_token/create` endpoint and then initialize Link with that `public_token`.

        A `public_token` is one-time use and expires after 30 minutes. You use a `public_token` to initialize Link in [update mode](/docs/link/update-mode) for a particular Item. You can generate a `public_token` for an Item even if you did not use Link to create the Item originally.

        The `/item/public_token/create` endpoint is **not** used to create your initial `public_token`. If you have not already received an `access_token` for a specific Item, use Link to obtain your `public_token` instead. See the [Quickstart](/docs/quickstart) for more information.
      externalDocs:
        url: /api/tokens/#itempublic_tokencreate
      operationId: itemCreatePublicToken
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ItemPublicTokenCreateRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    public_token: public-sandbox-b0e2c4ee-a763-4df5-bfe9-46a46bce993d
                    request_id: Aim3b
              schema:
                $ref: '#/components/schemas/ItemPublicTokenCreateResponse'
          description: OK
      summary: Create public token
      tags:
      - plaid
  /payment_initiation/payment/get:
    post:
      description: The `/payment_initiation/payment/get` endpoint can be used to check
        the status of a payment, as well as to receive basic information such as recipient
        and payment amount. In the case of standing orders, the `/payment_initiation/payment/get`
        endpoint will provide information about the status of the overall standing
        order itself; the API cannot be used to retrieve payment status for individual
        payments within a standing order.
      externalDocs:
        url: /api/products/#payment_initiationpaymentget
      operationId: paymentInitiationPaymentGet
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentInitiationPaymentGetRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    payment_id: payment-id-sandbox-feca8a7a-5591-4aef-9297-f3062bb735d3
                    payment_token: payment-token-sandbox-c6a26505-42b4-46fe-8ecf-bf9edcafbebb
                    reference: Account Funding 99744
                    amount:
                      currency: GBP
                      value: 100
                    status: PAYMENT_STATUS_INPUT_NEEDED
                    last_status_update: 2019-11-06T21:10:52Z
                    payment_expiration_time: 2019-11-06T21:25:52Z
                    recipient_id: recipient-id-sandbox-9b6b4679-914b-445b-9450-efbdb80296f6
                    request_id: aEAQmewMzlVa1k6
              schema:
                $ref: '#/components/schemas/PaymentInitiationPaymentGetResponse'
          description: OK
      summary: Get payment details
      tags:
      - plaid
  /payment_initiation/payment/list:
    post:
      description: The `/payment_initiation/payment/list` endpoint can be used to
        retrieve all created payments. By default, the 10 most recent payments are
        returned. You can request more payments and paginate through the results using
        the optional `count` and `cursor` parameters.
      externalDocs:
        url: /api/products/#payment_initiationpaymentlist
      operationId: paymentInitiationPaymentList
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentInitiationPaymentListRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    payments:
                    - payment_id: payment-id-sandbox-feca8a7a-5591-4aef-9297-f3062bb735d3
                      reference: Account Funding 99744
                      amount:
                        currency: GBP
                        value: 100
                      status: PAYMENT_STATUS_INPUT_NEEDED
                      last_status_update: 2019-11-06T21:10:52Z
                      recipient_id: recipient-id-sandbox-9b6b4679-914b-445b-9450-efbdb80296f6
                    next_cursor: 2020-01-01T00:00:00Z
                    request_id: aEAQmewMzlVa1k6
              schema:
                $ref: '#/components/schemas/PaymentInitiationPaymentListResponse'
          description: OK
      summary: List payments
      tags:
      - plaid
  /asset_report/create:
    post:
      description: |-
        The `/asset_report/create` endpoint initiates the process of creating an Asset Report, which can then be retrieved by passing the `asset_report_token` return value to the `/asset_report/get` or `/asset_report/pdf/get` endpoints.

        The Asset Report takes some time to be created and is not available immediately after calling `/asset_report/create`. When the Asset Report is ready to be retrieved using `/asset_report/get` or `/asset_report/pdf/get`, Plaid will fire a `PRODUCT_READY` webhook. For full details of the webhook schema, see [Asset Report webhooks](/docs/api/webhooks/#Assets-webhooks).

        The `/asset_report/create` endpoint creates an Asset Report at a moment in time. Asset Reports are immutable. To get an updated Asset Report, use the `/asset_report/refresh` endpoint.
      externalDocs:
        url: /api/products/#asset_reportcreate
      operationId: assetReportCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssetReportCreateRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    asset_report_token: assets-sandbox-6f12f5bb-22dd-4855-b918-f47ec439198a
                    asset_report_id: 1f414183-220c-44f5-b0c8-bc0e6d4053bb
                    request_id: Iam3b
              schema:
                $ref: '#/components/schemas/AssetReportCreateResponse'
          description: OK
      summary: Create an Asset Report
      tags:
      - plaid
  /asset_report/refresh:
    post:
      description: |-
        An Asset Report is an immutable snapshot of a user's assets. In order to "refresh" an Asset Report you created previously, you can use the `/asset_report/refresh` endpoint to create a new Asset Report based on the old one, but with the most recent data available.

        The new Asset Report will contain the same Items as the original Report, as well as the same filters applied by any call to `/asset_report/filter`. By default, the new Asset Report will also use the same parameters you submitted with your original `/asset_report/create` request, but the original `days_requested` value and the values of any parameters in the `options` object can be overridden with new values. To change these arguments, simply supply new values for them in your request to `/asset_report/refresh`. Submit an empty string ("") for any previously-populated fields you would like set as empty.
      externalDocs:
        url: /api/products/#asset_reportrefresh
      operationId: assetReportRefresh
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssetReportRefreshRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    asset_report_id: c33ebe8b-6a63-4d74-a83d-d39791231ac0
                    asset_report_token: assets-sandbox-8218d5f8-6d6d-403d-92f5-13a9afaa4398
                    request_id: NBZaq
              schema:
                $ref: '#/components/schemas/AssetReportRefreshResponse'
          description: OK
      summary: Refresh an Asset Report
      tags:
      - plaid
  /asset_report/remove:
    post:
      description: |-
        The `/item/remove` endpoint allows you to invalidate an `access_token`, meaning you will not be able to create new Asset Reports with it. Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove them specifically.

        The `/asset_report/remove` endpoint allows you to remove an Asset Report. Removing an Asset Report invalidates its `asset_report_token`, meaning you will no longer be able to use it to access Report data or create new Audit Copies. Removing an Asset Report does not affect the underlying Items, but does invalidate any `audit_copy_tokens` associated with the Asset Report.
      externalDocs:
        url: /api/products/#asset_reportremove
      operationId: assetReportRemove
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssetReportRemoveRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    removed: true
                    request_id: I6zHN
              schema:
                $ref: '#/components/schemas/AssetReportRemoveResponse'
          description: OK
      summary: Delete an Asset Report
      tags:
      - plaid
  /asset_report/filter:
    post:
      description: |-
        By default, an Asset Report will contain all of the accounts on a given Item. In some cases, you may not want the Asset Report to contain all accounts. For example, you might have the end user choose which accounts are relevant in Link using the Select Account view, which you can enable in the dashboard. Or, you might always exclude certain account types or subtypes, which you can identify by using the `/accounts/get` endpoint. To narrow an Asset Report to only a subset of accounts, use the `/asset_report/filter` endpoint.

        To exclude certain Accounts from an Asset Report, first use the `/asset_report/create` endpoint to create the report, then send the `asset_report_token` along with a list of `account_ids` to exclude to the `/asset_report/filter` endpoint, to create a new Asset Report which contains only a subset of the original Asset Report's data.

        Because Asset Reports are immutable, calling `/asset_report/filter` does not alter the original Asset Report in any way; rather, `/asset_report/filter` creates a new Asset Report with a new token and id. Asset Reports created via `/asset_report/filter` do not contain new Asset data, and are not billed.

        Plaid will fire a [`PRODUCT_READY`](/docs/api/webhooks) webhook once generation of the filtered Asset Report has completed.
      externalDocs:
        url: /api/products/#asset_reportfilter
      operationId: assetReportFilter
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssetReportFilterRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    asset_report_token: assets-sandbox-bc410c6a-4653-4c75-985c-e757c3497c5c
                    asset_report_id: fdc09207-0cef-4d88-b5eb-0d970758ebd9
                    request_id: qEg07
              schema:
                $ref: '#/components/schemas/AssetReportFilterResponse'
          description: OK
      summary: Filter Asset Report
      tags:
      - plaid
  /asset_report/get:
    post:
      description: |-
        The `/asset_report/get` endpoint retrieves the Asset Report in JSON format. Before calling `/asset_report/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](/docs/api/webhooks) webhook to fire, indicating that the Report is ready to be retrieved.

        By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report.

        To retrieve an Asset Report with Insights, call the `/asset_report/get` endpoint with `include_insights` set to `true`. Note that you will need to [contact us](https://dashboard.plaid.com/support) to get access to this feature.
      externalDocs:
        url: /api/products/#asset_reportget
      operationId: assetReportGet
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssetReportGetRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    report:
                      asset_report_id: bf3a0490-344c-4620-a219-2693162e4b1d
                      client_report_id: 123abc
                      date_generated: 2020-06-05T22:47:53Z
                      days_requested: 3
                      items:
                      - accounts:
                        - account_id: 3gE5gnRzNyfXpBK5wEEKcymJ5albGVUqg77gr
                          balances:
                            available: 200
                            current: 210
                            iso_currency_code: USD
                            limit: null
                            unofficial_currency_code: null
                          days_available: 3
                          historical_balances:
                          - current: 210
                            date: 2020-06-04
                            iso_currency_code: USD
                            unofficial_currency_code: null
                          - current: 210
                            date: 2020-06-03
                            iso_currency_code: USD
                            unofficial_currency_code: null
                          - current: 210
                            date: 2020-06-02
                            iso_currency_code: USD
                            unofficial_currency_code: null
                          mask: "1111"
                          name: Plaid Saving
                          official_name: Plaid Silver Standard 0.1% Interest Saving
                          owners:
                          - addresses:
                            - data:
                                city: Malakoff
                                country: US
                                postal_code: "14236"
                                region: NY
                                street: 2992 Cameron Road
                              primary: true
                            - data:
                                city: San Matias
                                country: US
                                postal_code: 93405-2255
                                region: CA
                                street: 2493 Leisure Lane
                              primary: false
                            emails:
                            - data: accountholder0@example.com
                              primary: true
                              type: primary
                            - data: accountholder1@example.com
                              primary: false
                              type: secondary
                            - data: extraordinarily.long.email.username.123456@reallylonghostname.com
                              primary: false
                              type: other
                            names:
                            - Alberta Bobbeth Charleson
                            phone_numbers:
                            - data: "1112223333"
                              primary: false
                              type: home
                            - data: "1112224444"
                              primary: false
                              type: work
                            - data: "1112225555"
                              primary: false
                              type: mobile
                          ownership_type: null
                          subtype: savings
                          transactions: []
                          type: depository
                        - account_id: BxBXxLj1m4HMXBm9WZJyUg9XLd4rKEhw8Pb1J
                          balances:
                            available: null
                            current: 56302.06
                            iso_currency_code: USD
                            limit: null
                            unofficial_currency_code: null
                          days_available: 3
                          historical_balances: []
                          mask: "8888"
                          name: Plaid Mortgage
                          official_name: null
                          owners:
                          - addresses:
                            - data:
                                city: Malakoff
                                country: US
                                postal_code: "14236"
                                region: NY
                                street: 2992 Cameron Road
                              primary: true
                            - data:
                                city: San Matias
                                country: US
                                postal_code: 93405-2255
                                region: CA
                                street: 2493 Leisure Lane
                              primary: false
                            emails:
                            - data: accountholder0@example.com
                              primary: true
                              type: primary
                            - data: accountholder1@example.com
                              primary: false
                              type: secondary
                            - data: extraordinarily.long.email.username.123456@reallylonghostname.com
                              primary: false
                              type: other
                            names:
                            - Alberta Bobbeth Charleson
                            phone_numbers:
                            - data: "1112223333"
                              primary: false
                              type: home
                            - data: "1112224444"
                              primary: false
                              type: work
                            - data: "1112225555"
                              primary: false
                              type: mobile
                          ownership_type: null
                          subtype: mortgage
                          transactions: []
                          type: loan
                        - account_id: dVzbVMLjrxTnLjX4G66XUp5GLklm4oiZy88yK
                          balances:
                            available: null
                            current: 410
                            iso_currency_code: USD
                            limit: null
                            unofficial_currency_code: null
                          days_available: 3
                          historical_balances:
                          - current: 410
                            date: 2020-06-04
                            iso_currency_code: USD
                            unofficial_currency_code: null
                          - current: 410
                            date: 2020-06-03
                            iso_currency_code: USD
                            unofficial_currency_code: null
                          - current: 410
                            date: 2020-06-02
                            iso_currency_code: USD
                            unofficial_currency_code: null
                          mask: "3333"
                          name: Plaid Credit Card
                          official_name: Plaid Diamond 12.5% APR Interest Credit Card
                          owners:
                          - addresses:
                            - data:
                                city: Malakoff
                                country: US
                                postal_code: "14236"
                                region: NY
                                street: 2992 Cameron Road
                              primary: true
                            - data:
                                city: San Matias
                                country: US
                                postal_code: 93405-2255
                                region: CA
                                street: 2493 Leisure Lane
                              primary: false
                            emails:
                            - data: accountholder0@example.com
                              primary: true
                              type: primary
                            - data: accountholder1@example.com
                              primary: false
                              type: secondary
                            - data: extraordinarily.long.email.username.123456@reallylonghostname.com
                              primary: false
                              type: other
                            names:
                            - Alberta Bobbeth Charleson
                            phone_numbers:
                            - data: "1112223333"
                              primary: false
                              type: home
                            - data: "1112224444"
                              primary: false
                              type: work
                            - data: "1112225555"
                              primary: false
                              type: mobile
                          ownership_type: null
                          subtype: credit card
                          transactions: []
                          type: credit
                        date_last_updated: 2020-06-05T22:47:52Z
                        institution_id: ins_3
                        institution_name: Chase
                        item_id: eVBnVMp7zdTJLkRNr33Rs6zr7KNJqBFL9DrE6
                      user:
                        client_user_id: "123456789"
                        email: accountholder0@example.com
                        first_name: Alberta
                        last_name: Charleson
                        middle_name: Bobbeth
                        phone_number: 111-222-3333
                        ssn: 123-45-6789
                    request_id: eYupqX1mZkEuQRx
                    warnings: []
              schema:
                $ref: '#/components/schemas/AssetReportGetResponse'
          description: OK
      summary: Retrieve an Asset Report
      tags:
      - plaid
  /asset_report/pdf/get:
    post:
      description: |-
        The `/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/asset_report/pdf/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](/docs/api/webhooks) webhook to fire, indicating that the Report is ready to be retrieved.

        The response to `/asset_report/pdf/get` is the PDF binary data. The `request_id`  is returned in the `Plaid-Request-ID` header.

        [View a sample PDF Asset Report with Insights](https://plaid.com/documents/sample-asset-report.pdf).
      externalDocs:
        url: /api/products/#asset_reportpdfget
      operationId: assetReportPdfGet
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssetReportPDFGetRequest'
        required: true
      responses:
        "200":
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/AssetReportPDFGetResponse'
          description: A PDF of the Asset Report
      summary: Retrieve a PDF Asset Report
      tags:
      - plaid
  /asset_report/audit_copy/create:
    post:
      description: |-
        Plaid can provide an Audit Copy of any Asset Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy directly to Fannie Mae on your behalf if you participate in the Day 1 Certainty™ program. An Audit Copy contains the same underlying data as the Asset Report.

        To grant access to an Audit Copy, use the `/asset_report/audit_copy/create` endpoint to create an `audit_copy_token` and then pass that token to the third party who needs access. Each third party has its own `auditor_id`, for example `fannie_mae`. You’ll need to create a separate Audit Copy for each third party to whom you want to grant access to the Report.
      externalDocs:
        url: /api/products/#asset_reportaudit_copycreate
      operationId: assetReportAuditCopyCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssetReportAuditCopyCreateRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    audit_copy_token: a-sandbox-3TAU2CWVYBDVRHUCAAAI27ULU4
                    request_id: Iam3b
              schema:
                $ref: '#/components/schemas/AssetReportAuditCopyCreateResponse'
          description: OK
      summary: Create Asset Report Audit Copy
      tags:
      - plaid
  /asset_report/audit_copy/remove:
    post:
      description: The `/asset_report/audit_copy/remove` endpoint allows you to remove
        an Audit Copy. Removing an Audit Copy invalidates the `audit_copy_token` associated
        with it, meaning both you and any third parties holding the token will no
        longer be able to use it to access Report data. Items associated with the
        Asset Report, the Asset Report itself and other Audit Copies of it are not
        affected and will remain accessible after removing the given Audit Copy.
      externalDocs:
        url: /api/products/#asset_reportaudit_copyremove
      operationId: assetReportAuditCopyRemove
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssetReportAuditCopyRemoveRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    removed: true
                    request_id: m8MDnv9okwxFNBV
              schema:
                $ref: '#/components/schemas/AssetReportAuditCopyRemoveResponse'
          description: OK
      summary: Remove Asset Report Audit Copy
      tags:
      - plaid
  /investments/holdings/get:
    post:
      description: The `/investments/holdings/get` endpoint allows developers to receive
        user-authorized stock position data for `investment`-type accounts.
      externalDocs:
        url: /api/products/#investmentsholdingsget
      operationId: investmentsHoldingsGet
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InvestmentsHoldingsGetRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    accounts:
                    - account_id: 5Bvpj4QknlhVWk7GygpwfVKdd133GoCxB814g
                      balances:
                        available: 43200
                        current: 43200
                        iso_currency_code: USD
                        limit: null
                        unofficial_currency_code: null
                      mask: "4444"
                      name: Plaid Money Market
                      official_name: Plaid Platinum Standard 1.85% Interest Money
                        Market
                      subtype: money market
                      type: depository
                    - account_id: JqMLm4rJwpF6gMPJwBqdh9ZjjPvvpDcb7kDK1
                      balances:
                        available: null
                        current: 320.76
                        iso_currency_code: USD
                        limit: null
                        unofficial_currency_code: null
                      mask: "5555"
                      name: Plaid IRA
                      official_name: null
                      subtype: ira
                      type: investment
                    - account_id: k67E4xKvMlhmleEa4pg9hlwGGNnnEeixPolGm
                      balances:
                        available: null
                        current: 23631.9805
                        iso_currency_code: USD
                        limit: null
                        unofficial_currency_code: null
                      mask: "6666"
                      name: Plaid 401k
                      official_name: null
                      subtype: 401k
                      type: investment
                    holdings:
                    - account_id: JqMLm4rJwpF6gMPJwBqdh9ZjjPvvpDcb7kDK1
                      cost_basis: 1
                      institution_price: 1
                      institution_price_as_of: null
                      institution_value: 0.01
                      iso_currency_code: USD
                      quantity: 0.01
                      security_id: d6ePmbPxgWCWmMVv66q9iPV94n91vMtov5Are
                      unofficial_currency_code: null
                    - account_id: k67E4xKvMlhmleEa4pg9hlwGGNnnEeixPolGm
                      cost_basis: 1.5
                      institution_price: 2.11
                      institution_price_as_of: null
                      institution_value: 2.11
                      iso_currency_code: USD
                      quantity: 1
                      security_id: KDwjlXj1Rqt58dVvmzRguxJybmyQL8FgeWWAy
                      unofficial_currency_code: null
                    - account_id: k67E4xKvMlhmleEa4pg9hlwGGNnnEeixPolGm
                      cost_basis: 10
                      institution_price: 10.42
                      institution_price_as_of: null
                      institution_value: 20.84
                      iso_currency_code: USD
                      quantity: 2
                      security_id: NDVQrXQoqzt5v3bAe8qRt4A7mK7wvZCLEBBJk
                      unofficial_currency_code: null
                    - account_id: JqMLm4rJwpF6gMPJwBqdh9ZjjPvvpDcb7kDK1
                      cost_basis: 0.01
                      institution_price: 0.011
                      institution_price_as_of: null
                      institution_value: 110
                      iso_currency_code: USD
                      quantity: 10000
                      security_id: 8E4L9XLl6MudjEpwPAAgivmdZRdBPJuvMPlPb
                      unofficial_currency_code: null
                    - account_id: k67E4xKvMlhmleEa4pg9hlwGGNnnEeixPolGm
                      cost_basis: 23
                      institution_price: 27
                      institution_price_as_of: null
                      institution_value: 636.309
                      iso_currency_code: USD
                      quantity: 23.567
                      security_id: JDdP7XPMklt5vwPmDN45t3KAoWAPmjtpaW7DP
                      unofficial_currency_code: null
                    - account_id: k67E4xKvMlhmleEa4pg9hlwGGNnnEeixPolGm
                      cost_basis: 15
                      institution_price: 13.73
                      institution_price_as_of: null
                      institution_value: 1373.6865
                      iso_currency_code: USD
                      quantity: 100.05
                      security_id: nnmo8doZ4lfKNEDe3mPJipLGkaGw3jfPrpxoN
                      unofficial_currency_code: null
                    - account_id: k67E4xKvMlhmleEa4pg9hlwGGNnnEeixPolGm
                      cost_basis: 1
                      institution_price: 1
                      institution_price_as_of: null
                      institution_value: 12345.67
                      iso_currency_code: USD
                      quantity: 12345.67
                      security_id: d6ePmbPxgWCWmMVv66q9iPV94n91vMtov5Are
                      unofficial_currency_code: null
                    item:
                      available_products:
                      - balance
                      - identity
                      - liabilities
                      - transactions
                      billed_products:
                      - assets
                      - auth
                      - investments
                      consent_expiration_time: null
                      error: null
                      institution_id: ins_3
                      item_id: 4z9LPae1nRHWy8pvg9jrsgbRP4ZNQvIdbLq7g
                      update_type: background
                      webhook: https://www.genericwebhookurl.com/webhook
                    request_id: l68wb8zpS0hqmsJ
                    securities:
                    - close_price: 0.011
                      close_price_as_of: null
                      cusip: null
                      institution_id: null
                      institution_security_id: null
                      is_cash_equivalent: false
                      isin: null
                      iso_currency_code: USD
                      name: Nflx Feb 01'18 $355 Call
                      proxy_security_id: null
                      security_id: 8E4L9XLl6MudjEpwPAAgivmdZRdBPJuvMPlPb
                      sedol: null
                      ticker_symbol: NFLX180201C00355000
                      type: derivative
                      unofficial_currency_code: null
                    - close_price: 27
                      close_price_as_of: null
                      cusip: "577130834"
                      institution_id: null
                      institution_security_id: null
                      is_cash_equivalent: false
                      isin: US5771308344
                      iso_currency_code: USD
                      name: Matthews Pacific Tiger Fund Insti Class
                      proxy_security_id: null
                      security_id: JDdP7XPMklt5vwPmDN45t3KAoWAPmjtpaW7DP
                      sedol: null
                      ticker_symbol: MIPTX
                      type: mutual fund
                      unofficial_currency_code: null
                    - close_price: 2.11
                      close_price_as_of: null
                      cusip: 00448Q201
                      institution_id: null
                      institution_security_id: null
                      is_cash_equivalent: false
                      isin: US00448Q2012
                      iso_currency_code: USD
                      name: Achillion Pharmaceuticals Inc.
                      proxy_security_id: null
                      security_id: KDwjlXj1Rqt58dVvmzRguxJybmyQL8FgeWWAy
                      sedol: null
                      ticker_symbol: ACHN
                      type: equity
                      unofficial_currency_code: null
                    - close_price: 10.42
                      close_price_as_of: null
                      cusip: "258620103"
                      institution_id: null
                      institution_security_id: null
                      is_cash_equivalent: false
                      isin: US2586201038
                      iso_currency_code: USD
                      name: DoubleLine Total Return Bond Fund
                      proxy_security_id: null
                      security_id: NDVQrXQoqzt5v3bAe8qRt4A7mK7wvZCLEBBJk
                      sedol: null
                      ticker_symbol: DBLTX
                      type: mutual fund
                      unofficial_currency_code: null
                    - close_price: 1
                      close_price_as_of: null
                      cusip: null
                      institution_id: null
                      institution_security_id: null
                      is_cash_equivalent: true
                      isin: null
                      iso_currency_code: USD
                      name: U S Dollar
                      proxy_security_id: null
                      security_id: d6ePmbPxgWCWmMVv66q9iPV94n91vMtov5Are
                      sedol: null
                      ticker_symbol: USD
                      type: cash
                      unofficial_currency_code: null
                    - close_price: 13.73
                      close_price_as_of: null
                      cusip: null
                      institution_id: ins_3
                      institution_security_id: NHX105509
                      is_cash_equivalent: false
                      isin: null
                      iso_currency_code: USD
                      name: NH PORTFOLIO 1055 (FIDELITY INDEX)
                      proxy_security_id: null
                      security_id: nnmo8doZ4lfKNEDe3mPJipLGkaGw3jfPrpxoN
                      sedol: null
                      ticker_symbol: NHX105509
                      type: etf
                      unofficial_currency_code: null
              schema:
                $ref: '#/components/schemas/InvestmentsHoldingsGetResponse'
          description: OK
      summary: Get Investment holdings
      tags:
      - plaid
  /investments/transactions/get:
    post:
      description: |-
        The `/investments/transactions/get` endpoint allows developers to retrieve user-authorized transaction data for investment accounts.

        Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift.

        Due to the potentially large number of investment transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the `total_investment_transactions` response body field to fetch all available investment transactions.
      externalDocs:
        url: /api/products/#investmentstransactionsget
      operationId: investmentsTransactionsGet
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InvestmentsTransactionsGetRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    accounts:
                    - account_id: 5e66Dl6jNatx3nXPGwZ7UkJed4z6KBcZA4Rbe
                      balances:
                        available: 100
                        current: 110
                        iso_currency_code: USD
                        limit: null
                        unofficial_currency_code: null
                      mask: "0000"
                      name: Plaid Checking
                      official_name: Plaid Gold Standard 0% Interest Checking
                      subtype: checking
                      type: depository
                    - account_id: KqZZMoZmBWHJlz7yKaZjHZb78VNpaxfVa7e5z
                      balances:
                        available: null
                        current: 320.76
                        iso_currency_code: USD
                        limit: null
                        unofficial_currency_code: null
                      mask: "5555"
                      name: Plaid IRA
                      official_name: null
                      subtype: ira
                      type: investment
                    - account_id: rz99ex9ZQotvnjXdgQLEsR81e3ArPgulVWjGj
                      balances:
                        available: null
                        current: 23631.9805
                        iso_currency_code: USD
                        limit: null
                        unofficial_currency_code: null
                      mask: "6666"
                      name: Plaid 401k
                      official_name: null
                      subtype: 401k
                      type: investment
                    investment_transactions:
                    - account_id: rz99ex9ZQotvnjXdgQLEsR81e3ArPgulVWjGj
                      amount: -8.72
                      cancel_transaction_id: null
                      date: 2020-05-29
                      fees: 0
                      investment_transaction_id: oq99Pz97joHQem4BNjXECev1E4B6L6sRzwANW
                      iso_currency_code: USD
                      name: INCOME DIV DIVIDEND RECEIVED
                      price: 0
                      quantity: 0
                      security_id: eW4jmnjd6AtjxXVrjmj6SX1dNEdZp3Cy8RnRQ
                      subtype: dividend
                      type: cash
                      unofficial_currency_code: null
                    - account_id: rz99ex9ZQotvnjXdgQLEsR81e3ArPgulVWjGj
                      amount: -1289.01
                      cancel_transaction_id: null
                      date: 2020-05-28
                      fees: 7.99
                      investment_transaction_id: pK99jB9e7mtwjA435GpVuMvmWQKVbVFLWme57
                      iso_currency_code: USD
                      name: SELL Matthews Pacific Tiger Fund Insti Class
                      price: 27.53
                      quantity: 47.74104242992852
                      security_id: JDdP7XPMklt5vwPmDN45t3KAoWAPmjtpaW7DP
                      subtype: sell
                      type: sell
                      unofficial_currency_code: null
                    - account_id: rz99ex9ZQotvnjXdgQLEsR81e3ArPgulVWjGj
                      amount: 7.7
                      cancel_transaction_id: null
                      date: 2020-05-27
                      fees: 7.99
                      investment_transaction_id: LKoo1ko93wtreBwM7yQnuQ3P5DNKbKSPRzBNv
                      iso_currency_code: USD
                      name: BUY DoubleLine Total Return Bond Fund
                      price: 10.42
                      quantity: 0.7388014749727547
                      security_id: NDVQrXQoqzt5v3bAe8qRt4A7mK7wvZCLEBBJk
                      subtype: buy
                      type: buy
                      unofficial_currency_code: null
                    item:
                      available_products:
                      - assets
                      - balance
                      - identity
                      - transactions
                      billed_products:
                      - auth
                      - investments
                      consent_expiration_time: null
                      error: null
                      institution_id: ins_12
                      item_id: 8Mqq5rqQ7Pcxq9MGDv3JULZ6yzZDLMCwoxGDq
                      update_type: background
                      webhook: https://www.genericwebhookurl.com/webhook
                    request_id: iv4q3ZlytOOthkv
                    securities:
                    - close_price: 27
                      close_price_as_of: null
                      cusip: "577130834"
                      institution_id: null
                      institution_security_id: null
                      is_cash_equivalent: false
                      isin: US5771308344
                      iso_currency_code: USD
                      name: Matthews Pacific Tiger Fund Insti Class
                      proxy_security_id: null
                      security_id: JDdP7XPMklt5vwPmDN45t3KAoWAPmjtpaW7DP
                      sedol: null
                      ticker_symbol: MIPTX
                      type: mutual fund
                      unofficial_currency_code: null
                    - close_price: 10.42
                      close_price_as_of: null
                      cusip: "258620103"
                      institution_id: null
                      institution_security_id: null
                      is_cash_equivalent: false
                      isin: US2586201038
                      iso_currency_code: USD
                      name: DoubleLine Total Return Bond Fund
                      proxy_security_id: null
                      security_id: NDVQrXQoqzt5v3bAe8qRt4A7mK7wvZCLEBBJk
                      sedol: null
                      ticker_symbol: DBLTX
                      type: mutual fund
                      unofficial_currency_code: null
                    - close_price: 34.73
                      close_price_as_of: null
                      cusip: 84470P109
                      institution_id: null
                      institution_security_id: null
                      is_cash_equivalent: false
                      isin: US84470P1093
                      iso_currency_code: USD
                      name: Southside Bancshares Inc.
                      proxy_security_id: null
                      security_id: eW4jmnjd6AtjxXVrjmj6SX1dNEdZp3Cy8RnRQ
                      sedol: null
                      ticker_symbol: SBSI
                      type: equity
                      unofficial_currency_code: null
                    total_investment_transactions: 3
              schema:
                $ref: '#/components/schemas/InvestmentsTransactionsGetResponse'
          description: OK
      summary: Get investment transactions
      tags:
      - plaid
  /processor/token/create:
    post:
      description: Used to create a token suitable for sending to one of Plaid's partners
        to enable integrations. Note that Stripe partnerships use bank account tokens
        instead; see `/processor/stripe/bank_account_token/create` for creating tokens
        for use with Stripe integrations.
      externalDocs:
        url: /api/processors/#processortokencreate
      operationId: processorTokenCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProcessorTokenCreateRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    processor_token: processor-sandbox-0asd1-a92nc
                    request_id: xrQNYZ7Zoh6R7gV
              schema:
                $ref: '#/components/schemas/ProcessorTokenCreateResponse'
          description: OK
      summary: Create processor token
      tags:
      - plaid
  /processor/stripe/bank_account_token/create:
    post:
      description: Used to create a token suitable for sending to Stripe to enable
        Plaid-Stripe integrations.
      externalDocs:
        url: /api/processors/#processorstripebank_account_tokencreate
      operationId: processorStripeBankAccountTokenCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProcessorStripeBankAccountTokenCreateRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    stripe_bank_account_token: btok_5oEetfLzPklE1fwJZ7SG
                    request_id: xrQNYZ7Zoh6R7gV
              schema:
                $ref: '#/components/schemas/ProcessorStripeBankAccountTokenCreateResponse'
          description: OK
      summary: Create Stripe bank account token
      tags:
      - plaid
  /processor/apex/processor_token/create:
    post:
      description: Used to create a token suitable for sending to Apex to enable Plaid-Apex
        integrations.
      externalDocs:
        url: /none/
      operationId: processorApexProcessorTokenCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProcessorApexProcessorTokenCreateRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessorTokenCreateResponse'
          description: OK
      summary: Create Apex bank account token
      tags:
      - plaid
  /deposit_switch/create:
    post:
      description: This endpoint creates a deposit switch entity that will be persisted
        throughout the lifecycle of the switch.
      externalDocs:
        url: /api/products#deposit_switchcreate
      operationId: depositSwitchCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DepositSwitchCreateRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    deposit_switch_id: c7jMwPPManIwy9rwMewWP7lpb4pKRbtrbMomp
                    request_id: lMjeOeu9X1VUh1F
              schema:
                $ref: '#/components/schemas/DepositSwitchCreateResponse'
          description: OK
      summary: Create a deposit switch
      tags:
      - plaid
  /item/import:
    post:
      description: |-
        `/item/import` creates an Item via your Plaid Exchange Integration and returns an `access_token`. As part of an `/item/import` request, you will include a User ID (`user_auth.user_id`) and Authentication Token (`user_auth.auth_token`) that enable data aggregation through your Plaid Exchange API endpoints. These authentication principals are to be chosen by you.

        Upon creating an Item via `/item/import`, Plaid will automatically begin an extraction of that Item through the Plaid Exchange infrastructure you have already integrated. This will automatically generate the Plaid native account ID for the account the user will switch their direct deposit to (`target_account_id`).
      operationId: itemImport
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ItemImportRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    access_token: access-sandbox-99ace160-3cf7-4e51-a083-403633425815
                    request_id: ewIBAn6RZirsk4W
              schema:
                $ref: '#/components/schemas/ItemImportResponse'
          description: OK
      summary: Import Item
      tags:
      - plaid
  /deposit_switch/token/create:
    post:
      description: |
        In order for the end user to take action, you will need to create a public token representing the deposit switch. This token is used to initialize Link. It can be used one time and expires after 30 minutes.
      externalDocs:
        url: /deposit-switch/reference#deposit_switchtokencreate
      operationId: depositSwitchTokenCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DepositSwitchTokenCreateRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    deposit_switch_token: deposit-switch-sandbox-3e5cacca-10a6-11ea-bcdb-6003089acac0
                    deposit_switch_token_expiration_time: 2019-12-31T12:01:37Z
                    request_id: 68MvHx4Ub5NYoXt
              schema:
                $ref: '#/components/schemas/DepositSwitchTokenCreateResponse'
          description: OK
      summary: Create a deposit switch token
      tags:
      - plaid
  /link/token/create:
    post:
      description: |-
        The `/link/token/create` endpoint creates a `link_token`, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a `public_token`, which can then be exchanged for an `access_token` via `/item/public_token/exchange` as part of the main Link flow.

        A `link_token` generated by `/link/token/create` is also used to initialize other Link flows, such as the update mode flow for tokens with expired credentials, or the Payment Initiation (Europe) flow.
      externalDocs:
        url: /api/tokens/#linktokencreate
      operationId: linkTokenCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinkTokenCreateRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    link_token: link-production-840204-193734
                    expiration: 2020-03-27T12:56:34Z
                    request_id: XQVgFigpGHXkb0b
              schema:
                $ref: '#/components/schemas/LinkTokenCreateResponse'
          description: OK
      summary: Create Link Token
      tags:
      - plaid
  /link/token/get:
    post:
      description: |-
        The `/link/token/get` endpoint gets information about a previously-created `link_token` using the
        `/link/token/create` endpoint. It can be useful for debugging purposes.
      externalDocs:
        url: /api/tokens/#linktokenget
      operationId: linkTokenGet
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinkTokenGetRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    created_at: 2020-12-02T21:14:54Z
                    expiration: 2020-12-03T01:14:54Z
                    link_token: link-sandbox-33792986-2b9c-4b80-b1f2-518caaac6183
                    metadata:
                      account_filters:
                        depository:
                          account_subtypes:
                          - checking
                          - savings
                      client_name: Insert Client name here
                      country_codes:
                      - US
                      initial_products:
                      - auth
                      language: en
                      redirect_uri: null
                      webhook: https://www.example.com/webhook
                    request_id: u0ydFs493XjyTYn
              schema:
                $ref: '#/components/schemas/LinkTokenGetResponse'
          description: OK
      summary: Get Link Token
      tags:
      - plaid
  /asset_report/audit_copy/get:
    post:
      description: '`/asset_report/audit_copy/get` allows auditors to get a copy of
        an Asset Report that was previously shared via the `/asset_report/audit_copy/create`
        endpoint.  The caller of `/asset_report/audit_copy/create` must provide the
        `audit_copy_token` to the auditor.  This token can then be used to call `/asset_report/audit_copy/create`.'
      externalDocs:
        url: /none/
      operationId: assetReportAuditCopyGet
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssetReportAuditCopyGetRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssetReportGetResponse'
          description: OK
      summary: Retrieve an Asset Report Audit Copy
      tags:
      - plaid
  /deposit_switch/get:
    post:
      description: This endpoint returns information related to how the user has configured
        their payroll allocation and the state of the switch. You can use this information
        to build logic related to the user's direct deposit allocation preferences.
      externalDocs:
        url: /api/products#deposit_switchget
      operationId: depositSwitchGet
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DepositSwitchGetRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    target_item_id: MdRAkq1QikR3BLjDyMfMkVpqLmEm1VR7bX5hE
                    target_account_id: bX5hEMdRAkq1QikR3BLjDyMfMkVpqLmEm1VR7
                    deposit_switch_id: LjDyMfMkVpqLmEm1VR7bQikR3BX5hEMdRAkq1
                    state: completed
                    date_created: 2019-11-01
                    date_completed: 2019-11-01
                    account_has_multiple_allocations: true
                    is_allocated_remainder: false
                    percent_allocated: 50
                    amount_allocated: null
                    request_id: lMjeOeu9X1VUh1F
              schema:
                $ref: '#/components/schemas/DepositSwitchGetResponse'
          description: OK
      summary: Retrieve a deposit switch
      tags:
      - plaid
  /bank_transfer/get:
    post:
      description: The `/bank_transfer/get` fetches information about the bank transfer
        corresponding to the given `bank_transfer_id`.
      externalDocs:
        url: /api/products#bank_transferget
      operationId: bankTransferGet
      parameters: []
      requestBody:
        content:
          application/json:
            examples: {}
            schema:
              $ref: '#/components/schemas/BankTransferGetRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    bank_transfer:
                      account_id: 6qL6lWoQkAfNE3mB8Kk5tAnvpX81qefrvvl7B
                      ach_class: ppd
                      amount: "12.34"
                      cancellable: true
                      created: 2020-08-06T17:27:15Z
                      custom_tag: my tag
                      description: Testing2
                      direction: outbound
                      failure_reason:
                        ach_return_code: R13
                        description: Invalid ACH routing number
                      id: 460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9
                      iso_currency_code: USD
                      metadata:
                        key1: value1
                        key2: value2
                      network: ach
                      origination_account_id: 11111111-1111-1111-1111-111111111111
                      status: pending
                      type: credit
                      user:
                        email_address: plaid@plaid.com
                        legal_name: John Smith
                        routing_number: "111111111"
                    request_id: saKrIBuEB9qJZno
              schema:
                $ref: '#/components/schemas/BankTransferGetResponse'
          description: OK
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Error response
      summary: Retrieve a bank transfer
      tags:
      - plaid
  /bank_transfer/create:
    post:
      description: Use the `/bank_transfer/create` endpoint to initiate a new bank
        transfer.
      externalDocs:
        url: /api/products#bank_transfercreate
      operationId: bankTransferCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BankTransferCreateRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    bank_transfer:
                      account_id: 6qL6lWoQkAfNE3mB8Kk5tAnvpX81qefrvvl7B
                      ach_class: ppd
                      amount: "12.34"
                      cancellable: true
                      created: 2020-08-06T17:27:15Z
                      custom_tag: my tag
                      description: Testing2
                      direction: outbound
                      failure_reason: null
                      id: 460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9
                      iso_currency_code: USD
                      metadata:
                        key1: value1
                        key2: value2
                      network: ach
                      origination_account_id: 11111111-1111-1111-1111-111111111111
                      status: pending
                      type: credit
                      user:
                        email_address: plaid@plaid.com
                        legal_name: John Smith
                        routing_number: "111111111"
                    request_id: saKrIBuEB9qJZno
              schema:
                $ref: '#/components/schemas/BankTransferCreateResponse'
          description: OK
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Error response
      summary: Create a bank transfer
      tags:
      - plaid
  /bank_transfer/list:
    post:
      description: |
        Use the `/bank_transfer/list` endpoint to see a list of all your bank transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired bank transfers.
      externalDocs:
        url: /api/products#bank_transferlist
      operationId: bankTransferList
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BankTransferListRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    bank_transfers:
                    - account_id: 6qL6lWoQkAfNE3mB8Kk5tAnvpX81qefrvvl7B
                      ach_class: ppd
                      amount: "12.34"
                      cancellable: true
                      created: 2020-08-06T17:27:15Z
                      custom_tag: my tag
                      description: Testing2
                      direction: outbound
                      failure_reason:
                        ach_return_code: R13
                        description: Invalid ACH routing number
                      id: 460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9
                      iso_currency_code: USD
                      metadata:
                        key1: value1
                        key2: value2
                      network: ach
                      origination_account_id: 11111111-1111-1111-1111-111111111111
                      status: pending
                      type: credit
                      user:
                        email_address: plaid@plaid.com
                        legal_name: John Smith
                        routing_number: "111111111"
                    request_id: saKrIBuEB9qJZno
              schema:
                $ref: '#/components/schemas/BankTransferListResponse'
          description: OK
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Error response
      summary: List bank transfers
      tags:
      - plaid
  /bank_transfer/cancel:
    post:
      description: Use the `/bank_transfer/cancel` endpoint to cancel a bank transfer.  A
        transfer is eligible for cancelation if the `cancellable` property returned
        by `/bank_transfer/get` is `true`.
      externalDocs:
        url: /api/products#bank_transfercancel
      operationId: bankTransferCancel
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BankTransferCancelRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    request_id: saKrIBuEB9qJZno
              schema:
                $ref: '#/components/schemas/BankTransferCancelResponse'
          description: OK
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Error response
      summary: Cancel a bank transfer
      tags:
      - plaid
  /bank_transfer/event/list:
    post:
      description: Use the `/bank_transfer/event/list` endpoint to get a list of bank
        transfer events based on specified filter criteria.
      externalDocs:
        url: /api/products#bank_transfereventlist
      operationId: bankTransferEventList
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BankTransferEventListRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    bank_transfer_events:
                    - account_id: 6qL6lWoQkAfNE3mB8Kk5tAnvpX81qefrvvl7B
                      bank_transfer_amount: "12.34"
                      bank_transfer_id: 460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9
                      bank_transfer_iso_currency_code: USD
                      bank_transfer_type: credit
                      direction: outbound
                      event_id: 1
                      event_type: receiver_pending
                      failure_reason: null
                      origination_account_id: null
                      receiver_details:
                        available_balance: positive
                      timestamp: 2020-08-06T17:27:15Z
                    request_id: mdqfuVxeoza6mhu
              schema:
                $ref: '#/components/schemas/BankTransferEventListResponse'
          description: OK
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Error response
      summary: List bank transfer events
      tags:
      - plaid
  /bank_transfer/event/sync:
    post:
      description: '`/bank_transfer/event/sync` allows you to request up to the next
        25 bank transfer events that happened after a specific `event_id`. Use the
        `/bank_transfer/event/sync` endpoint to guarantee you have seen all bank transfer
        events. '
      externalDocs:
        url: /api/products#bank_transfereventsync
      operationId: bankTransferEventSync
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BankTransferEventSyncRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    bank_transfer_events:
                    - account_id: 6qL6lWoQkAfNE3mB8Kk5tAnvpX81qefrvvl7B
                      bank_transfer_amount: "12.34"
                      bank_transfer_id: 460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9
                      bank_transfer_iso_currency_code: USD
                      bank_transfer_type: credit
                      direction: outbound
                      event_id: 1
                      event_type: pending
                      failure_reason: null
                      origination_account_id: null
                      receiver_details: null
                      timestamp: 2020-08-06T17:27:15Z
                    request_id: mdqfuVxeoza6mhu
              schema:
                $ref: '#/components/schemas/BankTransferEventSyncResponse'
          description: OK
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Error response
      summary: Sync bank transfer events
      tags:
      - plaid
  /bank_transfer/balance/get:
    post:
      description: |-
        Use the `/bank_transfer/balance/get` endpoint to see the available balance in your bank transfer account. Debit transfers increase this balance once their status is posted. Credit transfers decrease this balance when they are created.

        The transactable balance shows the amount in your account that you are able to use for transfers, and is essentially your available balance minus your minimum balance.

        Note that this endpoint can only be used with FBO accounts, when using Bank Transfers in the Full Service configuration. It cannot be used on your own account when using Bank Transfers in the BTS Platform configuration.
      externalDocs:
        url: /api/products#bank_transferbalanceget
      operationId: bankTransferBalanceGet
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BankTransferBalanceGetRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    balance:
                      available: "1721.70"
                      transactable: "721.70"
                    origination_account_id: 11111111-1111-1111-1111-111111111111
                    request_id: mdqfuVxeoza6mhu
              schema:
                $ref: '#/components/schemas/BankTransferBalanceGetResponse'
          description: OK
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Error response
      summary: Get balance of your Bank Transfer account
      tags:
      - plaid
  /bank_transfer/migrate_account:
    post:
      description: As an alternative to adding Items via Link, you can also use the
        `/bank_transfer/migrate_account` endpoint to migrate known account and routing
        numbers to Plaid Items.  Note that Items created in this way are not compatible
        with endpoints for other products, such as `/accounts/balance/get`, and can
        only be used with Bank Transfer endpoints.  If you require access to other
        endpoints, create the Item through Link instead.  Access to `/bank_transfer/migrate_account`
        is not enabled by default; to obtain access, contact your Plaid Account Manager.
      externalDocs:
        url: /api/products#bank_transfermigrate_account
      operationId: bankTransferMigrateAccount
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BankTransferMigrateAccountRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    access_token: access-sandbox-435beced-94e8-4df3-a181-1dde1cfa19f0
                    account_id: zvyDgbeeDluZ43AJP6m5fAxDlgoZXDuoy5gjN
                    request_id: mdqfuVxeoza6mhu
              schema:
                $ref: '#/components/schemas/BankTransferMigrateAccountResponse'
          description: OK
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Error response
      summary: Migrate account into Bank Transfers
      tags:
      - plaid
  /sandbox/bank_transfer/simulate:
    post:
      description: Use the `/sandbox/bank_transfer/simulate` endpoint to simulate
        a bank transfer event in the Sandbox environment.  Note that while an event
        will be simulated and will appear when using endpoints such as `/bank_transfer/event/sync`
        or `/bank_transfer/event/list`, no transactions will actually take place and
        funds will not move between accounts, even within the Sandbox.
      externalDocs:
        url: /api/sandbox/#sandboxbank_transfersimulate
      operationId: sandboxBankTransferSimulate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SandboxBankTransferSimulateRequest'
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    request_id: mdqfuVxeoza6mhu
              schema:
                $ref: '#/components/schemas/SandboxBankTransferSimulateResponse'
          description: OK
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Error response
      summary: Simulate a bank transfer event in Sandbox
      tags:
      - plaid
  /employers/search:
    post:
      description: |-
        `/employers/search` allows you the ability to search Plaid’s database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user's employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow.

        The data in the employer database is currently limited. As the Verification of Income product progresses through the beta period, more employers are being regularly added. Because the employer database is frequently updated, we recommend that you do not cache or store data from this endpoint for more than a day.
      externalDocs:
        url: /api/employers#employerssearch
      operationId: employersSearch
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmployersSearchRequest'
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    employers:
                    - name: Plaid Technologies Inc
                      address:
                        city: San Francisco
                        country: US
                        postal_code: "94103"
                        region: CA
                        street: 1098 Harrison St
                      confidence_score: 1
                      employer_id: emp_1
                    request_id: ixTBLZGvhD4NnmB
              schema:
                $ref: '#/components/schemas/EmployersSearchResponse'
          description: OK
      summary: Search employer database
      tags:
      - plaid
  /income/verification/create:
    post:
      description: '`/income/verification/create` begins the income verification process
        by returning an `income_verification_id`. You can then provide the `income_verification_id`
        to `/link/token/create` under the `income_verification` parameter in order
        to create a Link instance that will prompt the user to upload their income
        documents. Once the documents have been uploaded and parsed, Plaid will fire
        an `INCOME` webhook.'
      externalDocs:
        url: /income-verification/reference#incomeverificationcreate
      operationId: post-income-verification-create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IncomeVerificationCreateRequest'
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    income_verification_id: f2a826d7-25cf-483b-a124-c40beb64b732
                    request_id: lMjeOeu9X1VUh1F
              schema:
                $ref: '#/components/schemas/IncomeVerificationCreateResponse'
          description: OK
      summary: Create an income verification instance
      tags:
      - plaid
  /income/verification/summary/get:
    post:
      description: '`/income/verification/summary/get` returns a verification summary
        for the income that was verified for an end user. It can be called once the
        status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`,
        as reported by the `INCOME: verification_status` webhook. Attempting to call
        the endpoint before verification has been completed will result in an error.'
      externalDocs:
        url: /income-verification/reference#incomeverificationsummaryget
      operationId: incomeVerificationSummaryGet
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IncomeVerificationSummaryGetRequest'
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    income_summaries:
                    - employee_name:
                        value: ANNA CHARLESTON
                        verification_status: UNVERIFIED
                      employer_name:
                        value: PLAID INC
                        verification_status: UNVERIFIED
                      pay_frequency:
                        value: semimonthly
                        verification_status: UNVERIFIED
                      projected_wage:
                        value: 100000
                        verification_status: UNVERIFIED
                      verified_transaction:
                        account_id: ""
                        amount: 0
                        date: ""
                        description: ""
                        transaction_id: ""
                      ytd_gross_income:
                        value: 59375
                        verification_status: UNVERIFIED
                      ytd_net_income:
                        value: 66205.35714285713
                        verification_status: UNVERIFIED
                    request_id: LhQf0THi8SH1yJm
              schema:
                $ref: '#/components/schemas/IncomeVerificationSummaryGetResponse'
          description: OK
      summary: Retrieve a summary of information derived from income verification
      tags:
      - plaid
  /income/verification/paystub/get:
    post:
      description: '`/income/verification/paystub/get` returns the information collected
        from the paystub that was used to verify an end user''s income. It can be
        called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`,
        as reported by the `INCOME: verification_status` webhook. Attempting to call
        the endpoint before verification has been completed will result in an error.'
      externalDocs:
        url: /income-verification/reference#incomeverificationpaystubget
      operationId: incomeVerificationPaystubGet
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IncomeVerificationPaystubGetRequest'
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    account_id: null
                    employee:
                      address:
                        city: SAN FRANCISCO
                        country: US
                        postal_code: "94133"
                        region: CA
                        street: 2140 TAYLOR ST
                      name: ANNA CHARLESTON
                    employer:
                      name: PLAID INC
                    income_breakdown: []
                    pay_period_details:
                      check_amount: 1490.21
                      end_date: 2020-12-15
                      gross_earnings: 4500
                      pay_day: 2020-12-15
                      start_date: 2020-12-01
                    request_id: snygYZ9fR3vXuam
                    ytd_earnings:
                      gross_earnings: 59375
                      net_earnings: null
              schema:
                $ref: '#/components/schemas/IncomeVerificationPaystubGetResponse'
          description: OK
      summary: Retrieve information from the paystub used for income verification
      tags:
      - plaid
  /income/verification/documents/download:
    post:
      description: |-
        `/income/verification/documents/download` provides the ability to download the source paystub PDF that the end user uploaded via Paystub Import.

        The response to `/income/verification/documents/download` is a ZIP file in binary data. The `request_id`  is returned in the `Plaid-Request-ID` header.

        In the future, when Digital Verification is available, the most recent file available for download with the payroll provider will also be available from this endpoint.
      externalDocs:
        url: /income-verification/reference#incomeverificationdocumentsdownload
      operationId: incomeVerificationDocumentsDownload
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IncomeVerificationDocumentsDownloadRequest'
      responses:
        "200":
          content:
            application/zip:
              schema:
                format: binary
                type: string
          description: A ZIP file containing the source paystub(s) used as the basis
            for income verification.
      summary: Download the original documents used for income verification
      tags:
      - plaid
  /deposit_switch/alt/create:
    post:
      description: This endpoint provides an alternative to `/deposit_switch/create`
        for customers who have not yet fully integrated with Plaid Exchange. Like
        `/deposit_switch/create`, it created a deposit switch entity that will be
        persisted throughout the lifecycle of the switch.
      externalDocs:
        url: /api/products#deposit_switchaltcreate
      operationId: depositSwitchAltCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DepositSwitchAltCreateRequest'
      responses:
        "200":
          content:
            application/json:
              examples:
                example-1:
                  value:
                    deposit_switch_id: c7jMwPPManIwy9rwMewWP7lpb4pKRbtrbMomp
                    request_id: lMjeOeu9X1VUh1F
              schema:
                $ref: '#/components/schemas/DepositSwitchAltCreateResponse'
          description: OK
      summary: Create a deposit switch when not using Plaid Exchange.'
      tags:
      - plaid
components:
  schemas:
    ItemGetRequest:
      description: ItemGetRequest defines the request schema for `/item/get`
      example:
        access_token: access_token
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        access_token:
          description: The access token associated with the Item data is being requested
            for.
          title: AccessToken
          type: string
      required:
      - access_token
      type: object
    ItemGetResponse:
      additionalProperties: true
      description: ItemGetResponse defines the response schema for `/item/get` and
        `/item/webhook/update`
      example:
        item:
          update_type: background
          webhook: webhook
          item_id: item_id
          billed_products:
          - null
          - null
          consent_expiration_time: consent_expiration_time
          error:
            error_message: error_message
            suggested_action: suggested_action
            error_type: INVALID_REQUEST
            causes:
            - ""
            - ""
            display_message: display_message
            error_code: error_code
            documentation_url: documentation_url
            request_id: request_id
            status: 0.8008281904610115
          available_products:
          - null
          - null
          institution_id: institution_id
        request_id: request_id
      properties:
        item:
          $ref: '#/components/schemas/Item'
        status:
          $ref: '#/components/schemas/NullableItemStatus'
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
        access_token:
          $ref: '#/components/schemas/NullableAccessToken'
      required:
      - item
      - request_id
      type: object
    AuthGetRequest:
      description: AuthGetRequest defines the request schema for `/auth/get`
      example:
        access_token: access_token
        options:
          account_ids:
          - account_ids
          - account_ids
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        access_token:
          description: The access token associated with the Item data is being requested
            for.
          title: AccessToken
          type: string
        options:
          $ref: '#/components/schemas/AuthGetRequestOptions'
      required:
      - access_token
      type: object
    AuthGetRequestOptions:
      description: An optional object to filter `/auth/get` results.
      example:
        account_ids:
        - account_ids
        - account_ids
      properties:
        account_ids:
          description: |-
            A list of `account_ids` to retrieve for the Item.
            Note: An error will be returned if a provided `account_id` is not associated with the Item.
          items:
            type: string
          type: array
      type: object
    AuthGetResponse:
      additionalProperties: true
      description: AuthGetResponse defines the response schema for `/auth/get`
      example:
        item:
          update_type: background
          webhook: webhook
          item_id: item_id
          billed_products:
          - null
          - null
          consent_expiration_time: consent_expiration_time
          error:
            error_message: error_message
            suggested_action: suggested_action
            error_type: INVALID_REQUEST
            causes:
            - ""
            - ""
            display_message: display_message
            error_code: error_code
            documentation_url: documentation_url
            request_id: request_id
            status: 0.8008281904610115
          available_products:
          - null
          - null
          institution_id: institution_id
        numbers:
          bacs:
          - account_id: account_id
            sort_code: sort_code
            account: account
          - account_id: account_id
            sort_code: sort_code
            account: account
          eft:
          - institution: institution
            account_id: account_id
            branch: branch
            account: account
          - institution: institution
            account_id: account_id
            branch: branch
            account: account
          ach:
          - wire_routing: wire_routing
            routing: routing
            account_id: account_id
            account: account
          - wire_routing: wire_routing
            routing: routing
            account_id: account_id
            account: account
          international:
          - account_id: account_id
            iban: iban
            bic: bic
          - account_id: account_id
            iban: iban
            bic: bic
        accounts:
        - official_name: official_name
          balances:
            unofficial_currency_code: unofficial_currency_code
            current: 6.027456183070403
            available: 0.8008281904610115
            limit: 1.4658129805029452
            iso_currency_code: iso_currency_code
          account_id: account_id
          name: name
          verification_status: pending_automatic_verification
          mask: mask
        - official_name: official_name
          balances:
            unofficial_currency_code: unofficial_currency_code
            current: 6.027456183070403
            available: 0.8008281904610115
            limit: 1.4658129805029452
            iso_currency_code: iso_currency_code
          account_id: account_id
          name: name
          verification_status: pending_automatic_verification
          mask: mask
        request_id: request_id
      properties:
        accounts:
          description: The `accounts` for which numbers are being retrieved.
          items:
            $ref: '#/components/schemas/AccountBase'
          type: array
        numbers:
          $ref: '#/components/schemas/AuthGetNumbers'
        item:
          $ref: '#/components/schemas/Item'
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - accounts
      - item
      - numbers
      - request_id
      type: object
    AuthGetNumbers:
      additionalProperties: true
      description: An object containing identifying numbers used for making electronic
        transfers to and from the `accounts`. The identifying number type (ACH, EFT,
        IBAN, or BACS) used will depend on the country of the account. An account
        may have more than one number type. If a particular identifying number type
        is not used by any `accounts` for which data has been requested, the array
        for that type will be empty.
      example:
        bacs:
        - account_id: account_id
          sort_code: sort_code
          account: account
        - account_id: account_id
          sort_code: sort_code
          account: account
        eft:
        - institution: institution
          account_id: account_id
          branch: branch
          account: account
        - institution: institution
          account_id: account_id
          branch: branch
          account: account
        ach:
        - wire_routing: wire_routing
          routing: routing
          account_id: account_id
          account: account
        - wire_routing: wire_routing
          routing: routing
          account_id: account_id
          account: account
        international:
        - account_id: account_id
          iban: iban
          bic: bic
        - account_id: account_id
          iban: iban
          bic: bic
      properties:
        ach:
          description: An array of ACH numbers identifying accounts.
          items:
            $ref: '#/components/schemas/NumbersACH'
          type: array
        eft:
          description: An array of EFT numbers identifying accounts.
          items:
            $ref: '#/components/schemas/NumbersEFT'
          type: array
        international:
          description: An array of IBAN numbers identifying accounts.
          items:
            $ref: '#/components/schemas/NumbersInternationals'
          type: array
        bacs:
          description: An array of BACS numbers identifying accounts.
          items:
            $ref: '#/components/schemas/NumbersBACS'
          type: array
      type: object
    TransactionsGetRequest:
      description: TransactionsGetRequest defines the request schema for `/transactions/get`
      example:
        access_token: access_token
        end_date: 2000-01-23
        options:
          account_ids:
          - account_ids
          - account_ids
          offset: 0
          count: 40
        secret: secret
        client_id: client_id
        start_date: 2000-01-23
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        options:
          $ref: '#/components/schemas/TransactionsGetRequestOptions'
        access_token:
          description: The access token associated with the Item data is being requested
            for.
          title: AccessToken
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        start_date:
          description: The earliest date for which data should be returned. Dates
            should be formatted as YYYY-MM-DD.
          format: date
          type: string
        end_date:
          description: The latest date for which data should be returned. Dates should
            be formatted as YYYY-MM-DD.
          format: date
          type: string
      required:
      - access_token
      - end_date
      - start_date
      type: object
    TransactionsGetRequestOptions:
      description: An optional object to be used with the request. If specified, `options`
        must not be `null`.
      example:
        account_ids:
        - account_ids
        - account_ids
        offset: 0
        count: 40
      properties:
        account_ids:
          description: |-
            A list of `account_ids` to retrieve for the Item

            Note: An error will be returned if a provided `account_id` is not associated with the Item.
          items:
            type: string
          type: array
        count:
          default: 100
          description: The number of transactions to fetch.
          exclusiveMinimum: false
          maximum: 500
          minimum: 1
          type: integer
        offset:
          default: 0
          description: The number of transactions to skip. The default value is 0.
          minimum: 0
          type: integer
      type: object
    TransactionsGetResponse:
      additionalProperties: true
      description: TransactionsGetResponse defines the response schema for `/transactions/get`
      example:
        item:
          update_type: background
          webhook: webhook
          item_id: item_id
          billed_products:
          - null
          - null
          consent_expiration_time: consent_expiration_time
          error:
            error_message: error_message
            suggested_action: suggested_action
            error_type: INVALID_REQUEST
            causes:
            - ""
            - ""
            display_message: display_message
            error_code: error_code
            documentation_url: documentation_url
            request_id: request_id
            status: 0.8008281904610115
          available_products:
          - null
          - null
          institution_id: institution_id
        total_transactions: 5
        accounts:
        - official_name: official_name
          balances:
            unofficial_currency_code: unofficial_currency_code
            current: 6.027456183070403
            available: 0.8008281904610115
            limit: 1.4658129805029452
            iso_currency_code: iso_currency_code
          account_id: account_id
          name: name
          verification_status: pending_automatic_verification
          mask: mask
        - official_name: official_name
          balances:
            unofficial_currency_code: unofficial_currency_code
            current: 6.027456183070403
            available: 0.8008281904610115
            limit: 1.4658129805029452
            iso_currency_code: iso_currency_code
          account_id: account_id
          name: name
          verification_status: pending_automatic_verification
          mask: mask
        transactions:
        - transaction_id: transaction_id
          date: date
          unofficial_currency_code: unofficial_currency_code
          authorized_datetime: authorized_datetime
          amount: 1.4658129805029452
          payment_meta:
            payee: payee
            ppd_id: ppd_id
            reason: reason
            by_order_of: by_order_of
            payment_processor: payment_processor
            reference_number: reference_number
            payer: payer
            payment_method: payment_method
          pending: true
          merchant_name: merchant_name
          transaction_type: digital
          account_owner: account_owner
          datetime: datetime
          account_id: account_id
          category_id: category_id
          payment_channel: online
          name: name
          iso_currency_code: iso_currency_code
          pending_transaction_id: pending_transaction_id
          location:
            country: country
            address: address
            city: city
            store_number: store_number
            lon: 6.027456183070403
            region: region
            postal_code: postal_code
            lat: 0.8008281904610115
          category:
          - category
          - category
          authorized_date: authorized_date
        - transaction_id: transaction_id
          date: date
          unofficial_currency_code: unofficial_currency_code
          authorized_datetime: authorized_datetime
          amount: 1.4658129805029452
          payment_meta:
            payee: payee
            ppd_id: ppd_id
            reason: reason
            by_order_of: by_order_of
            payment_processor: payment_processor
            reference_number: reference_number
            payer: payer
            payment_method: payment_method
          pending: true
          merchant_name: merchant_name
          transaction_type: digital
          account_owner: account_owner
          datetime: datetime
          account_id: account_id
          category_id: category_id
          payment_channel: online
          name: name
          iso_currency_code: iso_currency_code
          pending_transaction_id: pending_transaction_id
          location:
            country: country
            address: address
            city: city
            store_number: store_number
            lon: 6.027456183070403
            region: region
            postal_code: postal_code
            lat: 0.8008281904610115
          category:
          - category
          - category
          authorized_date: authorized_date
        request_id: request_id
      properties:
        accounts:
          description: An array containing the `accounts` associated with the Item
            for which transactions are being returned. Each transaction can be mapped
            to its corresponding account via the `account_id` field.
          items:
            $ref: '#/components/schemas/AccountBase'
          type: array
        transactions:
          description: An array containing transactions from the account. Transactions
            are returned in reverse chronological order, with the most recent at the
            beginning of the array. The maximum number of transactions returned is
            determined by the `count` parameter.
          items:
            $ref: '#/components/schemas/Transaction'
          type: array
        total_transactions:
          description: The total number of transactions available within the date
            range specified. If `total_transactions` is larger than the size of the
            `transactions` array, more transactions are available and can be fetched
            via manipulating the `offset` parameter.
          type: integer
        item:
          $ref: '#/components/schemas/Item'
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - accounts
      - item
      - request_id
      - total_transactions
      - transactions
      type: object
    TransactionsSyncRequest:
      type: object
      description: TransactionsSyncRequest defines the request schema for `/transactions/sync`
      properties:
        client_id:
          $ref: '#/components/schemas/APIClientID'
        access_token:
          $ref: '#/components/schemas/AccessToken'
        secret:
          $ref: '#/components/schemas/APISecret'
        cursor:
          type: string
          description: |-
            The cursor value represents the last update requested. Providing it will cause the response to only return changes after this update.
            If omitted, the entire history of updates will be returned, starting with the first-added transactions on the item.
            Note: The upper-bound length of this cursor is 256 characters of base64.
        count:
          type: integer
          default: 100
          description: The number of transaction updates to fetch.
          minimum: 1
          maximum: 500
          exclusiveMinimum: false
        options:
          $ref: '#/components/schemas/TransactionsSyncRequestOptions'
      required:
      - access_token
    TransactionsSyncRequestOptions:
      type: object
      description: An optional object to be used with the request. If specified, `options` must not be `null`.
      properties:
        include_original_description:
          type: boolean
          default: false
          description: Include the raw unparsed transaction description from the financial institution. This field is disabled by default. If you need this information in addition to the parsed data provided, contact your Plaid Account Manager.
          nullable: true
        include_personal_finance_category:
          type: boolean
          default: false
          description: |-
            Include the [`personal_finance_category`](https://plaid.com/docs/api/products/transactions/#transactions-sync-response-added-personal-finance-category) object in the response.

            See the [`taxonomy csv file`](https://plaid.com/documents/transactions-personal-finance-category-taxonomy.csv) for a full list of personal finance categories.

            We’re introducing Category Rules - a new beta endpoint that will enable you to change the `personal_finance_category` for a transaction based on your users’ needs. When rules are set, the selected category will override the Plaid provided category. To learn more, send a note to transactions-feedback@plaid.com.
    TransactionsSyncResponse:
      type: object
      additionalProperties: true
      description: TransactionsSyncResponse defines the response schema for `/transactions/sync`
      properties:
        added:
          type: array
          description: Transactions that have been added to the item since `cursor` ordered by ascending last modified time.
          items:
            $ref: '#/components/schemas/Transaction'
        modified:
          type: array
          description: Transactions that have been modified on the item since `cursor` ordered by ascending last modified time.
          items:
            $ref: '#/components/schemas/Transaction'
        removed:
          type: array
          description: Transactions that have been removed from the item since `cursor` ordered by ascending last modified time.
          items:
            $ref: '#/components/schemas/RemovedTransaction'
        next_cursor:
          type: string
          description: Cursor used for fetching any future updates after the latest update provided in this response.
        has_more:
          type: boolean
          description: Represents if more than requested count of transaction updates exist. If true, the additional updates can be fetched by making an additional request with `cursor` set to `next_cursor`.
        request_id:
          $ref: '#/components/schemas/RequestID'
      required:
      - added
      - modified
      - removed
      - next_cursor
      - has_more
      - request_id
    TransactionsRefreshRequest:
      description: TransactionsRefreshRequest defines the request schema for `/transactions/refresh`
      example:
        access_token: access_token
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        access_token:
          description: The access token associated with the Item data is being requested
            for.
          title: AccessToken
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
      required:
      - access_token
      type: object
    TransactionsRefreshResponse:
      description: TransactionsRefreshResponse defines the response schema for `/transactions/refresh`
      example:
        request_id: request_id
      properties:
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - request_id
      type: object
    InstitutionsGetRequest:
      description: InstitutionsGetRequest defines the request schema for `/institutions/get`
      example:
        offset: 6
        count: 40
        options:
          include_optional_metadata: true
          routing_numbers:
          - routing_numbers
          - routing_numbers
          oauth: true
          products:
          - null
          - null
        country_codes:
        - null
        - null
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        count:
          description: The total number of Institutions to return.
          maximum: 500
          type: integer
        offset:
          description: The number of Institutions to skip.
          type: integer
        country_codes:
          description: |
            Specify an array of Plaid-supported country codes this institution supports, using the ISO-3166-1 alpha-2 country code standard.
          items:
            $ref: '#/components/schemas/CountryCode'
          minItems: 1
          type: array
        options:
          $ref: '#/components/schemas/InstitutionsGetRequestOptions'
      required:
      - count
      - country_codes
      - offset
      type: object
    InstitutionsGetRequestOptions:
      description: An optional object to filter `/institutions/get` results.
      example:
        include_optional_metadata: true
        routing_numbers:
        - routing_numbers
        - routing_numbers
        oauth: true
        products:
        - null
        - null
      properties:
        products:
          description: 'Filter the Institutions based on which products they support. '
          items:
            $ref: '#/components/schemas/Products'
          type: array
        routing_numbers:
          description: Specify an array of routing numbers to filter institutions.
          items:
            type: string
          type: array
        oauth:
          description: Limit results to institutions with or without OAuth login flows.
            This is primarily relevant to institutions with European country codes.
          type: boolean
        include_optional_metadata:
          description: |-
            When `true`, return the institution's homepage URL, logo and primary brand color.

            Note that Plaid does not own any of the logos shared by the API, and that by accessing or using these logos, you agree that you are doing so at your own risk and will, if necessary, obtain all required permissions from the appropriate rights holders and adhere to any applicable usage guidelines. Plaid disclaims all express or implied warranties with respect to the logos.
          type: boolean
      type: object
    InstitutionsGetResponse:
      additionalProperties: true
      description: InstitutionsGetResponse defines the response schema for `/institutions/get`
      example:
        institutions:
        - routing_numbers:
          - routing_numbers
          - routing_numbers
          name: name
          country_codes:
          - null
          - null
          logo: logo
          primary_color: primary_color
          oauth: true
          url: url
          institution_id: institution_id
          products:
          - null
          - null
          status:
            investments_updates:
              last_status_change: last_status_change
              breakdown:
                error_plaid: 6.027456183070403
                refresh_interval: NORMAL
                success: 0.8008281904610115
                error_institution: 1.4658129805029452
              status: HEALTHY
            balance:
              last_status_change: last_status_change
              breakdown:
                error_plaid: 6.027456183070403
                refresh_interval: NORMAL
                success: 0.8008281904610115
                error_institution: 1.4658129805029452
              status: HEALTHY
            auth:
              last_status_change: last_status_change
              breakdown:
                error_plaid: 6.027456183070403
                refresh_interval: NORMAL
                success: 0.8008281904610115
                error_institution: 1.4658129805029452
              status: HEALTHY
            identity:
              last_status_change: last_status_change
              breakdown:
                error_plaid: 6.027456183070403
                refresh_interval: NORMAL
                success: 0.8008281904610115
                error_institution: 1.4658129805029452
              status: HEALTHY
            item_logins:
              last_status_change: last_status_change
              breakdown:
                error_plaid: 6.027456183070403
                refresh_interval: NORMAL
                success: 0.8008281904610115
                error_institution: 1.4658129805029452
              status: HEALTHY
            health_incidents:
            - end_date: end_date
              incident_updates:
              - description: description
                updated_date: updated_date
                status: INVESTIGATING
              - description: description
                updated_date: updated_date
                status: INVESTIGATING
              title: title
              start_date: start_date
            - end_date: end_date
              incident_updates:
              - description: description
                updated_date: updated_date
                status: INVESTIGATING
              - description: description
                updated_date: updated_date
                status: INVESTIGATING
              title: title
              start_date: start_date
            transactions_updates:
              last_status_change: last_status_change
              breakdown:
                error_plaid: 6.027456183070403
                refresh_interval: NORMAL
                success: 0.8008281904610115
                error_institution: 1.4658129805029452
              status: HEALTHY
        - routing_numbers:
          - routing_numbers
          - routing_numbers
          name: name
          country_codes:
          - null
          - null
          logo: logo
          primary_color: primary_color
          oauth: true
          url: url
          institution_id: institution_id
          products:
          - null
          - null
          status:
            investments_updates:
              last_status_change: last_status_change
              breakdown:
                error_plaid: 6.027456183070403
                refresh_interval: NORMAL
                success: 0.8008281904610115
                error_institution: 1.4658129805029452
              status: HEALTHY
            balance:
              last_status_change: last_status_change
              breakdown:
                error_plaid: 6.027456183070403
                refresh_interval: NORMAL
                success: 0.8008281904610115
                error_institution: 1.4658129805029452
              status: HEALTHY
            auth:
              last_status_change: last_status_change
              breakdown:
                error_plaid: 6.027456183070403
                refresh_interval: NORMAL
                success: 0.8008281904610115
                error_institution: 1.4658129805029452
              status: HEALTHY
            identity:
              last_status_change: last_status_change
              breakdown:
                error_plaid: 6.027456183070403
                refresh_interval: NORMAL
                success: 0.8008281904610115
                error_institution: 1.4658129805029452
              status: HEALTHY
            item_logins:
              last_status_change: last_status_change
              breakdown:
                error_plaid: 6.027456183070403
                refresh_interval: NORMAL
                success: 0.8008281904610115
                error_institution: 1.4658129805029452
              status: HEALTHY
            health_incidents:
            - end_date: end_date
              incident_updates:
              - description: description
                updated_date: updated_date
                status: INVESTIGATING
              - description: description
                updated_date: updated_date
                status: INVESTIGATING
              title: title
              start_date: start_date
            - end_date: end_date
              incident_updates:
              - description: description
                updated_date: updated_date
                status: INVESTIGATING
              - description: description
                updated_date: updated_date
                status: INVESTIGATING
              title: title
              start_date: start_date
            transactions_updates:
              last_status_change: last_status_change
              breakdown:
                error_plaid: 6.027456183070403
                refresh_interval: NORMAL
                success: 0.8008281904610115
                error_institution: 1.4658129805029452
              status: HEALTHY
        total: 5
        request_id: request_id
      properties:
        institutions:
          description: A list of Plaid Institution
          items:
            $ref: '#/components/schemas/Institution'
          type: array
        total:
          description: The number of institutions returned
          type: integer
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - institutions
      - request_id
      - total
      type: object
    InstitutionsSearchRequest:
      description: InstitutionsSearchRequest defines the request schema for `/institutions/search`
      example:
        query: query
        options:
          account_filter:
            loan:
            - null
            - null
            investment:
            - null
            - null
            depository:
            - null
            - null
            credit:
            - null
            - null
          include_optional_metadata: true
          oauth: true
        country_codes:
        - null
        - null
        secret: secret
        client_id: client_id
        products:
        - null
        - null
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        query:
          description: The search query. Institutions with names matching the query
            are returned
          type: string
        products:
          description: Filter the Institutions based on whether they support all products
            listed in products. Provide `null` to get institutions regardless of supported
            products
          items:
            $ref: '#/components/schemas/Products'
          minItems: 1
          type: array
        country_codes:
          description: |
            Specify an array of Plaid-supported country codes this institution supports, using the ISO-3166-1 alpha-2 country code standard.
          items:
            $ref: '#/components/schemas/CountryCode'
          type: array
        options:
          $ref: '#/components/schemas/InstitutionsSearchRequestOptions'
      required:
      - country_codes
      - products
      - query
      type: object
    InstitutionsSearchRequestOptions:
      description: An optional object to filter `/institutions/search` results.
      example:
        account_filter:
          loan:
          - null
          - null
          investment:
          - null
          - null
          depository:
          - null
          - null
          credit:
          - null
          - null
        include_optional_metadata: true
        oauth: true
      properties:
        oauth:
          description: Limit results to institutions with or without OAuth login flows.
            This is primarily relevant to institutions with European country codes
          type: boolean
        include_optional_metadata:
          description: When true, return the institution's homepage URL, logo and
            primary brand color. Learn more
          type: boolean
        account_filter:
          $ref: '#/components/schemas/InstitutionsSearchAccountFilter'
      type: object
    InstitutionsSearchResponse:
      additionalProperties: true
      description: InstitutionsSearchResponse defines the response schema for `/institutions/search`
      example:
        institutions:
        - routing_numbers:
          - routing_numbers
          - routing_numbers
          name: name
          country_codes:
          - null
          - null
          logo: logo
          primary_color: primary_color
          oauth: true
          url: url
          institution_id: institution_id
          products:
          - null
          - null
          status:
            investments_updates:
              last_status_change: last_status_change
              breakdown:
                error_plaid: 6.027456183070403
                refresh_interval: NORMAL
                success: 0.8008281904610115
                error_institution: 1.4658129805029452
              status: HEALTHY
            balance:
              last_status_change: last_status_change
              breakdown:
                error_plaid: 6.027456183070403
                refresh_interval: NORMAL
                success: 0.8008281904610115
                error_institution: 1.4658129805029452
              status: HEALTHY
            auth:
              last_status_change: last_status_change
              breakdown:
                error_plaid: 6.027456183070403
                refresh_interval: NORMAL
                success: 0.8008281904610115
                error_institution: 1.4658129805029452
              status: HEALTHY
            identity:
              last_status_change: last_status_change
              breakdown:
                error_plaid: 6.027456183070403
                refresh_interval: NORMAL
                success: 0.8008281904610115
                error_institution: 1.4658129805029452
              status: HEALTHY
            item_logins:
              last_status_change: last_status_change
              breakdown:
                error_plaid: 6.027456183070403
                refresh_interval: NORMAL
                success: 0.8008281904610115
                error_institution: 1.4658129805029452
              status: HEALTHY
            health_incidents:
            - end_date: end_date
              incident_updates:
              - description: description
                updated_date: updated_date
                status: INVESTIGATING
              - description: description
                updated_date: updated_date
                status: INVESTIGATING
              title: title
              start_date: start_date
            - end_date: end_date
              incident_updates:
              - description: description
                updated_date: updated_date
                status: INVESTIGATING
              - description: description
                updated_date: updated_date
                status: INVESTIGATING
              title: title
              start_date: start_date
            transactions_updates:
              last_status_change: last_status_change
              breakdown:
                error_plaid: 6.027456183070403
                refresh_interval: NORMAL
                success: 0.8008281904610115
                error_institution: 1.4658129805029452
              status: HEALTHY
        - routing_numbers:
          - routing_numbers
          - routing_numbers
          name: name
          country_codes:
          - null
          - null
          logo: logo
          primary_color: primary_color
          oauth: true
          url: url
          institution_id: institution_id
          products:
          - null
          - null
          status:
            investments_updates:
              last_status_change: last_status_change
              breakdown:
                error_plaid: 6.027456183070403
                refresh_interval: NORMAL
                success: 0.8008281904610115
                error_institution: 1.4658129805029452
              status: HEALTHY
            balance:
              last_status_change: last_status_change
              breakdown:
                error_plaid: 6.027456183070403
                refresh_interval: NORMAL
                success: 0.8008281904610115
                error_institution: 1.4658129805029452
              status: HEALTHY
            auth:
              last_status_change: last_status_change
              breakdown:
                error_plaid: 6.027456183070403
                refresh_interval: NORMAL
                success: 0.8008281904610115
                error_institution: 1.4658129805029452
              status: HEALTHY
            identity:
              last_status_change: last_status_change
              breakdown:
                error_plaid: 6.027456183070403
                refresh_interval: NORMAL
                success: 0.8008281904610115
                error_institution: 1.4658129805029452
              status: HEALTHY
            item_logins:
              last_status_change: last_status_change
              breakdown:
                error_plaid: 6.027456183070403
                refresh_interval: NORMAL
                success: 0.8008281904610115
                error_institution: 1.4658129805029452
              status: HEALTHY
            health_incidents:
            - end_date: end_date
              incident_updates:
              - description: description
                updated_date: updated_date
                status: INVESTIGATING
              - description: description
                updated_date: updated_date
                status: INVESTIGATING
              title: title
              start_date: start_date
            - end_date: end_date
              incident_updates:
              - description: description
                updated_date: updated_date
                status: INVESTIGATING
              - description: description
                updated_date: updated_date
                status: INVESTIGATING
              title: title
              start_date: start_date
            transactions_updates:
              last_status_change: last_status_change
              breakdown:
                error_plaid: 6.027456183070403
                refresh_interval: NORMAL
                success: 0.8008281904610115
                error_institution: 1.4658129805029452
              status: HEALTHY
        request_id: request_id
      properties:
        institutions:
          description: An array of institutions matching the search criteria
          items:
            $ref: '#/components/schemas/Institution'
          type: array
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - institutions
      - request_id
      type: object
    InstitutionsGetByIdRequest:
      description: InstitutionsGetByIdRequest defines the request schema for `/institutions/get_by_id`
      example:
        options:
          include_optional_metadata: false
          include_status: false
        country_codes:
        - null
        - null
        secret: secret
        client_id: client_id
        institution_id: institution_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        institution_id:
          description: The ID of the institution to get details about
          type: string
        country_codes:
          description: |
            Specify an array of Plaid-supported country codes this institution supports, using the ISO-3166-1 alpha-2 country code standard.
          items:
            $ref: '#/components/schemas/CountryCode'
          type: array
        options:
          $ref: '#/components/schemas/InstitutionsGetByIdRequestOptions'
      required:
      - country_codes
      - institution_id
      type: object
    InstitutionsGetByIdRequestOptions:
      description: Specifies optional parameters for `/institutions/get_by_id`. If
        provided, must not be `null`.
      example:
        include_optional_metadata: false
        include_status: false
      properties:
        include_optional_metadata:
          default: false
          description: |-
            When `true`, return an institution's logo, brand color, and URL. When available, the bank's logo is returned as a base64 encoded 152x152 PNG, the brand color is in hexadecimal format. The default value is `false`.

            Note that Plaid does not own any of the logos shared by the API and that by accessing or using these logos, you agree that you are doing so at your own risk and will, if necessary, obtain all required permissions from the appropriate rights holders and adhere to any applicable usage guidelines. Plaid disclaims all express or implied warranties with respect to the logos.
          type: boolean
        include_status:
          default: false
          description: If `true`, the response will include status information about
            the institution. Default value is `false`.
          type: boolean
      type: object
    InstitutionsGetByIdResponse:
      additionalProperties: true
      description: InstitutionsGetByIdResponse defines the response schema for `/institutions/get_by_id`
      example:
        institution:
          routing_numbers:
          - routing_numbers
          - routing_numbers
          name: name
          country_codes:
          - null
          - null
          logo: logo
          primary_color: primary_color
          oauth: true
          url: url
          institution_id: institution_id
          products:
          - null
          - null
          status:
            investments_updates:
              last_status_change: last_status_change
              breakdown:
                error_plaid: 6.027456183070403
                refresh_interval: NORMAL
                success: 0.8008281904610115
                error_institution: 1.4658129805029452
              status: HEALTHY
            balance:
              last_status_change: last_status_change
              breakdown:
                error_plaid: 6.027456183070403
                refresh_interval: NORMAL
                success: 0.8008281904610115
                error_institution: 1.4658129805029452
              status: HEALTHY
            auth:
              last_status_change: last_status_change
              breakdown:
                error_plaid: 6.027456183070403
                refresh_interval: NORMAL
                success: 0.8008281904610115
                error_institution: 1.4658129805029452
              status: HEALTHY
            identity:
              last_status_change: last_status_change
              breakdown:
                error_plaid: 6.027456183070403
                refresh_interval: NORMAL
                success: 0.8008281904610115
                error_institution: 1.4658129805029452
              status: HEALTHY
            item_logins:
              last_status_change: last_status_change
              breakdown:
                error_plaid: 6.027456183070403
                refresh_interval: NORMAL
                success: 0.8008281904610115
                error_institution: 1.4658129805029452
              status: HEALTHY
            health_incidents:
            - end_date: end_date
              incident_updates:
              - description: description
                updated_date: updated_date
                status: INVESTIGATING
              - description: description
                updated_date: updated_date
                status: INVESTIGATING
              title: title
              start_date: start_date
            - end_date: end_date
              incident_updates:
              - description: description
                updated_date: updated_date
                status: INVESTIGATING
              - description: description
                updated_date: updated_date
                status: INVESTIGATING
              title: title
              start_date: start_date
            transactions_updates:
              last_status_change: last_status_change
              breakdown:
                error_plaid: 6.027456183070403
                refresh_interval: NORMAL
                success: 0.8008281904610115
                error_institution: 1.4658129805029452
              status: HEALTHY
        request_id: request_id
      properties:
        institution:
          $ref: '#/components/schemas/Institution'
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - institution
      - request_id
      type: object
    ItemRemoveRequest:
      description: ItemRemoveRequest defines the request schema for `/item/remove`
      example:
        access_token: access_token
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        access_token:
          description: The access token associated with the Item data is being requested
            for.
          title: AccessToken
          type: string
      required:
      - access_token
      type: object
    ItemRemoveResponse:
      additionalProperties: true
      description: ItemRemoveResponse defines the response schema for `/item/remove`
      example:
        request_id: request_id
      properties:
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - request_id
      type: object
    AccountsGetRequest:
      description: AccountsGetRequest defines the request schema for `/accounts/get`
      example:
        access_token: access_token
        options:
          account_ids:
          - account_ids
          - account_ids
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        access_token:
          description: The access token associated with the Item data is being requested
            for.
          title: AccessToken
          type: string
        options:
          $ref: '#/components/schemas/AccountsGetRequestOptions'
      required:
      - access_token
      type: object
      x-examples:
        example-1: {}
    AccountsGetRequestOptions:
      description: An optional object to filter `/accounts/get` results.
      example:
        account_ids:
        - account_ids
        - account_ids
      properties:
        account_ids:
          description: An array of `account_ids` to retrieve for the Account.
          items:
            type: string
          type: array
      type: object
    AccountsGetResponse:
      additionalProperties: true
      description: AccountsGetResponse defines the response schema for `/accounts/get`
        and `/accounts/balance/get`.
      example:
        item:
          update_type: background
          webhook: webhook
          item_id: item_id
          billed_products:
          - null
          - null
          consent_expiration_time: consent_expiration_time
          error:
            error_message: error_message
            suggested_action: suggested_action
            error_type: INVALID_REQUEST
            causes:
            - ""
            - ""
            display_message: display_message
            error_code: error_code
            documentation_url: documentation_url
            request_id: request_id
            status: 0.8008281904610115
          available_products:
          - null
          - null
          institution_id: institution_id
        accounts:
        - official_name: official_name
          balances:
            unofficial_currency_code: unofficial_currency_code
            current: 6.027456183070403
            available: 0.8008281904610115
            limit: 1.4658129805029452
            iso_currency_code: iso_currency_code
          account_id: account_id
          name: name
          verification_status: pending_automatic_verification
          mask: mask
        - official_name: official_name
          balances:
            unofficial_currency_code: unofficial_currency_code
            current: 6.027456183070403
            available: 0.8008281904610115
            limit: 1.4658129805029452
            iso_currency_code: iso_currency_code
          account_id: account_id
          name: name
          verification_status: pending_automatic_verification
          mask: mask
        request_id: request_id
      properties:
        accounts:
          description: |-
            An array of financial institution accounts associated with the Item.
            If `/accounts/balance/get` was called, each account will include real-time balance information.
          items:
            $ref: '#/components/schemas/AccountBase'
          type: array
        item:
          $ref: '#/components/schemas/Item'
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - accounts
      - item
      - request_id
      type: object
    CategoriesGetRequest:
      description: CategoriesGetRequest defines the request schema for `/categories/get`
      type: object
    CategoriesGetResponse:
      additionalProperties: true
      description: CategoriesGetResponse defines the response schema for `/categories/get`
      example:
        categories:
        - category_id: category_id
          hierarchy:
          - hierarchy
          - hierarchy
          group: group
        - category_id: category_id
          hierarchy:
          - hierarchy
          - hierarchy
          group: group
        request_id: request_id
      properties:
        categories:
          description: An array of all of the transaction categories used by Plaid.
          items:
            $ref: '#/components/schemas/Category'
          type: array
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - categories
      - request_id
      type: object
    SandboxOverridePassword:
      default: pass_good
      description: Test password to use for the creation of the Sandbox Item. Default
        value is `pass_good`.
      nullable: true
      type: string
    SandboxOverrideUsername:
      default: user_good
      description: Test username to use for the creation of the Sandbox Item. Default
        value is `user_good`.
      nullable: true
      type: string
    SandboxProcessorTokenCreateRequest:
      example:
        options:
          override_password: pass_good
          override_username: user_good
        secret: secret
        client_id: client_id
        institution_id: institution_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        institution_id:
          description: The ID of the institution the Item will be associated with
          type: string
        options:
          $ref: '#/components/schemas/SandboxProcessorTokenCreateRequestOptions'
      required:
      - institution_id
      type: object
    SandboxProcessorTokenCreateRequestOptions:
      description: An optional set of options to be used when configuring the Item.
        If specified, must not be `null`.
      example:
        override_password: pass_good
        override_username: user_good
      properties:
        override_username:
          default: user_good
          description: Test username to use for the creation of the Sandbox Item.
            Default value is `user_good`.
          nullable: true
          type: string
        override_password:
          default: pass_good
          description: Test password to use for the creation of the Sandbox Item.
            Default value is `pass_good`.
          nullable: true
          type: string
      type: object
    SandboxProcessorTokenCreateResponse:
      additionalProperties: true
      example:
        processor_token: processor_token
        request_id: request_id
      properties:
        processor_token:
          description: A processor token that can be used to call the `/processor/`
            endpoints.
          type: string
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - processor_token
      - request_id
      type: object
    SandboxPublicTokenCreateRequest:
      description: SandboxPublicTokenCreateRequest defines the request schema for
        `/sandbox/public_token/create`
      example:
        options:
          override_password: pass_good
          webhook: webhook
          override_username: user_good
          transactions:
            end_date: end_date
            start_date: start_date
        secret: secret
        initial_products:
        - null
        - null
        client_id: client_id
        institution_id: institution_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        institution_id:
          description: The ID of the institution the Item will be associated with
          type: string
        initial_products:
          description: The products to initially pull for the Item. May be any products
            that the specified `institution_id`  supports. This array may not be empty.
          items:
            $ref: '#/components/schemas/Products'
          minItems: 1
          type: array
        options:
          $ref: '#/components/schemas/SandboxPublicTokenCreateRequestOptions'
      required:
      - initial_products
      - institution_id
      type: object
    SandboxPublicTokenCreateRequestOptions:
      description: An optional set of options to be used when configuring the Item.
        If specified, must not be `null`.
      example:
        override_password: pass_good
        webhook: webhook
        override_username: user_good
        transactions:
          end_date: end_date
          start_date: start_date
      properties:
        webhook:
          description: Specify a webhook to associate with the new Item.
          type: string
        override_username:
          default: user_good
          description: Test username to use for the creation of the Sandbox Item.
            Default value is `user_good`.
          nullable: true
          type: string
        override_password:
          default: pass_good
          description: Test password to use for the creation of the Sandbox Item.
            Default value is `pass_good`.
          nullable: true
          type: string
        transactions:
          $ref: '#/components/schemas/SandboxPublicTokenCreateRequestOptionsTransactions'
      type: object
    SandboxPublicTokenCreateRequestOptionsTransactions:
      description: SandboxPublicTokenCreateRequestOptionsTransactions is an optional
        set of corresponding to transactions options.
      example:
        end_date: end_date
        start_date: start_date
      properties:
        start_date:
          description: The earliest date for which to fetch transaction history. Dates
            should be formatted as YYYY-MM-DD.
          type: string
        end_date:
          description: The most recent date for which to fetch transaction history.
            Dates should be formatted as YYYY-MM-DD.
          type: string
      type: object
    SandboxPublicTokenCreateResponse:
      additionalProperties: true
      description: SandboxPublicTokenCreateResponse defines the response schema for
        `/sandbox/public_token/create`
      example:
        public_token: public_token
        request_id: request_id
      properties:
        public_token:
          description: A public token that can be exchanged for an access token using
            `/item/public_token/exchange`
          type: string
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - public_token
      - request_id
      type: object
    SandboxItemFireWebhookRequest:
      description: SandboxItemFireWebhookRequest defines the request schema for `/sandbox/item/fire_webhook`
      example:
        access_token: access_token
        secret: secret
        webhook_code: DEFAULT_UPDATE
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        access_token:
          description: The access token associated with the Item data is being requested
            for.
          title: AccessToken
          type: string
        webhook_code:
          description: |-
            The following values for `webhook_code` are supported:

            * `DEFAULT_UPDATE`
          enum:
          - DEFAULT_UPDATE
          type: string
      required:
      - access_token
      type: object
    SandboxItemFireWebhookResponse:
      additionalProperties: true
      description: SandboxItemFireWebhookResponse defines the response schema for
        `/sandbox/item/fire_webhook`
      example:
        webhook_fired: true
        request_id: request_id
      properties:
        webhook_fired:
          description: Value is `true`  if the test` webhook_code`  was successfully
            fired.
          type: boolean
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - request_id
      - webhook_fired
      type: object
    AccountsBalanceGetRequest:
      description: AccountsBalanceGetRequest defines the request schema for `/accounts/balance/get`
      example:
        access_token: access_token
        options:
          account_ids:
          - account_ids
          - account_ids
        secret: secret
        client_id: client_id
      properties:
        access_token:
          description: The access token associated with the Item data is being requested
            for.
          title: AccessToken
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        options:
          $ref: '#/components/schemas/AccountsBalanceGetRequestOptions'
      required:
      - access_token
      type: object
    AccountsBalanceGetRequestOptions:
      description: An optional object to filter `/accounts/balance/get` results.
      example:
        account_ids:
        - account_ids
        - account_ids
      properties:
        account_ids:
          description: |-
            A list of `account_ids` to retrieve for the Item. The default value is `null`.

            Note: An error will be returned if a provided `account_id` is not associated with the Item.
          items:
            type: string
          type: array
      type: object
    IdentityGetRequest:
      description: IdentityGetRequest defines the request schema for `/identity/get`
      example:
        access_token: access_token
        options:
          account_ids:
          - account_ids
          - account_ids
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        access_token:
          description: The access token associated with the Item data is being requested
            for.
          title: AccessToken
          type: string
        options:
          $ref: '#/components/schemas/IdentityGetRequestOptions'
      required:
      - access_token
      type: object
    IdentityGetRequestOptions:
      description: An optional object to filter `/identity/get` results.
      example:
        account_ids:
        - account_ids
        - account_ids
      properties:
        account_ids:
          description: |-
            A list of `account_ids` to retrieve for the Item.
            Note: An error will be returned if a provided `account_id` is not associated with the Item.
          items:
            type: string
          type: array
      type: object
    IdentityGetResponse:
      additionalProperties: true
      description: IdentityGetResponse defines the response schema for `/identity/get`
      example:
        item:
          update_type: background
          webhook: webhook
          item_id: item_id
          billed_products:
          - null
          - null
          consent_expiration_time: consent_expiration_time
          error:
            error_message: error_message
            suggested_action: suggested_action
            error_type: INVALID_REQUEST
            causes:
            - ""
            - ""
            display_message: display_message
            error_code: error_code
            documentation_url: documentation_url
            request_id: request_id
            status: 0.8008281904610115
          available_products:
          - null
          - null
          institution_id: institution_id
        accounts:
        - null
        - null
        request_id: request_id
      properties:
        accounts:
          description: The accounts for which Identity data has been requested
          items:
            $ref: '#/components/schemas/AccountIdentity'
          type: array
        item:
          $ref: '#/components/schemas/Item'
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - accounts
      - item
      - request_id
      type: object
    ProcessorAuthGetRequest:
      description: ProcessorAuthGetRequest defines the request schema for `/processor/auth/get`
      example:
        secret: secret
        processor_token: processor_token
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        processor_token:
          description: 'The processor token obtained from the Plaid integration partner.
            Processor tokens are in the format: `processor-<environment>-<identifier>`'
          title: ProcessorToken
          type: string
      required:
      - processor_token
      type: object
    ProcessorAuthGetResponse:
      additionalProperties: true
      description: ProcessorAuthGetResponse defines the response schema for `/processor/auth/get`
      example:
        numbers: {}
        request_id: request_id
        account:
          official_name: official_name
          balances:
            unofficial_currency_code: unofficial_currency_code
            current: 6.027456183070403
            available: 0.8008281904610115
            limit: 1.4658129805029452
            iso_currency_code: iso_currency_code
          account_id: account_id
          name: name
          verification_status: pending_automatic_verification
          mask: mask
      properties:
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
        numbers:
          $ref: '#/components/schemas/ProcessorNumber'
        account:
          $ref: '#/components/schemas/AccountBase'
      required:
      - account
      - numbers
      - request_id
      type: object
    ProcessorNumber:
      additionalProperties: true
      description: An object containing identifying numbers used for making electronic
        transfers to and from the `account`. The identifying number type (ACH, EFT,
        IBAN, or BACS) used will depend on the country of the account. An account
        may have more than one number type. If a particular identifying number type
        is not used by the `account` for which auth data has been requested, a null
        value will be returned.
      example: {}
      properties:
        ach:
          $ref: '#/components/schemas/NullableNumbersACH'
        eft:
          $ref: '#/components/schemas/NullableNumbersEFT'
        international:
          $ref: '#/components/schemas/NullableNumbersInternational'
        bacs:
          $ref: '#/components/schemas/NullableNumbersBACS'
      type: object
    ProcessorIdentityGetRequest:
      description: ProcessorIdentityGetRequest defines the request schema for `/processor/identity/get`
      example:
        secret: secret
        processor_token: processor_token
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        processor_token:
          description: 'The processor token obtained from the Plaid integration partner.
            Processor tokens are in the format: `processor-<environment>-<identifier>`'
          title: ProcessorToken
          type: string
      required:
      - processor_token
      type: object
    ProcessorIdentityGetResponse:
      additionalProperties: true
      description: ProcessorIdentityGetResponse defines the response schema for `/processor/identity/get`
      example:
        request_id: request_id
      properties:
        account:
          $ref: '#/components/schemas/AccountIdentity'
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - account
      - request_id
      type: object
    ProcessorBalanceGetRequest:
      description: ProcessorBalanceGetRequest defines the request schema for `/processor/balance/get`
      example:
        secret: secret
        processor_token: processor_token
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        processor_token:
          description: 'The processor token obtained from the Plaid integration partner.
            Processor tokens are in the format: `processor-<environment>-<identifier>`'
          title: ProcessorToken
          type: string
      required:
      - processor_token
      type: object
    ProcessorBalanceGetResponse:
      additionalProperties: true
      description: ProcessorBalanceGetResponse defines the response schema for `/processor/balance/get`
      example:
        request_id: request_id
        account:
          official_name: official_name
          balances:
            unofficial_currency_code: unofficial_currency_code
            current: 6.027456183070403
            available: 0.8008281904610115
            limit: 1.4658129805029452
            iso_currency_code: iso_currency_code
          account_id: account_id
          name: name
          verification_status: pending_automatic_verification
          mask: mask
      properties:
        account:
          $ref: '#/components/schemas/AccountBase'
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - account
      - request_id
      type: object
    ItemWebhookUpdateRequest:
      description: ItemWebhookUpdateRequest defines the request schema for `/item/webhook/update`
      example:
        access_token: access_token
        webhook: webhook
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        access_token:
          description: The access token associated with the Item data is being requested
            for.
          title: AccessToken
          type: string
        webhook:
          description: The new webhook URL to associate with the Item.
          type: string
      required:
      - access_token
      - webhook
      type: object
    ItemWebhookUpdateResponse:
      additionalProperties: true
      description: ItemWebhookUpdateResponse defines the response schema for `/item/webhook/update`
      example:
        item:
          update_type: background
          webhook: webhook
          item_id: item_id
          billed_products:
          - null
          - null
          consent_expiration_time: consent_expiration_time
          error:
            error_message: error_message
            suggested_action: suggested_action
            error_type: INVALID_REQUEST
            causes:
            - ""
            - ""
            display_message: display_message
            error_code: error_code
            documentation_url: documentation_url
            request_id: request_id
            status: 0.8008281904610115
          available_products:
          - null
          - null
          institution_id: institution_id
        request_id: request_id
      properties:
        item:
          $ref: '#/components/schemas/Item'
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - item
      - request_id
      type: object
    ItemAccessTokenInvalidateRequest:
      description: ItemAccessTokenInvalidateRequest defines the request schema for
        `/item/access_token/invalidate`
      example:
        access_token: access_token
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        access_token:
          description: The access token associated with the Item data is being requested
            for.
          title: AccessToken
          type: string
      required:
      - access_token
      type: object
    ItemAccessTokenInvalidateResponse:
      additionalProperties: true
      description: ItemAccessTokenInvalidateResponse defines the response schema for
        `/item/access_token/invalidate`
      example:
        new_access_token: new_access_token
        request_id: request_id
      properties:
        new_access_token:
          description: The access token associated with the Item data is being requested
            for.
          title: AccessToken
          type: string
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - new_access_token
      - request_id
      type: object
    WebhookVerificationKeyGetRequest:
      description: WebhookVerificationKeyGetRequest defines the request schema for
        `/webhook_verification_key/get`
      example:
        key_id: key_id
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        key_id:
          description: The key ID ( `kid` ) from the JWT header.
          type: string
      required:
      - key_id
      type: object
    WebhookVerificationKeyGetResponse:
      additionalProperties: true
      description: WebhookVerificationKeyGetResponse defines the response schema for
        `/webhook_verification_key/get`
      example:
        request_id: request_id
        key:
          kty: kty
          crv: crv
          use: use
          kid: kid
          x: x
          y: "y"
          created_at: 0
          expired_at: 6
          alg: alg
      properties:
        key:
          $ref: '#/components/schemas/JWKPublicKey'
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - key
      - request_id
      type: object
    JWKPublicKey:
      additionalProperties: true
      description: A JSON Web Key (JWK) that can be used in conjunction with [JWT
        libraries](https://jwt.io/#libraries-io) to verify Plaid webhooks
      example:
        kty: kty
        crv: crv
        use: use
        kid: kid
        x: x
        y: "y"
        created_at: 0
        expired_at: 6
        alg: alg
      properties:
        alg:
          description: The alg member identifies the cryptographic algorithm family
            used with the key.
          type: string
        crv:
          description: The crv member identifies the cryptographic curve used with
            the key.
          type: string
        kid:
          description: The kid (Key ID) member can be used to match a specific key.
            This can be used, for instance, to choose among a set of keys within the
            JWK during key rollover.
          type: string
        kty:
          description: The kty (key type) parameter identifies the cryptographic algorithm
            family used with the key, such as RSA or EC.
          type: string
        use:
          description: The use (public key use) parameter identifies the intended
            use of the public key.
          type: string
        x:
          description: The x member contains the x coordinate for the elliptic curve
            point.
          type: string
        y:
          description: The y member contains the y coordinate for the elliptic curve
            point.
          type: string
        created_at:
          type: integer
        expired_at:
          nullable: true
          type: integer
      type: object
    LiabilitiesGetRequest:
      description: LiabilitiesGetRequest defines the request schema for `/liabilities/get`
      example:
        access_token: access_token
        options:
          account_ids:
          - account_ids
          - account_ids
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        access_token:
          description: The access token associated with the Item data is being requested
            for.
          title: AccessToken
          type: string
        options:
          $ref: '#/components/schemas/LiabilitiesGetRequestOptions'
      required:
      - access_token
      type: object
    LiabilitiesGetRequestOptions:
      description: An optional object to filter `/liabilities/get` results. If provided,
        `options` cannot be null.
      example:
        account_ids:
        - account_ids
        - account_ids
      properties:
        account_ids:
          description: |-
            A list of accounts to retrieve for the Item.

            An error will be returned if a provided `account_id` is not associated with the Item
          items:
            type: string
          type: array
      type: object
    LiabilitiesGetResponse:
      additionalProperties: true
      description: LiabilitiesGetResponse defines the response schema for `/liabilities/get`
      example:
        item:
          update_type: background
          webhook: webhook
          item_id: item_id
          billed_products:
          - null
          - null
          consent_expiration_time: consent_expiration_time
          error:
            error_message: error_message
            suggested_action: suggested_action
            error_type: INVALID_REQUEST
            causes:
            - ""
            - ""
            display_message: display_message
            error_code: error_code
            documentation_url: documentation_url
            request_id: request_id
            status: 0.8008281904610115
          available_products:
          - null
          - null
          institution_id: institution_id
        liabilities:
          mortgage:
          - origination_principal_amount: 7.386281948385884
            account_number: account_number
            next_monthly_payment: 4.145608029883936
            loan_type_description: loan_type_description
            escrow_balance: 9.301444243932576
            has_pmi: true
            last_payment_date: last_payment_date
            past_due_amount: 1.2315135367772556
            maturity_date: maturity_date
            has_prepayment_penalty: true
            current_late_fee: 7.061401241503109
            last_payment_amount: 2.027123023002322
            property_address:
              country: country
              city: city
              street: street
              postal_code: postal_code
              region: region
            account_id: account_id
            origination_date: origination_date
            loan_term: loan_term
            interest_rate:
              percentage: 3.616076749251911
              type: type
            ytd_interest_paid: 1.0246457001441578
            ytd_principal_paid: 1.4894159098541704
            next_payment_due_date: next_payment_due_date
          - origination_principal_amount: 7.386281948385884
            account_number: account_number
            next_monthly_payment: 4.145608029883936
            loan_type_description: loan_type_description
            escrow_balance: 9.301444243932576
            has_pmi: true
            last_payment_date: last_payment_date
            past_due_amount: 1.2315135367772556
            maturity_date: maturity_date
            has_prepayment_penalty: true
            current_late_fee: 7.061401241503109
            last_payment_amount: 2.027123023002322
            property_address:
              country: country
              city: city
              street: street
              postal_code: postal_code
              region: region
            account_id: account_id
            origination_date: origination_date
            loan_term: loan_term
            interest_rate:
              percentage: 3.616076749251911
              type: type
            ytd_interest_paid: 1.0246457001441578
            ytd_principal_paid: 1.4894159098541704
            next_payment_due_date: next_payment_due_date
          student:
          - origination_principal_amount: 5.025004791520295
            account_number: account_number
            payment_reference_number: payment_reference_number
            guarantor: guarantor
            last_statement_issue_date: last_statement_issue_date
            last_statement_balance: 1.1730742509559433
            expected_payoff_date: expected_payoff_date
            pslf_status:
              payments_remaining: 6.683562403749608
              payments_made: 9.369310271410669
              estimated_eligibility_date: estimated_eligibility_date
            outstanding_interest_amount: 9.965781217890562
            ytd_interest_paid: 8.762042012749001
            ytd_principal_paid: 9.018348186070783
            loan_name: loan_name
            next_payment_due_date: next_payment_due_date
            loan_status:
              end_date: end_date
              type: cancelled
            repayment_plan:
              description: description
              type: extended graduated
            last_payment_date: last_payment_date
            is_overdue: true
            last_payment_amount: 7.457744773683766
            sequence_number: sequence_number
            account_id: account_id
            interest_rate_percentage: 6.84685269835264
            disbursement_dates:
            - disbursement_dates
            - disbursement_dates
            origination_date: origination_date
            servicer_address:
              country: country
              city: city
              street: street
              region: region
              postal_code: postal_code
            minimum_payment_amount: 4.965218492984954
          - origination_principal_amount: 5.025004791520295
            account_number: account_number
            payment_reference_number: payment_reference_number
            guarantor: guarantor
            last_statement_issue_date: last_statement_issue_date
            last_statement_balance: 1.1730742509559433
            expected_payoff_date: expected_payoff_date
            pslf_status:
              payments_remaining: 6.683562403749608
              payments_made: 9.369310271410669
              estimated_eligibility_date: estimated_eligibility_date
            outstanding_interest_amount: 9.965781217890562
            ytd_interest_paid: 8.762042012749001
            ytd_principal_paid: 9.018348186070783
            loan_name: loan_name
            next_payment_due_date: next_payment_due_date
            loan_status:
              end_date: end_date
              type: cancelled
            repayment_plan:
              description: description
              type: extended graduated
            last_payment_date: last_payment_date
            is_overdue: true
            last_payment_amount: 7.457744773683766
            sequence_number: sequence_number
            account_id: account_id
            interest_rate_percentage: 6.84685269835264
            disbursement_dates:
            - disbursement_dates
            - disbursement_dates
            origination_date: origination_date
            servicer_address:
              country: country
              city: city
              street: street
              region: region
              postal_code: postal_code
            minimum_payment_amount: 4.965218492984954
          credit:
          - account_id: account_id
            last_payment_date: last_payment_date
            is_overdue: true
            last_statement_issue_date: last_statement_issue_date
            minimum_payment_amount: 2.3021358869347655
            aprs:
            - apr_percentage: 0.8008281904610115
              apr_type: balance_transfer_apr
              interest_charge_amount: 1.4658129805029452
              balance_subject_to_apr: 6.027456183070403
            - apr_percentage: 0.8008281904610115
              apr_type: balance_transfer_apr
              interest_charge_amount: 1.4658129805029452
              balance_subject_to_apr: 6.027456183070403
            last_payment_amount: 5.962133916683182
            next_payment_due_date: next_payment_due_date
            last_statement_balance: 5.637376656633329
          - account_id: account_id
            last_payment_date: last_payment_date
            is_overdue: true
            last_statement_issue_date: last_statement_issue_date
            minimum_payment_amount: 2.3021358869347655
            aprs:
            - apr_percentage: 0.8008281904610115
              apr_type: balance_transfer_apr
              interest_charge_amount: 1.4658129805029452
              balance_subject_to_apr: 6.027456183070403
            - apr_percentage: 0.8008281904610115
              apr_type: balance_transfer_apr
              interest_charge_amount: 1.4658129805029452
              balance_subject_to_apr: 6.027456183070403
            last_payment_amount: 5.962133916683182
            next_payment_due_date: next_payment_due_date
            last_statement_balance: 5.637376656633329
        accounts:
        - official_name: official_name
          balances:
            unofficial_currency_code: unofficial_currency_code
            current: 6.027456183070403
            available: 0.8008281904610115
            limit: 1.4658129805029452
            iso_currency_code: iso_currency_code
          account_id: account_id
          name: name
          verification_status: pending_automatic_verification
          mask: mask
        - official_name: official_name
          balances:
            unofficial_currency_code: unofficial_currency_code
            current: 6.027456183070403
            available: 0.8008281904610115
            limit: 1.4658129805029452
            iso_currency_code: iso_currency_code
          account_id: account_id
          name: name
          verification_status: pending_automatic_verification
          mask: mask
        request_id: request_id
      properties:
        accounts:
          description: An array of accounts associated with the Item
          items:
            $ref: '#/components/schemas/AccountBase'
          type: array
        item:
          $ref: '#/components/schemas/Item'
        liabilities:
          $ref: '#/components/schemas/LiabilitiesObject'
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - accounts
      - item
      - liabilities
      - request_id
      type: object
    PaymentInitiationRecipientCreateRequest:
      description: PaymentInitiationRecipientCreateRequest defines the request schema
        for `/payment_initiation/recipient/create`
      example:
        address:
          country: country
          city: city
          street:
          - street
          - street
          postal_code: postal_code
        iban: iban
        name: name
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        name:
          description: The name of the recipient
          type: string
        iban:
          description: The International Bank Account Number (IBAN) for the recipient.
            If BACS data is not provided, an IBAN is required.
          type: string
        bacs:
          $ref: '#/components/schemas/NullableRecipientBACS'
        address:
          $ref: '#/components/schemas/PaymentInitiationAddress'
      required:
      - name
      type: object
    PaymentInitiationRecipientCreateResponse:
      additionalProperties: true
      description: PaymentInitiationRecipientCreateResponse defines the response schema
        for `/payment_initation/recipient/create`
      example:
        request_id: request_id
        recipient_id: recipient_id
      properties:
        recipient_id:
          description: A unique ID identifying the recipient
          type: string
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - recipient_id
      - request_id
      type: object
    PaymentInitiationRecipientGetRequest:
      description: PaymentInitiationRecipientGetRequest defines the request schema
        for `/payment_initiation/recipient/get`
      example:
        secret: secret
        client_id: client_id
        recipient_id: recipient_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        recipient_id:
          description: The ID of the recipient
          type: string
      required:
      - recipient_id
      type: object
    PaymentInitiationRecipientGetResponse:
      additionalProperties: true
      description: PaymentInitiationRecipientGetResponse defines the response schema
        for `/payment_initiation/recipient/get`
      example:
        address:
          country: country
          city: city
          street:
          - street
          - street
          postal_code: postal_code
        iban: iban
        name: name
        request_id: request_id
        recipient_id: recipient_id
      properties:
        recipient_id:
          description: The ID of the recipient.
          type: string
        name:
          description: The name of the recipient.
          type: string
        address:
          $ref: '#/components/schemas/PaymentInitiationAddress'
        iban:
          description: The International Bank Account Number (IBAN) for the recipient.
          nullable: true
          type: string
        bacs:
          $ref: '#/components/schemas/NullableRecipientBACS'
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - iban
      - name
      - recipient_id
      - request_id
      type: object
    PaymentInitiationRecipientListRequest:
      description: PaymentInitiationRecipientListRequest defines the request schema
        for `/payment_initiation/recipient/list`
      example:
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
      type: object
    PaymentInitiationRecipientListResponse:
      additionalProperties: true
      description: PaymentInitiationRecipientListResponse defines the response schema
        for `/payment_initiation/recipient/list`
      example:
        recipients:
        - bacs:
            key: '{}'
          address:
            country: country
            city: city
            street:
            - street
            - street
            postal_code: postal_code
          iban: iban
          name: name
          recipient_id: recipient_id
        - bacs:
            key: '{}'
          address:
            country: country
            city: city
            street:
            - street
            - street
            postal_code: postal_code
          iban: iban
          name: name
          recipient_id: recipient_id
        request_id: request_id
      properties:
        recipients:
          description: An array of payment recipients created for Payment Initiation
          items:
            $ref: '#/components/schemas/PaymentInitiationRecipient'
          type: array
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - recipients
      - request_id
      type: object
    PaymentInitiationPaymentCreateRequest:
      description: PaymentInitiationPaymentCreateRequest defines the request schema
        for `/payment_initiation/payment/create`
      example:
        reference: reference
        schedule:
          end_date: 2000-01-23
          interval: interval
          interval_execution_day: 6.027456183070403
          start_date: 2000-01-23
        amount:
          currency: GBP
          value: 0.8008281904610115
        secret: secret
        client_id: client_id
        recipient_id: recipient_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        recipient_id:
          description: The ID of the recipient the payment is for.
          type: string
        reference:
          description: A reference for the payment. This must be an alphanumeric string
            with at most 18 characters and must not contain any special characters
            (since not all institutions support them).
          type: string
        amount:
          $ref: '#/components/schemas/Amount'
        schedule:
          $ref: '#/components/schemas/ExternalPaymentSchedule'
      required:
      - amount
      - recipient_id
      - reference
      type: object
    PaymentInitiationPaymentCreateResponse:
      additionalProperties: true
      description: PaymentInitiationPaymentCreateResponse defines the response schema
        for `/payment_initiation/payment/create`
      example:
        payment_id: payment_id
        request_id: request_id
        status: status
      properties:
        payment_id:
          description: A unique ID identifying the payment
          type: string
        status:
          description: |-
            For a payment returned by this endpoint, there is only one possible value:

            `PAYMENT_STATUS_INPUT_NEEDED`: The initial phase of the payment
          type: string
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - payment_id
      - request_id
      - status
      type: object
    SandboxItemResetLoginRequest:
      description: SandboxItemResetLoginRequest defines the request schema for `/sandbox/item/reset_login`
      example:
        access_token: access_token
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        access_token:
          description: The access token associated with the Item data is being requested
            for.
          title: AccessToken
          type: string
      required:
      - access_token
      type: object
    SandboxItemResetLoginResponse:
      additionalProperties: true
      description: SandboxItemResetLoginResponse defines the response schema for `/sandbox/item/reset_login`
      example:
        reset_login: true
        request_id: request_id
      properties:
        reset_login:
          description: '`true` if the call succeeded'
          type: boolean
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - request_id
      - reset_login
      type: object
    SandboxItemSetVerificationStatusRequest:
      description: SandboxItemSetVerificationStatusRequest defines the request schema
        for `/sandbox/item/set_verification_status`
      example:
        access_token: access_token
        account_id: account_id
        secret: secret
        verification_status: automatically_verified
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        access_token:
          description: The access token associated with the Item data is being requested
            for.
          title: AccessToken
          type: string
        account_id:
          description: The `account_id` of the account whose verification status is
            to be modified
          type: string
        verification_status:
          description: The verification status to set the account to.
          enum:
          - automatically_verified
          - verification_expired
          type: string
      required:
      - access_token
      - account_id
      - verification_status
      type: object
    SandboxItemSetVerificationStatusResponse:
      additionalProperties: true
      description: SandboxItemSetVerificationStatusResponse defines the response schema
        for `/sandbox/item/set_verification_status`
      example:
        request_id: request_id
      properties:
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - request_id
      type: object
    ItemPublicTokenExchangeRequest:
      description: ItemPublicTokenExchangeRequest defines the request schema for `/item/public_token/exchange`
      example:
        public_token: public_token
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        public_token:
          description: Your `public_token`, obtained from the Link `onSuccess` callback
            or `/sandbox/item/public_token/create`.
          type: string
      required:
      - public_token
      type: object
    ItemPublicTokenExchangeResponse:
      additionalProperties: true
      description: ItemPublicTokenExchangeResponse defines the response schema for
        `/item/public_token/exchange`
      example:
        access_token: access_token
        item_id: item_id
        request_id: request_id
      properties:
        access_token:
          description: The access token associated with the Item data is being requested
            for.
          title: AccessToken
          type: string
        item_id:
          description: The `item_id` value of the Item associated with the returned
            `access_token`
          type: string
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - access_token
      - item_id
      - request_id
      type: object
    ItemPublicTokenCreateRequest:
      description: ItemPublicTokenCreateRequest defines the request schema for `/item/public_token/create`
      example:
        access_token: access_token
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        access_token:
          description: The access token associated with the Item data is being requested
            for.
          title: AccessToken
          type: string
      required:
      - access_token
      type: object
    ItemPublicTokenCreateResponse:
      additionalProperties: true
      description: ItemPublicTokenCreateResponse defines the response schema for `/item/public_token/create`
      example:
        public_token: public_token
        expiration: 2000-01-23T04:56:07.000+00:00
        request_id: request_id
      properties:
        public_token:
          description: A `public_token` for the particular Item corresponding to the
            specified `access_token`
          type: string
        expiration:
          format: date-time
          type: string
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - public_token
      - request_id
      type: object
    PaymentInitiationPaymentGetRequest:
      description: PaymentInitiationPaymentGetRequest defines the request schema for
        `/payment_initiation/payment/get`
      example:
        payment_id: payment_id
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        payment_id:
          description: The `payment_id` returned from `/payment_initiation/payment/create`.
          type: string
      required:
      - payment_id
      type: object
    PaymentInitiationPaymentGetResponse:
      additionalProperties: true
      description: PaymentInitiationPaymentGetResponse defines the response schema
        for `/payment_initation/payment/get`
      example:
        reference: reference
        schedule:
          adjusted_start_date: 2000-01-23
        amount:
          currency: currency
          value: 0.8008281904610115
        payment_id: payment_id
        last_status_update: last_status_update
        request_id: request_id
        adjusted_reference: adjusted_reference
        status: PAYMENT_STATUS_INPUT_NEEDED
        recipient_id: recipient_id
      properties:
        payment_id:
          description: The ID of the payment. Like all Plaid identifiers, the `payment_id`
            is case sensitive.
          type: string
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
        amount:
          $ref: '#/components/schemas/PaymentAmount'
        status:
          description: |-
            The status of the payment.

            `PAYMENT_STATUS_INPUT_NEEDED`: This is the initial state of all payments. It indicates that the payment is waiting on user input to continue processing. A payment may re-enter this state later on if further input is needed.

            `PAYMENT_STATUS_PROCESSING`: The payment is currently being processed. The payment will automatically exit this state when processing is complete.

            `PAYMENT_STATUS_INITIATED`: The payment has been successfully initiated and is considered complete.

            `PAYMENT_STATUS_COMPLETED`: Indicates that the standing order has been successfully established. This state is only used for standing orders.

            `PAYMENT_STATUS_INSUFFICIENT_FUNDS`: The payment has failed due to insufficient funds.

            `PAYMENT_STATUS_FAILED`: The payment has failed to be initiated. This error is retryable once the root cause is resolved.

            `PAYMENT_STATUS_BLOCKED`: The payment has been blocked. This is a retryable error.

            `PAYMENT_STATUS_UNKNOWN`: The payment status is unknown.
          enum:
          - PAYMENT_STATUS_INPUT_NEEDED
          - PAYMENT_STATUS_PROCESSING
          - PAYMENT_STATUS_INITIATED
          - PAYMENT_STATUS_COMPLETED
          - PAYMENT_STATUS_INSUFFICIENT_FUNDS
          - PAYMENT_STATUS_FAILED
          - PAYMENT_STATUS_BLOCKED
          - PAYMENT_STATUS_UNKNOWN
          type: string
        recipient_id:
          description: The ID of the recipient
          type: string
        reference:
          description: A reference for the payment.
          type: string
        adjusted_reference:
          description: The value of the reference sent to the bank after adjustment
            to pass bank validation rules.
          nullable: true
          type: string
        last_status_update:
          description: The date and time of the last time the `status` was updated,
            in IS0 8601 format
          type: string
        schedule:
          $ref: '#/components/schemas/ExternalPaymentScheduleGet'
      required:
      - amount
      - last_status_update
      - payment_id
      - recipient_id
      - reference
      - status
      type: object
    PaymentInitiationPaymentTokenCreateRequest:
      description: PaymentInitiationPaymentTokenCreateRequest defines the request
        schema for `/payment_initiation/payment/token/create`
      example:
        payment_id: payment_id
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        payment_id:
          description: The `payment_id` returned from `/payment_initiation/payment/create`.
          type: string
      required:
      - payment_id
      type: object
    PaymentInitiationPaymentTokenCreateResponse:
      additionalProperties: true
      description: PaymentInitiationPaymentTokenCreateResponse defines the response
        schema for `/payment_initiation/payment/token/create`
      example:
        payment_token_expiration_time: payment_token_expiration_time
        payment_token: payment_token
        request_id: request_id
      properties:
        payment_token:
          description: A `payment_token` that can be provided to Link initialization
            to enter the payment initiation flow
          type: string
        payment_token_expiration_time:
          description: The date and time at which the token will expire, in ISO 8601
            format. A `payment_token` expires after 15 minutes.
          type: string
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - payment_token
      - payment_token_expiration_time
      - request_id
      type: object
    PaymentInitiationPaymentListRequest:
      description: PaymentInitiationPaymentListRequest defines the request schema
        for `/payment_initiation/payment/list`
      example:
        cursor: cursor
        count: 16
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        count:
          default: 10
          description: The maximum number of payments to return. If `count` is not
            specified, a maximum of 10 payments will be returned, beginning with the
            most recent payment before the cursor (if specified).
          maximum: 200
          type: integer
        cursor:
          description: A string in RFC 3339 format (i.e. "2019-12-06T22:35:49Z").
            Only payments created before the cursor will be returned.
          type: string
      type: object
    PaymentInitiationPaymentListResponse:
      additionalProperties: true
      description: PaymentInitiationPaymentListResponse defines the response schema
        for `/payment_initiation/payment/list`
      example:
        next_cursor: next_cursor
        payments:
        - reference: reference
          schedule:
            adjusted_start_date: 2000-01-23
          amount:
            currency: currency
            value: 0.8008281904610115
          payment_id: payment_id
          last_status_update: last_status_update
          request_id: request_id
          adjusted_reference: adjusted_reference
          status: PAYMENT_STATUS_INPUT_NEEDED
          recipient_id: recipient_id
        - reference: reference
          schedule:
            adjusted_start_date: 2000-01-23
          amount:
            currency: currency
            value: 0.8008281904610115
          payment_id: payment_id
          last_status_update: last_status_update
          request_id: request_id
          adjusted_reference: adjusted_reference
          status: PAYMENT_STATUS_INPUT_NEEDED
          recipient_id: recipient_id
        request_id: request_id
      properties:
        payments:
          description: An array of payments that have been created, associated with
            the given `client_id`.
          items:
            $ref: '#/components/schemas/PaymentInitiationPaymentGetResponse'
          type: array
        next_cursor:
          description: The value that, when used as the optional `cursor` parameter
            to `/payment_initiation/payment/list`, will return the next unreturned
            payment as its first payment.
          type: string
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - next_cursor
      - payments
      - request_id
      type: object
    AssetReportCreateRequest:
      description: AssetReportCreateRequest defines the request schema for `/asset_report/create`
      example:
        options:
          webhook: webhook
          client_report_id: client_report_id
          user:
            client_user_id: client_user_id
            last_name: last_name
            phone_number: phone_number
            middle_name: middle_name
            first_name: first_name
            email: email
            ssn: ssn
        secret: secret
        access_tokens:
        - null
        - null
        - null
        - null
        - null
        client_id: client_id
        days_requested: 58
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        access_tokens:
          description: An array of access tokens corresponding to the Items that will
            be included in the report. The `assets` product must have been initialized
            for the Items during link; the Assets product cannot be added after initialization.
          items:
            $ref: '#/components/schemas/AccessToken'
          maxItems: 99
          minItems: 1
          type: array
        days_requested:
          description: The maximum integer number of days of history to include in
            the Asset Report. If using Fannie Mae Day 1 Certainty, `days_requested`
            must be at least 61 for new originations or at least 31 for refinancings.
          maximum: 730
          minimum: 0
          type: integer
        options:
          $ref: '#/components/schemas/AssetReportCreateRequestOptions'
      required:
      - access_tokens
      - days_requested
      type: object
    AssetReportCreateRequestOptions:
      description: An optional object to filter `/asset_report/create` results. If
        provided, must be non-`null`. The optional `user` object is required for the
        report to be eligible for Fannie Mae's Day 1 Certainty program.
      example:
        webhook: webhook
        client_report_id: client_report_id
        user:
          client_user_id: client_user_id
          last_name: last_name
          phone_number: phone_number
          middle_name: middle_name
          first_name: first_name
          email: email
          ssn: ssn
      properties:
        client_report_id:
          description: Client-generated identifier, which can be used by lenders to
            track loan applications.
          type: string
        webhook:
          description: URL to which Plaid will send Assets webhooks, for example when
            the requested Asset Report is ready.
          type: string
        user:
          $ref: '#/components/schemas/AssetReportUser'
      type: object
    AssetReportCreateResponse:
      additionalProperties: true
      description: AssetReportCreateResponse defines the response schema for `/asset_report/create`
      example:
        asset_report_token: asset_report_token
        request_id: request_id
        asset_report_id: asset_report_id
      properties:
        asset_report_token:
          description: A token that can be provided to endpoints such as `/asset_report/get`
            or `/asset_report/pdf/get` to fetch or update an Asset Report.
          title: AssetReportToken
          type: string
        asset_report_id:
          description: A unique ID identifying an Asset Report. Like all Plaid identifiers,
            this ID is case sensitive.
          title: AssetReportId
          type: string
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - asset_report_id
      - asset_report_token
      - request_id
      type: object
    AssetReportRefreshRequest:
      description: AssetReportRefreshRequest defines the request schema for `/asset_report/refresh`
      example:
        asset_report_token: asset_report_token
        options:
          webhook: webhook
          client_report_id: client_report_id
          user:
            client_user_id: client_user_id
            last_name: last_name
            phone_number: phone_number
            middle_name: middle_name
            first_name: first_name
            email: email
            ssn: ssn
        secret: secret
        client_id: client_id
        days_requested: 58
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        asset_report_token:
          description: The `asset_report_token` returned by the original call to `/asset_report/create`
          title: AssetReportRefreshAssetReportToken
          type: string
        days_requested:
          description: The maximum number of days of history to include in the Asset
            Report. Must be an integer. If not specified, the value from the original
            call to `/asset_report/create` will be used.
          maximum: 730
          minimum: 0
          type: integer
        options:
          $ref: '#/components/schemas/AssetReportRefreshRequestOptions'
      required:
      - asset_report_token
      type: object
    AssetReportRefreshRequestOptions:
      description: An optional object to filter `/asset_report/refresh` results. If
        provided, cannot be `null`. If not specified, the `options` from the original
        call to `/asset_report/create` will be used.
      example:
        webhook: webhook
        client_report_id: client_report_id
        user:
          client_user_id: client_user_id
          last_name: last_name
          phone_number: phone_number
          middle_name: middle_name
          first_name: first_name
          email: email
          ssn: ssn
      properties:
        client_report_id:
          description: Client-generated identifier, which can be used by lenders to
            track loan applications.
          type: string
        webhook:
          description: URL to which Plaid will send Assets webhooks, for example when
            the requested Asset Report is ready.
          type: string
        user:
          $ref: '#/components/schemas/AssetReportUser'
      type: object
    AssetReportRefreshResponse:
      additionalProperties: true
      description: AssetReportRefreshResponse defines the response schema for `/asset_report/refresh`
      example:
        asset_report_token: asset_report_token
        request_id: request_id
        asset_report_id: asset_report_id
      properties:
        asset_report_id:
          description: A unique ID identifying an Asset Report. Like all Plaid identifiers,
            this ID is case sensitive.
          title: AssetReportId
          type: string
        asset_report_token:
          description: A token that can be provided to endpoints such as `/asset_report/get`
            or `/asset_report/pdf/get` to fetch or update an Asset Report.
          title: AssetReportToken
          type: string
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - asset_report_id
      - asset_report_token
      - request_id
      type: object
    AssetReportRemoveRequest:
      description: AssetReportRemoveRequest defines the request schema for `/asset_report/remove`
      example:
        asset_report_token: asset_report_token
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        asset_report_token:
          description: A token that can be provided to endpoints such as `/asset_report/get`
            or `/asset_report/pdf/get` to fetch or update an Asset Report.
          title: AssetReportToken
          type: string
      required:
      - asset_report_token
      type: object
    AssetReportRemoveResponse:
      additionalProperties: true
      description: AssetReportRemoveResponse defines the response schema for `/asset_report/remove`
      example:
        removed: true
        request_id: request_id
      properties:
        removed:
          description: '`true` if the Asset Report was successfully removed.'
          type: boolean
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - removed
      - request_id
      type: object
    AssetReportFilterRequest:
      description: AssetReportFilterRequest defines the request schema for `/asset_report/filter`
      example:
        account_ids_to_exclude:
        - account_ids_to_exclude
        - account_ids_to_exclude
        asset_report_token: asset_report_token
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        asset_report_token:
          description: A token that can be provided to endpoints such as `/asset_report/get`
            or `/asset_report/pdf/get` to fetch or update an Asset Report.
          title: AssetReportToken
          type: string
        account_ids_to_exclude:
          description: The accounts to exclude from the Asset Report, identified by
            `account_id`.
          items:
            type: string
          type: array
      required:
      - account_ids_to_exclude
      - asset_report_token
      type: object
    AssetReportFilterResponse:
      additionalProperties: true
      description: AssetReportFilterResponse defines the response schema for `/asset_report/filter`
      example:
        asset_report_token: asset_report_token
        request_id: request_id
        asset_report_id: asset_report_id
      properties:
        asset_report_token:
          description: A token that can be provided to endpoints such as `/asset_report/get`
            or `/asset_report/pdf/get` to fetch or update an Asset Report.
          title: AssetReportToken
          type: string
        asset_report_id:
          description: A unique ID identifying an Asset Report. Like all Plaid identifiers,
            this ID is case sensitive.
          title: AssetReportId
          type: string
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - asset_report_id
      - asset_report_token
      - request_id
      type: object
    AssetReportGetRequest:
      description: AssetReportGetRequest defines the request schema for `/asset_report/get`
      example:
        asset_report_token: asset_report_token
        include_insights: true
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        asset_report_token:
          description: A token that can be provided to endpoints such as `/asset_report/get`
            or `/asset_report/pdf/get` to fetch or update an Asset Report.
          title: AssetReportToken
          type: string
        include_insights:
          description: '`true` if you would like to retrieve the Asset Report with
            Insights, `false` otherwise. This field defaults to `false` if omitted.
            [Contact Plaid Support](https://dashboard.plaid.com/support) to get access
            to this feature.'
          type: boolean
      required:
      - asset_report_token
      type: object
    AssetReportGetResponse:
      additionalProperties: true
      description: AssetReportGetResponse defines the response schema for `/asset_report/get`
      example:
        warnings:
        - warning_type: warning_type
          cause:
            item_id: item_id
            error:
              error_message: error_message
              suggested_action: suggested_action
              error_type: INVALID_REQUEST
              causes:
              - ""
              - ""
              display_message: display_message
              error_code: error_code
              documentation_url: documentation_url
              request_id: request_id
              status: 0.8008281904610115
          warning_code: warning_code
        - warning_type: warning_type
          cause:
            item_id: item_id
            error:
              error_message: error_message
              suggested_action: suggested_action
              error_type: INVALID_REQUEST
              causes:
              - ""
              - ""
              display_message: display_message
              error_code: error_code
              documentation_url: documentation_url
              request_id: request_id
              status: 0.8008281904610115
          warning_code: warning_code
        report:
          date_generated: date_generated
          client_report_id: client_report_id
          user:
            client_user_id: client_user_id
            last_name: last_name
            phone_number: phone_number
            middle_name: middle_name
            first_name: first_name
            email: email
            ssn: ssn
          items:
          - item_id: item_id
            accounts:
            - null
            - null
            institution_name: institution_name
            institution_id: institution_id
            date_last_updated: date_last_updated
          - item_id: item_id
            accounts:
            - null
            - null
            institution_name: institution_name
            institution_id: institution_id
            date_last_updated: date_last_updated
          asset_report_id: asset_report_id
          days_requested: 0.8008281904610115
        request_id: request_id
      properties:
        report:
          $ref: '#/components/schemas/AssetReport'
        warnings:
          description: If the Asset Report generation was successful but identity
            information cannot be returned, this array will contain information about
            the errors causing identity information to be missing
          items:
            $ref: '#/components/schemas/Warning'
          type: array
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - report
      - request_id
      - warnings
      type: object
    AssetReportPDFGetRequest:
      description: AssetReportPDFGetRequest defines the request schema for `/asset_report/pdf/get`
      example:
        asset_report_token: asset_report_token
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        asset_report_token:
          description: A token that can be provided to endpoints such as `/asset_report/get`
            or `/asset_report/pdf/get` to fetch or update an Asset Report.
          title: AssetReportToken
          type: string
      required:
      - asset_report_token
      type: object
    AssetReportPDFGetResponse:
      format: binary
      type: string
    AssetReportAuditCopyCreateRequest:
      description: AssetReportAuditCopyCreateRequest defines the request schema for
        `/asset_report/audit_copy/get`
      example:
        asset_report_token: asset_report_token
        secret: secret
        client_id: client_id
        auditor_id: auditor_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        asset_report_token:
          description: A token that can be provided to endpoints such as `/asset_report/get`
            or `/asset_report/pdf/get` to fetch or update an Asset Report.
          title: AssetReportToken
          type: string
        auditor_id:
          description: The `auditor_id` of the third party with whom you would like
            to share the Asset Report.
          type: string
      required:
      - asset_report_token
      - auditor_id
      type: object
    AssetReportAuditCopyCreateResponse:
      additionalProperties: true
      description: AssetReportAuditCopyCreateResponse defines the response schema
        for `/asset_report/audit_copy/get`
      example:
        audit_copy_token: audit_copy_token
        request_id: request_id
      properties:
        audit_copy_token:
          description: A token that can be shared with a third party auditor to allow
            them to obtain access to the Asset Report. This token should be stored
            securely.
          type: string
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - audit_copy_token
      - request_id
      type: object
    AssetReportAuditCopyRemoveRequest:
      description: AssetReportAuditCopyRemoveRequest defines the request schema for
        `/asset_report/audit_copy/remove`
      example:
        audit_copy_token: audit_copy_token
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        audit_copy_token:
          description: The `audit_copy_token` granting access to the Audit Copy you
            would like to revoke.
          type: string
      required:
      - audit_copy_token
      type: object
    AssetReportAuditCopyRemoveResponse:
      additionalProperties: true
      description: AssetReportAuditCopyRemoveResponse defines the response schema
        for `/asset_report/audit_copy/remove`
      example:
        removed: true
        request_id: request_id
      properties:
        removed:
          description: '`true` if the Audit Copy was successfully removed.'
          type: boolean
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - removed
      - request_id
      type: object
    InvestmentsHoldingsGetRequest:
      description: InvestmentsHoldingsGetRequest defines the request schema for `/investments/holdings/get`
      example:
        access_token: access_token
        options:
          account_ids:
          - account_ids
          - account_ids
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        access_token:
          description: The access token associated with the Item data is being requested
            for.
          title: AccessToken
          type: string
        options:
          $ref: '#/components/schemas/InvestmentHoldingsGetRequestOptions'
      required:
      - access_token
      type: object
    InvestmentHoldingsGetRequestOptions:
      description: An optional object to filter `/investments/holdings/get` results.
        If provided, must not be `null`.
      example:
        account_ids:
        - account_ids
        - account_ids
      properties:
        account_ids:
          description: An array of `account_id`s to retrieve for the Item. An error
            will be returned if a provided `account_id` is not associated with the
            Item.
          items:
            type: string
          type: array
      type: object
    InvestmentsHoldingsGetResponse:
      additionalProperties: true
      description: InvestmentsHoldingsGetResponse defines the response schema for
        `/investments/holdings/get`
      example:
        item:
          update_type: background
          webhook: webhook
          item_id: item_id
          billed_products:
          - null
          - null
          consent_expiration_time: consent_expiration_time
          error:
            error_message: error_message
            suggested_action: suggested_action
            error_type: INVALID_REQUEST
            causes:
            - ""
            - ""
            display_message: display_message
            error_code: error_code
            documentation_url: documentation_url
            request_id: request_id
            status: 0.8008281904610115
          available_products:
          - null
          - null
          institution_id: institution_id
        accounts:
        - official_name: official_name
          balances:
            unofficial_currency_code: unofficial_currency_code
            current: 6.027456183070403
            available: 0.8008281904610115
            limit: 1.4658129805029452
            iso_currency_code: iso_currency_code
          account_id: account_id
          name: name
          verification_status: pending_automatic_verification
          mask: mask
        - official_name: official_name
          balances:
            unofficial_currency_code: unofficial_currency_code
            current: 6.027456183070403
            available: 0.8008281904610115
            limit: 1.4658129805029452
            iso_currency_code: iso_currency_code
          account_id: account_id
          name: name
          verification_status: pending_automatic_verification
          mask: mask
        holdings:
        - cost_basis: 1.4658129805029452
          unofficial_currency_code: unofficial_currency_code
          institution_price: 0.8008281904610115
          account_id: account_id
          quantity: 5.962133916683182
          institution_value: 6.027456183070403
          iso_currency_code: iso_currency_code
          institution_price_as_of: institution_price_as_of
          security_id: security_id
        - cost_basis: 1.4658129805029452
          unofficial_currency_code: unofficial_currency_code
          institution_price: 0.8008281904610115
          account_id: account_id
          quantity: 5.962133916683182
          institution_value: 6.027456183070403
          iso_currency_code: iso_currency_code
          institution_price_as_of: institution_price_as_of
          security_id: security_id
        request_id: request_id
        securities:
        - unofficial_currency_code: unofficial_currency_code
          cusip: cusip
          ticker_symbol: ticker_symbol
          institution_security_id: institution_security_id
          close_price_as_of: close_price_as_of
          sedol: sedol
          type: type
          institution_id: institution_id
          close_price: 5.637376656633329
          proxy_security_id: proxy_security_id
          name: name
          iso_currency_code: iso_currency_code
          is_cash_equivalent: true
          security_id: security_id
          isin: isin
        - unofficial_currency_code: unofficial_currency_code
          cusip: cusip
          ticker_symbol: ticker_symbol
          institution_security_id: institution_security_id
          close_price_as_of: close_price_as_of
          sedol: sedol
          type: type
          institution_id: institution_id
          close_price: 5.637376656633329
          proxy_security_id: proxy_security_id
          name: name
          iso_currency_code: iso_currency_code
          is_cash_equivalent: true
          security_id: security_id
          isin: isin
      properties:
        accounts:
          description: The accounts associated with the Item
          items:
            $ref: '#/components/schemas/AccountBase'
          type: array
        holdings:
          description: 'The holdings belonging to investment accounts associated with
            the Item. Details of the securities in the holdings are provided in the
            `securities` field. '
          items:
            $ref: '#/components/schemas/Holding'
          type: array
        securities:
          description: 'Objects describing the securities held in the accounts associated
            with the Item. '
          items:
            $ref: '#/components/schemas/Security'
          type: array
        item:
          $ref: '#/components/schemas/Item'
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - accounts
      - holdings
      - item
      - request_id
      - securities
      type: object
    InvestmentsTransactionsGetRequest:
      description: InvestmentsTransactionsGetRequest defines the request schema for
        `/investments/transactions/get`
      example:
        access_token: access_token
        end_date: 2000-01-23
        options:
          account_ids:
          - account_ids
          - account_ids
          offset: 0
          count: 40
        secret: secret
        client_id: client_id
        start_date: 2000-01-23
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        access_token:
          description: The access token associated with the Item data is being requested
            for.
          title: AccessToken
          type: string
        start_date:
          description: The earliest date for which to fetch transaction history. Dates
            should be formatted as YYYY-MM-DD.
          format: date
          type: string
        end_date:
          description: The most recent date for which to fetch transaction history.
            Dates should be formatted as YYYY-MM-DD.
          format: date
          type: string
        options:
          $ref: '#/components/schemas/InvestmentsTransactionsGetRequestOptions'
      required:
      - access_token
      - end_date
      - start_date
      type: object
    InvestmentsTransactionsGetRequestOptions:
      description: An optional object to filter `/investments/transactions/get` results.
        If provided, must be non-`null`.
      example:
        account_ids:
        - account_ids
        - account_ids
        offset: 0
        count: 40
      properties:
        account_ids:
          description: An array of `account_ids` to retrieve for the Item.
          items:
            type: string
          type: array
        count:
          default: 100
          description: |
            The number of transactions to fetch.
          maximum: 500
          minimum: 0
          type: integer
        offset:
          default: 0
          description: The number of transactions to skip when fetching transaction
            history
          minimum: 0
          type: integer
      type: object
    InvestmentsTransactionsGetResponse:
      additionalProperties: true
      description: InvestmentsTransactionsGetResponse defines the response schema
        for `/investments/transactions/get`
      example:
        item:
          update_type: background
          webhook: webhook
          item_id: item_id
          billed_products:
          - null
          - null
          consent_expiration_time: consent_expiration_time
          error:
            error_message: error_message
            suggested_action: suggested_action
            error_type: INVALID_REQUEST
            causes:
            - ""
            - ""
            display_message: display_message
            error_code: error_code
            documentation_url: documentation_url
            request_id: request_id
            status: 0.8008281904610115
          available_products:
          - null
          - null
          institution_id: institution_id
        accounts:
        - official_name: official_name
          balances:
            unofficial_currency_code: unofficial_currency_code
            current: 6.027456183070403
            available: 0.8008281904610115
            limit: 1.4658129805029452
            iso_currency_code: iso_currency_code
          account_id: account_id
          name: name
          verification_status: pending_automatic_verification
          mask: mask
        - official_name: official_name
          balances:
            unofficial_currency_code: unofficial_currency_code
            current: 6.027456183070403
            available: 0.8008281904610115
            limit: 1.4658129805029452
            iso_currency_code: iso_currency_code
          account_id: account_id
          name: name
          verification_status: pending_automatic_verification
          mask: mask
        investment_transactions:
        - date: date
          unofficial_currency_code: unofficial_currency_code
          amount: 6.027456183070403
          fees: 5.962133916683182
          quantity: 0.8008281904610115
          type: buy
          cancel_transaction_id: cancel_transaction_id
          account_id: account_id
          subtype: account fee
          investment_transaction_id: investment_transaction_id
          price: 1.4658129805029452
          name: name
          iso_currency_code: iso_currency_code
          security_id: security_id
        - date: date
          unofficial_currency_code: unofficial_currency_code
          amount: 6.027456183070403
          fees: 5.962133916683182
          quantity: 0.8008281904610115
          type: buy
          cancel_transaction_id: cancel_transaction_id
          account_id: account_id
          subtype: account fee
          investment_transaction_id: investment_transaction_id
          price: 1.4658129805029452
          name: name
          iso_currency_code: iso_currency_code
          security_id: security_id
        total_investment_transactions: 5
        request_id: request_id
        securities:
        - unofficial_currency_code: unofficial_currency_code
          cusip: cusip
          ticker_symbol: ticker_symbol
          institution_security_id: institution_security_id
          close_price_as_of: close_price_as_of
          sedol: sedol
          type: type
          institution_id: institution_id
          close_price: 5.637376656633329
          proxy_security_id: proxy_security_id
          name: name
          iso_currency_code: iso_currency_code
          is_cash_equivalent: true
          security_id: security_id
          isin: isin
        - unofficial_currency_code: unofficial_currency_code
          cusip: cusip
          ticker_symbol: ticker_symbol
          institution_security_id: institution_security_id
          close_price_as_of: close_price_as_of
          sedol: sedol
          type: type
          institution_id: institution_id
          close_price: 5.637376656633329
          proxy_security_id: proxy_security_id
          name: name
          iso_currency_code: iso_currency_code
          is_cash_equivalent: true
          security_id: security_id
          isin: isin
      properties:
        item:
          $ref: '#/components/schemas/Item'
        accounts:
          description: The accounts for which transaction history is being fetched.
          items:
            $ref: '#/components/schemas/AccountBase'
          type: array
        securities:
          description: All securities for which there is a corresponding transaction
            being fetched.
          items:
            $ref: '#/components/schemas/Security'
          type: array
        investment_transactions:
          description: The transactions being fetched
          items:
            $ref: '#/components/schemas/InvestmentTransaction'
          type: array
        total_investment_transactions:
          description: The total number of transactions available within the date
            range specified. If `total_investment_transactions` is larger than the
            size of the `transactions` array, more transactions are available and
            can be fetched via manipulating the `offset` parameter.'
          type: integer
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - accounts
      - investment_transactions
      - item
      - request_id
      - securities
      - total_investment_transactions
      type: object
    ProcessorTokenCreateRequest:
      description: ProcessorTokenCreateRequest defines the request schema for `/processor/token/create`
      example:
        access_token: access_token
        account_id: account_id
        secret: secret
        processor: processor
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        access_token:
          description: The access token associated with the Item data is being requested
            for.
          title: AccessToken
          type: string
        account_id:
          description: The `account_id` value obtained from the `onSuccess` callback
            in Link
          type: string
        processor:
          description: The processor you are integrating with. Valid values are `"achq"`,
            `"check"`, `"checkbook"`, `"circle"`, `"drivewealth"`, `"dwolla"`, `"galileo"`,
            "`interactive_brokers`", `"modern_treasury"`, `"ocrolus"`, `"prime_trust"`,
            `"rize"`, `"sila_money"`, `"unit"`, `"velox"`, `"vesta"`, `"vopay"`, `"wyre"`
          type: string
      required:
      - access_token
      - account_id
      - processor
      type: object
    ProcessorTokenCreateResponse:
      additionalProperties: true
      description: ProcessorTokenCreateResponse defines the response schema for `/processor/token/create`
        and `/processor/apex/processor_token/create`
      example:
        processor_token: processor_token
        request_id: request_id
      properties:
        processor_token:
          description: The `processor_token` that can then be used by the Plaid partner
            to make API requests
          type: string
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - processor_token
      - request_id
      type: object
    ProcessorStripeBankAccountTokenCreateRequest:
      description: ProcessorStripeBankAccountTokenCreateRequest defines the request
        schema for `/processor/stripe/bank_account/create`
      example:
        access_token: access_token
        account_id: account_id
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        access_token:
          description: The access token associated with the Item data is being requested
            for.
          title: AccessToken
          type: string
        account_id:
          description: The `account_id` value obtained from the `onSuccess` callback
            in Link
          type: string
      required:
      - access_token
      - account_id
      type: object
    ProcessorStripeBankAccountTokenCreateResponse:
      additionalProperties: true
      description: ProcessorStripeBankAccountTokenCreateResponse defines the response
        schema for `/processor/stripe/bank_account/create`
      example:
        stripe_bank_account_token: stripe_bank_account_token
        request_id: request_id
      properties:
        stripe_bank_account_token:
          description: A token that can be sent to Stripe for use in making API calls
            to Plaid
          type: string
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - request_id
      - stripe_bank_account_token
      type: object
    ProcessorApexProcessorTokenCreateRequest:
      description: ProcessorApexProcessorTokenCreateRequest defines the request schema
        for `/processor/apex/processor_token/create`
      example:
        access_token: access_token
        account_id: account_id
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        access_token:
          description: The access token associated with the Item data is being requested
            for.
          title: AccessToken
          type: string
        account_id:
          description: The `account_id` value obtained from the `onSuccess` callback
            in Link
          type: string
      required:
      - access_token
      - account_id
      type: object
    DepositSwitchCreateRequest:
      description: DepositSwitchCreateRequest defines the request schema for `/deposit_switch/create`
      example:
        target_access_token: target_access_token
        target_account_id: target_account_id
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        target_access_token:
          description: 'Access token for the target Item, typically provided in the
            Import Item response. '
          type: string
        target_account_id:
          description: Plaid Account ID that specifies the target bank account. This
            account will become the recipient for a user's direct deposit.
          type: string
      required:
      - target_access_token
      - target_account_id
      type: object
    DepositSwitchCreateResponse:
      additionalProperties: true
      description: DepositSwitchCreateResponse defines the response schema for `/deposit_switch/create`
      example:
        deposit_switch_id: deposit_switch_id
        request_id: request_id
      properties:
        deposit_switch_id:
          description: ID of the deposit switch. This ID is persisted throughout the
            lifetime of the deposit switch.
          type: string
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - deposit_switch_id
      - request_id
      type: object
    ItemImportRequest:
      description: ItemImportRequest defines the request schema for `/item/import`
      example:
        user_auth:
          user_id: user_id
          auth_token: auth_token
        options:
          webhook: webhook
        secret: secret
        client_id: client_id
        products:
        - null
        - null
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        products:
          description: Array of product strings
          items:
            $ref: '#/components/schemas/Products'
          minItems: 1
          type: array
        user_auth:
          $ref: '#/components/schemas/ItemImportRequestUserAuth'
        options:
          $ref: '#/components/schemas/ItemImportRequestOptions'
      required:
      - products
      - user_auth
      type: object
    ItemImportRequestOptions:
      description: An optional object to configure `/item/import` request.
      example:
        webhook: webhook
      properties:
        webhook:
          description: |
            Specifies a webhook URL to associate with an Item. Plaid fires a webhook if credentials fail.
          type: string
      type: object
    ItemImportRequestUserAuth:
      description: Object of user ID and auth token pair, permitting Plaid to aggregate
        a user’s accounts
      example:
        user_id: user_id
        auth_token: auth_token
      properties:
        user_id:
          description: Opaque user identifier
          type: string
        auth_token:
          description: Authorization token Plaid will use to aggregate this user’s
            accounts
          type: string
      required:
      - auth_token
      - user_id
      type: object
    ItemImportResponse:
      additionalProperties: true
      description: ItemImportResponse defines the response schema for `/item/import`
      example:
        access_token: access_token
        request_id: request_id
      properties:
        access_token:
          description: The access token associated with the Item data is being requested
            for.
          title: AccessToken
          type: string
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - access_token
      - request_id
      type: object
    DepositSwitchTokenCreateRequest:
      description: DepositSwitchTokenCreateRequest defines the request schema for
        `/deposit_switch/token/create`
      example:
        secret: secret
        deposit_switch_id: deposit_switch_id
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        deposit_switch_id:
          description: The ID of the deposit switch
          type: string
      required:
      - deposit_switch_id
      type: object
    DepositSwitchTokenCreateResponse:
      additionalProperties: true
      description: DepositSwitchTokenCreateResponse defines the response schema for
        `/deposit_switch/token/create`
      example:
        deposit_switch_token: deposit_switch_token
        deposit_switch_token_expiration_time: deposit_switch_token_expiration_time
        request_id: request_id
      properties:
        deposit_switch_token:
          description: Deposit switch token, used to initialize Link for the Deposit
            Switch product
          type: string
        deposit_switch_token_expiration_time:
          description: Expiration time of the token, in ISO8601 format
          type: string
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - deposit_switch_token
      - deposit_switch_token_expiration_time
      - request_id
      type: object
    LinkTokenGetRequest:
      description: LinkTokenGetRequest defines the request schema for `/link/token/get`
      example:
        link_token: link_token
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        link_token:
          description: A `link_token` from a previous invocation of `/link/token/create`
          type: string
      required:
      - link_token
      type: object
    LinkTokenCreateRequest:
      description: LinkTokenCreateRequest defines the request schema for `/link/token/create`
      example:
        webhook: webhook
        link_customization_name: link_customization_name
        language: language
        secret: secret
        deposit_switch:
          deposit_switch_id: deposit_switch_id
        client_id: client_id
        products:
        - null
        - null
        institution_id: institution_id
        access_token: access_token
        android_package_name: android_package_name
        account_filters:
          loan:
            account_subtypes:
            - null
            - null
          investment:
            account_subtypes:
            - null
            - null
          depository:
            account_subtypes:
            - null
            - null
          credit:
            account_subtypes:
            - null
            - null
        country_codes:
        - null
        - null
        redirect_uri: redirect_uri
        client_name: client_name
        user:
          phone_number_verified_time: phone_number_verified_time
          email_address: email_address
          client_user_id: client_user_id
          date_of_birth: date_of_birth
          phone_number: phone_number
          legal_name: legal_name
          email_address_verified_time: email_address_verified_time
          ssn: ssn
        payment_initiation:
          payment_id: payment_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        client_name:
          description: The name of your application, as it should be displayed in
            Link.
          type: string
        language:
          description: |-
            The language that Link should be displayed in.

            Supported languages are:
            - English (`'en'`)
            - French (`'fr'`)
            - Spanish (`'es'`)
            - Dutch (`'nl'`)

            When using a Link customization, the language configured here must match the setting in the customization, or the customization will not be applied.
          type: string
        country_codes:
          description: |-
            Specify an array of Plaid-supported country codes using the ISO-3166-1 alpha-2 country code standard. Institutions from all listed countries will be shown.  Supported country codes are: `US`, `CA`, `ES`, `FR`, `GB`, `IE`, `NL`. Example value: `['US', 'CA']`.

            If Link is launched with multiple country codes, only products that you are enabled for in all countries will be used by Link. Note that while all countries are enabled by default in Sandbox and Development, in Production only US and Canada are enabled by default. To gain access to European institutions in the Production environment, [file a product access Support ticket](https://dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access) via the Plaid dashboard. If you initialize with a European country code, your users will see the European consent panel during the Link flow.

            If using a Link customization, make sure the country codes in the customization match those specified in `country_codes`. If both `country_codes` and a Link customization are used, the value in `country_codes` may override the value in the customization.

            If using the Auth features Instant Match, Same-day Micro-deposits, or Automated Micro-deposits, `country_codes` must be set to `['US']`.
          items:
            $ref: '#/components/schemas/CountryCode'
          minItems: 1
          type: array
        user:
          $ref: '#/components/schemas/LinkTokenCreateRequestUser'
        products:
          description: |-
            List of Plaid product(s) you wish to use. If launching Link in update mode, should be omitted; required otherwise. Valid products are:

            `transactions`, `auth`, `identity`, `assets`, `investments`, `liabilities`, `payment_initiation`, `deposit_switch`

            Example: `['auth', 'transactions']`

            `balance` is *not* a valid value, the Balance product does not require explicit initalization and will automatically be initialized when any other product is initialized.

            Only institutions that support *all* requested products will be shown in Link; to maximize the number of institutions listed, it is recommended to initialize Link with the minimal product set required for your use case. Additional products can be added after Link initialization by calling the relevant endpoints. For details and exceptions, see [Choosing when to initialize products](/docs/link/best-practices/#choosing-when-to-initialize-products).

            In Production, you will be billed for each product that you specify when initializing Link. Note that a product cannot be removed from an Item once the Item has been initialized with that product. To stop billing on an Item for subscription-based products, such as Liabilities, Investments, and Transactions, remove the Item via `/item/remove`.
          items:
            $ref: '#/components/schemas/Products'
          type: array
        webhook:
          description: The destination URL to which any webhooks should be sent.
          type: string
        access_token:
          description: The `access_token` associated with the Item to update, used
            when updating or modifying an existing `access_token`. Used when launching
            Link in update mode, when completing the Same-day (manual) Micro-deposit
            flow, or (optionally) when initializing Link as part of the Payment Initiation
            (UK and Europe) flow.
          type: string
        link_customization_name:
          description: The name of the Link customization from the Plaid Dashboard
            to be applied to Link. If not specified, the `default` customization will
            be used. When using a Link customization, the language in the customization
            must match the language selected via the `language` parameter, and the
            countries in the customization should match the country codes selected
            via `country_codes`.
          type: string
        redirect_uri:
          description: A URI indicating the destination where a user should be forwarded
            after completing the Link flow; used to support OAuth authentication flows
            when launching Link in the browser or via a webview. The `redirect_uri`
            should not contain any query parameters. If `android_package_name` is
            specified, this field should be left blank. Any redirect URI specified
            here must also be added under the "Allowed redirect URIs" configuration
            on the [developer dashboard](https://dashboard.plaid.com/team/api). In
            non-Sandbox (Production and Development) environments, the `redirect_uri`
            must begin with https.
          type: string
        android_package_name:
          description: 'The name of your app''s Android package. Required if using
            the `link_token` to initialize Link on Android. When creating a `link_token`
            for initializing Link on other platforms, this field must be left blank.
            Any package name specified here must also be added to the Allowed Android
            package names setting on the [developer dashboard](https://dashboard.plaid.com/team/api). '
          type: string
        account_filters:
          $ref: '#/components/schemas/LinkTokenAccountFilters'
        institution_id:
          deprecated: true
          description: Used for certain legacy use cases
          type: string
        payment_initiation:
          $ref: '#/components/schemas/LinkTokenCreateRequestPaymentInitiation'
        deposit_switch:
          $ref: '#/components/schemas/LinkTokenCreateRequestDepositSwitch'
      required:
      - client_name
      - country_codes
      - language
      - user
      type: object
    LinkTokenAccountFilters:
      additionalProperties: true
      description: |
        By default, Link will only display account types that are compatible with all products supplied in the `products` parameter of `/link/token/create`. You can further limit the accounts shown in Link by using `account_filters` to specify the account subtypes to be shown in Link. Only the specified subtypes will be shown. This filtering applies to both the Account Select view (if enabled) and the Institution Select view. Institutions that do not support the selected subtypes will be omitted from Link. To indicate that all subtypes should be shown, use the value `"all"`. If the `account_filters` filter is used, any account type for which a filter is not specified will be entirely omitted from Link. For a full list of valid types and subtypes, see the [Account schema](/docs/api/accounts#accounts-schema).

        For institutions using OAuth, the filter will not affect the list of institutions or accounts shown by the bank in the OAuth window.
      example:
        loan:
          account_subtypes:
          - null
          - null
        investment:
          account_subtypes:
          - null
          - null
        depository:
          account_subtypes:
          - null
          - null
        credit:
          account_subtypes:
          - null
          - null
      properties:
        depository:
          $ref: '#/components/schemas/DepositoryFilter'
        credit:
          $ref: '#/components/schemas/CreditFilter'
        loan:
          $ref: '#/components/schemas/LoanFilter'
        investment:
          $ref: '#/components/schemas/InvestmentFilter'
      type: object
    LinkTokenCreateRequestPaymentInitiation:
      description: Specifies options for initializing Link for use with the Payment
        Initiation (Europe) product. This field is required if `payment_initiation`
        is included in the `products` array.
      example:
        payment_id: payment_id
      properties:
        payment_id:
          description: The `payment_id` provided by the `/payment_initiation/payment/create`
            endpoint.
          type: string
      required:
      - payment_id
      type: object
    LinkTokenCreateRequestDepositSwitch:
      description: Specifies options for initializing Link for use with the Deposit
        Switch (beta) product. This field is required if `deposit_switch` is included
        in the `products` array.
      example:
        deposit_switch_id: deposit_switch_id
      properties:
        deposit_switch_id:
          description: The `deposit_switch_id` provided by the `/deposit_switch/create`
            endpoint.
          type: string
      required:
      - deposit_switch_id
      type: object
    LinkTokenCreateRequestUser:
      description: An object specifying information about the end user who will be
        linking their account.
      example:
        phone_number_verified_time: phone_number_verified_time
        email_address: email_address
        client_user_id: client_user_id
        date_of_birth: date_of_birth
        phone_number: phone_number
        legal_name: legal_name
        email_address_verified_time: email_address_verified_time
        ssn: ssn
      properties:
        client_user_id:
          description: A unique ID representing the end user. Typically this will
            be a user ID number from your application. Personally identifiable information,
            such as an email address or phone number, should not be used in the `client_user_id`.
            It is currently used as a means of searching logs for the given user in
            the Plaid Dashboard.
          type: string
        legal_name:
          description: The user's full legal name. This is an optional field used
            in the [returning user experience](/docs/link/returning-user) to associate
            Items to the user.
          type: string
        phone_number:
          description: The user's phone number in [E.164](https://en.wikipedia.org/wiki/E.164)
            format. This field is optional, but required to enable the [returning
            user experience](/docs/link/returning-user).
          type: string
        phone_number_verified_time:
          description: |
            The date and time the phone number was verified in ISO 8601 format (`YYYY-MM-DDThh:mm:ssZ`). This field is optional, but required to enable any [returning user experience](/docs/link/returning-user).

             Only pass a verification time for a phone number that you have verified. If you have performed verification but don’t have the time, you may supply a signal value of the start of the UNIX epoch.

             Example: `2020-01-01T00:00:00Z`
          type: string
        email_address:
          description: The user's email address. This field is optional, but required
            to enable the [pre-authenticated returning user flow](/docs/link/returning-user/#enabling-the-returning-user-experience).
          type: string
        email_address_verified_time:
          description: |-
            The date and time the email address was verified in ISO 8601 format (`YYYY-MM-DDThh:mm:ssZ`). This is an optional field used in the [returning user experience](/docs/link/returning-user).

             Only pass a verification time for an email address that you have verified. If you have performed verification but don’t have the time, you may supply a signal value of the start of the UNIX epoch.

             Example: `2020-01-01T00:00:00Z`
          type: string
        ssn:
          description: To be provided in the format "ddd-dd-dddd". This field is optional
            and will support not-yet-implemented functionality for new products.
          type: string
        date_of_birth:
          description: To be provided in the format "yyyy-mm-dd". This field is optional
            and will support not-yet-implemented functionality for new products.
          type: string
      required:
      - client_user_id
      type: object
    LinkTokenCreateRequestAccountSubtypes:
      description: |
        By default, Link will only display account types that are compatible with all products supplied in the `products` parameter of `/link/token/create`. You can further limit the accounts shown in Link by using `account_filters` to specify the account subtypes to be shown in Link. Only the specified subtypes will be shown. This filtering applies to both the Account Select view (if enabled) and the Institution Select view. Institutions that do not support the selected subtypes will be omitted from Link. To indicate that all subtypes should be shown, use the value `"all"`. If the `account_filters` filter is used, any account type for which a filter is not specified will be entirely omitted from Link.

        For a full list of valid types and subtypes, see the [Account schema](/docs/api/accounts#accounts-schema).

        For institutions using OAuth, the filter will not affect the list of institutions or accounts shown by the bank in the OAuth window.
      properties:
        depository:
          additionalProperties: true
          description: A filter to apply to `depository`-type accounts
          properties:
            account_subtypes:
              $ref: '#/components/schemas/AccountSubtypes'
          type: object
        credit:
          additionalProperties: true
          description: A filter to apply to `credit`-type accounts
          properties:
            account_subtypes:
              $ref: '#/components/schemas/AccountSubtypes'
          type: object
        loan:
          additionalProperties: true
          description: A filter to apply to `loan`-type accounts
          properties:
            account_subtypes:
              $ref: '#/components/schemas/AccountSubtypes'
          type: object
        investment:
          additionalProperties: true
          description: A filter to apply to `investment`-type accounts
          properties:
            account_subtypes:
              $ref: '#/components/schemas/AccountSubtypes'
          type: object
      type: object
    LinkTokenGetResponse:
      additionalProperties: true
      description: LinkTokenGetResponse defines the response schema for `/link/token/get`
      example:
        metadata:
          webhook: webhook
          account_filters:
            loan:
              account_subtypes:
              - null
              - null
            investment:
              account_subtypes:
              - null
              - null
            depository:
              account_subtypes:
              - null
              - null
            credit:
              account_subtypes:
              - null
              - null
          country_codes:
          - null
          - null
          language: language
          redirect_uri: redirect_uri
          initial_products:
          - null
          - null
          client_name: client_name
        link_token: link_token
        created_at: 2000-01-23T04:56:07.000+00:00
        expiration: 2000-01-23T04:56:07.000+00:00
        request_id: request_id
      properties:
        link_token:
          description: A `link_token`, which can be supplied to Link in order to initialize
            it and receive a `public_token`, which can be exchanged for an `access_token`.
          type: string
        created_at:
          description: The creation timestamp for the `link_token`, in ISO 8601 format.
          format: date-time
          nullable: true
          type: string
        expiration:
          description: The expiration timestamp for the `link_token`, in ISO 8601
            format.
          format: date-time
          nullable: true
          type: string
        metadata:
          $ref: '#/components/schemas/LinkTokenGetMetadataResponse'
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - request_id
      type: object
    LinkTokenGetMetadataResponse:
      additionalProperties: true
      description: An object specifying the arguments originally provided to the `/link/token/create`
        call.
      example:
        webhook: webhook
        account_filters:
          loan:
            account_subtypes:
            - null
            - null
          investment:
            account_subtypes:
            - null
            - null
          depository:
            account_subtypes:
            - null
            - null
          credit:
            account_subtypes:
            - null
            - null
        country_codes:
        - null
        - null
        language: language
        redirect_uri: redirect_uri
        initial_products:
        - null
        - null
        client_name: client_name
      properties:
        initial_products:
          description: The `products` specified in the `/link/token/create` call.
          items:
            $ref: '#/components/schemas/Products'
          type: array
        webhook:
          description: The `webhook` specified in the `/link/token/create` call.
          nullable: true
          type: string
        country_codes:
          description: The `country_codes` specified in the `/link/token/create` call.
          items:
            $ref: '#/components/schemas/CountryCode'
          type: array
        language:
          description: The `language` specified in the `/link/token/create` call.
          nullable: true
          type: string
        account_filters:
          $ref: '#/components/schemas/AccountFiltersResponse'
        redirect_uri:
          description: The `redirect_uri` specified in the `/link/token/create` call.
          nullable: true
          type: string
        client_name:
          description: The `client_name` specified in the `/link/token/create` call.
          nullable: true
          type: string
      type: object
    LinkTokenCreateResponse:
      additionalProperties: true
      description: LinkTokenCreateResponse defines the response schema for `/link/token/create`
      example:
        link_token: link_token
        expiration: 2000-01-23T04:56:07.000+00:00
        request_id: request_id
      properties:
        link_token:
          description: A `link_token`, which can be supplied to Link in order to initialize
            it and receive a `public_token`, which can be exchanged for an `access_token`.
          type: string
        expiration:
          description: The expiration date for the `link_token`, in ISO 8601 format.
            A `link_token` created to generate a `public_token` that will be exchanged
            for a new `access_token` expires after 4 hours. 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.
          format: date-time
          type: string
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - expiration
      - link_token
      - request_id
      type: object
    Item:
      description: Metadata about the Item.
      type: object
      additionalProperties: true
      properties:
        item_id:
          description: The Plaid Item ID. The `item_id` is always unique; linking the same account at the same institution twice will result in two Items with different `item_id` values. Like all Plaid identifiers, the `item_id` is case-sensitive.
          type: string
        institution_id:
          description: The Plaid Institution ID associated with the Item. Field is `null` for Items created via Same Day Micro-deposits.
          type: string
          nullable: true
        webhook:
          description: The URL registered to receive webhooks for the Item.
          type: string
          nullable: true
        error:
          $ref: '#/components/schemas/PlaidError'
        available_products:
          description: A list of products available for the Item that have not yet been accessed. The contents of this array will be mutually exclusive with `billed_products`.
          type: array
          items:
            $ref: '#/components/schemas/Products'
        billed_products:
          description: |
            A list of products that have been billed for the Item. The contents of this array will be mutually exclusive with `available_products`. Note - `billed_products` is populated in all environments but only requests in Production are billed. Also note that products that are billed on a pay-per-call basis rather than a pay-per-Item basis, such as `balance`, will not appear here.
          type: array
          items:
            $ref: '#/components/schemas/Products'
        products:
          description: |
            A list of initialized products for the Item. In almost all cases, this will be the same as the `billed_products` field. For some products, it is possible for the product to be initialized on an Item but not yet billed (e.g. Assets, before `/asset_report/create` has been called), in which case the product may appear in `products` but not in `billed_products`.
          type: array
          items:
            $ref: '#/components/schemas/Products'
        consented_products:
          description: |
            A list of products that have gone through consent collection for the Item. Only present for those enabled in the [Data Transparency](https://plaid.com/docs/link/data-transparency-messaging-migration-guide) beta. If you are not enrolled in Data Transparency, this field is not used.
          type: array
          items:
            $ref: '#/components/schemas/Products'
        consent_expiration_time:
          description: |
            The RFC 3339 timestamp after which the consent provided by the end user will expire. Upon consent expiration, the item will enter the `ITEM_LOGIN_REQUIRED` error state. To circumvent the `ITEM_LOGIN_REQUIRED` error and maintain continuous consent, the end user can reauthenticate via Link’s update mode in advance of the consent expiration time.

            Note - This is only relevant for certain OAuth-based institutions. For all other institutions, this field will be null.
          type: string
          format: date-time
          nullable: true
        update_type:
          type: string
          description: |-
            Indicates whether an Item requires user interaction to be updated, which can be the case for Items with some forms of two-factor authentication.

            `background` - Item can be updated in the background

            `user_present_required` - Item requires user interaction to be updated
          enum:
          - background
          - user_present_required
      required:
      - item_id
      - available_products
      - billed_products
      - update_type
    Error:
      additionalProperties: true
      description: We use standard HTTP response codes for success and failure notifications,
        and our errors are further classified by `error_type`. In general, 200 HTTP
        codes correspond to success, 40X codes are for developer- or user-related
        failures, and 50X codes are for Plaid-related issues.  Error fields will be
        `null` if no error has occurred.
      example:
        error_message: error_message
        suggested_action: suggested_action
        error_type: INVALID_REQUEST
        causes:
        - ""
        - ""
        display_message: display_message
        error_code: error_code
        documentation_url: documentation_url
        request_id: request_id
        status: 0.8008281904610115
      nullable: true
      properties:
        error_type:
          description: A broad categorization of the error. Safe for programatic use.
          enum:
          - INVALID_REQUEST
          - INVALID_INPUT
          - INSTITUTION_ERROR
          - RATE_LIMIT_EXCEEDED
          - API_ERROR
          - ITEM_ERROR
          - ASSET_REPORT_ERROR
          - RECAPTCHA_ERROR
          - OAUTH_ERROR
          - PAYMENT_ERROR
          - BANK_TRANSFER_ERROR
          type: string
        error_code:
          description: The particular error code. Safe for programmatic use.
          type: string
        error_message:
          description: A developer-friendly representation of the error code. This
            may change over time and is not safe for programmatic use.
          type: string
        display_message:
          description: |-
            A user-friendly representation of the error code. `null` if the error is not related to user action.

            This may change over time and is not safe for programmatic use.
          nullable: true
          type: string
        request_id:
          description: A unique identifying the request, to be used for troubleshooting
            purposes. This field will be omitted in errors provided by webhooks.
          type: string
        causes:
          description: |-
            In the Assets product, a request can pertain to more than one Item. If an error is returned for such a request, `causes` will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified.

            `causes` will only be provided for the `error_type` `ASSET_REPORT_ERROR`.
          items: {}
          type: array
        status:
          description: The HTTP status code associated with the error. This will only
            be returned in the response body when the error information is provided
            via a webhook.
          nullable: true
          type: number
        documentation_url:
          description: The URL of a Plaid documentation page with more information
            about the error
          nullable: true
          type: string
        suggested_action:
          description: Suggested steps for resolving the error
          nullable: true
          type: string
      required:
      - error_code
      - error_message
      - error_type
      - request_id
      title: Error
      type: object
    NullableItemStatus:
      allOf:
      - $ref: '#/components/schemas/ItemStatus'
      - additionalProperties: true
        type: object
      nullable: true
    ItemStatus:
      additionalProperties: true
      description: An object with information about the status of the Item.
      nullable: true
      properties:
        investments:
          additionalProperties: true
          description: Information about the last successful and failed investments
            update for the Item.
          nullable: true
          properties:
            last_successful_update:
              description: ISO 8601 timestamp of the last successful investments update
                for the Item. The status will update each time Plaid successfully
                connects with the institution, regardless of whether any new data
                is available in the update.
              nullable: true
              type: string
            last_failed_update:
              description: ISO 8601 timestamp of the last failed investments update
                for the Item. The status will update each time Plaid fails an attempt
                to connect with the institution, regardless of whether any new data
                is available in the update.
              nullable: true
              type: string
          type: object
        transactions:
          additionalProperties: true
          description: Information about the last successful and failed transactions
            update for the Item.
          nullable: true
          properties:
            last_successful_update:
              description: ISO 8601 timestamp of the last successful transactions
                update for the Item. The status will update each time Plaid successfully
                connects with the institution, regardless of whether any new data
                is available in the update.
              nullable: true
              type: string
            last_failed_update:
              description: ISO 8601 timestamp of the last failed transactions update
                for the Item. The status will update each time Plaid fails an attempt
                to connect with the institution, regardless of whether any new data
                is available in the update.
              nullable: true
              type: string
          type: object
        last_webhook:
          additionalProperties: true
          description: Information about the last webhook fired for the Item.
          nullable: true
          properties:
            sent_at:
              description: ISO 8601 timestamp of when the webhook was fired.
              nullable: true
              type: string
            code_sent:
              description: The last webhook code sent.
              nullable: true
              type: string
          type: object
      title: ItemStatus
      type: object
      x-examples:
        example-1: {}
    AccountType:
      description: |-
        `investment:` Investment account

        `credit:` Credit card

        `depository:` Depository account

        `loan:` Loan account

        `brokerage`: An investment account. Used for `/assets/` endpoints only; other endpoints use `investment`.

        `other:` Non-specified account type

        See the [Account type schema](/docs/api/accounts#account-type-schema) for a full listing of account types and corresponding subtypes.
      enum:
      - investment
      - credit
      - depository
      - loan
      - brokerage
      - other
      title: AccountType
      type: string
    AccountBase:
      additionalProperties: true
      description: A single account at a financial institution.
      example:
        official_name: official_name
        balances:
          unofficial_currency_code: unofficial_currency_code
          current: 6.027456183070403
          available: 0.8008281904610115
          limit: 1.4658129805029452
          iso_currency_code: iso_currency_code
        account_id: account_id
        name: name
        verification_status: pending_automatic_verification
        mask: mask
      properties:
        account_id:
          description: |-
            Plaid’s unique identifier for the account. This value will not change unless Plaid can't reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new `account_id` will be assigned to the account.

            The `account_id` can also change if the `access_token` is deleted and the same credentials that were used to generate that `access_token` are used to generate a new `access_token` on a later date. In that case, the new `account_id` will be different from the old `account_id`.

            Like all Plaid identifiers, the `account_id` is case sensitive.
          type: string
        balances:
          $ref: '#/components/schemas/AccountBalance'
        mask:
          description: The last 2-4 alphanumeric characters of an account's official
            account number. Note that the mask may be non-unique between an Item's
            accounts, and it may also not match the mask that the bank displays to
            the user.
          nullable: true
          type: string
        name:
          description: The name of the account, either assigned by the user or by
            the financial institution itself
          type: string
        official_name:
          description: The official name of the account as given by the financial
            institution
          nullable: true
          type: string
        type:
          $ref: '#/components/schemas/AccountType'
        subtype:
          $ref: '#/components/schemas/AccountSubtype'
        verification_status:
          description: "The current verification status of an Auth Item initiated\
            \ through Automated or Manual micro-deposits.  Returned for Auth Items\
            \ only.\n\n`pending_automatic_verification`: The Item is pending automatic\
            \ verification\n\n`pending_manual_verification`: The Item is pending manual\
            \ micro-deposit verification. Items remain in this state until the user\
            \ successfully verifies the two amounts.\n\n`automatically_verified`:\
            \ The Item has successfully been automatically verified\t\n\n`manually_verified`:\
            \ The Item has successfully been manually verified\n\n`verification_expired`:\
            \ Plaid was unable to automatically verify the deposit within 7 calendar\
            \ days and will no longer attempt to validate the Item. Users may retry\
            \ by submitting their information again through Link.\n\n`verification_failed`:\
            \ The Item failed manual micro-deposit verification because the user exhausted\
            \ all 3 verification attempts. Users may retry by submitting their information\
            \ again through Link.\t\n\t"
          enum:
          - pending_automatic_verification
          - pending_manual_verification
          - manually_verified
          - verification_expired
          - verification_failed
          nullable: true
          type: string
      required:
      - account_id
      - balances
      - name
      - subtype
      - type
      title: Account
      type: object
      x-examples:
        example-1: {}
    AccountBalance:
      additionalProperties: true
      description: 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`.
      example:
        unofficial_currency_code: unofficial_currency_code
        current: 6.027456183070403
        available: 0.8008281904610115
        limit: 1.4658129805029452
        iso_currency_code: iso_currency_code
      properties:
        available:
          description: |-
            The amount of funds available to be withdrawn from the account, as determined by the financial institution.

            For `credit`-type accounts, the `available` balance typically equals the `limit` less the `current` balance, less any pending outflows plus any pending inflows.

            For `depository`-type accounts, the `available` balance typically equals the `current` balance less any pending outflows plus any pending inflows. For `depository`-type accounts, the `available` balance does not include the overdraft limit.

            For `investment`-type accounts, the `available` balance is the total cash available to withdraw as presented by the institution.

            Note that not all institutions calculate the `available`  balance. In the event that `available` balance is unavailable, Plaid will return an `available` balance value of `null`.

            Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by `/accounts/balance/get`.
          nullable: true
          type: number
        current:
          description: |-
            The total amount of funds in or owed by the account.

            For `credit`-type accounts, a positive balance indicates the amount owed; a negative amount indicates the lender owing the account holder.

            For `loan`-type accounts, the current balance is the principal remaining on the loan, except in the case of student loan accounts at Sallie Mae (`ins_116944`). For Sallie Mae student loans, the account's balance includes both principal and any outstanding interest.

            For `investment`-type accounts, the current balance is the total value of assets as presented by the institution.

            Note that balance information may be cached unless the value was returned by `/accounts/balance/get`, and current balance information is typically not updated intra-day. If you require realtime balance information, use the `available` balance as provided by `/accounts/balance/get`.
          type: number
        limit:
          description: |-
            For `credit`-type accounts, this represents the credit limit.

            For `depository`-type accounts, this represents the pre-arranged overdraft limit, which is common for current (checking) accounts in Europe.

            In North America, this field is typically only available for `credit`-type accounts.
          nullable: true
          type: number
        iso_currency_code:
          description: The ISO-4217 currency code of the balance. Always null if `unofficial_currency_code`
            is non-null.
          nullable: true
          type: string
        unofficial_currency_code:
          description: |-
            The unofficial currency code associated with the balance. Always null if `iso_currency_code` is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.

            See the [currency code schema](/docs/api/accounts#currency-code-schema) for a full listing of supported `unofficial_currency_code`s.
          nullable: true
          type: string
      required:
      - current
      title: AccountBalance
      type: object
    AccountSubtype:
      description: See the [Account type schema](/docs/api/accounts/#account-type-schema)
        for a full listing of account types and corresponding subtypes.
      enum:
      - 401a
      - 401k
      - 403B
      - 457b
      - "529"
      - brokerage
      - cash isa
      - education savings account
      - gic
      - health reimbursement arrangement
      - hsa
      - isa
      - ira
      - lif
      - lira
      - lrif
      - lrsp
      - non-taxable brokerage account
      - other
      - prif
      - rdsp
      - resp
      - rlif
      - rrif
      - pension
      - profit sharing plan
      - retirement
      - roth
      - roth 401k
      - rrsp
      - sep ira
      - simple ira
      - sipp
      - stock plan
      - thrift savings plan
      - tfsa
      - trust
      - ugma
      - utma
      - variable annuity
      - credit card
      - paypal
      - cd
      - checking
      - savings
      - money market
      - prepaid
      - auto
      - commercial
      - construction
      - consumer
      - home
      - home equity
      - loan
      - mortgage
      - overdraft
      - line of credit
      - student
      - cash management
      - keogh
      - mutual fund
      - recurring
      - rewards
      - safe deposit
      - sarsep
      - null
      nullable: true
      title: AccountSubtype
      type: string
    NumbersACH:
      additionalProperties: true
      description: Identifying information for transferring money to or from a US
        account via ACH or wire transfer.
      example:
        wire_routing: wire_routing
        routing: routing
        account_id: account_id
        account: account
      properties:
        account_id:
          description: The Plaid account ID associated with the account numbers
          type: string
        account:
          description: The ACH account number for the account
          type: string
        routing:
          description: The ACH routing number for the account
          type: string
        wire_routing:
          description: The wire transfer routing number for the account, if available
          nullable: true
          type: string
      required:
      - account
      - account_id
      - routing
      title: NumbersACH
      type: object
    NullableNumbersACH:
      allOf:
      - $ref: '#/components/schemas/NumbersACH'
      - additionalProperties: true
        type: object
      nullable: true
    NumbersEFT:
      additionalProperties: true
      description: Identifying information for transferring money to or from a Canadian
        bank account via EFT.
      example:
        institution: institution
        account_id: account_id
        branch: branch
        account: account
      properties:
        account_id:
          description: The Plaid account ID associated with the account numbers
          type: string
        account:
          description: The EFT account number for the account
          type: string
        institution:
          description: The EFT institution number for the account
          type: string
        branch:
          description: The EFT branch number for the account
          type: string
      required:
      - account
      - account_id
      - branch
      - institution
      title: NumbersEFT
      type: object
    NullableNumbersEFT:
      allOf:
      - $ref: '#/components/schemas/NumbersEFT'
      - additionalProperties: true
        type: object
      nullable: true
    NumbersInternationals:
      additionalProperties: true
      description: Identifying information for transferring money to or from an international
        bank account via wire transfer.
      example:
        account_id: account_id
        iban: iban
        bic: bic
      properties:
        account_id:
          description: The Plaid account ID associated with the account numbers
          type: string
        iban:
          description: The International Bank Account Number (IBAN) for the account
          type: string
        bic:
          description: The Bank Identifier Code (BIC) for the account
          type: string
      required:
      - account_id
      - bic
      - iban
      title: NumbersInternationals
      type: object
    NullableNumbersInternational:
      allOf:
      - $ref: '#/components/schemas/NumbersInternationals'
      - additionalProperties: true
        type: object
      nullable: true
    NumbersBACS:
      additionalProperties: true
      description: Identifying information for transferring money to or from a UK
        bank account via BACS.
      example:
        account_id: account_id
        sort_code: sort_code
        account: account
      properties:
        account_id:
          description: The Plaid account ID associated with the account numbers
          type: string
        account:
          description: The BACS account number for the account
          type: string
        sort_code:
          description: The BACS sort code for the account
          type: string
      required:
      - account
      - account_id
      - sort_code
      title: NumbersBACS
      type: object
    NullableNumbersBACS:
      allOf:
      - $ref: '#/components/schemas/NumbersBACS'
      - additionalProperties: true
        type: object
      nullable: true
    RecipientBACS:
      additionalProperties: true
      description: 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, BACS data is required.
      properties:
        account:
          description: The account number of the account. Maximum of 10 characters.
          type: string
        sort_code:
          description: The 6-character sort code of the account.
          type: string
      title: RecipientBACS
      type: object
    NullableRecipientBACS:
      allOf:
      - $ref: '#/components/schemas/RecipientBACS'
      - additionalProperties: true
        description: The sort code of the account.
        type: object
      nullable: true
    RequestID:
      description: A unique identifier for the request, which can be used for troubleshooting.
        This identifier, like all Plaid identifiers, is case sensitive.
      title: RequestID
      type: string
    Transaction:
      additionalProperties: true
      description: A representation of a transaction
      example:
        transaction_id: transaction_id
        date: date
        unofficial_currency_code: unofficial_currency_code
        authorized_datetime: authorized_datetime
        amount: 1.4658129805029452
        payment_meta:
          payee: payee
          ppd_id: ppd_id
          reason: reason
          by_order_of: by_order_of
          payment_processor: payment_processor
          reference_number: reference_number
          payer: payer
          payment_method: payment_method
        pending: true
        merchant_name: merchant_name
        transaction_type: digital
        account_owner: account_owner
        datetime: datetime
        account_id: account_id
        category_id: category_id
        payment_channel: online
        name: name
        iso_currency_code: iso_currency_code
        pending_transaction_id: pending_transaction_id
        location:
          country: country
          address: address
          city: city
          store_number: store_number
          lon: 6.027456183070403
          region: region
          postal_code: postal_code
          lat: 0.8008281904610115
        category:
        - category
        - category
        authorized_date: authorized_date
      properties:
        transaction_type:
          deprecated: true
          description: |
            Please use the `payment_channel` field, `transaction_type` will be deprecated in the future.

            `digital:` transactions that took place online.

            `place:` transactions that were made at a physical location.

            `special:` transactions that relate to banks, e.g. fees or deposits.

            `unresolved:` transactions that do not fit into the other three types.
          enum:
          - digital
          - place
          - special
          - unresolved
          type: string
        transaction_id:
          description: The unique ID of the transaction. Like all Plaid identifiers,
            the `transaction_id` is case sensitive.
          type: string
        account_owner:
          description: The name of the account owner. This field is not typically
            populated and only relevant when dealing with sub-accounts.
          nullable: true
          type: string
        pending_transaction_id:
          description: The ID of a posted transaction's associated pending transaction,
            where applicable.
          nullable: true
          type: string
        pending:
          description: When `true`, identifies the transaction as pending or unsettled.
            Pending transaction details (name, type, amount, category ID) may change
            before they are settled.
          type: boolean
        payment_channel:
          description: |
            The channel used to make a payment.
            `online:` transactions that took place online.

            `in store:` transactions that were made at a physical location.

            `other:` transactions that relate to banks, e.g. fees or deposits.

            This field replaces the `transaction_type` field.
          enum:
          - online
          - in store
          - other
          type: string
        payment_meta:
          $ref: '#/components/schemas/PaymentMeta'
        name:
          description: |-
            The merchant name or transaction description.

            If the `transaction` object was returned by a Transactions endpoint such as `/transactions/get`, this field will always appear. If the `transaction` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights.
          type: string
        merchant_name:
          description: The merchant name, as extracted by Plaid from the `name` field.
          nullable: true
          type: string
        location:
          $ref: '#/components/schemas/Location'
        authorized_date:
          description: The date that the transaction was authorized. Dates are returned
            in an ISO 8601 format ( `YYYY-MM-DD` ).
          nullable: true
          type: string
        authorized_datetime:
          description: |-
            Date and time when a transaction was authorized in ISO 8601 format ( `YYYY-MM-DDTHH:mm:ssZ` ).

            This field is only populated for UK institutions. For institutions in other countries, will be `null`.
          nullable: true
          type: string
        date:
          description: For pending transactions, the date that the transaction occurred;
            for posted transactions, the date that the transaction posted. Both dates
            are returned in an ISO 8601 format ( `YYYY-MM-DD` ).
          type: string
        datetime:
          description: |-
            Date and time when a transaction was posted in ISO 8601 format ( `YYYY-MM-DDTHH:mm:ssZ` ).

            This field is only populated for UK institutions. For institutions in other countries, will be `null`.
          nullable: true
          type: string
        category_id:
          description: |-
            The ID of the category to which this transaction belongs. See [Categories](https://plaid.com/docs/#category-overview).

            If the `transaction` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights.
          type: string
        category:
          description: |-
            A hierarchical array of the categories to which this transaction belongs. See [Categories](https://plaid.com/docs/#category-overview).

            If the `transaction` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights.
          items:
            type: string
          nullable: true
          type: array
        unofficial_currency_code:
          description: |-
            The unofficial currency code associated with the transaction. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.

            See the [currency code schema](/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.
          nullable: true
          type: string
        iso_currency_code:
          description: The ISO-4217 currency code of the transaction. Always `null`
            if `unofficial_currency_code` is non-null.
          nullable: true
          type: string
        amount:
          description: The settled value of the transaction, denominated in the account's
            currency, as stated in `iso_currency_code` or `unofficial_currency_code`.
            Positive values when money moves out of the account; negative values when
            money moves in. For example, debit card purchases are positive; credit
            card payments, direct deposits, and refunds are negative.
          type: number
        account_id:
          description: The ID of the account in which this transaction occurred.
          type: string
        transaction_code:
          $ref: '#/components/schemas/TransactionCode'
      required:
      - account_id
      - amount
      - date
      - pending
      - transaction_id
      title: Transaction
      type: object
      x-examples: {}
    RemovedTransaction:
      title: RemovedTransaction
      type: object
      description: A representation of a removed transaction
      x-examples: {}
      properties:
        transaction_id:
          type: string
          description: The ID of the removed transaction.
    Location:
      additionalProperties: true
      description: A representation of where a transaction took place
      example:
        country: country
        address: address
        city: city
        store_number: store_number
        lon: 6.027456183070403
        region: region
        postal_code: postal_code
        lat: 0.8008281904610115
      properties:
        address:
          description: The street address where the transaction occurred.
          nullable: true
          type: string
        city:
          description: The city where the transaction occurred.
          nullable: true
          type: string
        region:
          description: The region or state where the transaction occurred.
          nullable: true
          type: string
        postal_code:
          description: The postal code where the transaction occurred.
          nullable: true
          type: string
        country:
          description: The ISO 3166-1 alpha-2 country code where the transaction occurred.
          nullable: true
          type: string
        lat:
          description: The latitude where the transaction occurred.
          nullable: true
          type: number
        lon:
          description: The longitude where the transaction occurred.
          nullable: true
          type: number
        store_number:
          description: The merchant defined store number where the transaction occurred.
          nullable: true
          type: string
      title: Transaction Location
      type: object
    Institution:
      additionalProperties: true
      description: Details relating to a specific financial institution
      example:
        routing_numbers:
        - routing_numbers
        - routing_numbers
        name: name
        country_codes:
        - null
        - null
        logo: logo
        primary_color: primary_color
        oauth: true
        url: url
        institution_id: institution_id
        products:
        - null
        - null
        status:
          investments_updates:
            last_status_change: last_status_change
            breakdown:
              error_plaid: 6.027456183070403
              refresh_interval: NORMAL
              success: 0.8008281904610115
              error_institution: 1.4658129805029452
            status: HEALTHY
          balance:
            last_status_change: last_status_change
            breakdown:
              error_plaid: 6.027456183070403
              refresh_interval: NORMAL
              success: 0.8008281904610115
              error_institution: 1.4658129805029452
            status: HEALTHY
          auth:
            last_status_change: last_status_change
            breakdown:
              error_plaid: 6.027456183070403
              refresh_interval: NORMAL
              success: 0.8008281904610115
              error_institution: 1.4658129805029452
            status: HEALTHY
          identity:
            last_status_change: last_status_change
            breakdown:
              error_plaid: 6.027456183070403
              refresh_interval: NORMAL
              success: 0.8008281904610115
              error_institution: 1.4658129805029452
            status: HEALTHY
          item_logins:
            last_status_change: last_status_change
            breakdown:
              error_plaid: 6.027456183070403
              refresh_interval: NORMAL
              success: 0.8008281904610115
              error_institution: 1.4658129805029452
            status: HEALTHY
          health_incidents:
          - end_date: end_date
            incident_updates:
            - description: description
              updated_date: updated_date
              status: INVESTIGATING
            - description: description
              updated_date: updated_date
              status: INVESTIGATING
            title: title
            start_date: start_date
          - end_date: end_date
            incident_updates:
            - description: description
              updated_date: updated_date
              status: INVESTIGATING
            - description: description
              updated_date: updated_date
              status: INVESTIGATING
            title: title
            start_date: start_date
          transactions_updates:
            last_status_change: last_status_change
            breakdown:
              error_plaid: 6.027456183070403
              refresh_interval: NORMAL
              success: 0.8008281904610115
              error_institution: 1.4658129805029452
            status: HEALTHY
      properties:
        institution_id:
          description: Unique identifier for the institution
          type: string
        name:
          description: The official name of the institution
          type: string
        products:
          description: A list of the Plaid products supported by the institution
          items:
            $ref: '#/components/schemas/Products'
          type: array
        country_codes:
          description: A list of the country codes supported by the institution.
          items:
            $ref: '#/components/schemas/CountryCode'
          type: array
        url:
          description: The URL for the institution's website
          nullable: true
          type: string
        primary_color:
          description: Hexadecimal representation of the primary color used by the
            institution
          nullable: true
          type: string
        logo:
          description: Base64 encoded representation of the institution's logo
          nullable: true
          type: string
        routing_numbers:
          description: A partial list of routing numbers associated with the institution.
            This list is provided for the purpose of looking up institutions by routing
            number. It is not comprehensive and should never be used as a complete
            list of routing numbers for an institution.
          items:
            type: string
          nullable: true
          type: array
        oauth:
          description: Indicates that the institution has an OAuth login flow. This
            is primarily relevant to institutions with European country codes.
          type: boolean
        status:
          $ref: '#/components/schemas/InstitutionStatus'
      required:
      - country_codes
      - institution_id
      - name
      - oauth
      - products
      title: Institution
      type: object
    InstitutionStatus:
      additionalProperties: true
      description: |
        The status of an institution is determined by the health of its Item logins, Transactions updates, Investments updates, Auth requests, Balance requests, and Identity requests. A login attempt is conducted during the initial Item add in Link. If there is not enough traffic to accurately calculate an institution's status, Plaid will return null rather than potentially inaccurate data.

        Institution status is accessible in the Dashboard and via the API using the `/institutions/get_by_id` endpoint with the `include_status` option set to true. Note that institution status is not available in the Sandbox environment.
      example:
        investments_updates:
          last_status_change: last_status_change
          breakdown:
            error_plaid: 6.027456183070403
            refresh_interval: NORMAL
            success: 0.8008281904610115
            error_institution: 1.4658129805029452
          status: HEALTHY
        balance:
          last_status_change: last_status_change
          breakdown:
            error_plaid: 6.027456183070403
            refresh_interval: NORMAL
            success: 0.8008281904610115
            error_institution: 1.4658129805029452
          status: HEALTHY
        auth:
          last_status_change: last_status_change
          breakdown:
            error_plaid: 6.027456183070403
            refresh_interval: NORMAL
            success: 0.8008281904610115
            error_institution: 1.4658129805029452
          status: HEALTHY
        identity:
          last_status_change: last_status_change
          breakdown:
            error_plaid: 6.027456183070403
            refresh_interval: NORMAL
            success: 0.8008281904610115
            error_institution: 1.4658129805029452
          status: HEALTHY
        item_logins:
          last_status_change: last_status_change
          breakdown:
            error_plaid: 6.027456183070403
            refresh_interval: NORMAL
            success: 0.8008281904610115
            error_institution: 1.4658129805029452
          status: HEALTHY
        health_incidents:
        - end_date: end_date
          incident_updates:
          - description: description
            updated_date: updated_date
            status: INVESTIGATING
          - description: description
            updated_date: updated_date
            status: INVESTIGATING
          title: title
          start_date: start_date
        - end_date: end_date
          incident_updates:
          - description: description
            updated_date: updated_date
            status: INVESTIGATING
          - description: description
            updated_date: updated_date
            status: INVESTIGATING
          title: title
          start_date: start_date
        transactions_updates:
          last_status_change: last_status_change
          breakdown:
            error_plaid: 6.027456183070403
            refresh_interval: NORMAL
            success: 0.8008281904610115
            error_institution: 1.4658129805029452
          status: HEALTHY
      properties:
        item_logins:
          $ref: '#/components/schemas/ProductStatus'
        transactions_updates:
          $ref: '#/components/schemas/ProductStatus'
        auth:
          $ref: '#/components/schemas/ProductStatus'
        balance:
          $ref: '#/components/schemas/ProductStatus'
        identity:
          $ref: '#/components/schemas/ProductStatus'
        investments_updates:
          $ref: '#/components/schemas/ProductStatus'
        health_incidents:
          description: Details of recent health incidents associated with the institution.
          items:
            $ref: '#/components/schemas/HealthIncident'
          nullable: true
          type: array
      required:
      - auth
      - balance
      - identity
      - investments_updates
      - item_logins
      - transactions_updates
      title: InstitutionStatus
      type: object
      x-examples:
        example-1:
          status:
            item_logins:
              status: HEALTHY
              last_status_change: 2019-02-15T15:53:00Z
              breakdown:
                success: 0.9
                error_plaid: 0.01
                error_institution: 0.09
            transactions_updates:
              status: HEALTHY
              last_status_change: 2019-02-12T08:22:00Z
              breakdown:
                success: 0.95
                error_plaid: 0.02
                error_institution: 0.03
                refresh_interval: NORMAL
            auth:
              status: HEALTHY
              last_status_change: 2019-02-15T15:53:00Z
              breakdown:
                success: 0.91
                error_plaid: 0.01
                error_institution: 0.08
            balance:
              status: HEALTHY
              last_status_change: 2019-02-15T15:53:00Z
              breakdown:
                success: 0.89
                error_plaid: 0.02
                error_institution: 0.09
            identity:
              status: DEGRADED
              last_status_change: 2019-02-15T15:50:00Z
              breakdown:
                success: 0.42
                error_plaid: 0.08
                error_institution: 0.5
            investments_updates:
              status: HEALTHY
              last_status_change: 2019-02-12T08:22:00Z
              breakdown:
                success: 0.95
                error_plaid: 0.02
                error_institution: 0.03
                refresh_interval: NORMAL
    CountryCode:
      description: ISO-3166-1 alpha-2 country code standard.
      enum:
      - US
      - GB
      - ES
      - NL
      - FR
      - IE
      - CA
      title: CountryCode
      type: string
    PaymentMeta:
      additionalProperties: true
      description: |-
        Transaction information specific to inter-bank transfers. If the transaction was not an inter-bank transfer, all fields will be `null`.

        If the `transaction` object was returned by a Transactions endpoint such as `/transactions/get`, the `payment_meta` key will always appear, but no data elements are guaranteed. If the `transaction` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights.
      example:
        payee: payee
        ppd_id: ppd_id
        reason: reason
        by_order_of: by_order_of
        payment_processor: payment_processor
        reference_number: reference_number
        payer: payer
        payment_method: payment_method
      properties:
        reference_number:
          description: The transaction reference number supplied by the financial
            institution.
          nullable: true
          type: string
        ppd_id:
          description: The ACH PPD ID for the payer.
          nullable: true
          type: string
        payee:
          description: For transfers, the party that is receiving the transaction.
          nullable: true
          type: string
        by_order_of:
          description: The party initiating a wire transfer. Will be `null` if the
            transaction is not a wire transfer.
          nullable: true
          type: string
        payer:
          description: For transfers, the party that is paying the transaction.
          nullable: true
          type: string
        payment_method:
          description: The type of transfer, e.g. 'ACH'
          nullable: true
          type: string
        payment_processor:
          description: The name of the payment processor
          nullable: true
          type: string
        reason:
          description: The payer-supplied description of the transfer.
          nullable: true
          type: string
      title: payment_meta
      type: object
    TransactionCode:
      description: |-
        An identifier classifying the transaction type.

        This field is only populated for European institutions. For institutions in the US and Canada, this field is set to `null`.

        `adjustment:` Bank adjustment

        `atm:` Cash deposit or withdrawal via an automated teller machine

        `bank charge:` Charge or fee levied by the institution

        `bill payment`: Payment of a bill

        `cash:` Cash deposit or withdrawal

        `cashback:` Cash withdrawal while making a debit card purchase

        `cheque:` Document ordering the payment of money to another person or organization

        `direct debit:` Automatic withdrawal of funds initiated by a third party at a regular interval

        `interest:` Interest earned or incurred

        `purchase:` Purchase made with a debit or credit card

        `standing order:` Payment instructed by the account holder to a third party at a regular interval

        `transfer:` Transfer of money between accounts
      enum:
      - adjustment
      - atm
      - bank charge
      - bill payment
      - cash
      - cashback
      - cheque
      - direct debit
      - interest
      - purchase
      - standing order
      - transfer
      - null
      nullable: true
      title: transaction_code
      type: string
    Category:
      additionalProperties: true
      description: Information describing a transaction category
      example:
        category_id: category_id
        hierarchy:
        - hierarchy
        - hierarchy
        group: group
      properties:
        category_id:
          description: An identifying number for the category. `category_id` is a
            Plaid-specific identifier and does not necessarily correspond to merchant
            category codes.
          type: string
        group:
          description: '`place` for physical transactions or `special` for other transactions
            such as bank charges.'
          type: string
        hierarchy:
          description: A hierarchical array of the categories to which this `category_id`
            belongs.
          items:
            type: string
          type: array
      required:
      - category_id
      - group
      - hierarchy
      title: Category
      type: object
    AccessToken:
      description: The access token associated with the Item data is being requested
        for.
      title: AccessToken
      type: string
    NullableAccessToken:
      allOf:
      - $ref: '#/components/schemas/AccessToken'
      - type: string
      nullable: true
    BankTransferAccessToken:
      description: The Plaid `access_token` for the account that will be debited or
        credited.
      type: string
    APISecret:
      description: Your Plaid API `secret`.
      title: APISecret
      type: string
    APIClientID:
      description: Your Plaid API `client_id`.
      title: ClientID
      type: string
    TransactionsRemovedWebhook:
      additionalProperties: true
      description: Fired when transaction(s) for an Item are deleted. The deleted
        transaction IDs are included in the webhook payload. Plaid will typically
        check for deleted transaction data several times a day.
      properties:
        webhook_type:
          description: '`TRANSACTIONS`'
          type: string
        webhook_code:
          description: '`TRANSACTIONS_REMOVED`'
          type: string
        error:
          $ref: '#/components/schemas/Error'
        removed_transactions:
          description: An array of `transaction_ids` corresponding to the removed
            transactions
          items:
            type: string
          type: array
        item_id:
          description: The `item_id` of the Item associated with this webhook, warning,
            or error
          title: ItemId
          type: string
      required:
      - item_id
      - removed_transactions
      - webhook_code
      - webhook_type
      title: TransactionsRemovedWebhook
      type: object
      x-examples:
        example-1:
          webhook_type: TRANSACTIONS
          webhook_code: TRANSACTIONS_REMOVED
          item_id: wz666MBjYWTp2PDzzggYhM6oWWmBb
          removed_transactions:
          - yBVBEwrPyJs8GvR77N7QTxnGg6wG74H7dEDN6
          - kgygNvAVPzSX9KkddNdWHaVGRVex1MHm3k9no
    DefaultUpdateWebhook:
      additionalProperties: true
      description: |
        Fired when new transaction data is available for an Item. Plaid will typically check for new transaction data several times a day.
      properties:
        webhook_type:
          description: '`TRANSACTIONS`'
          type: string
        webhook_code:
          description: '`DEFAULT_UPDATE`'
          type: string
        error:
          $ref: '#/components/schemas/Error'
        new_transactions:
          description: The number of new transactions detected since the last time
            this webhook was fired.
          title: DefaultUpdateWebhook
          type: number
        item_id:
          description: The `item_id` of the Item the webhook relates to.
          type: string
      required:
      - item_id
      - new_transactions
      - webhook_code
      - webhook_type
      type: object
      x-examples:
        example-1:
          webhook_type: TRANSACTIONS
          webhook_code: DEFAULT_UPDATE
          item_id: wz666MBjYWTp2PDzzggYhM6oWWmBb
          new_transactions: 3
    HistoricalUpdateWebhook:
      additionalProperties: true
      description: Fired when an Item's historical transaction pull is completed and
        Plaid has prepared as much historical transaction data as possible for the
        Item. Once this webhook has been fired, transaction data beyond the most recent
        30 days can be fetched for the Item.
      properties:
        webhook_type:
          description: '`TRANSACTIONS`'
          type: string
        webhook_code:
          description: '`HISTORICAL_UPDATE`'
          type: string
        error:
          $ref: '#/components/schemas/Error'
        new_transactions:
          description: The number of new, unfetched transactions available
          type: number
        item_id:
          description: The `item_id` of the Item associated with this webhook, warning,
            or error
          title: ItemId
          type: string
      required:
      - item_id
      - new_transactions
      - webhook_code
      - webhook_type
      title: HistoricalUpdateWebhook
      type: object
      x-examples:
        example-1:
          webhook_type: TRANSACTIONS
          webhook_code: HISTORICAL_UPDATE
          item_id: wz666MBjYWTp2PDzzggYhM6oWWmBb
          new_transactions: 231
    SyncUpdatesAvailableWebhook:
      title: SyncUpdatesAvailableWebhook
      description: |-
        Fired when an Item's transactions change. This can be due to any event resulting in new changes, such as an initial 30-day transactions fetch upon the initialization of an Item with transactions, the backfill of historical transactions that occurs shortly after, or when changes are populated from a regularly-scheduled transactions update job. It is recommended to listen for the `SYNC_UPDATES_AVAILABLE` webhook when using the `/transactions/sync` endpoint. Note that when using `/transactions/sync` the older webhooks `INITIAL_UPDATE`, `HISTORICAL_UPDATE`, `DEFAULT_UPDATE`, and `TRANSACTIONS_REMOVED`, which are intended for use with `/transactions/get`, will also continue to be sent in order to maintain backwards compatibility. It is not necessary to listen for and respond to those webhooks when using `/transactions/sync`.

        After receipt of this webhook, the new changes can be fetched for the Item from `/transactions/sync`.

        Note that to receive this webhook for an Item, `/transactions/sync` must have been called at least once on that Item.
      type: object
      additionalProperties: true
      properties:
        webhook_type:
          type: string
          description: '`TRANSACTIONS`'
        webhook_code:
          type: string
          description: '`SYNC_UPDATES_AVAILABLE`'
        item_id:
          $ref: '#/components/schemas/ItemId'
        initial_update_complete:
          type: boolean
          description: Indicates if initial pull information is available.
        historical_update_complete:
          type: boolean
          description: Indicates if historical pull information is available.
      required:
      - webhook_type
      - webhook_code
      - item_id
      - initial_update_complete
      - historical_update_complete
      x-examples:
        example-1:
          webhook_type: TRANSACTIONS
          webhook_code: SYNC_UPDATES_AVAILABLE
          item_id: wz666MBjYWTp2PDzzggYhM6oWWmBb
          initial_update_complete: true
          historical_update_complete: false
          environment: production
    InitialUpdateWebhook:
      additionalProperties: true
      description: Fired when an Item's initial transaction pull is completed. Once
        this webhook has been fired, transaction data for the most recent 30 days
        can be fetched for the Item.
      properties:
        webhook_type:
          description: '`TRANSACTIONS`'
          type: string
        webhook_code:
          description: '`INITIAL_UPDATE`'
          type: string
        error:
          description: The error code associated with the webhook.
          nullable: true
          type: string
        new_transactions:
          description: The number of new, unfetched transactions available.
          type: number
        item_id:
          description: The `item_id` of the Item associated with this webhook, warning,
            or error
          title: ItemId
          type: string
      required:
      - item_id
      - new_transactions
      - webhook_code
      - webhook_type
      title: InitialUpdateWebhook
      type: object
      x-examples:
        example-1:
          webhook_type: TRANSACTIONS
          webhook_code: INITIAL_UPDATE
          item_id: wz666MBjYWTp2PDzzggYhM6oWWmBb
          new_transactions: 19
    PhoneNumber:
      additionalProperties: true
      description: A phone number
      properties:
        data:
          description: The phone number.
          type: string
        primary:
          description: When `true`, identifies the phone number as the primary number
            on an account.
          nullable: true
          type: boolean
        type:
          description: The type of phone number.
          enum:
          - home
          - work
          - office
          - mobile
          - mobile1
          - other
          nullable: true
          type: string
      required:
      - data
      title: PhoneNumber
      type: object
    Email:
      additionalProperties: true
      description: An object representing an email address
      properties:
        data:
          description: The email address.
          type: string
        primary:
          description: When `true`, identifies the email address as the primary email
            on an account.
          type: boolean
        type:
          description: The type of email account as described by the financial institution.
          enum:
          - primary
          - secondary
          - other
          type: string
      required:
      - data
      - primary
      - type
      title: Email
      type: object
    Address:
      additionalProperties: true
      description: A physical mailing address.
      properties:
        data:
          $ref: '#/components/schemas/AddressData'
        primary:
          description: When `true`, identifies the address as the primary address
            on an account.
          nullable: true
          type: boolean
      required:
      - data
      title: Address
      type: object
    NullableAddress:
      allOf:
      - $ref: '#/components/schemas/Address'
      - additionalProperties: true
        type: object
      nullable: true
    NullableAddressData:
      allOf:
      - $ref: '#/components/schemas/AddressData'
      - additionalProperties: true
        type: object
      nullable: true
    AddressData:
      additionalProperties: true
      description: Data about the components comprising an address.
      properties:
        city:
          description: The full city name
          type: string
        region:
          description: |-
            The region or state
            Example: `"NC"`
          nullable: true
          type: string
        street:
          description: |-
            The full street address
            Example: `"564 Main Street, APT 15"`
          type: string
        postal_code:
          description: The postal code
          nullable: true
          type: string
        country:
          description: The ISO 3166-1 alpha-2 country code
          type: string
      required:
      - city
      - country
      - street
      title: AddressData
      type: object
    ProcessorToken:
      description: 'The processor token obtained from the Plaid integration partner.
        Processor tokens are in the format: `processor-<environment>-<identifier>`'
      title: ProcessorToken
      type: string
    HistoricalBalance:
      additionalProperties: true
      description: An object representing a balance held by an account in the past
      properties:
        date:
          description: The date of the calculated historical balance, in an ISO 8601
            format (YYYY-MM-DD)
          type: string
        current:
          description: |-
            The total amount of funds in the account, calculated from the `current` balance in the `balance` object by subtracting inflows and adding back outflows according to the posted date of each transaction.

            If the account has any pending transactions, historical balance amounts on or after the date of the earliest pending transaction may differ if retrieved in subsequent Asset Reports as a result of those pending transactions posting.
          type: number
        iso_currency_code:
          description: The ISO-4217 currency code of the balance. Always `null` if
            `unofficial_currency_code` is non-`null`.
          nullable: true
          type: string
        unofficial_currency_code:
          description: |-
            The unofficial currency code associated with the balance. Always `null` if `iso_currency_code` is non-`null`.

            See the [currency code schema](/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.
          nullable: true
          type: string
      required:
      - current
      - date
      title: HistoricalBalance
      type: object
    Owner:
      additionalProperties: true
      description: Data returned from the financial institution about the owner or
        owners of an account. Only the `names` array must be non-empty.
      properties:
        names:
          description: |-
            A list of names associated with the account by the financial institution. These should always be the names of individuals, even for business accounts. If the name of a business is reported, please contact Plaid Support.  In the case of a joint account, the names of all account holders will be reported.

            If an Item contains multiple accounts with different owner names, some institutions will report all names associated with the Item in each account's `names` array.
          items:
            type: string
          type: array
        phone_numbers:
          description: A list of phone numbers associated with the account by the
            financial institution. May be an empty array if no relevant information
            is returned from the financial institution.
          items:
            $ref: '#/components/schemas/PhoneNumber'
          type: array
        emails:
          description: A list of email addresses associated with the account by the
            financial institution. May be an empty array if no relevant information
            is returned from the financial institution.
          items:
            $ref: '#/components/schemas/Email'
          type: array
        addresses:
          description: Data about the various addresses associated with the account
            by the financial institution. May be an empty array if no relevant information
            is returned from the financial institution.
          items:
            $ref: '#/components/schemas/Address'
          type: array
      required:
      - addresses
      - emails
      - names
      - phone_numbers
      title: Owner
      type: object
    OwnerOverride:
      additionalProperties: true
      description: Data about the owner or owners of an account. Any fields not specified
        will be filled in with default Sandbox information.
      properties:
        names:
          description: A list of names associated with the account by the financial
            institution. These should always be the names of individuals, even for
            business accounts. Note that the same name data will be used for all accounts
            associated with an Item.
          items:
            type: string
          type: array
        phone_numbers:
          description: A list of phone numbers associated with the account.
          items:
            $ref: '#/components/schemas/PhoneNumber'
          type: array
        emails:
          description: A list of email addresses associated with the account.
          items:
            $ref: '#/components/schemas/Email'
          type: array
        addresses:
          description: Data about the various addresses associated with the account.
          items:
            $ref: '#/components/schemas/Address'
          type: array
      required:
      - addresses
      - emails
      - names
      - phone_numbers
      title: OwnerOverride
      type: object
    LiabilitiesObject:
      additionalProperties: true
      description: An object containing liability accounts
      example:
        mortgage:
        - origination_principal_amount: 7.386281948385884
          account_number: account_number
          next_monthly_payment: 4.145608029883936
          loan_type_description: loan_type_description
          escrow_balance: 9.301444243932576
          has_pmi: true
          last_payment_date: last_payment_date
          past_due_amount: 1.2315135367772556
          maturity_date: maturity_date
          has_prepayment_penalty: true
          current_late_fee: 7.061401241503109
          last_payment_amount: 2.027123023002322
          property_address:
            country: country
            city: city
            street: street
            postal_code: postal_code
            region: region
          account_id: account_id
          origination_date: origination_date
          loan_term: loan_term
          interest_rate:
            percentage: 3.616076749251911
            type: type
          ytd_interest_paid: 1.0246457001441578
          ytd_principal_paid: 1.4894159098541704
          next_payment_due_date: next_payment_due_date
        - origination_principal_amount: 7.386281948385884
          account_number: account_number
          next_monthly_payment: 4.145608029883936
          loan_type_description: loan_type_description
          escrow_balance: 9.301444243932576
          has_pmi: true
          last_payment_date: last_payment_date
          past_due_amount: 1.2315135367772556
          maturity_date: maturity_date
          has_prepayment_penalty: true
          current_late_fee: 7.061401241503109
          last_payment_amount: 2.027123023002322
          property_address:
            country: country
            city: city
            street: street
            postal_code: postal_code
            region: region
          account_id: account_id
          origination_date: origination_date
          loan_term: loan_term
          interest_rate:
            percentage: 3.616076749251911
            type: type
          ytd_interest_paid: 1.0246457001441578
          ytd_principal_paid: 1.4894159098541704
          next_payment_due_date: next_payment_due_date
        student:
        - origination_principal_amount: 5.025004791520295
          account_number: account_number
          payment_reference_number: payment_reference_number
          guarantor: guarantor
          last_statement_issue_date: last_statement_issue_date
          last_statement_balance: 1.1730742509559433
          expected_payoff_date: expected_payoff_date
          pslf_status:
            payments_remaining: 6.683562403749608
            payments_made: 9.369310271410669
            estimated_eligibility_date: estimated_eligibility_date
          outstanding_interest_amount: 9.965781217890562
          ytd_interest_paid: 8.762042012749001
          ytd_principal_paid: 9.018348186070783
          loan_name: loan_name
          next_payment_due_date: next_payment_due_date
          loan_status:
            end_date: end_date
            type: cancelled
          repayment_plan:
            description: description
            type: extended graduated
          last_payment_date: last_payment_date
          is_overdue: true
          last_payment_amount: 7.457744773683766
          sequence_number: sequence_number
          account_id: account_id
          interest_rate_percentage: 6.84685269835264
          disbursement_dates:
          - disbursement_dates
          - disbursement_dates
          origination_date: origination_date
          servicer_address:
            country: country
            city: city
            street: street
            region: region
            postal_code: postal_code
          minimum_payment_amount: 4.965218492984954
        - origination_principal_amount: 5.025004791520295
          account_number: account_number
          payment_reference_number: payment_reference_number
          guarantor: guarantor
          last_statement_issue_date: last_statement_issue_date
          last_statement_balance: 1.1730742509559433
          expected_payoff_date: expected_payoff_date
          pslf_status:
            payments_remaining: 6.683562403749608
            payments_made: 9.369310271410669
            estimated_eligibility_date: estimated_eligibility_date
          outstanding_interest_amount: 9.965781217890562
          ytd_interest_paid: 8.762042012749001
          ytd_principal_paid: 9.018348186070783
          loan_name: loan_name
          next_payment_due_date: next_payment_due_date
          loan_status:
            end_date: end_date
            type: cancelled
          repayment_plan:
            description: description
            type: extended graduated
          last_payment_date: last_payment_date
          is_overdue: true
          last_payment_amount: 7.457744773683766
          sequence_number: sequence_number
          account_id: account_id
          interest_rate_percentage: 6.84685269835264
          disbursement_dates:
          - disbursement_dates
          - disbursement_dates
          origination_date: origination_date
          servicer_address:
            country: country
            city: city
            street: street
            region: region
            postal_code: postal_code
          minimum_payment_amount: 4.965218492984954
        credit:
        - account_id: account_id
          last_payment_date: last_payment_date
          is_overdue: true
          last_statement_issue_date: last_statement_issue_date
          minimum_payment_amount: 2.3021358869347655
          aprs:
          - apr_percentage: 0.8008281904610115
            apr_type: balance_transfer_apr
            interest_charge_amount: 1.4658129805029452
            balance_subject_to_apr: 6.027456183070403
          - apr_percentage: 0.8008281904610115
            apr_type: balance_transfer_apr
            interest_charge_amount: 1.4658129805029452
            balance_subject_to_apr: 6.027456183070403
          last_payment_amount: 5.962133916683182
          next_payment_due_date: next_payment_due_date
          last_statement_balance: 5.637376656633329
        - account_id: account_id
          last_payment_date: last_payment_date
          is_overdue: true
          last_statement_issue_date: last_statement_issue_date
          minimum_payment_amount: 2.3021358869347655
          aprs:
          - apr_percentage: 0.8008281904610115
            apr_type: balance_transfer_apr
            interest_charge_amount: 1.4658129805029452
            balance_subject_to_apr: 6.027456183070403
          - apr_percentage: 0.8008281904610115
            apr_type: balance_transfer_apr
            interest_charge_amount: 1.4658129805029452
            balance_subject_to_apr: 6.027456183070403
          last_payment_amount: 5.962133916683182
          next_payment_due_date: next_payment_due_date
          last_statement_balance: 5.637376656633329
      properties:
        credit:
          description: The credit accounts returned. If no credit accounts are returned,
            `credit` will not be present in the schema.
          items:
            $ref: '#/components/schemas/CreditCardLiability'
          nullable: true
          type: array
        mortgage:
          description: The mortgage accounts returned. If no mortgage accounts are
            returned, `mortgage` will not be present in the schema.
          items:
            $ref: '#/components/schemas/MortgageLiability'
          nullable: true
          type: array
        student:
          description: The student loan accounts returned. If no student loan accounts
            are returned, `student` will not be present in the schema.
          items:
            $ref: '#/components/schemas/StudentLoan'
          nullable: true
          type: array
      title: LiabilitiesObject
      type: object
    StudentLoan:
      additionalProperties: true
      description: Contains details about a student loan account
      example:
        origination_principal_amount: 5.025004791520295
        account_number: account_number
        payment_reference_number: payment_reference_number
        guarantor: guarantor
        last_statement_issue_date: last_statement_issue_date
        last_statement_balance: 1.1730742509559433
        expected_payoff_date: expected_payoff_date
        pslf_status:
          payments_remaining: 6.683562403749608
          payments_made: 9.369310271410669
          estimated_eligibility_date: estimated_eligibility_date
        outstanding_interest_amount: 9.965781217890562
        ytd_interest_paid: 8.762042012749001
        ytd_principal_paid: 9.018348186070783
        loan_name: loan_name
        next_payment_due_date: next_payment_due_date
        loan_status:
          end_date: end_date
          type: cancelled
        repayment_plan:
          description: description
          type: extended graduated
        last_payment_date: last_payment_date
        is_overdue: true
        last_payment_amount: 7.457744773683766
        sequence_number: sequence_number
        account_id: account_id
        interest_rate_percentage: 6.84685269835264
        disbursement_dates:
        - disbursement_dates
        - disbursement_dates
        origination_date: origination_date
        servicer_address:
          country: country
          city: city
          street: street
          region: region
          postal_code: postal_code
        minimum_payment_amount: 4.965218492984954
      properties:
        account_id:
          description: The ID of the account that this liability belongs to.
          nullable: true
          type: string
        account_number:
          description: The account number of the loan.
          nullable: true
          type: string
        disbursement_dates:
          description: The dates on which loaned funds were disbursed or will be disbursed.
            These are often in the past. Dates are returned in an ISO 8601 format
            (YYYY-MM-DD).
          items:
            type: string
          nullable: true
          type: array
        expected_payoff_date:
          description: The date when the student loan is expected to be paid off.
            Availability for this field is limited. Dates are returned in an ISO 8601
            format (YYYY-MM-DD).
          nullable: true
          type: string
        guarantor:
          description: The guarantor of the student loan.
          nullable: true
          type: string
        interest_rate_percentage:
          description: The interest rate on the loan as a percentage.
          type: number
        is_overdue:
          description: '`true` if a payment is currently overdue. Availability for
            this field is limited.'
          nullable: true
          type: boolean
        last_payment_amount:
          description: The amount of the last payment.
          nullable: true
          type: number
        last_payment_date:
          description: The date of the last payment. Dates are returned in an ISO
            8601 format (YYYY-MM-DD).
          nullable: true
          type: string
        last_statement_balance:
          description: 'The outstanding balance on the last statement. This field
            could also be interpreted as the next payment due. Availability for this
            field is limited. '
          nullable: true
          type: number
        last_statement_issue_date:
          description: The date of the last statement. Dates are returned in an ISO
            8601 format (YYYY-MM-DD).
          nullable: true
          type: string
        loan_name:
          description: The type of loan, e.g., "Consolidation Loans".
          nullable: true
          type: string
        loan_status:
          $ref: '#/components/schemas/StudentLoanStatus'
        minimum_payment_amount:
          description: |-
            The minimum payment due for the next billing cycle. There are some exceptions:
            Some institutions require a minimum payment across all loans associated with an account number. Our API presents that same minimum payment amount on each loan. The institutions that do this are: Great Lakes ( `ins_116861`), Firstmark (`ins_116295`), Commonbond Firstmark Services (`ins_116950`), Nelnet (`ins_116528`), EdFinancial Services (`ins_116304`), Granite State (`ins_116308`), and Oklahoma Student Loan Authority (`ins_116945`).
            Firstmark (`ins_116295` ) will display as $0 if there is an autopay program in effect.
          nullable: true
          type: number
        next_payment_due_date:
          description: The due date for the next payment. The due date is `null` if
            a payment is not expected. A payment is not expected if `loan_status.type`
            is `deferment`, `in_school`, `consolidated`, `paid in full`, or `transferred`.
            Dates are returned in an ISO 8601 format (YYYY-MM-DD).
          nullable: true
          type: string
        origination_date:
          description: |
            The date on which the loan was initially lent. Dates are returned in an ISO 8601 format (YYYY-MM-DD).
          nullable: true
          type: string
        origination_principal_amount:
          description: The original principal balance of the loan.
          nullable: true
          type: number
        outstanding_interest_amount:
          description: The total dollar amount of the accrued interest balance. For
            Sallie Mae ( `ins_116944`), this amount is included in the current balance
            of the loan, so this field will return as `null`.
          nullable: true
          type: number
        payment_reference_number:
          description: The relevant account number that should be used to reference
            this loan for payments. In the majority of cases, `payment_reference_number`
            will match a`ccount_number,` but in some institutions, such as Great Lakes
            (`ins_116861`), it will be different.
          nullable: true
          type: string
        pslf_status:
          $ref: '#/components/schemas/PSLFStatus'
        repayment_plan:
          $ref: '#/components/schemas/StudentRepaymentPlan'
        sequence_number:
          description: The sequence number of the student loan. Heartland ECSI (`ins_116948`)
            does not make this field available.
          nullable: true
          type: string
        servicer_address:
          $ref: '#/components/schemas/ServicerAddressData'
        ytd_interest_paid:
          description: The year to date (YTD) interest paid. Availability for this
            field is limited.
          nullable: true
          type: number
        ytd_principal_paid:
          description: The year to date (YTD) principal paid. Availability for this
            field is limited.
          nullable: true
          type: number
      required:
      - interest_rate_percentage
      title: StudentLoan
      type: object
    CreditCardLiability:
      additionalProperties: true
      description: An object representing a credit card account.
      example:
        account_id: account_id
        last_payment_date: last_payment_date
        is_overdue: true
        last_statement_issue_date: last_statement_issue_date
        minimum_payment_amount: 2.3021358869347655
        aprs:
        - apr_percentage: 0.8008281904610115
          apr_type: balance_transfer_apr
          interest_charge_amount: 1.4658129805029452
          balance_subject_to_apr: 6.027456183070403
        - apr_percentage: 0.8008281904610115
          apr_type: balance_transfer_apr
          interest_charge_amount: 1.4658129805029452
          balance_subject_to_apr: 6.027456183070403
        last_payment_amount: 5.962133916683182
        next_payment_due_date: next_payment_due_date
        last_statement_balance: 5.637376656633329
      properties:
        account_id:
          description: The ID of the account that this liability belongs to.
          nullable: true
          type: string
        aprs:
          description: The various interest rates that apply to the account.
          items:
            $ref: '#/components/schemas/APR'
          type: array
        is_overdue:
          description: true if a payment is currently overdue. Availability for this
            field is limited.
          nullable: true
          type: boolean
        last_payment_amount:
          description: The amount of the last payment.
          type: number
        last_payment_date:
          description: The date of the last payment. Dates are returned in an ISO
            8601 format (YYYY-MM-DD). Availability for this field is limited.
          type: string
        last_statement_balance:
          description: The outstanding balance on the last statement. Availability
            for this field is limited.
          type: number
        last_statement_issue_date:
          description: The date of the last statement. Dates are returned in an ISO
            8601 format (YYYY-MM-DD).
          type: string
        minimum_payment_amount:
          description: The minimum payment due for the next billing cycle.
          type: number
        next_payment_due_date:
          description: The due date for the next payment. The due date is `null` if
            a payment is not expected. Dates are returned in an ISO 8601 format (YYYY-MM-DD).
          type: string
      required:
      - aprs
      - last_payment_amount
      - last_payment_date
      - last_statement_balance
      - last_statement_issue_date
      - minimum_payment_amount
      - next_payment_due_date
      title: CreditCardLiability
      type: object
    MortgageLiability:
      additionalProperties: true
      description: Contains details about a mortgage account.
      example:
        origination_principal_amount: 7.386281948385884
        account_number: account_number
        next_monthly_payment: 4.145608029883936
        loan_type_description: loan_type_description
        escrow_balance: 9.301444243932576
        has_pmi: true
        last_payment_date: last_payment_date
        past_due_amount: 1.2315135367772556
        maturity_date: maturity_date
        has_prepayment_penalty: true
        current_late_fee: 7.061401241503109
        last_payment_amount: 2.027123023002322
        property_address:
          country: country
          city: city
          street: street
          postal_code: postal_code
          region: region
        account_id: account_id
        origination_date: origination_date
        loan_term: loan_term
        interest_rate:
          percentage: 3.616076749251911
          type: type
        ytd_interest_paid: 1.0246457001441578
        ytd_principal_paid: 1.4894159098541704
        next_payment_due_date: next_payment_due_date
      properties:
        account_id:
          description: The ID of the account that this liability belongs to.
          nullable: true
          type: string
        account_number:
          description: The account number of the loan.
          type: string
        current_late_fee:
          description: The current outstanding amount charged for late payment.
          nullable: true
          type: number
        escrow_balance:
          description: Total amount held in escrow to pay taxes and insurance on behalf
            of the borrower.
          nullable: true
          type: number
        has_pmi:
          description: Indicates whether the borrower has private mortgage insurance
            in effect.
          nullable: true
          type: boolean
        has_prepayment_penalty:
          description: Indicates whether the borrower will pay a penalty for early
            payoff of mortgage.
          nullable: true
          type: boolean
        interest_rate:
          $ref: '#/components/schemas/MortgageInterestRate'
        last_payment_amount:
          description: The amount of the last payment.
          nullable: true
          type: number
        last_payment_date:
          description: The date of the last payment. Dates are returned in an ISO
            8601 format (YYYY-MM-DD).
          nullable: true
          type: string
        loan_type_description:
          description: Description of the type of loan, for example `conventional`,
            `fixed`, or `variable`. This field is provided directly from the loan
            servicer and does not have an enumerated set of possible values.
          nullable: true
          type: string
        loan_term:
          description: Full duration of mortgage as at origination (e.g. `10 year`).
          nullable: true
          type: string
        maturity_date:
          description: Original date on which mortgage is due in full. Dates are returned
            in an ISO 8601 format (YYYY-MM-DD).
          nullable: true
          type: string
        next_monthly_payment:
          description: The amount of the next payment.
          nullable: true
          type: number
        next_payment_due_date:
          description: The due date for the next payment. Dates are returned in an
            ISO 8601 format (YYYY-MM-DD).
          nullable: true
          type: string
        origination_date:
          description: The date on which the loan was initially lent. Dates are returned
            in an ISO 8601 format (YYYY-MM-DD).
          nullable: true
          type: string
        origination_principal_amount:
          description: The original principal balance of the mortgage.
          nullable: true
          type: number
        past_due_amount:
          description: Amount of loan (principal + interest) past due for payment.
          nullable: true
          type: number
        property_address:
          $ref: '#/components/schemas/MortgagePropertyAddress'
        ytd_interest_paid:
          description: The year to date (YTD) interest paid.
          nullable: true
          type: number
        ytd_principal_paid:
          description: The YTD principal paid.
          nullable: true
          type: number
      required:
      - account_number
      title: MortgageLiability
      type: object
    MortgageInterestRate:
      additionalProperties: true
      description: Object containing metadata about the interest rate for the mortgage.
      example:
        percentage: 3.616076749251911
        type: type
      properties:
        percentage:
          description: Percentage value (interest rate of current mortgage, not APR)
            of interest payable on a loan.
          nullable: true
          type: number
        type:
          description: The type of interest charged (fixed or variable).
          nullable: true
          type: string
      title: MortgageInterestRate
      type: object
    MortgagePropertyAddress:
      additionalProperties: true
      description: Object containing fields describing property address.
      example:
        country: country
        city: city
        street: street
        postal_code: postal_code
        region: region
      properties:
        city:
          description: The city name.
          nullable: true
          type: string
        country:
          description: The ISO 3166-1 alpha-2 country code.
          nullable: true
          type: string
        postal_code:
          description: The five or nine digit postal code.
          nullable: true
          type: string
        region:
          description: The region or state (example "NC").
          nullable: true
          type: string
        street:
          description: The full street address (example "564 Main Street, Apt 15").
          nullable: true
          type: string
      title: MortgagePropertyAddress
      type: object
    StudentLoanStatus:
      additionalProperties: true
      description: An object representing the status of the student loan
      example:
        end_date: end_date
        type: cancelled
      properties:
        end_date:
          description: |
            The date until which the loan will be in its current status. Dates are returned in an ISO 8601 format (YYYY-MM-DD).
          nullable: true
          type: string
        type:
          description: The status type of the student loan
          enum:
          - cancelled
          - charged off
          - claim
          - consolidated
          - deferment
          - delinquent
          - discharged
          - extension
          - forbearance
          - in grace
          - in military
          - in school
          - not fully disbursed
          - other
          - paid in full
          - refunded
          - repayment
          - transferred
          nullable: true
          type: string
      title: StudentLoanStatus
      type: object
    StudentRepaymentPlan:
      additionalProperties: true
      description: An object representing the repayment plan for the student loan
      example:
        description: description
        type: extended graduated
      properties:
        description:
          description: The description of the repayment plan as provided by the servicer.
          nullable: true
          type: string
        type:
          description: The type of the repayment plan.
          enum:
          - extended graduated
          - extended standard
          - graduated
          - income-contingent repayment
          - income-based repayment
          - interest-only
          - other
          - pay as you earn
          - revised pay as you earn
          - standard
          nullable: true
          type: string
      title: StudentRepaymentPlan
      type: object
    PSLFStatus:
      additionalProperties: true
      description: 'Information about the student''s eligibility in the Public Service
        Loan Forgiveness program. This is only returned if the institution is Fedloan
        (`ins_116527`). '
      example:
        payments_remaining: 6.683562403749608
        payments_made: 9.369310271410669
        estimated_eligibility_date: estimated_eligibility_date
      properties:
        estimated_eligibility_date:
          description: The estimated date borrower will have completed 120 qualifying
            monthly payments. Returned in ISO 8601 format (YYYY-MM-DD).
          nullable: true
          type: string
        payments_made:
          description: The number of qualifying payments that have been made.
          nullable: true
          type: number
        payments_remaining:
          description: The number of qualifying payments remaining.
          nullable: true
          type: number
      title: PSLFStatus
      type: object
    ServicerAddressData:
      additionalProperties: true
      description: The address of the student loan servicer. This is generally the
        remittance address to which payments should be sent.
      example:
        country: country
        city: city
        street: street
        region: region
        postal_code: postal_code
      properties:
        city:
          description: The full city name
          nullable: true
          type: string
        region:
          description: |-
            The region or state
            Example: `"NC"`
          nullable: true
          type: string
        street:
          description: |-
            The full street address
            Example: `"564 Main Street, APT 15"`
          nullable: true
          type: string
        postal_code:
          description: The postal code
          nullable: true
          type: string
        country:
          description: The ISO 3166-1 alpha-2 country code
          nullable: true
          type: string
      title: ServicerAddressData
      type: object
    APR:
      additionalProperties: true
      description: Information about the APR on the account.
      example:
        apr_percentage: 0.8008281904610115
        apr_type: balance_transfer_apr
        interest_charge_amount: 1.4658129805029452
        balance_subject_to_apr: 6.027456183070403
      properties:
        apr_percentage:
          description: |
            Annual Percentage Rate applied.
          type: number
        apr_type:
          description: The type of balance to which the APR applies.
          enum:
          - balance_transfer_apr
          - cash_apr
          - purchase_apr
          - special
          type: string
        balance_subject_to_apr:
          description: Amount of money that is subjected to the APR if a balance was
            carried beyond payment due date. How it is calculated can vary by card
            issuer. It is often calculated as an average daily balance.
          nullable: true
          type: number
        interest_charge_amount:
          description: Amount of money charged due to interest from last statement.
          nullable: true
          type: number
      required:
      - apr_percentage
      - apr_type
      title: APR
      type: object
    PaymentInitiationAddress:
      additionalProperties: true
      description: The optional address of the payment recipient. This object is not
        currently required to make payments from UK institutions and should not be
        populated, though may be necessary for future European expansion.
      example:
        country: country
        city: city
        street:
        - street
        - street
        postal_code: postal_code
      nullable: true
      properties:
        street:
          description: An array of length 1-2 representing the street address where
            the recipient is located. Maximum of 70 characters.
          items:
            type: string
          minItems: 1
          type: array
        city:
          description: The city where the recipient is located. Maximum of 35 characters.
          type: string
        postal_code:
          description: The postal code where the recipient is located. Maximum of
            16 characters.
          type: string
        country:
          description: The ISO 3166-1 alpha-2 country code where the recipient is
            located.
          type: string
      title: PaymentInitiationAddress
      type: object
    PaymentInitiationRecipient:
      additionalProperties: true
      description: Information about a payment recipient configured for the Payment
        Initiation product
      example:
        bacs:
          key: '{}'
        address:
          country: country
          city: city
          street:
          - street
          - street
          postal_code: postal_code
        iban: iban
        name: name
        recipient_id: recipient_id
      properties:
        recipient_id:
          description: The ID of the recipient. Like all Plaid identifiers, the `recipient_id`
            is case sensitive.
          type: string
        name:
          description: The name of the recipient
          type: string
        address:
          $ref: '#/components/schemas/PaymentInitiationAddress'
        iban:
          description: The International Bank Account Number (IBAN) for the recipient.
          nullable: true
          type: string
        bacs:
          additionalProperties: true
          nullable: true
          properties:
            account:
              type: string
            sort_code:
              type: string
          required:
          - account
          - sort_code
          type: object
      required:
      - address
      - name
      - recipient_id
      title: PaymentInitiationRecipient
      type: object
    Amount:
      additionalProperties: true
      description: A payment amount.
      example:
        currency: GBP
        value: 0.8008281904610115
      properties:
        currency:
          description: The ISO-4217 currency code of the payment. For standing orders,
            `"GBP"` must be used.
          enum:
          - GBP
          - EUR
          type: string
        value:
          description: The amount of the payment. Must contain at most two digits
            of precision e.g. `1.23`. Minimum accepted value is `1`.
          type: number
      required:
      - currency
      - value
      title: Amount
      type: object
    ExternalPaymentSchedule:
      additionalProperties: true
      description: The schedule that the payment will be executed on. If a schedule
        is provided, the payment is automatically set up as a standing order. If no
        schedule is specified, the payment will be executed only once.
      example:
        end_date: 2000-01-23
        interval: interval
        interval_execution_day: 6.027456183070403
        start_date: 2000-01-23
      nullable: true
      properties:
        interval:
          description: The frequency interval of the payment. Valid values are `"WEEKLY"`
            or `"MONTHLY"`.
          type: string
        interval_execution_day:
          description: |-
            The day of the interval on which to schedule the payment.

            If the payment interval is weekly, `interval_execution_day` should be an integer from 1 (Monday) to 7 (Sunday).

            If the payment interval is monthly, `interval_execution_day` should be an integer indicating which day of the month to make the payment on. Integers from 1 to 28 can be used to make a payment on that day of the month. Negative integers from -1 to -5 can be used to make a payment relative to the end of the month. To make a payment on the last day of the month, use -1; to make the payment on the second-to-last day, use -2, and so on.
          type: number
        start_date:
          description: |-
            A date in ISO 8601 format (YYYY-MM-DD). Standing order payments will begin on the first `interval_execution_day` on or after the `start_date`.

            If the first `interval_execution_day` on or after the start date is also the same day that `/payment_initiation/payment/create` was called, the bank *may* make the first payment on that day, but it is not guaranteed to do so.
          format: date
          type: string
        end_date:
          description: |-
            A date in ISO 8601 format (YYYY-MM-DD). Standing order payments will end on the last `interval_execution_day` on or before the `end_date`.

            If the only `interval_execution_day` between the start date and the end date (inclusive) is also the same day that `/payment_initiation/payment/create` was called, the bank *may* make a payment on that day, but it is not guaranteed to do so.
          format: date
          type: string
      required:
      - interval
      - interval_execution_day
      - start_date
      title: ExternalPaymentSchedule
      type: object
    ExternalPaymentScheduleGet:
      allOf:
      - $ref: '#/components/schemas/ExternalPaymentSchedule'
      description: The schedule that the payment will be executed on. If a schedule
        is provided, the payment is automatically set up as a standing order. If no
        schedule is specified, the payment will be executed only once.
      example:
        adjusted_start_date: 2000-01-23
      nullable: true
      properties:
        adjusted_start_date:
          description: The start date sent to the bank after adjusting for holidays
            or weekends.  Will be provided in ISO 8601 format (YYYY-MM-DD). If the
            start date did not require adjustment, this field will be `null`.
          format: date
          nullable: true
          type: string
      required:
      - interval
      - interval_execution_day
      - start_date
      title: ExternalPaymentScheduleGet
      type: object
    Products:
      description: 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 not need to be specified during initialization.
      enum:
      - assets
      - auth
      - balance
      - identity
      - investments
      - investments_auth
      - liabilities
      - payment_initiation
      - identity_verification
      - transactions
      - credit_details
      - income
      - income_verification
      - deposit_switch
      - standing_orders
      - transfer
      - employment
      - recurring_transactions
      - signal
      - statements
      title: Products
      type: string
    ProductStatus:
      additionalProperties: true
      description: A representation of the status health of a request type. Auth requests,
        Balance requests, Identity requests, Transactions updates, Investments updates,
        and Item logins each have their own status object.
      example:
        last_status_change: last_status_change
        breakdown:
          error_plaid: 6.027456183070403
          refresh_interval: NORMAL
          success: 0.8008281904610115
          error_institution: 1.4658129805029452
        status: HEALTHY
      properties:
        status:
          description: |-
            `HEALTHY`: the majority of requests are successful
            `DEGRADED`: only some requests are successful
            `DOWN`: all requests are failing
          enum:
          - HEALTHY
          - DEGRADED
          - DOWN
          type: string
        last_status_change:
          description: ISO 8601 formatted timestamp of the last status change for
            the institution.
          type: string
        breakdown:
          $ref: '#/components/schemas/ProductStatusBreakdown'
      required:
      - breakdown
      - last_status_change
      - status
      title: ProductStatus
      type: object
    ProductStatusBreakdown:
      additionalProperties: true
      description: A detailed breakdown of the institution's performance for a request
        type. The values for `success`, `error_plaid`, and `error_institution` sum
        to 1.
      example:
        error_plaid: 6.027456183070403
        refresh_interval: NORMAL
        success: 0.8008281904610115
        error_institution: 1.4658129805029452
      properties:
        success:
          description: The percentage of login attempts that are successful, expressed
            as a decimal.
          type: number
        error_plaid:
          description: |
            The percentage of logins that are failing due to an internal Plaid issue, expressed as a decimal.
          type: number
        error_institution:
          description: The percentage of logins that are failing due to an issue in
            the institution's system, expressed as a decimal.
          type: number
        refresh_interval:
          description: The `refresh_interval` may be `DELAYED` or `STOPPED` even when
            the success rate is high. This value is only returned for Transactions
            status breakdowns.
          enum:
          - NORMAL
          - DELAYED
          - STOPPED
          nullable: true
          type: string
      required:
      - error_institution
      - error_plaid
      - success
      title: StatusBreakdown
      type: object
    UserCustomPassword:
      additionalProperties: true
      description: Custom test accounts are configured with a JSON configuration object
        formulated according to the schema below. All fields are optional. Sending
        an empty object as a configuration will result in an account configured with
        random balances and transaction history.
      properties:
        version:
          description: The version of the password schema to use, possible values
            are 1 or 2. The default value is 2. You should only specify 1 if you know
            it is necessary for your test suite.
          nullable: true
          type: string
        seed:
          description: |-
            A seed, in the form of a string, that will be used to randomly generate account and transaction data, if this data is not specified using the `override_accounts` argument. If no seed is specified, the randomly generated data will be different each time.

            Note that transactions data is generated relative to the Item's creation date. Different Items created on different dates with the same seed for transactions data will have different dates for the transactions. The number of days between each transaction and the Item creation will remain constant. For example, an Item created on December 15 might show a transaction on December 14. An Item created on December 20, using the same seed, would show that same transaction occurring on December 19.
          type: string
        override_accounts:
          description: An array of account overrides to configure the accounts for
            the Item. By default, if no override is specified, transactions and account
            data will be randomly generated based on the account type and subtype,
            and other products will have fixed or empty data.
          items:
            $ref: '#/components/schemas/OverrideAccounts'
          type: array
        mfa:
          $ref: '#/components/schemas/MFA'
        recaptcha:
          description: You may trigger a reCAPTCHA in Plaid Link in the Sandbox environment
            by using the recaptcha field. Possible values are `good` or `bad`. A value
            of `good` will result in successful Item creation and `bad` will result
            in a `RECAPTCHA_BAD` error to simulate a failed reCAPTCHA. Both values
            require the reCAPTCHA to be manually solved within Plaid Link.
          type: string
        force_error:
          description: |-
            An error code to force on Item creation. Possible values are:

            `"INSTITUTION_NOT_RESPONDING"`
            `"INSTITUTION_NO_LONGER_SUPPORTED"`
            `"INVALID_CREDENTIALS"`
            `"INVALID_MFA"`
            `"ITEM_LOCKED"`
            `"ITEM_LOGIN_REQUIRED"`
            `"ITEM_NOT_SUPPORTED"`
            `"INVALID_LINK_TOKEN"`
            `"MFA_NOT_SUPPORTED"`
            `"NO_ACCOUNTS"`
            `"PLAID_ERROR"`
            `"PRODUCTS_NOT_SUPPORTED"`
            `"USER_SETUP_REQUIRED"`
          type: string
      required:
      - force_error
      - mfa
      - override_accounts
      - recaptcha
      - seed
      title: UserCustomPassword
      type: object
      x-examples: {}
    MFA:
      additionalProperties: true
      description: Specifies the multi-factor authentication settings to use with
        this test account
      properties:
        type:
          description: |-
            Possible values are `device`, `selections`, or `questions`.

            If value is `device`, the MFA answer is `1234`.

            If value is `selections`, the MFA answer is always the first option.

            If value is `questions`, the MFA answer is  `answer_<i>_<j>` for the j-th question in the i-th round, starting from 0. For example, the answer to the first question in the second round is `answer_1_0`.
          type: string
        question_rounds:
          description: 'Number of rounds of questions. Required if value of `type`
            is `questions`. '
          type: number
        questions_per_round:
          description: Number of questions per round. Required if value of `type`
            is `questions`. If value of type is `selections`, default value is 2.
          type: number
        selection_rounds:
          description: Number of rounds of selections, used if `type` is `selections`.
            Defaults to 1.
          type: number
        selections_per_question:
          description: |
            Number of available answers per question, used if `type` is `selection`. Defaults to 2.
          type: number
      required:
      - question_rounds
      - questions_per_round
      - selection_rounds
      - selections_per_question
      - type
      title: MFA
      type: object
    OverrideAccounts:
      additionalProperties: true
      description: Data to use to set values of test accounts. Some values cannot
        be specified in the schema and will instead will be calculated from other
        test data in order to achieve more consistent, realistic test data.
      properties:
        type:
          $ref: '#/components/schemas/AccountType'
        subtype:
          $ref: '#/components/schemas/AccountSubtype'
        starting_balance:
          description: |
            If provided, the account will start with this amount as the current balance.
          type: number
        force_available_balance:
          description: If provided, the account will always have this amount as its  available
            balance, regardless of current balance or changes in transactions over
            time.
          type: number
        currency:
          description: ISO-4217 currency code. If provided, the account will be denominated
            in the given currency. Transactions will also be in this currency by default.
          type: string
        meta:
          $ref: '#/components/schemas/Meta'
        numbers:
          $ref: '#/components/schemas/Numbers'
        transactions:
          description: Specify the list of transactions on the account.
          items:
            $ref: '#/components/schemas/TransactionOverride'
          type: array
        identity:
          $ref: '#/components/schemas/OwnerOverride'
        liability:
          $ref: '#/components/schemas/LiabilityOverride'
        inflow_model:
          $ref: '#/components/schemas/InflowModel'
      required:
      - currency
      - force_available_balance
      - identity
      - inflow_model
      - liability
      - meta
      - numbers
      - starting_balance
      - subtype
      - transactions
      - type
      title: OverrideAccounts
      type: object
    Meta:
      additionalProperties: true
      description: Allows specifying the metadata of the test account
      properties:
        name:
          description: The account's name
          type: string
        official_name:
          description: The account's official name
          type: string
        limit:
          description: The account's limit
          type: number
      required:
      - limit
      - name
      - official_name
      title: Meta
      type: object
    Numbers:
      additionalProperties: true
      description: Account and bank identifier number data used to configure the test
        account. All values are optional.
      properties:
        account:
          description: Will be used for the account number.
          type: string
        ach_routing:
          description: Must be a valid ACH routing number.
          type: string
        ach_wire_routing:
          description: Must be a valid wire transfer routing number.
          type: string
        eft_institution:
          description: EFT institution number. Must be specified alongside `eft_branch`.
          type: string
        eft_branch:
          description: EFT branch number. Must be specified alongside `eft_institution`.
          type: string
        international_bic:
          description: Bank identifier code (BIC). Must be specified alongside `international_iban`.
          type: string
        international_iban:
          description: International bank account number (IBAN). If no account number
            is specified via `account`, will also be used as the account number by
            default. Must be specified alongside `international_bic`.
          type: string
        bacs_sort_code:
          description: BACS sort code
          type: string
      required:
      - account
      - ach_routing
      - ach_wire_routing
      - bacs_sort_code
      - eft_branch
      - eft_institution
      - international_bic
      - international_iban
      title: Numbers
      type: object
    TransactionOverride:
      additionalProperties: true
      description: Data to populate as test transaction data. If not specified, random
        transactions will be generated instead.
      properties:
        transaction_date:
          description: The date of the transaction, in ISO8601 (YYYY-MM-DD) format.
            Transaction dates in the past or present will result in posted transactions;
            transaction dates in the future will result in pending transactions. Transactions
            in Sandbox will move from pending to posted once their transaction date
            has been reached.
          type: string
        posted_date:
          description: The date the transaction posted, in ISO8601 (YYYY-MM-DD) format
          type: string
        amount:
          description: The transaction amount. Can be negative.
          type: number
        description:
          description: The transaction description.
          type: string
        currency:
          description: The ISO-4217 format currency code for the transaction.
          type: string
      required:
      - amount
      - description
      - posted_date
      - transaction_date
      title: TransactionOverride
      type: object
    LiabilityOverride:
      additionalProperties: true
      description: Used to configure Sandbox test data for the Liabilities product
      properties:
        type:
          description: The type of the liability object, either `credit` or `student`.
          type: string
        purchase_apr:
          description: The purchase APR percentage value. For simplicity, this is
            the only interest rate used to calculate interest charges. Can only be
            set if `type` is `credit`.
          type: number
        cash_apr:
          description: The cash APR percentage value. Can only be set if `type` is
            `credit`.
          type: number
        balance_transfer_apr:
          description: The balance transfer APR percentage value. Can only be set
            if `type` is `credit`. Can only be set if `type` is `credit`.
          type: number
        special_apr:
          description: The special APR percentage value. Can only be set if `type`
            is `credit`.
          type: number
        last_payment_amount:
          description: Override the `last_payment_amount` field. Can only be set if
            `type` is `credit`.
          type: number
        last_statement_balance:
          description: Override the `last_statement_balance` field. Can only be set
            if `type` is `credit`.
          type: number
        minimum_payment_amount:
          description: Override the `minimum_payment_amount` field. Can only be set
            if `type` is `credit`.
          type: number
        is_overdue:
          description: Override the `is_overdue` field
          type: boolean
        origination_date:
          description: The date on which the loan was initially lent, in ISO 8601
            (YYYY-MM-DD) format. Can only be set if `type` is `student`.
          type: string
        principal:
          description: The original loan principal. Can only be set if `type` is `student`.
          type: number
        nominal_apr:
          description: The interest rate on the loan as a percentage. Can only be
            set if `type` is `student`.
          type: number
        interest_capitalization_grace_period_months:
          description: If set, interest capitalization begins at the given number
            of months after loan origination. By default interest is never capitalized.
            Can only be set if `type` is `student`.
          type: number
        repayment_model:
          $ref: '#/components/schemas/StudentLoanRepaymentModel'
        expected_payoff_date:
          description: Override the `expected_payoff_date` field. Can only be set
            if `type` is `student`.
          type: string
        guarantor:
          description: Override the `guarantor` field. Can only be set if `type` is
            `student`.
          type: string
        is_federal:
          description: Override the `is_federal` field. Can only be set if `type`
            is `student`.
          type: boolean
        loan_name:
          description: Override the `loan_name` field. Can only be set if `type` is
            `student`.
          type: string
        loan_status:
          description: Override the `loan_status` field. Can only be set if `type`
            is `student`.
          type: string
        payment_reference_number:
          description: Override the `payment_reference_number` field. Can only be
            set if `type` is `student`.
          type: string
        pslf_status:
          description: Override the `pslf_status` field. Can only be set if `type`
            is `student`.
          type: string
        repayment_plan_description:
          description: Override the `repayment_plan.description` field. Can only be
            set if `type` is `student`.
          type: string
        repayment_plan_type:
          description: 'Override the `repayment_plan.type` field. Can only be set
            if `type` is `student`. Possible values are: `"extended graduated"`, `"extended
            standard"`, `"graduated"`, `"income-contingent repayment"`, `"income-based
            repayment"`, `"interest only"`, `"other"`, `"pay as you earn"`, `"revised
            pay as you earn"`, or `"standard"`.'
          type: string
        sequence_number:
          description: Override the `sequence_number` field. Can only be set if `type`
            is `student`.
          type: string
        servicer_address:
          $ref: '#/components/schemas/Address'
      required:
      - balance_transfer_apr
      - cash_apr
      - expected_payoff_date
      - guarantor
      - interest_capitalization_grace_period_months
      - is_federal
      - is_overdue
      - last_payment_amount
      - last_statement_balance
      - loan_name
      - loan_status
      - minimum_payment_amount
      - nominal_apr
      - origination_date
      - payment_reference_number
      - principal
      - pslf_status
      - purchase_apr
      - repayment_model
      - repayment_plan_description
      - repayment_plan_type
      - sequence_number
      - servicer_address
      - special_apr
      - type
      type: object
    StudentLoanRepaymentModel:
      additionalProperties: true
      description: Student loan repayment information used to configure Sandbox test
        data for the Liabilities product
      properties:
        type:
          description: The only currently supported value for this field is `standard`.
          type: string
        non_repayment_months:
          description: Configures the number of months before repayment starts.
          type: number
        repayment_months:
          description: Configures the number of months of repayments before the loan
            is paid off.
          type: number
      required:
      - non_repayment_months
      - repayment_months
      - type
      title: StudentLoanRepaymentModel
      type: object
    InflowModel:
      additionalProperties: true
      description: The `inflow_model` allows you to model a test account that receives
        regular income or make regular payments on a loan. Any transactions generated
        by the `inflow_model` will appear in addition to randomly generated test data
        or transactions specified by `override_accounts`.
      properties:
        type:
          description: |-
            Inflow model. One of the following:

            `none`: No income
            `monthly-income`: Income occurs once per month `monthly-balance-payment`: Pays off the balance on a liability account at the given statement day of month
            `monthly-interest-only-payment`: Makes an interest-only payment on a liability account at the given statement day of month. Note that account types supported by Liabilities will accrue interest in the Sandbox. The types are account type `credit` with subtype `credit` or `paypal`, and account type `loan` with subtype `student` or `mortgage`.
          type: string
        income_amount:
          description: Amount of income per month. This value is required if `type`
            is `monthly-income`.
          type: number
        payment_day_of_month:
          description: Number between 1 and 28, or `last` meaning the last day of
            the month. The day of the month on which the income transaction will appear.
            The name of the income transaction. This field is required if `type` is
            `monthly-income`, `monthly-balance-payment` or `monthly-interest-only-payment`.
          type: number
        transaction_name:
          description: The name of the income transaction. This field is required
            if `type` is `monthly-income`, `monthly-balance-payment` or `monthly-interest-only-payment`.
          type: string
        statement_day_of_month:
          description: Number between 1 and 28, or `last` meaning the last day of
            the month. The day of the month on which the balance is calculated for
            the next payment. The name of the income transaction. This field is required
            if `type` is `monthly-balance-payment` or `monthly-interest-only-payment`.
          type: string
      required:
      - income_amount
      - payment_day_of_month
      - statement_day_of_month
      - transaction_name
      - type
      title: InflowModel
      type: object
    ItemId:
      description: The `item_id` of the Item associated with this webhook, warning,
        or error
      title: ItemId
      type: string
    AutomaticallyVerifiedWebhook:
      additionalProperties: true
      description: Fired when an Item is verified via micro-deposits. We recommend
        communicating to your users when this event is received to notify them that
        their account is verified and ready for use.
      properties:
        webhook_type:
          description: '`AUTH`'
          type: string
        webhook_code:
          description: '`AUTOMATICALLY_VERIFIED`'
          type: string
        account_id:
          description: The `account_id` of the account associated with the webhook
          type: string
        item_id:
          description: The `item_id` of the Item associated with this webhook, warning,
            or error
          title: ItemId
          type: string
      required:
      - account_id
      - item_id
      - webhook_code
      - webhook_type
      title: AutomaticallyVerifiedWebhook
      type: object
      x-examples:
        example-1:
          webhook_type: AUTH
          webhook_code: AUTOMATICALLY_VERIFIED
          item_id: eVBnVMp7zdTJLkRNr33Rs6zr7KNJqBFL9DrE6
          account_id: dVzbVMLjrxTnLjX4G66XUp5GLklm4oiZy88yK
    JWTHeader:
      additionalProperties: true
      description: A JWT Header, used for webhook validation
      properties:
        id:
          type: string
      required:
      - id
      title: JWTHeader
      type: object
    VerificationExpiredWebhook:
      additionalProperties: true
      description: Fired when an Item was not verified via micro-deposits after ten
        days since the micro-deposit was made.
      properties:
        webhook_type:
          description: '`AUTH`'
          type: string
        webhook_code:
          description: '`VERIFICATION_EXPIRED`'
          type: string
        item_id:
          description: The `item_id` of the Item associated with this webhook, warning,
            or error
          title: ItemId
          type: string
        account_id:
          description: The `account_id` of the account associated with the webhook
          type: string
      required:
      - account_id
      - item_id
      - webhook_code
      - webhook_type
      title: VerificationExpiredWebhook
      type: object
      x-examples:
        example-1:
          webhook_type: AUTH
          webhook_code: VERIFICATION_EXPIRED
          item_id: eVBnVMp7zdTJLkRNr33Rs6zr7KNJqBFL9DrE6
          account_id: BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp
    WebhookUpdateAcknowledgedWebhook:
      additionalProperties: true
      description: Fired when an Item's webhook is updated. This will be sent to the
        newly specified webhook.
      properties:
        webhook_type:
          description: '`ITEM`'
          type: string
        webhook_code:
          description: '`WEBHOOK_UPDATE_ACKNOWLEDGED`'
          type: string
        item_id:
          description: The `item_id` of the Item associated with this webhook, warning,
            or error
          title: ItemId
          type: string
        new_webhook_url:
          description: The new webhook URL
          type: string
        error:
          $ref: '#/components/schemas/Error'
      required:
      - item_id
      - new_webhook_url
      - webhook_code
      - webhook_type
      title: WebhookUpdateAcknowledgedWebhook
      type: object
      x-examples:
        example-1:
          webhook_type: ITEM
          webhook_code: WEBHOOK_UPDATE_ACKNOWLEDGED
          item_id: wz666MBjYWTp2PDzzggYhM6oWWmBb
          new_webhook_url: https://plaid.com/example/webhook
    PendingExpirationWebhook:
      additionalProperties: true
      description: Fired when an Item’s access consent is expiring in 7 days. Some
        Items have explicit expiration times and we try to relay this when possible
        to reduce service disruption. This can be resolved by having the user go through
        Link’s update mode.
      properties:
        webhook_type:
          description: '`ITEM`'
          type: string
        webhook_code:
          description: '`PENDING_EXPIRATION`'
          type: string
        item_id:
          description: The `item_id` of the Item associated with this webhook, warning,
            or error
          title: ItemId
          type: string
        consent_expiration_time:
          description: The date and time at which the Item's access consent will expire,
            in ISO 8601 format
          type: string
      required:
      - consent_expiration_time
      - item_id
      - webhook_code
      - webhook_type
      title: PendingExpirationWebhook
      type: object
      x-examples:
        example-1:
          webhook_type: ITEM
          webhook_code: PENDING_EXPIRATION
          item_id: wz666MBjYWTp2PDzzggYhM6oWWmBb
          consent_expiration_time: 2020-01-15T13:25:17.766Z
    ItemErrorWebhook:
      additionalProperties: true
      description: Fired when an error is encountered with an Item. The error can
        be resolved by having the user go through Link’s update mode.
      properties:
        webhook_type:
          description: '`ITEM`'
          type: string
        webhook_code:
          description: '`ERROR`'
          type: string
        item_id:
          description: The `item_id` of the Item associated with this webhook, warning,
            or error
          title: ItemId
          type: string
        error:
          $ref: '#/components/schemas/Error'
      required:
      - error
      - item_id
      - webhook_code
      - webhook_type
      title: ItemErrorWebhook
      type: object
      x-examples:
        example-1:
          webhook_type: ITEM
          webhook_code: ERROR
          item_id: wz666MBjYWTp2PDzzggYhM6oWWmBb
          error:
            error_code: ITEM_LOGIN_REQUIRED
            error_message: the login details of this item have changed (credentials,
              MFA, or required user action) and a user login is required to update
              this information. use Link's update mode to restore the item to a good
              state
            error_type: ITEM_ERROR
            status: 400
    ItemProductReadyWebhook:
      additionalProperties: true
      description: Fired once Plaid calculates income from an Item.
      properties:
        webhook_type:
          description: '`INCOME`'
          type: string
        webhook_code:
          description: '`PRODUCT_READY`'
          type: string
        item_id:
          description: The `item_id` of the Item associated with this webhook, warning,
            or error
          title: ItemId
          type: string
        error:
          $ref: '#/components/schemas/Error'
      required:
      - item_id
      - webhook_code
      - webhook_type
      title: ItemProductReadyWebhook
      type: object
      x-examples:
        example-1:
          webhook_type: INCOME
          webhook_code: PRODUCT_READY
          item_id: wz666MBjYWTp2PDzzggYhM6oWWmBb
    Recaptcha_RequiredError:
      additionalProperties: true
      description: The request was flagged by Plaid's fraud system, and requires additional
        verification to ensure they are not a bot.
      properties:
        error_type:
          description: RECAPTCHA_ERROR
          type: string
        error_code:
          description: RECAPTCHA_REQUIRED
          type: string
        display_message:
          type: string
        http_code:
          description: "400"
          type: string
        link_user_experience:
          description: Your user will be prompted to solve a Google reCAPTCHA challenge
            in the Link Recaptcha pane. If they solve the challenge successfully,
            the user's request is resubmitted and they are directed to the next Item
            creation step.
          type: string
        common_causes:
          description: Plaid's fraud system detects abusive traffic and considers
            a variety of parameters throughout Item creation requests. When a request
            is considered risky or possibly fraudulent, Link presents a reCAPTCHA
            for the user to solve.
          type: string
        troubleshooting_steps:
          description: |-
            Link will automatically guide your user through reCAPTCHA verification. As a general rule, we recommend instrumenting basic fraud monitoring to detect and protect your website from spam and abuse.

            If your user cannot verify their session, please submit a Support ticket with the following identifiers: `link_session_id` or `request_id`
          type: string
      required:
      - common_causes
      - display_message
      - error_code
      - error_type
      - http_code
      - link_user_experience
      - troubleshooting_steps
      title: Recaptcha_RequiredError
      type: object
      x-examples:
        example-1:
          error_type: RECAPTCHA_ERROR
          error_code: RECAPTCHA_REQUIRED
          error_message: This request requires additional verification. Please resubmit
            the request after completing the challenge
          http_code: 400
          request_id: HNTDNrA8F1shFEW
    InvestmentsDefaultUpdateWebhook:
      additionalProperties: true
      description: Fired when new or canceled transactions have been detected on an
        investment account.
      properties:
        webhook_type:
          description: '`INVESTMENTS_TRANSACTIONS`'
          type: string
        webhook_code:
          description: '`DEFAULT_UPDATE`'
          type: string
        item_id:
          description: The `item_id` of the Item associated with this webhook, warning,
            or error
          title: ItemId
          type: string
        error:
          $ref: '#/components/schemas/Error'
        new_investments_transactions:
          description: The number of new transactions reported since the last time
            this webhook was fired.
          type: number
        canceled_investments_transactions:
          description: The number of canceled transactions reported since the last
            time this webhook was fired.
          type: number
      required:
      - canceled_investments_transactions
      - item_id
      - new_investments_transactions
      - webhook_code
      - webhook_type
      title: TransactionsUpdateInvestmentsWebhook
      type: object
      x-examples:
        example-1:
          webhook_type: INVESTMENTS_TRANSACTIONS
          webhook_code: DEFAULT_UPDATE
          item_id: wz666MBjYWTp2PDzzggYhM6oWWmBb
          new_investments_transactions: 16
          canceled_investments_transactions: 0
    HoldingsDefaultUpdateWebhook:
      additionalProperties: true
      description: Fired when new or updated holdings have been detected on an investment
        account. The webhook typically fires once per day, after market close, in
        response to any newly added holdings or price changes to existing holdings.
      properties:
        webhook_type:
          description: '`HOLDINGS`'
          type: string
        webhook_code:
          description: '`DEFAULT_UPDATE`'
          type: string
        item_id:
          description: The `item_id` of the Item associated with this webhook, warning,
            or error
          title: ItemId
          type: string
        error:
          $ref: '#/components/schemas/Error'
        new_holdings:
          description: The number of new holdings reported since the last time this
            webhook was fired.
          type: number
        updated_holdings:
          description: The number of updated holdings reported since the last time
            this webhook was fired.
          type: number
      required:
      - item_id
      - new_holdings
      - updated_holdings
      - webhook_code
      - webhook_type
      title: HoldingsDefaultUpdateWebhook
      type: object
      x-examples:
        example-1:
          webhook_type: HOLDINGS
          webhook_code: DEFAULT_UPDATE
          item_id: wz666MBjYWTp2PDzzggYhM6oWWmBb
          new_holdings: 19
          updated_holdings: 0
    AssetsProductReadyWebhook:
      additionalProperties: true
      description: Fired when the Asset Report has been generated and `/asset_report/get`
        is ready to be called.  If you attempt to retrieve an Asset Report before
        this webhook has fired, you’ll receive a response with the HTTP status code
        400 and a Plaid error code of `PRODUCT_NOT_READY`.
      properties:
        webhook_type:
          description: '`ASSETS`'
          type: string
        webhook_code:
          description: '`PRODUCT_READY`'
          type: string
        asset_report_id:
          description: The `asset_report_id` that can be provided to `/asset_report/get`
            to retrieve the Asset Report.
          type: string
      required:
      - asset_report_id
      - webhook_code
      - webhook_type
      title: AssetsProductReadyWebhook
      type: object
      x-examples:
        example-1:
          webhook_type: ASSETS
          webhook_code: PRODUCT_READY
          asset_report_id: 47dfc92b-bba3-4583-809e-ce871b321f05
    AssetsErrorWebhook:
      additionalProperties: true
      description: Fired when Asset Report generation has failed. The resulting `error`
        will have an `error_type` of `ASSET_REPORT_ERROR`.
      properties:
        webhook_type:
          description: '`ASSETS`'
          type: string
        webhook_code:
          description: '`ERROR`'
          type: string
        error:
          $ref: '#/components/schemas/Error'
        asset_report_id:
          description: The ID associated with the Asset Report.
          type: string
      required:
      - asset_report_id
      - error
      - webhook_code
      - webhook_type
      title: AssetsErrorWebhook
      type: object
      x-examples:
        example-1:
          webhook_type: ASSETS
          webhook_code: ERROR
          asset_report_id: 47dfc92b-bba3-4583-809e-ce871b321f05
          error:
            error_code: PRODUCT_NOT_ENABLED
            error_message: 'the ''assets'' product is not enabled for the following
              access tokens: access-sandbox-fb88b20c-7b74-4197-8d01-0ab122dad0bc.
              please ensure that ''assets'' is included in the ''product'' array when
              initializing Link and create the Item(s) again.'
            error_type: ASSET_REPORT_ERROR
            request_id: m8MDnv9okwxFNBV
    Cause:
      additionalProperties: true
      description: An error object and associated `item_id` used to identify a specific
        Item and error when a batch operation operating on multiple Items has encountered
        an error in one of the Items.
      example:
        item_id: item_id
        error:
          error_message: error_message
          suggested_action: suggested_action
          error_type: INVALID_REQUEST
          causes:
          - ""
          - ""
          display_message: display_message
          error_code: error_code
          documentation_url: documentation_url
          request_id: request_id
          status: 0.8008281904610115
      properties:
        item_id:
          description: The `item_id` of the Item associated with this webhook, warning,
            or error
          title: ItemId
          type: string
        error:
          $ref: '#/components/schemas/Error'
      required:
      - error
      - item_id
      title: Cause
      type: object
    Warning:
      additionalProperties: true
      description: It is possible for an Asset Report to be returned with missing
        account owner information. In such cases, the Asset Report will contain warning
        data in the response, indicating why obtaining the owner information failed.
      example:
        warning_type: warning_type
        cause:
          item_id: item_id
          error:
            error_message: error_message
            suggested_action: suggested_action
            error_type: INVALID_REQUEST
            causes:
            - ""
            - ""
            display_message: display_message
            error_code: error_code
            documentation_url: documentation_url
            request_id: request_id
            status: 0.8008281904610115
        warning_code: warning_code
      properties:
        warning_type:
          description: The warning type, which will always be `ASSET_REPORT_WARNING`
          type: string
        warning_code:
          description: The warning code identifies a specific kind of warning. Currently,
            the only possible warning code is `OWNERS_UNAVAILABLE`, which indicates
            that account-owner information is not available.
          type: string
        cause:
          $ref: '#/components/schemas/Cause'
      required:
      - cause
      - warning_code
      - warning_type
      title: Warning
      type: object
      x-examples:
        example-1:
          warning_type: ASSET_REPORT_WARNING
          warning_code: OWNERS_UNAVAILABLE
          cause:
            error_type: ITEM_ERROR
            http_code: 400
            error_code: PRODUCTS_NOT_SUPPORTED
            error_message: 'The following products are not supported by this institution:
              Identity'
            request_id: s32PXYOyplhGTHd
    PaymentAmount:
      additionalProperties: true
      description: The amount and currency of a payment
      example:
        currency: currency
        value: 0.8008281904610115
      properties:
        currency:
          description: The ISO-4217 currency code of the payment amount
          type: string
        value:
          description: The payment amount
          type: number
      required:
      - currency
      - value
      title: PaymentAmount
      type: object
    AssetReportUser:
      additionalProperties: true
      description: The user object allows you to provide additional information about
        the user to be appended to the Asset Report. All fields are optional. The
        `first_name`, `last_name`, and `ssn` fields are required if you would like
        the Report to be eligible for Fannie Mae’s Day 1 Certainty™ program.
      example:
        client_user_id: client_user_id
        last_name: last_name
        phone_number: phone_number
        middle_name: middle_name
        first_name: first_name
        email: email
        ssn: ssn
      properties:
        client_user_id:
          description: An identifier you determine and submit for the user.
          nullable: true
          type: string
        first_name:
          description: The user's first name. Required for the Fannie Mae Day 1 Certainty™
            program.
          nullable: true
          type: string
        middle_name:
          description: The user's middle name
          nullable: true
          type: string
        last_name:
          description: The user's last name.  Required for the Fannie Mae Day 1 Certainty™
            program.
          nullable: true
          type: string
        ssn:
          description: |-
            The user's Social Security Number. Required for the Fannie Mae Day 1 Certainty™ program.

            Format: "ddd-dd-dddd"
          nullable: true
          type: string
        phone_number:
          description: 'The user''s phone number, in E.164 format: +{countrycode}{number}.
            For example: "+14151234567"'
          nullable: true
          type: string
        email:
          description: The user's email address.
          nullable: true
          type: string
      title: AssetReportUser
      type: object
    AssetReportId:
      description: A unique ID identifying an Asset Report. Like all Plaid identifiers,
        this ID is case sensitive.
      title: AssetReportId
      type: string
    AssetReportToken:
      description: A token that can be provided to endpoints such as `/asset_report/get`
        or `/asset_report/pdf/get` to fetch or update an Asset Report.
      title: AssetReportToken
      type: string
    AssetReportRefreshAssetReportToken:
      description: The `asset_report_token` returned by the original call to `/asset_report/create`
      title: AssetReportRefreshAssetReportToken
      type: string
    StandaloneCurrencyCodeList:
      additionalProperties: true
      description: The following currency codes are supported by Plaid.
      properties:
        iso_currency_code:
          description: Plaid supports all ISO 4217 currency codes.
          type: string
        unofficial_currency_code:
          description: List of unofficial currency codes
          properties:
            ADA:
              description: Cardano
              type: string
            BAT:
              description: Basic Attention Token
              type: string
            BCH:
              description: Bitcoin Cash
              type: string
            BNB:
              description: Binance Coin
              type: string
            BTC:
              description: Bitcoin
              type: string
            BTG:
              description: Bitcoin Gold
              type: string
            CNH:
              description: Chinese Yuan (offshore)
              type: string
            DASH:
              description: Dash
              type: string
            DOGE:
              description: Dogecoin
              type: string
            ETC:
              description: Ethereum Classic
              type: string
            ETH:
              description: Ethereum
              type: string
            GBX:
              description: Pence sterling, i.e. British penny
              type: string
            LSK:
              description: Lisk
              type: string
            NEO:
              description: Neo
              type: string
            OMG:
              description: OmiseGO
              type: string
            QTUM:
              description: Qtum
              type: string
            USDT:
              description: TehterUS
              type: string
            XLM:
              description: Stellar Lumen
              type: string
            XMR:
              description: Monero
              type: string
            XRP:
              description: Ripple
              type: string
            ZEC:
              description: Zcash
              type: string
            ZRX:
              description: 0x
              type: string
          required:
          - ADA
          - BAT
          - BCH
          - BNB
          - BTC
          - BTG
          - CNH
          - DASH
          - DOGE
          - ETC
          - ETH
          - GBX
          - LSK
          - NEO
          - OMG
          - QTUM
          - USDT
          - XLM
          - XMR
          - XRP
          - ZEC
          - ZRX
          title: UnofficialCurrencyCodeList
          type: string
      required:
      - iso_currency_code
      - unofficial_currency_code
      title: StandaloneCurrencyCodeList
      type: object
    UnofficialCurrencyCodeList:
      description: List of unofficial currency codes
      properties:
        ADA:
          description: Cardano
          type: string
        BAT:
          description: Basic Attention Token
          type: string
        BCH:
          description: Bitcoin Cash
          type: string
        BNB:
          description: Binance Coin
          type: string
        BTC:
          description: Bitcoin
          type: string
        BTG:
          description: Bitcoin Gold
          type: string
        CNH:
          description: Chinese Yuan (offshore)
          type: string
        DASH:
          description: Dash
          type: string
        DOGE:
          description: Dogecoin
          type: string
        ETC:
          description: Ethereum Classic
          type: string
        ETH:
          description: Ethereum
          type: string
        GBX:
          description: Pence sterling, i.e. British penny
          type: string
        LSK:
          description: Lisk
          type: string
        NEO:
          description: Neo
          type: string
        OMG:
          description: OmiseGO
          type: string
        QTUM:
          description: Qtum
          type: string
        USDT:
          description: TehterUS
          type: string
        XLM:
          description: Stellar Lumen
          type: string
        XMR:
          description: Monero
          type: string
        XRP:
          description: Ripple
          type: string
        ZEC:
          description: Zcash
          type: string
        ZRX:
          description: 0x
          type: string
      required:
      - ADA
      - BAT
      - BCH
      - BNB
      - BTC
      - BTG
      - CNH
      - DASH
      - DOGE
      - ETC
      - ETH
      - GBX
      - LSK
      - NEO
      - OMG
      - QTUM
      - USDT
      - XLM
      - XMR
      - XRP
      - ZEC
      - ZRX
      title: UnofficialCurrencyCodeList
      type: string
    StandaloneAccountType:
      additionalProperties: true
      description: The schema below describes the various `types` and corresponding
        `subtypes` that Plaid recognizes and reports for financial institution accounts.
      properties:
        depository:
          description: 'An account type holding cash, in which funds are deposited.
            Supported products for `depository` accounts are: Auth, Balance, Transactions,
            Identity, Payment Initiation, and Assets.'
          properties:
            checking:
              description: Checking account
              type: string
            savings:
              description: Savings account
              type: string
            hsa:
              description: Health Savings Account (US only) that can only hold cash
              type: string
            cd:
              description: Certificate of deposit account
              type: string
            money market:
              description: Money market account
              type: string
            paypal:
              description: PayPal depository account
              type: string
            prepaid:
              description: Prepaid debit card
              type: string
            cash management:
              description: A cash management account, typically a cash account at
                a brokerage
              type: string
            ebt:
              description: An Electronic Benefit Transfer (EBT) account, used by certain
                public assistance programs to distribute funds (US only)
              type: string
          required:
          - cash management
          - cd
          - checking
          - ebt
          - hsa
          - money market
          - paypal
          - prepaid
          - savings
          title: DepositoryAccount
          type: string
        credit:
          description: 'A credit card type account. Supported products for `credit`
            accounts are: Balance, Transactions, Identity, and Liabilities.'
          properties:
            credit card:
              description: Bank-issued credit card
              type: string
            paypal:
              description: PayPal-issued credit card
              type: string
          required:
          - credit card
          - paypal
          title: CreditAccount
          type: string
        loan:
          description: 'A loan type account. Supported products for `loan` accounts
            are: Balance, Liabilities, and Transactions.'
          properties:
            auto:
              description: Auto loan
              type: string
            commercial:
              description: Commercial loan
              type: string
            construction:
              description: Construction loan
              type: string
            consumer:
              description: Consumer loan
              type: string
            home equity:
              description: Home Equity Line of Credit (HELOC)
              type: string
            loan:
              description: General loan
              type: string
            mortgage:
              description: Mortgage loan
              type: string
            overdraft:
              description: Pre-approved overdraft account, usually tied to a checking
                account
              type: string
            line of credit:
              description: Pre-approved line of credit
              type: string
            student:
              description: Student loan
              type: string
            other:
              description: Other loan type or unknown loan type
              type: string
          required:
          - auto
          - commercial
          - construction
          - consumer
          - home equity
          - line of credit
          - loan
          - mortgage
          - other
          - overdraft
          - student
          title: LoanAccount
          type: string
        investment:
          description: 'An investment account. Supported products for `investment`
            accounts are: Balance and Investments.'
          properties:
            "529":
              description: |
                Tax-advantaged college savings and prepaid tuition 529 plans (US)
              type: string
            "401a":
              description: Employer-sponsored money-purchase 401(a) retirement plan
                (US)
              type: string
            "401k":
              description: Standard 401(k) retirement account (US)
              type: string
            "403b":
              description: 403(b) retirement savings account for non-profits and schools
                (US)
              type: string
            "457b":
              description: Tax-advantaged deferred-compensation 457(b) retirement
                plan for governments and non-profits (US)
              type: string
            brokerage:
              description: Standard brokerage account
              type: string
            cash isa:
              description: Individual Savings Account (ISA) that pays interest tax-free
                (UK)
              type: string
            education savings account:
              description: Tax-advantaged Coverdell Education Savings Account (ESA)
                (US)
              type: string
            fixed annuity:
              description: Fixed annuity
              type: string
            gic:
              description: Guaranteed Investment Certificate (Canada)
              type: string
            health reimbursement arrangement:
              description: Tax-advantaged Health Reimbursement Arrangement (HRA) benefit
                plan (US)
              type: string
            hsa:
              description: |
                Non-cash tax-advantaged medical Health Savings Account (HSA) (US)
              type: string
            ira:
              description: Traditional Invididual Retirement Account (IRA) (US)
              type: string
            isa:
              description: Non-cash Individual Savings Account (ISA) (UK)
              type: string
            keogh:
              description: Keogh self-employed retirement plan (US)
              type: string
            lif:
              description: |
                Life Income Fund (LIF) retirement account (Canada)
              type: string
            lira:
              description: Locked-in Retirement Account (LIRA) (Canada)
              type: string
            lrif:
              description: Locked-in Retirement Income Fund (LRIF) (Canada)
              type: string
            lrsp:
              description: Locked-in Retirement Savings Plan (Canada)
              type: string
            mutual fund:
              description: Mutual fund account
              type: string
            "non-taxable brokerage account\t":
              description: A non-taxable brokerage account that is not covered by
                a more specific subtype
              type: string
            pension:
              description: Standard pension account
              type: string
            prif:
              description: Prescribed Registered Retirement Income Fund (Canada)
              type: string
            profit sharing plan:
              description: Plan that gives employees share of company profits
              type: string
            qshr:
              description: Qualifying share account
              type: string
            rdsp:
              description: Registered Disability Savings Plan (RSDP) (Canada)
              type: string
            resp:
              description: Registered Education Savings Plan (Canada)
              type: string
            retirement:
              description: Retirement account not covered by other subtypes
              type: string
            rlif:
              description: Restricted Life Income Fund (RLIF) (Canada)
              type: string
            roth:
              description: Roth IRA (US)
              type: string
            roth 401k:
              description: Employer-sponsored Roth 401(k) plan (US)
              type: string
            rrif:
              description: Registered Retirement Income Fund (RRIF) (Canada)
              type: string
            rrsp:
              description: Registered Retirement Savings Plan (Canadian, similar to
                US 401(k))
              type: string
            sarsep:
              description: Salary Reduction Simplified Employee Pension Plan (SARSEP),
                discontinued retirement plan (US)
              type: string
            sep ira:
              description: Simplified Employee Pension IRA (SEP IRA), retirement plan
                for small businesses and self-employed (US)
              type: string
            simple ira:
              description: Savings Incentive Match Plan for Employees IRA, retirement
                plan for small businesses (US)
              type: string
            sipp:
              description: Self-Invested Personal Pension (SIPP) (UK)
              type: string
            stock plan:
              description: Standard stock plan account
              type: string
            tfsa:
              description: Tax-Free Savings Account (TFSA), a retirement plan similar
                to a Roth IRA (Canada)
              type: string
            trust:
              description: Account representing funds or assets held by a trustee
                for the benefit of a beneficiary. Includes both revocable and irrevocable
                trusts.
              type: string
            ugma:
              description: '''Uniform Gift to Minors Act'' (brokerage account for
                minors, US)'
              type: string
            utma:
              description: |
                'Uniform Transfers to Minors Act' (brokerage account for minors, US)
              type: string
            variable annuity:
              description: Tax-deferred capital accumulation annuity contract
              type: string
          required:
          - 401a
          - 401k
          - 403b
          - 457b
          - "529"
          - brokerage
          - cash isa
          - education savings account
          - fixed annuity
          - gic
          - health reimbursement arrangement
          - hsa
          - ira
          - isa
          - keogh
          - lif
          - lira
          - lrif
          - lrsp
          - mutual fund
          - "non-taxable brokerage account\t"
          - pension
          - prif
          - profit sharing plan
          - qshr
          - rdsp
          - resp
          - retirement
          - rlif
          - roth
          - roth 401k
          - rrif
          - rrsp
          - sarsep
          - sep ira
          - simple ira
          - sipp
          - stock plan
          - tfsa
          - trust
          - ugma
          - utma
          title: InvestmentAccountSubtype
          type: string
        other:
          description: 'Other or unknown account type. Supported products for `other`
            accounts are: Balance, Transactions, Identity, and Assets.'
          type: string
      required:
      - credit
      - depository
      - investment
      - loan
      - other
      title: StandaloneAccountType
      type: object
    DepositoryAccount:
      description: 'An account type holding cash, in which funds are deposited. Supported
        products for `depository` accounts are: Auth, Balance, Transactions, Identity,
        Payment Initiation, and Assets.'
      properties:
        checking:
          description: Checking account
          type: string
        savings:
          description: Savings account
          type: string
        hsa:
          description: Health Savings Account (US only) that can only hold cash
          type: string
        cd:
          description: Certificate of deposit account
          type: string
        money market:
          description: Money market account
          type: string
        paypal:
          description: PayPal depository account
          type: string
        prepaid:
          description: Prepaid debit card
          type: string
        cash management:
          description: A cash management account, typically a cash account at a brokerage
          type: string
        ebt:
          description: An Electronic Benefit Transfer (EBT) account, used by certain
            public assistance programs to distribute funds (US only)
          type: string
      required:
      - cash management
      - cd
      - checking
      - ebt
      - hsa
      - money market
      - paypal
      - prepaid
      - savings
      title: DepositoryAccount
      type: string
    CreditAccount:
      description: 'A credit card type account. Supported products for `credit` accounts
        are: Balance, Transactions, Identity, and Liabilities.'
      properties:
        credit card:
          description: Bank-issued credit card
          type: string
        paypal:
          description: PayPal-issued credit card
          type: string
      required:
      - credit card
      - paypal
      title: CreditAccount
      type: string
    LoanAccount:
      description: 'A loan type account. Supported products for `loan` accounts are:
        Balance, Liabilities, and Transactions.'
      properties:
        auto:
          description: Auto loan
          type: string
        commercial:
          description: Commercial loan
          type: string
        construction:
          description: Construction loan
          type: string
        consumer:
          description: Consumer loan
          type: string
        home equity:
          description: Home Equity Line of Credit (HELOC)
          type: string
        loan:
          description: General loan
          type: string
        mortgage:
          description: Mortgage loan
          type: string
        overdraft:
          description: Pre-approved overdraft account, usually tied to a checking
            account
          type: string
        line of credit:
          description: Pre-approved line of credit
          type: string
        student:
          description: Student loan
          type: string
        other:
          description: Other loan type or unknown loan type
          type: string
      required:
      - auto
      - commercial
      - construction
      - consumer
      - home equity
      - line of credit
      - loan
      - mortgage
      - other
      - overdraft
      - student
      title: LoanAccount
      type: string
    InvestmentAccountSubtype:
      description: 'An investment account. Supported products for `investment` accounts
        are: Balance and Investments.'
      properties:
        "529":
          description: |
            Tax-advantaged college savings and prepaid tuition 529 plans (US)
          type: string
        "401a":
          description: Employer-sponsored money-purchase 401(a) retirement plan (US)
          type: string
        "401k":
          description: Standard 401(k) retirement account (US)
          type: string
        "403b":
          description: 403(b) retirement savings account for non-profits and schools
            (US)
          type: string
        "457b":
          description: Tax-advantaged deferred-compensation 457(b) retirement plan
            for governments and non-profits (US)
          type: string
        brokerage:
          description: Standard brokerage account
          type: string
        cash isa:
          description: Individual Savings Account (ISA) that pays interest tax-free
            (UK)
          type: string
        education savings account:
          description: Tax-advantaged Coverdell Education Savings Account (ESA) (US)
          type: string
        fixed annuity:
          description: Fixed annuity
          type: string
        gic:
          description: Guaranteed Investment Certificate (Canada)
          type: string
        health reimbursement arrangement:
          description: Tax-advantaged Health Reimbursement Arrangement (HRA) benefit
            plan (US)
          type: string
        hsa:
          description: |
            Non-cash tax-advantaged medical Health Savings Account (HSA) (US)
          type: string
        ira:
          description: Traditional Invididual Retirement Account (IRA) (US)
          type: string
        isa:
          description: Non-cash Individual Savings Account (ISA) (UK)
          type: string
        keogh:
          description: Keogh self-employed retirement plan (US)
          type: string
        lif:
          description: |
            Life Income Fund (LIF) retirement account (Canada)
          type: string
        lira:
          description: Locked-in Retirement Account (LIRA) (Canada)
          type: string
        lrif:
          description: Locked-in Retirement Income Fund (LRIF) (Canada)
          type: string
        lrsp:
          description: Locked-in Retirement Savings Plan (Canada)
          type: string
        mutual fund:
          description: Mutual fund account
          type: string
        "non-taxable brokerage account\t":
          description: A non-taxable brokerage account that is not covered by a more
            specific subtype
          type: string
        pension:
          description: Standard pension account
          type: string
        prif:
          description: Prescribed Registered Retirement Income Fund (Canada)
          type: string
        profit sharing plan:
          description: Plan that gives employees share of company profits
          type: string
        qshr:
          description: Qualifying share account
          type: string
        rdsp:
          description: Registered Disability Savings Plan (RSDP) (Canada)
          type: string
        resp:
          description: Registered Education Savings Plan (Canada)
          type: string
        retirement:
          description: Retirement account not covered by other subtypes
          type: string
        rlif:
          description: Restricted Life Income Fund (RLIF) (Canada)
          type: string
        roth:
          description: Roth IRA (US)
          type: string
        roth 401k:
          description: Employer-sponsored Roth 401(k) plan (US)
          type: string
        rrif:
          description: Registered Retirement Income Fund (RRIF) (Canada)
          type: string
        rrsp:
          description: Registered Retirement Savings Plan (Canadian, similar to US
            401(k))
          type: string
        sarsep:
          description: Salary Reduction Simplified Employee Pension Plan (SARSEP),
            discontinued retirement plan (US)
          type: string
        sep ira:
          description: Simplified Employee Pension IRA (SEP IRA), retirement plan
            for small businesses and self-employed (US)
          type: string
        simple ira:
          description: Savings Incentive Match Plan for Employees IRA, retirement
            plan for small businesses (US)
          type: string
        sipp:
          description: Self-Invested Personal Pension (SIPP) (UK)
          type: string
        stock plan:
          description: Standard stock plan account
          type: string
        tfsa:
          description: Tax-Free Savings Account (TFSA), a retirement plan similar
            to a Roth IRA (Canada)
          type: string
        trust:
          description: Account representing funds or assets held by a trustee for
            the benefit of a beneficiary. Includes both revocable and irrevocable
            trusts.
          type: string
        ugma:
          description: '''Uniform Gift to Minors Act'' (brokerage account for minors,
            US)'
          type: string
        utma:
          description: |
            'Uniform Transfers to Minors Act' (brokerage account for minors, US)
          type: string
        variable annuity:
          description: Tax-deferred capital accumulation annuity contract
          type: string
      required:
      - 401a
      - 401k
      - 403b
      - 457b
      - "529"
      - brokerage
      - cash isa
      - education savings account
      - fixed annuity
      - gic
      - health reimbursement arrangement
      - hsa
      - ira
      - isa
      - keogh
      - lif
      - lira
      - lrif
      - lrsp
      - mutual fund
      - "non-taxable brokerage account\t"
      - pension
      - prif
      - profit sharing plan
      - qshr
      - rdsp
      - resp
      - retirement
      - rlif
      - roth
      - roth 401k
      - rrif
      - rrsp
      - sarsep
      - sep ira
      - simple ira
      - sipp
      - stock plan
      - tfsa
      - trust
      - ugma
      - utma
      title: InvestmentAccountSubtype
      type: string
    AssetReport:
      additionalProperties: true
      description: An object representing an Asset Report
      example:
        date_generated: date_generated
        client_report_id: client_report_id
        user:
          client_user_id: client_user_id
          last_name: last_name
          phone_number: phone_number
          middle_name: middle_name
          first_name: first_name
          email: email
          ssn: ssn
        items:
        - item_id: item_id
          accounts:
          - null
          - null
          institution_name: institution_name
          institution_id: institution_id
          date_last_updated: date_last_updated
        - item_id: item_id
          accounts:
          - null
          - null
          institution_name: institution_name
          institution_id: institution_id
          date_last_updated: date_last_updated
        asset_report_id: asset_report_id
        days_requested: 0.8008281904610115
      properties:
        asset_report_id:
          description: A unique ID identifying an Asset Report. Like all Plaid identifiers,
            this ID is case sensitive.
          title: AssetReportId
          type: string
        client_report_id:
          description: An identifier you determine and submit for the Asset Report.
          type: string
        date_generated:
          description: The date and time when the Asset Report was created, in ISO
            8601 format (e.g. "2018-04-12T03:32:11Z").
          type: string
        days_requested:
          description: The duration of transaction history you requested
          type: number
        user:
          $ref: '#/components/schemas/AssetReportUser'
        items:
          description: Data returned by Plaid about each of the Items included in
            the Asset Report.
          items:
            $ref: '#/components/schemas/AssetReportItem'
          type: array
      required:
      - asset_report_id
      - client_report_id
      - date_generated
      - days_requested
      - items
      - user
      title: AssetReport
      type: object
    AssetReportItem:
      additionalProperties: true
      description: A representation of an Item within an Asset Report.
      example:
        item_id: item_id
        accounts:
        - null
        - null
        institution_name: institution_name
        institution_id: institution_id
        date_last_updated: date_last_updated
      properties:
        item_id:
          description: The `item_id` of the Item associated with this webhook, warning,
            or error
          title: ItemId
          type: string
        institution_name:
          description: The full financial institution name associated with the Item.
          type: string
        institution_id:
          description: The id of the financial institution associated with the Item.
          type: string
        date_last_updated:
          description: The date and time when this Item’s data was last retrieved
            from the financial institution, in ISO 8601 format.
          type: string
        accounts:
          description: Data about each of the accounts open on the Item.
          items:
            $ref: '#/components/schemas/AccountAssets'
          type: array
      required:
      - accounts
      - date_last_updated
      - institution_id
      - institution_name
      - item_id
      title: AssetReportItem
      type: object
    PaymentStatusUpdateWebhook:
      additionalProperties: true
      description: Fired when the status of a payment has changed.
      properties:
        webhook_type:
          description: '`PAYMENT_INITIATION`'
          type: string
        webhook_code:
          description: '`PAYMENT_STATUS_UPDATE`'
          type: string
        payment_id:
          description: The `payment_id` for the payment being updated
          type: string
        new_payment_status:
          description: |-
            The new status of the payment.

            `PAYMENT_STATUS_INPUT_NEEDED`: This is the initial state of all payments. It indicates that the payment is waiting on user input to continue processing. A payment may re-enter this state later on if further input is needed.

            `PAYMENT_STATUS_PROCESSING`: The payment is currently being processed. The payment will automatically exit this state when processing is complete.

            `PAYMENT_STATUS_INITIATED`: The payment has been successfully initiated and is considered complete.

            `PAYMENT_STATUS_COMPLETED`: Indicates that the standing order has been successfully established. This state is only used for standing orders.

            `PAYMENT_STATUS_INSUFFICIENT_FUNDS`: The payment has failed due to insufficient funds.

            `PAYMENT_STATUS_FAILED`: The payment has failed to be initiated. This error is retryable once the root cause is resolved.

            `PAYMENT_STATUS_BLOCKED`: The payment has been blocked. This is a retryable error.

            `PAYMENT_STATUS_UNKNOWN`: The payment status is unknown.
          enum:
          - PAYMENT_STATUS_INPUT_NEEDED
          - PAYMENT_STATUS_PROCESSING
          - PAYMENT_STATUS_INITIATED
          - PAYMENT_STATUS_COMPLETED
          - PAYMENT_STATUS_INSUFFICIENT_FUNDS
          - PAYMENT_STATUS_FAILED
          - PAYMENT_STATUS_BLOCKED
          - PAYMENT_STATUS_UNKNOWN
          type: string
        old_payment_status:
          description: |-
            The previous status of the payment.

            `PAYMENT_STATUS_INPUT_NEEDED`: This is the initial state of all payments. It indicates that the payment is waiting on user input to continue processing. A payment may re-enter this state later on if further input is needed.

            `PAYMENT_STATUS_PROCESSING`: The payment is currently being processed. The payment will automatically exit this state when processing is complete.

            `PAYMENT_STATUS_INITIATED`: The payment has been successfully initiated and is considered complete.

            `PAYMENT_STATUS_COMPLETED`: Indicates that the standing order has been successfully established. This state is only used for standing orders.

            `PAYMENT_STATUS_INSUFFICIENT_FUNDS`: The payment has failed due to insufficient funds.

            `PAYMENT_STATUS_FAILED`: The payment has failed to be initiated. This error is retryable once the root cause is resolved.

            `PAYMENT_STATUS_BLOCKED`: The payment has been blocked. This is a retryable error.

            `PAYMENT_STATUS_UNKNOWN`: The payment status is unknown.
          enum:
          - PAYMENT_STATUS_INPUT_NEEDED
          - PAYMENT_STATUS_PROCESSING
          - PAYMENT_STATUS_INITIATED
          - PAYMENT_STATUS_COMPLETED
          - PAYMENT_STATUS_INSUFFICIENT_FUNDS
          - PAYMENT_STATUS_FAILED
          - PAYMENT_STATUS_BLOCKED
          - PAYMENT_STATUS_UNKNOWN
          type: string
        original_reference:
          description: The original value of the reference when creating the payment.
          nullable: true
          type: string
        adjusted_reference:
          description: The value of the reference sent to the bank after adjustment
            to pass bank validation rules.
          nullable: true
          type: string
        original_start_date:
          description: The original value of the `start_date` provided during the
            creation of a standing order. If the payment is not a standing order,
            this field will be `null`.
          format: date
          nullable: true
          type: string
        adjusted_start_date:
          description: The start date sent to the bank after adjusting for holidays
            or weekends.  Will be provided in ISO 8601 format (YYYY-MM-DD). If the
            start date did not require adjustment, or if the payment is not a standing
            order, this field will be `null`.
          format: date
          nullable: true
          type: string
        timestamp:
          description: The timestamp of the update, in ISO 8601 format, e.g. `"2017-09-14T14:42:19.350Z"`
          type: string
        error:
          $ref: '#/components/schemas/Error'
      required:
      - new_payment_status
      - old_payment_status
      - payment_id
      - timestamp
      - webhook_code
      - webhook_type
      title: PaymentStatusUpdateWebhook
      type: object
      x-examples:
        example-1:
          webhook_type: PAYMENT_INITIATION
          webhook_code: PAYMENT_STATUS_UPDATE
          payment_id: payment-id-production-2ba30780-d549-4335-b1fe-c2a938aa39d2
          new_payment_status: PAYMENT_STATUS_INITIATED
          old_payment_status: PAYMENT_STATUS_PROCESSING
          original_reference: Account Funding 99744
          adjusted_reference: Account Funding 99
          original_start_date: 2017-09-14
          adjusted_start_date: 2017-09-15
          timestamp: 2017-09-14T14:42:19.350Z
    Holding:
      additionalProperties: true
      description: A securities holding at an institution.
      example:
        cost_basis: 1.4658129805029452
        unofficial_currency_code: unofficial_currency_code
        institution_price: 0.8008281904610115
        account_id: account_id
        quantity: 5.962133916683182
        institution_value: 6.027456183070403
        iso_currency_code: iso_currency_code
        institution_price_as_of: institution_price_as_of
        security_id: security_id
      properties:
        account_id:
          description: The Plaid `account_id` associated with the holding.
          type: string
        security_id:
          description: The Plaid `security_id` associated with the holding.
          type: string
        institution_price:
          description: The last price given by the institution for this security.
          type: number
        institution_price_as_of:
          description: The date at which `institution_price` was current.
          nullable: true
          type: string
        institution_value:
          description: The value of the holding, as reported by the institution.
          type: number
        cost_basis:
          description: The cost basis of the holding.
          nullable: true
          type: number
        quantity:
          description: The total quantity of the asset held, as reported by the financial
            institution.
          type: number
        iso_currency_code:
          description: The ISO-4217 currency code of the holding. Always `null` if
            `unofficial_currency_code` is non-`null`.
          nullable: true
          type: string
        unofficial_currency_code:
          description: |
            The unofficial currency code associated with the holding. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.

            See the [currency code schema](/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.
          nullable: true
          type: string
      required:
      - account_id
      - institution_price
      - institution_value
      - quantity
      - security_id
      title: Holding
      type: object
    Security:
      additionalProperties: true
      description: Contains details about a security
      example:
        unofficial_currency_code: unofficial_currency_code
        cusip: cusip
        ticker_symbol: ticker_symbol
        institution_security_id: institution_security_id
        close_price_as_of: close_price_as_of
        sedol: sedol
        type: type
        institution_id: institution_id
        close_price: 5.637376656633329
        proxy_security_id: proxy_security_id
        name: name
        iso_currency_code: iso_currency_code
        is_cash_equivalent: true
        security_id: security_id
        isin: isin
      properties:
        security_id:
          description: A unique, Plaid-specific identifier for the security, used
            to associate securities with holdings. Like all Plaid identifiers, the
            `security_id` is case sensitive.
          type: string
        isin:
          description: 12-character ISIN, a globally unique securities identifier.
          nullable: true
          type: string
        cusip:
          description: 9-character CUSIP, an identifier assigned to North American
            securities.
          nullable: true
          type: string
        sedol:
          description: 7-character SEDOL, an identifier assigned to securities in
            the UK.
          nullable: true
          type: string
        institution_security_id:
          description: An identifier given to the security by the institution
          nullable: true
          type: string
        institution_id:
          description: If `institution_security_id` is present, this field indicates
            the Plaid `institution_id` of the institution to whom the identifier belongs.
          nullable: true
          type: string
        proxy_security_id:
          description: In certain cases, Plaid will provide the ID of another security
            whose performance resembles this security, typically when the original
            security has low volume, or when a private security can be modeled with
            a publicly traded security.
          nullable: true
          type: string
        name:
          description: A descriptive name for the security, suitable for display.
          nullable: true
          type: string
        ticker_symbol:
          description: The security’s trading symbol for publicly traded securities,
            and otherwise a short identifier if available.
          nullable: true
          type: string
        is_cash_equivalent:
          description: Indicates that a security is a highly liquid asset and can
            be treated like cash.
          type: boolean
        type:
          description: |-
            The security type of the holding. Valid security types are:

            `cash`: Cash, currency, and money market funds

            `derivative`: Options, warrants, and other derivative instruments

            `equity`: Domestic and foreign equities

            `etf`: Multi-asset exchange-traded investment funds

            `fixed income`: Bonds and certificates of deposit (CDs)

            `loan`: Loans and loan receivables.

            `mutual fund`: Open- and closed-end vehicles pooling funds of multiple investors.

            `other`: Unknown or other investment types
          type: string
        close_price:
          description: Price of the security at the close of the previous trading
            session. `null` for non-public securities.
          nullable: true
          type: number
        close_price_as_of:
          description: Date for which `close_price` is accurate. Always `null` if
            `close_price` is `null`.
          nullable: true
          type: string
        iso_currency_code:
          description: The ISO-4217 currency code of the price given. Always `null`
            if `unofficial_currency_code` is non-`null`.
          nullable: true
          type: string
        unofficial_currency_code:
          description: |-
            The unofficial currency code associated with the security. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.

            See the [currency code schema](/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.
          nullable: true
          type: string
      required:
      - security_id
      - type
      title: Security
      type: object
    InvestmentTransaction:
      additionalProperties: true
      description: A transaction within an investment account.
      example:
        date: date
        unofficial_currency_code: unofficial_currency_code
        amount: 6.027456183070403
        fees: 5.962133916683182
        quantity: 0.8008281904610115
        type: buy
        cancel_transaction_id: cancel_transaction_id
        account_id: account_id
        subtype: account fee
        investment_transaction_id: investment_transaction_id
        price: 1.4658129805029452
        name: name
        iso_currency_code: iso_currency_code
        security_id: security_id
      properties:
        investment_transaction_id:
          description: The ID of the Investment transaction, unique across all Plaid
            transactions. Like all Plaid identifiers, the `investment_transaction_id`
            is case sensitive.
          type: string
        cancel_transaction_id:
          nullable: true
          type: string
        account_id:
          description: The `account_id` of the account against which this transaction
            posted.
          type: string
        security_id:
          description: The `security_id` to which this transaction is related.
          nullable: true
          type: string
        date:
          description: The ISO-8601 posting date for the transaction, or transacted
            date for pending transactions.
          type: string
        name:
          description: The institution’s description of the transaction.
          type: string
        quantity:
          description: The number of units of the security involved in this transactions
          type: number
        amount:
          description: The complete value of the transaction. Positive values when
            cash is debited, e.g. purchases of stock; negative values when cash is
            credited, e.g. sales of stock. Treatment remains the same for cash-only
            movements unassociated with securities.
          type: number
        price:
          description: The price of the security at which this transaction occurred.
          type: number
        fees:
          description: The combined value of all fees applied to this transaction
          nullable: true
          type: number
        type:
          description: |-
            Value is one of the following:
            `buy`: Buying an investment
            `sell`: Selling an investment
            `cancel`: A cancellation of a pending transaction
             `cash`: Activity that modifies a cash position
            `fee`: A fee on the account
            `transfer`: Activity which modifies a position, but not through buy/sell activity e.g. options exercise, portfolio transfer
          enum:
          - buy
          - sell
          - cancel
          - cash
          - fee
          - transfer
          type: string
        subtype:
          description: For descriptions of possible transaction subtypes, see [Investment
            transaction subtypes schema](/docs/api/accounts/#investment-transaction-subtypes-schema).
          enum:
          - account fee
          - assignment
          - buy
          - buy to cover
          - contribution
          - deposit
          - distribution
          - dividend
          - dividend reinvestment
          - exercise
          - expire
          - fund fee
          - interest
          - interest receivable
          - interest reinvestment
          - legal fee
          - loan payment
          - long-term capital gain
          - long-term capital gain reinvestment
          - management fee
          - margin expense
          - merger
          - miscellaneous fee
          - non-qualified dividend
          - non-resident tax
          - pending credit
          - pending debit
          - qualified dividend
          - rebalance
          - return of principal
          - sell
          - sell short
          - short-term capital gain
          - short-term capital gain reinvestment
          - spin off
          - split
          - stock distribution
          - tax
          - tax withheld
          - transfer
          - transfer fee
          - trust fee
          - unqualified gain
          - withdrawal
          type: string
        iso_currency_code:
          description: The ISO-4217 currency code of the transaction. Always `null`
            if `unofficial_currency_code` is non-`null`.
          nullable: true
          type: string
        unofficial_currency_code:
          description: |-
            The unofficial currency code associated with the holding. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.

            See the [currency code schema](/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.
          nullable: true
          type: string
      required:
      - account_id
      - amount
      - date
      - investment_transaction_id
      - name
      - price
      - quantity
      - subtype
      - type
      title: InvestmentTransaction
      type: object
    StandaloneInvestmentTransactionType:
      additionalProperties: true
      description: Valid values for investment transaction types
      properties:
        buy:
          description: Buying an investment
          type: string
        sell:
          description: Selling an investment
          type: string
        cancel:
          description: A cancellation of a pending transaction
          type: string
        cash:
          description: Activity that modifies a cash position
          type: string
        fee:
          description: Fees on the account, e.g. commission, bookkeeping, options-related.
          type: string
        transfer:
          description: Activity which modifies a position, but not through buy/sell
            activity e.g. options exercise, portfolio transfer
          type: string
      required:
      - buy
      - cancel
      - cash
      - fee
      - sell
      - transfer
      title: StandaloneInvestmentTransactionType
      type: object
    StandaloneInvestmentTransactionSubtype:
      additionalProperties: true
      description: Valid subtypes for Investment transaction subtypes. Note that transactions
        representing inflow of cash will appear as negative amounts, outflow of cash
        will appear as positive amounts.
      properties:
        account fee:
          description: Fees paid for account maintenance
          type: string
        assignment:
          description: Assignment of short option holding
          type: string
        buy:
          description: Purchase to open or increase a position
          type: string
        buy to cover:
          description: Purchase to close a short position
          type: string
        contribution:
          description: Inflow of assets into a tax-advantaged account
          type: string
        deposit:
          description: Inflow of cash into an account
          type: string
        distribution:
          description: Outflow of assets from a tax-advantaged account
          type: string
        dividend:
          description: Inflow of cash from a dividend
          type: string
        dividend reinvestment:
          description: Purchase using proceeds from a cash dividend
          type: string
        exercise:
          description: Exercise of an option or warrant contract
          type: string
        expire:
          description: |
            Expiration of an option or warrant contract
          type: string
        fund fee:
          description: Fees paid for administration of a mutual fund or other pooled
            investment vehicle
          type: string
        interest:
          description: Inflow of cash from interest
          type: string
        interest receivable:
          description: Inflow of cash from interest receivable
          type: string
        interest reinvestment:
          description: Purchase using proceeds from a cash interest payment
          type: string
        legal fee:
          description: Fees paid for legal charges or services
          type: string
        loan payment:
          description: Inflow of cash related to payment on a loan
          type: string
        long-term capital gain:
          description: Long-term capital gain received as cash
          type: string
        long-term capital gain reinvestment:
          description: Purchase using long-term capital gain cash proceeds
          type: string
        management fee:
          description: Fees paid for investment management of a mutual fund or other
            pooled investment vehicle
          type: string
        margin expense:
          description: Fees paid for maintaining margin debt
          type: string
        merger:
          description: Stock exchanged at a pre-defined ratio as part of a merger
            between companies
          type: string
        miscellaneous fee:
          description: Fee associated with various account or holding actions
          type: string
        non-qualified dividend:
          description: Inflow of cash from a non-qualified dividend
          type: string
        non-resident tax:
          description: Taxes paid on behalf of the investor for non-residency in investment
            jurisdiction
          type: string
        pending credit:
          description: Pending inflow of cash
          type: string
        pending debit:
          description: Pending outflow of cash
          type: string
        qualified dividend:
          description: Inflow of cash from a qualified dividend
          type: string
        rebalance:
          description: Rebalancing transaction (buy or sell) with no net impact to
            value in the account
          type: string
        return of principal:
          description: Repayment of loan principal
          type: string
        sell:
          description: Sell to close or decrease an existing holding
          type: string
        sell short:
          description: Sell to open a short position
          type: string
        short-term capital gain:
          description: Short-term capital gain received as cash
          type: string
        short-term capital gain reinvestment:
          description: Purchase using short-term capital gain cash proceeds
          type: string
        spin off:
          description: Inflow of stock from spin-off transaction of an existing holding
          type: string
        split:
          description: Inflow of stock from a forward split of an existing holding
          type: string
        stock distribution:
          description: Inflow of stock from a distribution
          type: string
        tax:
          description: Taxes paid on behalf of the investor
          type: string
        tax withheld:
          description: Taxes withheld on behalf of the customer
          type: string
        transfer:
          description: Movement of assets into or out of an account
          type: string
        transfer fee:
          description: Fees incurred for transfer of a holding or account
          type: string
        trust fee:
          description: Fees related to adminstration of a trust account
          type: string
        unqualified gain:
          description: Unqualified capital gain received as cash
          type: string
        withdrawal:
          description: Outflow of cash from an account
          type: string
      title: StandaloneInvestmentTransactionSubtype
      type: object
    AccountSubtypes:
      description: '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 [Account schema](/docs/api/accounts#accounts-schema). '
      items:
        $ref: '#/components/schemas/AccountSubtype'
      title: AccountSubtypes
      type: array
    UserPermissionRevokedWebhook:
      additionalProperties: true
      description: The `USER_PERMISSION_REVOKED` webhook is fired to when an end user
        has used the [my.plaid.com portal](https://my.plaid.com) to revoke the permission
        that they previously granted to access an Item. Once access to an Item has
        been revoked, it cannot be restored. If the user subsequently returns to your
        application, a new Item must be created for the user.
      properties:
        webhook_type:
          description: '`ITEM`'
          type: string
        webhook_code:
          description: '`USER_PERMISSION_REVOKED`'
          type: string
        item_id:
          description: The `item_id` of the Item associated with this webhook, warning,
            or error
          title: ItemId
          type: string
        error:
          $ref: '#/components/schemas/Error'
      required:
      - item_id
      - webhook_code
      - webhook_type
      title: UserPermissionRevokedWebhook
      type: object
      x-examples:
        example-1:
          webhook_type: ITEM
          webhook_code: USER_PERMISSION_REVOKED
          error:
            error_code: USER_PERMISSION_REVOKED
            error_message: the holder of this account has revoked their permission
              for your application to access it
            error_type: ITEM_ERROR
            status: 400
          item_id: gAXlMgVEw5uEGoQnnXZ6tn9E7Mn3LBc4PJVKZ
    DepositSwitchGetRequest:
      description: DepositSwitchGetRequest defines the request schema for `/deposit_switch/get`
      example:
        secret: secret
        deposit_switch_id: deposit_switch_id
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        deposit_switch_id:
          description: The ID of the deposit switch
          type: string
      required:
      - deposit_switch_id
      title: DepositSwitchGetRequest
      type: object
      x-examples: {}
    DepositSwitchGetResponse:
      additionalProperties: true
      description: DepositSwitchGetResponse defines the response schema for `/deposit_switch/get`
      example:
        is_allocated_remainder: true
        percent_allocated: 0.8008281904610115
        date_created: 2000-01-23
        target_account_id: target_account_id
        account_has_multiple_allocations: true
        date_completed: 2000-01-23
        target_item_id: target_item_id
        state: initialized
        deposit_switch_id: deposit_switch_id
        amount_allocated: 6.027456183070403
        request_id: request_id
      properties:
        deposit_switch_id:
          description: The ID of the deposit switch
          type: string
        target_account_id:
          description: The ID of the bank account the direct deposit was switched
            to
          nullable: true
          type: string
        target_item_id:
          description: The ID of the Item the direct deposit was switched to.
          nullable: true
          type: string
        state:
          description: The state of the deposit switch.
          enum:
          - initialized
          - completed
          - error
          type: string
        account_has_multiple_allocations:
          description: When `true`, user’s direct deposit goes to multiple banks.
            When false, user’s direct deposit only goes to the target account. Always
            `null` if the deposit switch has not been completed.
          nullable: true
          type: boolean
        is_allocated_remainder:
          description: When `true`, the target account is allocated the remainder
            of direct deposit after all other allocations have been deducted. When
            `false`, user’s direct deposit is allocated as a percent or amount. Always
            `null` if the deposit switch has not been completed.
          nullable: true
          type: boolean
        percent_allocated:
          description: The percentage of direct deposit allocated to the target account.
            Always `null` if the target account is not allocated a percentage or if
            the deposit switch has not been completed or if `is_allocated_remainder`
            is true.
          nullable: true
          type: number
        amount_allocated:
          description: The dollar amount of direct deposit allocated to the target
            account. Always `null` if the target account is not allocated an amount
            or if the deposit switch has not been completed.
          nullable: true
          type: number
        date_created:
          description: ISO8601 date the deposit switch was created.
          format: date
          type: string
        date_completed:
          description: ISO8601 date the deposit switch was completed. Always `null`
            if the deposit switch has not been completed.
          format: date
          nullable: true
          type: string
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - account_has_multiple_allocations
      - amount_allocated
      - date_completed
      - date_created
      - deposit_switch_id
      - is_allocated_remainder
      - percent_allocated
      - request_id
      - state
      - target_account_id
      - target_item_id
      title: DepositSwitchGetResponse
      type: object
    AssetReportAuditCopyGetRequest:
      description: AssetReportAuditCopyGetRequest defines the request schema for `/asset_report/audit_copy/get`
      example:
        audit_copy_token: audit_copy_token
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        audit_copy_token:
          description: The `audit_copy_token` granting access to the Audit Copy you
            would like to get.
          type: string
      required:
      - audit_copy_token
      title: AssetReportAuditCopyGetRequest
      type: object
    BankTransferGetRequest:
      description: BankTransferGetRequest defines the request schema for `/bank_transfer/get`
      example:
        bank_transfer_id: bank_transfer_id
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        bank_transfer_id:
          description: Plaid’s unique identifier for a bank transfer.
          title: BankTransferID
          type: string
      required:
      - bank_transfer_id
      title: BankTransferGetRequest
      type: object
    BankTransferGetResponse:
      additionalProperties: true
      description: BankTransferGetResponse defines the response schema for `/bank_transfer/get`
      example:
        bank_transfer:
          amount: amount
          metadata:
            key: metadata
          created: created
          description: description
          failure_reason:
            ach_return_code: ach_return_code
            description: description
          cancellable: true
          custom_tag: custom_tag
          account_id: account_id
          iso_currency_code: iso_currency_code
          origination_account_id: origination_account_id
          id: id
          user:
            email_address: email_address
            legal_name: legal_name
            routing_number: routing_number
        request_id: request_id
      properties:
        bank_transfer:
          $ref: '#/components/schemas/BankTransfer'
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - bank_transfer
      - request_id
      title: BankTransferGetResponse
      type: object
    BankTransferID:
      description: Plaid’s unique identifier for a bank transfer.
      title: BankTransferID
      type: string
    BankTransfer:
      additionalProperties: true
      description: Represents a bank transfer within the Bank Transfers API.
      example:
        amount: amount
        metadata:
          key: metadata
        created: created
        description: description
        failure_reason:
          ach_return_code: ach_return_code
          description: description
        cancellable: true
        custom_tag: custom_tag
        account_id: account_id
        iso_currency_code: iso_currency_code
        origination_account_id: origination_account_id
        id: id
        user:
          email_address: email_address
          legal_name: legal_name
          routing_number: routing_number
      properties:
        id:
          description: Plaid’s unique identifier for a bank transfer.
          title: BankTransferID
          type: string
        ach_class:
          $ref: '#/components/schemas/ACHClass'
        account_id:
          description: The account ID that should be credited/debited for this bank
            transfer.
          type: string
        type:
          $ref: '#/components/schemas/BankTransferType'
        user:
          $ref: '#/components/schemas/BankTransferUser'
        amount:
          description: The amount of the transfer (decimal string with two digits
            of precision e.g. “10.00”).
          type: string
        iso_currency_code:
          description: The currency of the transfer amount, e.g. "USD"
          type: string
        description:
          description: The description of the transfer.
          type: string
        created:
          description: The datetime when this bank transfer was created. This will
            be of the form `2006-01-02T15:04:05Z`
          type: string
        status:
          $ref: '#/components/schemas/BankTransferStatus'
        network:
          $ref: '#/components/schemas/BankTransferNetwork'
        cancellable:
          description: When `true`, you can still cancel this bank transfer.
          type: boolean
        failure_reason:
          $ref: '#/components/schemas/BankTransferFailure'
        custom_tag:
          description: A string containing the custom tag provided by the client in
            the create request. Will be null if not provided.
          nullable: true
          type: string
        metadata:
          additionalProperties:
            type: string
          description: |
            The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply:
            - The JSON values must be Strings (no nested JSON objects allowed)
            - Only ASCII characters may be used
            - Maximum of 50 key/value pairs
            - Maximum key length of 40 characters
            - Maximum value length of 500 characters
          maxProperties: 50
          nullable: true
          title: BankTransferMetadata
          type: object
        origination_account_id:
          description: Plaid’s unique identifier for the origination account that
            was used for this transfer.
          type: string
        direction:
          $ref: '#/components/schemas/BankTransferDirection'
      required:
      - account_id
      - ach_class
      - amount
      - cancellable
      - created
      - description
      - direction
      - id
      - iso_currency_code
      - metadata
      - network
      - origination_account_id
      - status
      - type
      - user
      title: BankTransfer
      type: object
    ACHClass:
      description: |-
        Specifies the use case of the transfer.  Required for transfers on an ACH network.

        `"arc"` - Accounts Receivable Entry

        `"cbr`" - Cross Border Entry

        `"ccd"` - Corporate Credit or Debit - fund transfer between two corporate bank accounts

        `"cie"` - Customer Initiated Entry

        `"cor"` - Automated Notification of Change

        `"ctx"` - Corporate Trade Exchange

        `"iat"` - International

        `"mte"` - Machine Transfer Entry

        `"pbr"` - Cross Border Entry

        `"pop`" - Point-of-Purchase Entry

        `"pos"` - Point-of-Sale Entry

        `"ppd"` - Prearranged Payment or Deposit - the transfer is part of a pre-existing relationship with a consumer, eg. bill payment

        `"rck"` - Re-presented Check Entry

        `"tel"` - Telephone-Initiated Entry

        `"web"` - Internet-Initiated Entry - debits from a consumer’s account where their authorization is obtained over the Internet
      enum:
      - arc
      - cbr
      - ccd
      - cie
      - cor
      - ctx
      - iat
      - mte
      - pbr
      - pop
      - pos
      - ppd
      - rck
      - tel
      - web
      title: ACHClass
      type: string
    BankTransferUser:
      additionalProperties: true
      description: The legal name and other information for the account holder.
      example:
        email_address: email_address
        legal_name: legal_name
        routing_number: routing_number
      properties:
        legal_name:
          description: The account holder’s full legal name.
          type: string
        email_address:
          description: The account holder’s email.
          nullable: true
          type: string
        routing_number:
          description: The account holder's routing number. This field is only used
            for response data. Do not provide this field when making requests.
          readOnly: true
          type: string
      required:
      - legal_name
      title: BankTransferUser
      type: object
    BankTransferMetadata:
      additionalProperties:
        type: string
      description: |
        The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply:
        - The JSON values must be Strings (no nested JSON objects allowed)
        - Only ASCII characters may be used
        - Maximum of 50 key/value pairs
        - Maximum key length of 40 characters
        - Maximum value length of 500 characters
      maxProperties: 50
      nullable: true
      title: BankTransferMetadata
      type: object
    BankTransferType:
      description: 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 transfer of money out of your origination account.
      enum:
      - debit
      - credit
      title: BankTransferType
      type: string
    BankTransferStatus:
      description: The status of the transfer.
      enum:
      - pending
      - posted
      - cancelled
      - failed
      - reversed
      title: BankTransferStatus
      type: string
    BankTransferNetwork:
      description: The network or rails used for the transfer. Valid options are `ach`,
        `same-day-ach`, or `wire`.
      enum:
      - ach
      - same-day-ach
      - wire
      title: BankTransferNetwork
      type: string
    BankTransferFailure:
      additionalProperties: true
      description: The failure reason if the type of this transfer is `"failed"` or
        `"reversed"`. Null value otherwise.
      example:
        ach_return_code: ach_return_code
        description: description
      nullable: true
      properties:
        ach_return_code:
          description: The ACH return code, e.g. `R01`.  A return code will be provided
            if and only if the transfer status is `reversed`. For a full listing of
            ACH return codes, see [Bank Transfers errors](/docs/errors/bank-transfers/#ach-return-codes).
          nullable: true
          type: string
        description:
          description: A human-readable description of the reason for the failure
            or reversal.
          type: string
      title: BankTransferFailure
      type: object
    BankTransferCreateRequest:
      description: BankTransferCreateRequest defines the request schema for `/bank_transfer/create`
      example:
        amount: amount
        metadata:
          key: metadata
        description: description
        secret: secret
        client_id: client_id
        access_token: access_token
        custom_tag: custom_tag
        account_id: account_id
        iso_currency_code: iso_currency_code
        idempotency_key: idempotency_key
        origination_account_id: origination_account_id
        user:
          email_address: email_address
          legal_name: legal_name
          routing_number: routing_number
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        idempotency_key:
          description: |-
            A random key provided by the client, per unique bank transfer. Maximum of 50 characters.

            The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create a bank transfer fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single bank transfer is created.
          maxLength: 50
          type: string
        access_token:
          description: The Plaid `access_token` for the account that will be debited
            or credited.
          type: string
        account_id:
          description: The Plaid `account_id` for the account that will be debited
            or credited.
          type: string
        type:
          $ref: '#/components/schemas/BankTransferType'
        network:
          $ref: '#/components/schemas/BankTransferNetwork'
        amount:
          description: The transfer amount (decimal string with two digits of precision
            e.g. "10.00").
          type: string
        iso_currency_code:
          description: The currency of the transfer amount – should be set to "USD".
          type: string
        description:
          description: The transfer description. Maximum of 10 characters.
          maxLength: 10
          type: string
        ach_class:
          $ref: '#/components/schemas/ACHClass'
        user:
          $ref: '#/components/schemas/BankTransferUser'
        custom_tag:
          description: An arbitrary string provided by the client for storage with
            the bank transfer. Will be returned in all `BankTransfer` objects. May
            be up to 100 characters.
          maxLength: 100
          nullable: true
          type: string
        metadata:
          additionalProperties:
            type: string
          description: |
            The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply:
            - The JSON values must be Strings (no nested JSON objects allowed)
            - Only ASCII characters may be used
            - Maximum of 50 key/value pairs
            - Maximum key length of 40 characters
            - Maximum value length of 500 characters
          maxProperties: 50
          nullable: true
          title: BankTransferMetadata
          type: object
        origination_account_id:
          description: Plaid’s unique identifier for the origination account for this
            transfer. If you have more than one origination account, this value must
            be specified.
          nullable: true
          type: string
      required:
      - access_token
      - account_id
      - amount
      - description
      - idempotency_key
      - iso_currency_code
      - network
      - type
      - user
      title: BankTransferCreateRequest
      type: object
    BankTransferCreateResponse:
      additionalProperties: true
      description: BankTransferCreateResponse defines the response schema for `/bank_transfer/create`
      example:
        bank_transfer:
          amount: amount
          metadata:
            key: metadata
          created: created
          description: description
          failure_reason:
            ach_return_code: ach_return_code
            description: description
          cancellable: true
          custom_tag: custom_tag
          account_id: account_id
          iso_currency_code: iso_currency_code
          origination_account_id: origination_account_id
          id: id
          user:
            email_address: email_address
            legal_name: legal_name
            routing_number: routing_number
        request_id: request_id
      properties:
        bank_transfer:
          $ref: '#/components/schemas/BankTransfer'
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - bank_transfer
      - request_id
      title: BankTransferCreateResponse
      type: object
    BankTransferListRequest:
      description: BankTransferListRequest defines the request schema for `/bank_transfer/list`
      example:
        end_date: 2000-01-23T04:56:07.000+00:00
        offset: 0
        count: 2
        origination_account_id: origination_account_id
        secret: secret
        client_id: client_id
        start_date: 2000-01-23T04:56:07.000+00:00
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        start_date:
          description: The start datetime of bank transfers to list. This should be
            in RFC 3339 format (i.e. `2019-12-06T22:35:49Z`)
          format: date-time
          nullable: true
          type: string
        end_date:
          description: The end datetime of bank transfers to list. This should be
            in RFC 3339 format (i.e. `2019-12-06T22:35:49Z`)
          format: date-time
          nullable: true
          type: string
        count:
          default: 25
          description: The maximum number of bank transfers to return.
          maximum: 25
          minimum: 1
          type: integer
        offset:
          default: 0
          description: The number of bank transfers to skip before returning results.
          minimum: 0
          type: integer
        origination_account_id:
          description: Filter bank transfers to only those originated through the
            specified origination account.
          nullable: true
          type: string
        direction:
          $ref: '#/components/schemas/BankTransferDirection'
      title: BankTransferListRequest
      type: object
    BankTransferListResponse:
      additionalProperties: true
      description: BankTransferListResponse defines the response schema for `/bank_transfer/list`
      example:
        bank_transfers:
        - amount: amount
          metadata:
            key: metadata
          created: created
          description: description
          failure_reason:
            ach_return_code: ach_return_code
            description: description
          cancellable: true
          custom_tag: custom_tag
          account_id: account_id
          iso_currency_code: iso_currency_code
          origination_account_id: origination_account_id
          id: id
          user:
            email_address: email_address
            legal_name: legal_name
            routing_number: routing_number
        - amount: amount
          metadata:
            key: metadata
          created: created
          description: description
          failure_reason:
            ach_return_code: ach_return_code
            description: description
          cancellable: true
          custom_tag: custom_tag
          account_id: account_id
          iso_currency_code: iso_currency_code
          origination_account_id: origination_account_id
          id: id
          user:
            email_address: email_address
            legal_name: legal_name
            routing_number: routing_number
        request_id: request_id
      properties:
        bank_transfers:
          items:
            $ref: '#/components/schemas/BankTransfer'
          type: array
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - bank_transfers
      - request_id
      title: BankTransferListResponse
      type: object
    BankTransferDirection:
      description: 'Indicates the direction of the transfer: `outbound` for API-initiated
        transfers, or `inbound` for payments received by the FBO account.'
      enum:
      - outbound
      - inbound
      nullable: true
      title: BankTransferDirection
      type: string
    BankTransferCancelRequest:
      description: BankTransferCancelRequest defines the request schema for `/bank_transfer/cancel`
      example:
        bank_transfer_id: bank_transfer_id
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        bank_transfer_id:
          description: Plaid’s unique identifier for a bank transfer.
          title: BankTransferID
          type: string
      required:
      - bank_transfer_id
      title: BankTransferCancelRequest
      type: object
    BankTransferCancelResponse:
      additionalProperties: true
      description: BankTransferCancelResponse defines the response schema for `/bank_transfer/cancel`
      example:
        request_id: request_id
      properties:
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - request_id
      title: BankTransferCancelResponse
      type: object
    BankTransferEventListRequest:
      description: BankTransferEventListRequest defines the request schema for `/bank_transfer/event/list`
      example:
        end_date: 2000-01-23T04:56:07.000+00:00
        account_id: account_id
        event_types:
        - null
        - null
        offset: 0
        bank_transfer_id: bank_transfer_id
        bank_transfer_type: debit
        count: 2
        origination_account_id: origination_account_id
        secret: secret
        client_id: client_id
        start_date: 2000-01-23T04:56:07.000+00:00
        direction: direction
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        start_date:
          description: The start datetime of bank transfers to list. This should be
            in RFC 3339 format (i.e. `2019-12-06T22:35:49Z`)
          format: date-time
          nullable: true
          type: string
        end_date:
          description: The end datetime of bank transfers to list. This should be
            in RFC 3339 format (i.e. `2019-12-06T22:35:49Z`)
          format: date-time
          nullable: true
          type: string
        bank_transfer_id:
          description: Plaid’s unique identifier for a bank transfer.
          nullable: true
          title: BankTransferID
          type: string
        account_id:
          description: The account ID to get events for all transactions to/from an
            account.
          nullable: true
          type: string
        bank_transfer_type:
          description: 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 transfer of money out of your origination account.
          enum:
          - debit
          - credit
          nullable: true
          title: BankTransferType
          type: string
        event_types:
          description: Filter events by event type.
          items:
            $ref: '#/components/schemas/BankTransferEventType'
          type: array
        count:
          default: 25
          description: The maximum number of bank transfer events to return. If the
            number of events matching the above parameters is greater than `count`,
            the most recent events will be returned.
          maximum: 25
          minimum: 1
          nullable: true
          type: integer
        offset:
          default: 0
          description: The offset into the list of bank transfer events. When `count`=25
            and `offset`=0, the first 25 events will be returned. When `count`=25
            and `offset`=25, the next 25 bank transfer events will be returned.
          minimum: 0
          nullable: true
          type: integer
        origination_account_id:
          description: The origination account ID to get events for transfers from
            a specific origination account.
          nullable: true
          type: string
        direction:
          description: 'Indicates the direction of the transfer: `outbound` for API-initiated
            transfers, or `inbound` for payments received by the FBO account.'
          nullable: true
          title: BankTransferDirection
          type: string
      title: BankTransferEventListRequest
      type: object
    BankTransferEventType:
      description: |-
        `pending`: A new transfer was created; it is in the pending state.

        `cancelled`: The transfer was cancelled by the client.

        `failed`: The transfer failed, no funds were moved.

        `posted`: The transfer has been successfully submitted to the payment network.

        `reversed`: A posted transfer was reversed.

        `receiver_pending`: The matching transfer was found as a pending transaction in the receiver's account

        `receiver_posted`: The matching transfer was found as a posted transaction in the receiver's account
      enum:
      - pending
      - cancelled
      - failed
      - posted
      - reversed
      - receiver_pending
      - receiver_posted
      title: BankTransferEventType
      type: string
    BankTransferEvent:
      additionalProperties: true
      description: Represents an event in the Bank Transfers API.
      example:
        event_id: 0
        account_id: account_id
        bank_transfer_amount: bank_transfer_amount
        bank_transfer_id: bank_transfer_id
        origination_account_id: origination_account_id
        failure_reason:
          ach_return_code: ach_return_code
          description: description
        receiver_details:
          available_balance: positive
        bank_transfer_iso_currency_code: bank_transfer_iso_currency_code
        timestamp: timestamp
      properties:
        event_id:
          description: Plaid’s unique identifier for this event. IDs are sequential
            unsigned 64-bit integers.
          minimum: 0
          type: integer
        timestamp:
          description: The datetime when this event occurred. This will be of the
            form `2006-01-02T15:04:05Z`.
          type: string
        event_type:
          $ref: '#/components/schemas/BankTransferEventType'
        account_id:
          description: The account ID associated with the bank transfer.
          type: string
        bank_transfer_id:
          description: Plaid’s unique identifier for a bank transfer.
          title: BankTransferID
          type: string
        origination_account_id:
          description: The ID of the origination account that this balance belongs
            to.
          nullable: true
          type: string
        bank_transfer_type:
          $ref: '#/components/schemas/BankTransferType'
        bank_transfer_amount:
          description: The bank transfer amount.
          type: string
        bank_transfer_iso_currency_code:
          description: The currency of the bank transfer amount.
          type: string
        failure_reason:
          $ref: '#/components/schemas/BankTransferFailure'
        direction:
          $ref: '#/components/schemas/BankTransferDirection'
        receiver_details:
          $ref: '#/components/schemas/BankTransferReceiverDetails'
      required:
      - account_id
      - bank_transfer_amount
      - bank_transfer_id
      - bank_transfer_iso_currency_code
      - bank_transfer_type
      - direction
      - event_id
      - event_type
      - failure_reason
      - receiver_details
      - timestamp
      title: BankTransferEvent
      type: object
    BankTransferEventListResponse:
      additionalProperties: true
      description: BankTransferEventListResponse defines the response schema for `/bank_transfer/event/list`
      example:
        bank_transfer_events:
        - event_id: 0
          account_id: account_id
          bank_transfer_amount: bank_transfer_amount
          bank_transfer_id: bank_transfer_id
          origination_account_id: origination_account_id
          failure_reason:
            ach_return_code: ach_return_code
            description: description
          receiver_details:
            available_balance: positive
          bank_transfer_iso_currency_code: bank_transfer_iso_currency_code
          timestamp: timestamp
        - event_id: 0
          account_id: account_id
          bank_transfer_amount: bank_transfer_amount
          bank_transfer_id: bank_transfer_id
          origination_account_id: origination_account_id
          failure_reason:
            ach_return_code: ach_return_code
            description: description
          receiver_details:
            available_balance: positive
          bank_transfer_iso_currency_code: bank_transfer_iso_currency_code
          timestamp: timestamp
        request_id: request_id
      properties:
        bank_transfer_events:
          items:
            $ref: '#/components/schemas/BankTransferEvent'
          type: array
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - bank_transfer_events
      - request_id
      title: BankTransferEventListResponse
      type: object
    BankTransferEventSyncRequest:
      description: BankTransferEventSyncRequest defines the request schema for `/bank_transfer/event/sync`
      example:
        count: 15
        after_id: 0
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        after_id:
          description: The latest (largest) `event_id` fetched via the sync endpoint,
            or 0 initially.
          minimum: 0
          type: integer
        count:
          default: 25
          description: The maximum number of bank transfer events to return.
          maximum: 25
          minimum: 1
          nullable: true
          type: integer
      required:
      - after_id
      title: BankTransferEventSyncRequest
      type: object
    BankTransferEventSyncResponse:
      additionalProperties: true
      description: BankTransferEventSyncResponse defines the response schema for `/bank_transfer/event/sync`
      example:
        bank_transfer_events:
        - event_id: 0
          account_id: account_id
          bank_transfer_amount: bank_transfer_amount
          bank_transfer_id: bank_transfer_id
          origination_account_id: origination_account_id
          failure_reason:
            ach_return_code: ach_return_code
            description: description
          receiver_details:
            available_balance: positive
          bank_transfer_iso_currency_code: bank_transfer_iso_currency_code
          timestamp: timestamp
        - event_id: 0
          account_id: account_id
          bank_transfer_amount: bank_transfer_amount
          bank_transfer_id: bank_transfer_id
          origination_account_id: origination_account_id
          failure_reason:
            ach_return_code: ach_return_code
            description: description
          receiver_details:
            available_balance: positive
          bank_transfer_iso_currency_code: bank_transfer_iso_currency_code
          timestamp: timestamp
        request_id: request_id
      properties:
        bank_transfer_events:
          items:
            $ref: '#/components/schemas/BankTransferEvent'
          type: array
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - bank_transfer_events
      - request_id
      title: BankTransferEventSyncResponse
      type: object
    BankTransferBalanceGetRequest:
      description: BankTransferBalanceGetRequest defines the request schema for `/bank_transfer/balance/get`
      example:
        origination_account_id: origination_account_id
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        origination_account_id:
          description: If multiple origination accounts are available, `origination_account_id`
            must be used to specify the account for which balance will be returned.
          nullable: true
          type: string
      title: BankTransferBalanceGetRequest
      type: object
    BankTransferBalanceGetResponse:
      additionalProperties: true
      description: BankTransferBalanceGetResponse defines the response schema for
        `/bank_transfer/balance/get`
      example:
        balance:
          transactable: transactable
          available: available
        origination_account_id: origination_account_id
        request_id: request_id
      properties:
        balance:
          $ref: '#/components/schemas/BankTransferBalance'
        origination_account_id:
          description: The ID of the origination account that this balance belongs
            to.
          nullable: true
          type: string
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - balance
      - origination_account_id
      - request_id
      title: BankTransferBalanceGetResponse
      type: object
    BankTransferBalance:
      additionalProperties: true
      example:
        transactable: transactable
        available: available
      properties:
        available:
          description: The total available balance - the sum of all successful debit
            transfer amounts minus all credit transfer amounts.
          type: string
        transactable:
          description: The transactable balance shows the amount in your account that
            you are able to use for transfers, and is essentially your available balance
            minus your minimum balance.
          type: string
      required:
      - available
      - transactable
      title: BankTransferBalance
      type: object
    BankTransferMigrateAccountRequest:
      description: BankTransferMigrateAccountRequest defines the request schema for
        `/bank_transfer/migrate_account`
      example:
        account_number: account_number
        account_type: account_type
        secret: secret
        routing_number: routing_number
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        account_number:
          description: The user's account number.
          type: string
        routing_number:
          description: The user's routing number.
          type: string
        account_type:
          description: The type of the bank account (`checking` or `savings`).
          type: string
      required:
      - account_number
      - account_type
      - routing_number
      title: BankTransferMigrateAccountRequest
      type: object
    BankTransferMigrateAccountResponse:
      additionalProperties: true
      description: BankTransferMigrateAccountResponse defines the response schema
        for `/bank_transfer/migrate_account`
      example:
        access_token: access_token
        account_id: account_id
        request_id: request_id
      properties:
        access_token:
          description: The Plaid `access_token` for the newly created Item.
          type: string
        account_id:
          description: The Plaid `account_id` for the newly created Item.
          type: string
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - access_token
      - account_id
      - request_id
      title: BankTransferMigrateAccountResponse
      type: object
    SandboxBankTransferSimulateRequest:
      description: SandboxBankTransferSimulateRequest defines the request schema for
        `/sandbox/bank_transfer/simulate`
      example:
        event_type: event_type
        bank_transfer_id: bank_transfer_id
        secret: secret
        failure_reason:
          ach_return_code: ach_return_code
          description: description
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        bank_transfer_id:
          description: Plaid’s unique identifier for a bank transfer.
          title: BankTransferID
          type: string
        event_type:
          description: |
            The asynchronous event to be simulated. May be: `posted`, `failed`, or `reversed`.

            An error will be returned if the event type is incompatible with the current transfer status. Compatible status --> event type transitions include:

            `pending` --> `failed`

            `pending` --> `posted`

            `posted` --> `reversed`
          type: string
        failure_reason:
          $ref: '#/components/schemas/BankTransferFailure'
      required:
      - bank_transfer_id
      - event_type
      title: SandboxBankTransferSimulateRequest
      type: object
    SandboxBankTransferSimulateResponse:
      additionalProperties: true
      description: SandboxBankTransferSimulateResponse defines the response schema
        for `/sandbox/bank_transfer/simulate`
      example:
        request_id: request_id
      properties:
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - request_id
      title: SandboxBankTransferSimulateResponse
      type: object
    BankTransferReceiverDetails:
      additionalProperties: true
      description: The receiver details if the type of this event is `reciever_pending`
        or `reciever_posted`. Null value otherwise.
      example:
        available_balance: positive
      nullable: true
      properties:
        available_balance:
          description: The sign of the available balance for the receiver bank account
            associated with the receiver event at the time the matching transaction
            was found. Can be `positive`, `negative`, or null if the balance was not
            available at the time.
          enum:
          - positive
          - negative
          nullable: true
          type: string
      title: BankTransferReceiverDetails
      type: object
    AccountFiltersResponse:
      additionalProperties: true
      description: |
        The `account_filters` specified in the original call to `/link/token/create`.
      example:
        loan:
          account_subtypes:
          - null
          - null
        investment:
          account_subtypes:
          - null
          - null
        depository:
          account_subtypes:
          - null
          - null
        credit:
          account_subtypes:
          - null
          - null
      properties:
        depository:
          $ref: '#/components/schemas/DepositoryFilter'
        credit:
          $ref: '#/components/schemas/CreditFilter'
        loan:
          $ref: '#/components/schemas/LoanFilter'
        investment:
          $ref: '#/components/schemas/InvestmentFilter'
      title: AccountFiltersResponse
      type: object
    InstitutionsSearchAccountFilter:
      additionalProperties: true
      example:
        loan:
        - null
        - null
        investment:
        - null
        - null
        depository:
        - null
        - null
        credit:
        - null
        - null
      properties:
        loan:
          items:
            $ref: '#/components/schemas/AccountSubtype'
          type: array
        depository:
          items:
            $ref: '#/components/schemas/AccountSubtype'
          type: array
        credit:
          items:
            $ref: '#/components/schemas/AccountSubtype'
          type: array
        investment:
          items:
            $ref: '#/components/schemas/AccountSubtype'
          type: array
      title: InstitutionsSearchAccountFilter
      type: object
    AccountIdentity:
      allOf:
      - $ref: '#/components/schemas/AccountBase'
      - $ref: '#/components/schemas/AccountIdentity_allOf'
      title: AccountIdentity
    AccountAssets:
      allOf:
      - $ref: '#/components/schemas/AccountBase'
      - $ref: '#/components/schemas/AccountAssets_allOf'
      title: AccountAssets
    DepositoryFilter:
      additionalProperties: true
      description: A filter to apply to `depository`-type accounts
      example:
        account_subtypes:
        - null
        - null
      properties:
        account_subtypes:
          description: '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 [Account schema](/docs/api/accounts#accounts-schema). '
          items:
            $ref: '#/components/schemas/AccountSubtype'
          title: AccountSubtypes
          type: array
      required:
      - account_subtypes
      title: DepositoryFilter
      type: object
    CreditFilter:
      additionalProperties: true
      description: A filter to apply to `credit`-type accounts
      example:
        account_subtypes:
        - null
        - null
      properties:
        account_subtypes:
          description: '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 [Account schema](/docs/api/accounts#accounts-schema). '
          items:
            $ref: '#/components/schemas/AccountSubtype'
          title: AccountSubtypes
          type: array
      required:
      - account_subtypes
      title: CreditFilter
      type: object
    LoanFilter:
      additionalProperties: true
      description: A filter to apply to `loan`-type accounts
      example:
        account_subtypes:
        - null
        - null
      properties:
        account_subtypes:
          description: '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 [Account schema](/docs/api/accounts#accounts-schema). '
          items:
            $ref: '#/components/schemas/AccountSubtype'
          title: AccountSubtypes
          type: array
      required:
      - account_subtypes
      title: LoanFilter
      type: object
    InvestmentFilter:
      additionalProperties: true
      description: A filter to apply to `investment`-type accounts
      example:
        account_subtypes:
        - null
        - null
      properties:
        account_subtypes:
          description: '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 [Account schema](/docs/api/accounts#accounts-schema). '
          items:
            $ref: '#/components/schemas/AccountSubtype'
          title: AccountSubtypes
          type: array
      required:
      - account_subtypes
      title: InvestmentFilter
      type: object
    EmployersSearchRequest:
      description: EmployersSearchRequest defines the request schema for `/employers/search`.
      example:
        query: query
        secret: secret
        client_id: client_id
        products:
        - products
        - products
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        query:
          description: The employer name to be searched for.
          type: string
        products:
          description: The Plaid products the returned employers should support. Currently,
            this field must be set to `"deposit_switch"`.
          items:
            type: string
          type: array
      required:
      - products
      - query
      title: EmployersSearchRequest
      type: object
    EmployersSearchResponse:
      additionalProperties: true
      description: EmployersSearchResponse defines the response schema for `/employers/search`.
      example:
        employers:
        - confidence_score: 0.8008281904610115
          name: name
          employer_id: employer_id
        - confidence_score: 0.8008281904610115
          name: name
          employer_id: employer_id
        request_id: request_id
      properties:
        employers:
          description: A list of employers matching the search criteria.
          items:
            $ref: '#/components/schemas/Employer'
          type: array
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - employers
      - request_id
      title: EmployersSearchResponse
      type: object
    Employer:
      additionalProperties: true
      description: Data about the employer.
      example:
        confidence_score: 0.8008281904610115
        name: name
        employer_id: employer_id
      properties:
        employer_id:
          description: Plaid's unique identifier for the employer.
          type: string
        name:
          description: The name of the employer
          type: string
        address:
          $ref: '#/components/schemas/NullableAddressData'
        confidence_score:
          description: A number from 0 to 1 indicating Plaid's level of confidence
            in the pairing between the employer and the institution (not yet implemented).
          nullable: true
          type: number
      required:
      - employer_id
      - name
      title: Employer
      type: object
    IncomeVerificationCreateRequest:
      description: IncomeVerificationCreateRequest defines the request schema for
        `/income/verification/create`
      example:
        webhook: webhook
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        webhook:
          description: The URL endpoint to which Plaid should send webhooks related
            to the progress of the income verification process.
          type: string
      required:
      - webhook
      title: IncomeVerificationCreateRequest
      type: object
    IncomeVerificationCreateResponse:
      additionalProperties: true
      description: IncomeVerificationCreateResponse defines the response schema for
        `/income/verification/create`.
      example:
        income_verification_id: income_verification_id
        request_id: request_id
      properties:
        income_verification_id:
          description: ID of the verification. This ID is persisted throughout the
            lifetime of the verification.
          type: string
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - income_verification_id
      - request_id
      title: IncomeVerificationCreateResponse
      type: object
    LinkTokenCreateRequestIncomeVerification:
      description: Specifies options for initializing Link for use with the Income
        Verification (beta) product. This field is required if `income_verification`
        is included in the `products` array.
      properties:
        income_verification_id:
          description: The `income_verification_id` of the verification instance,
            as provided by `/income/verification/create`.
          type: string
        asset_report_id:
          description: The `asset_report_id` of an asset report associated with the
            user, as provided by `/asset_report/create`. Providing an `asset_report_id`
            is optional and can be used to verify the user through a streamlined flow.
            If provided, the bank linking flow will be skipped.
          nullable: true
          type: string
      required:
      - income_verification_id
      title: LinkTokenCreateRequestIncomeVerification
      type: object
    IncomeVerificationStatusWebhook:
      additionalProperties: true
      description: Fired when the status of an income verification instance has changed.
        It will typically take several minutes for this webhook to fire after the
        end user has uploaded their documents, and may take up to 15 minutes.
      properties:
        webhook_type:
          description: '`"INCOME"`'
          type: string
        webhook_code:
          description: '`income_verification`'
          type: string
        income_verification_id:
          description: The `income_verification_id` of the verification instance whose
            status is being reported.
          type: string
        verification_status:
          description: |-
            `VERIFICATION_STATUS_PROCESSING_COMPLETE`: The income verification status processing has completed.

            `VERIFICATION_STATUS_UPLOAD_ERROR`: An upload error occurred when the end user attempted to upload their verification documentation.

            `VERIFICATION_STATUS_INVALID_TYPE`: The end user attempted to upload verification documentation in an unsupported file format.

            `VERIFICATION_STATUS_DOCUMENT_REJECTED`: The documentation uploaded by the end user was recognized as a supported file format, but not recognized as a valid paystub.

            `VERIFICATION_STATUS_PROCESSING_FAILED`: A failure occurred when attempting to process the verification documentation.
          type: string
      required:
      - income_verification_id
      - verification_status
      - webhook_code
      - webhook_type
      title: IncomeVerificationStatusWebhook
      type: object
    IncomeVerificationSummaryGetRequest:
      description: IncomeVerificationSummaryGetRequest defines the request schema
        for `/income/verification/summary/get`.
      example:
        income_verification_id: income_verification_id
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        income_verification_id:
          description: The ID of the verification.
          type: string
      required:
      - income_verification_id
      title: IncomeVerificationSummaryGetRequest
      type: object
    IncomeVerificationSummaryGetResponse:
      additionalProperties: true
      description: IncomeVerificationSummaryGetResponse defines the response schema
        for `/income/verification/summary/get`.
      example:
        income_summaries:
        - pay_frequency:
            value: monthly
          verified_transaction:
            date: date
            transaction_id: transaction_id
            amount: 0.8008281904610115
            account_id: account_id
            description: description
        - pay_frequency:
            value: monthly
          verified_transaction:
            date: date
            transaction_id: transaction_id
            amount: 0.8008281904610115
            account_id: account_id
            description: description
        request_id: request_id
      properties:
        income_summaries:
          description: A list of income summaries.
          items:
            $ref: '#/components/schemas/IncomeSummary'
          type: array
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - income_summaries
      - request_id
      title: IncomeVerificationSummaryGetResponse
      type: object
    IncomeSummary:
      additionalProperties: true
      description: The verified fields from a paystub verification. All fields are
        provided as reported on the paystub.
      example:
        pay_frequency:
          value: monthly
        verified_transaction:
          date: date
          transaction_id: transaction_id
          amount: 0.8008281904610115
          account_id: account_id
          description: description
      properties:
        employer_name:
          $ref: '#/components/schemas/EmployerIncomeSummaryFieldString'
        employee_name:
          $ref: '#/components/schemas/EmployeeIncomeSummaryFieldString'
        ytd_gross_income:
          $ref: '#/components/schemas/YTDGrossIncomeSummaryFieldNumber'
        ytd_net_income:
          $ref: '#/components/schemas/YTDNetIncomeSummaryFieldNumber'
        pay_frequency:
          $ref: '#/components/schemas/PayFrequency'
        projected_wage:
          $ref: '#/components/schemas/ProjectedIncomeSummaryFieldNumber'
        verified_transaction:
          $ref: '#/components/schemas/TransactionData'
      title: IncomeSummary
      type: object
    TransactionData:
      additionalProperties: true
      description: Information about the matched direct deposit transaction used to
        verify a user's payroll information.
      example:
        date: date
        transaction_id: transaction_id
        amount: 0.8008281904610115
        account_id: account_id
        description: description
      nullable: true
      properties:
        description:
          description: The description of the transaction.
          type: string
        amount:
          description: The amount of the transaction.
          type: number
        date:
          description: The date of the transaction, in ISO 8601 format ("yyyy-mm-dd").
          type: string
        account_id:
          description: A unique identifier for the end user's account.
          type: string
        transaction_id:
          description: A unique identifier for the transaction.
          type: string
      required:
      - account_id
      - amount
      - date
      - description
      - transaction_id
      title: TransactionData
      type: object
    IncomeSummaryFieldString:
      additionalProperties: true
      nullable: true
      properties:
        value:
          description: The value of the field.
          type: string
        verification_status:
          $ref: '#/components/schemas/VerificationStatus'
      required:
      - value
      - verification_status
      title: IncomeSummaryFieldString
      type: object
    EmployerIncomeSummaryFieldString:
      allOf:
      - $ref: '#/components/schemas/IncomeSummaryFieldString'
      - additionalProperties: true
        description: The name of the employer, as reported on the paystub.
        type: object
    EmployeeIncomeSummaryFieldString:
      allOf:
      - $ref: '#/components/schemas/IncomeSummaryFieldString'
      - additionalProperties: true
        description: The name of the employee, as reported on the paystub.
        type: object
    IncomeSummaryFieldNumber:
      additionalProperties: true
      nullable: true
      properties:
        value:
          description: The value of the field.
          type: number
        verification_status:
          $ref: '#/components/schemas/VerificationStatus'
      required:
      - value
      - verification_status
      title: IncomeSummaryFieldNumber
      type: object
    YTDGrossIncomeSummaryFieldNumber:
      allOf:
      - $ref: '#/components/schemas/IncomeSummaryFieldNumber'
      - additionalProperties: true
        description: Year-to-date pre-tax earnings, as reported on the paystub.
        type: object
    YTDNetIncomeSummaryFieldNumber:
      allOf:
      - $ref: '#/components/schemas/IncomeSummaryFieldNumber'
      - additionalProperties: true
        description: Year-to-date earnings after any tax withholdings, benefit payments
          or deductions, as reported on the paystub.
        type: object
    ProjectedIncomeSummaryFieldNumber:
      allOf:
      - $ref: '#/components/schemas/IncomeSummaryFieldNumber'
      - additionalProperties: true
        description: The employee's estimated annual salary, as derived from information
          reported on the paystub.
        type: object
    PayFrequency:
      additionalProperties: true
      example:
        value: monthly
      nullable: true
      properties:
        value:
          description: The frequency of the pay period.
          enum:
          - monthly
          - semimonthly
          - weekly
          - biweekly
          - unknown
          - "null"
          type: string
        verification_status:
          $ref: '#/components/schemas/VerificationStatus'
      required:
      - value
      - verification_status
      title: PayFrequency
      type: object
    VerificationStatus:
      description: |-
        The verification status. One of the following:

        `"VERIFIED"`: The information was successfully verified.

        `"UNVERIFIED"`: The verification has not yet been performed.

        `"NEEDS_INFO"`: The verification was attempted but could not be completed due to missing information.

        "`UNABLE_TO_VERIFY`": The verification was performed and the information could not be verified.

        `"UNKNOWN"`: The verification status is unknown.
      enum:
      - VERIFIED
      - UNVERIFIED
      - NEEDS_INFO
      - UNABLE_TO_VERIFY
      - UNKNOWN
      title: VerificationStatus
      type: string
    IncomeVerificationPaystubGetRequest:
      description: IncomeVerificationPaystubGetRequest defines the request schema
        for `/income/verification/paystub/get`.
      example:
        income_verification_id: income_verification_id
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        income_verification_id:
          description: The ID of the verification for which to get paystub information.
          type: string
      required:
      - income_verification_id
      title: IncomeVerificationPaystubGetRequest
      type: object
    IncomeVerificationPaystubGetResponse:
      additionalProperties: true
      description: IncomeVerificationPaystubGetResponse defines the response schema
        for `/income/verification/paystub/get`.
      example:
        paystub:
          account_id: account_id
          pay_period_details:
            end_date: end_date
            pay_day: pay_day
            gross_earnings: 0.8008281904610115
            check_amount: 6.027456183070403
            start_date: start_date
          ytd_earnings:
            gross_earnings: 2.3021358869347655
            net_earnings: 7.061401241503109
          employer:
            confidence_score: 0.8008281904610115
            name: name
            employer_id: employer_id
          employee:
            ssn_masked: ssn_masked
            name: name
          income_breakdown:
            hours: 5.962133916683182
            total: 5.637376656633329
            rate: 1.4658129805029452
            type: type
          paystub_id: paystub_id
        request_id: request_id
      properties:
        paystub:
          $ref: '#/components/schemas/Paystub'
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      title: IncomeVerificationPaystubGetResponse
      type: object
    Paystub:
      additionalProperties: true
      description: An object representing data extracted from the end user's paystub.
      example:
        account_id: account_id
        pay_period_details:
          end_date: end_date
          pay_day: pay_day
          gross_earnings: 0.8008281904610115
          check_amount: 6.027456183070403
          start_date: start_date
        ytd_earnings:
          gross_earnings: 2.3021358869347655
          net_earnings: 7.061401241503109
        employer:
          confidence_score: 0.8008281904610115
          name: name
          employer_id: employer_id
        employee:
          ssn_masked: ssn_masked
          name: name
        income_breakdown:
          hours: 5.962133916683182
          total: 5.637376656633329
          rate: 1.4658129805029452
          type: type
        paystub_id: paystub_id
      properties:
        paystub_id:
          description: The unique identifier for this paystub.
          type: string
        account_id:
          description: The account identifier for the account associated with this
            paystub.
          nullable: true
          type: string
        employer:
          $ref: '#/components/schemas/Employer'
        employee:
          $ref: '#/components/schemas/Employee'
        pay_period_details:
          $ref: '#/components/schemas/PayPeriodDetails'
        income_breakdown:
          $ref: '#/components/schemas/IncomeBreakdown'
        ytd_earnings:
          $ref: '#/components/schemas/PaystubYTDDetails'
      required:
      - employee
      - employer
      - income_breakdown
      - pay_period_details
      - paystub_id
      - ytd_earnings
      title: Paystub
      type: object
    IncomeBreakdown:
      additionalProperties: true
      example:
        hours: 5.962133916683182
        total: 5.637376656633329
        rate: 1.4658129805029452
        type: type
      properties:
        type:
          description: The type of income. Possible values include `"regular"`, `"overtime"`,
            and `"bonus"`.
          nullable: true
          type: string
        rate:
          description: The hourly rate at which the income is paid.
          nullable: true
          type: number
        hours:
          description: The number of hours logged for this income for this pay period.
          nullable: true
          type: number
        total:
          description: The total pay for this pay period.
          nullable: true
          type: number
      title: IncomeBreakdown
      type: object
    Employee:
      additionalProperties: true
      description: Data about the employee.
      example:
        ssn_masked: ssn_masked
        name: name
      properties:
        name:
          description: The name of the employee.
          nullable: true
          type: string
        address:
          $ref: '#/components/schemas/NullableAddressData'
        ssn_masked:
          description: 'The SSN of the employee, with all but the last 4 digits masked
            out. For example: "XXX-XX-1111".'
          nullable: true
          type: string
      title: Employee
      type: object
    PayPeriodDetails:
      additionalProperties: true
      description: Details about the pay period.
      example:
        end_date: end_date
        pay_day: pay_day
        gross_earnings: 0.8008281904610115
        check_amount: 6.027456183070403
        start_date: start_date
      properties:
        start_date:
          description: 'The pay period start date, in ISO 8601 format: "yyyy-mm-dd".'
          nullable: true
          type: string
        end_date:
          description: 'The pay period end date, in ISO 8601 format: "yyyy-mm-dd".'
          nullable: true
          type: string
        pay_day:
          description: The date on which the paystub was issued, in ISO 8601 format
            ("yyyy-mm-dd").
          nullable: true
          type: string
        gross_earnings:
          description: Total earnings before tax.
          nullable: true
          type: number
        check_amount:
          description: The net amount of the paycheck.
          nullable: true
          type: number
      title: PayPeriodDetails
      type: object
    PaystubDeduction:
      additionalProperties: true
      properties:
        type:
          description: 'The description of the deduction, as provided on the paystub.
            For example: `"401(k)"`, `"FICA MED TAX"`.'
          nullable: true
          type: string
        is_pretax:
          description: '`true` if the deduction is pre-tax; `false` otherwise.'
          nullable: true
          type: boolean
        total:
          description: The amount of the deduction.
          nullable: true
          type: number
      title: PaystubDeduction
      type: object
    PaystubYTDDetails:
      additionalProperties: true
      example:
        gross_earnings: 2.3021358869347655
        net_earnings: 7.061401241503109
      properties:
        gross_earnings:
          description: Year-to-date gross earnings.
          type: number
        net_earnings:
          description: Year-to-date net (take home) earnings.
          type: number
      required:
      - gross_earnings
      - net_earnings
      title: PaystubYTDDetails
      type: object
    IncomeVerificationDocumentsDownloadRequest:
      description: IncomeVerificationDocumentsDownloadRequest defines the request
        schema for `/income/verification/documents/download`.
      example:
        income_verification_id: income_verification_id
        secret: secret
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        income_verification_id:
          description: The ID of the verification.
          type: string
      required:
      - income_verification_id
      title: IncomeVerificationDocumentsDownloadRequest
      type: object
    IncomeVerificationDocumentsDownloadResponse:
      additionalProperties: true
      description: IncomeVerificationDocumentsDownloadResponse defines the response
        schema for `/income/verification/documents/download`.
      properties:
        id:
          type: string
      required:
      - id
      title: IncomeVerificationDocumentsDownloadResponse
      type: object
    IncomeVerificationWebhookStatus:
      additionalProperties: true
      properties:
        id:
          type: string
      required:
      - id
      title: IncomeVerificationWebhookStatus
      type: object
    AssetReportTransaction:
      allOf:
      - $ref: '#/components/schemas/Transaction'
      - $ref: '#/components/schemas/AssetReportTransaction_allOf'
      title: AssetReportTransaction
    HealthIncident:
      additionalProperties: true
      example:
        end_date: end_date
        incident_updates:
        - description: description
          updated_date: updated_date
          status: INVESTIGATING
        - description: description
          updated_date: updated_date
          status: INVESTIGATING
        title: title
        start_date: start_date
      properties:
        start_date:
          description: The start date of the incident, in ISO 8601 format, e.g. `"2020-10-30T15:26:48Z"`.
          nullable: true
          type: string
        end_date:
          description: The end date of the incident, in ISO 8601 format, e.g. `"2020-10-30T15:26:48Z"`.
          nullable: true
          type: string
        title:
          description: The title of the incident
          type: string
        incident_updates:
          description: Updates on the health incident.
          items:
            $ref: '#/components/schemas/IncidentUpdate'
          type: array
      title: HealthIncident
      type: object
    IncidentUpdate:
      additionalProperties: true
      example:
        description: description
        updated_date: updated_date
        status: INVESTIGATING
      properties:
        description:
          description: The content of the update.
          type: string
        status:
          description: The status of the incident.
          enum:
          - INVESTIGATING
          - IDENTIFIED
          - RESOLVED
          - UNKNOWN
          type: string
        updated_date:
          description: The date when the update was published, in ISO 8601 format,
            e.g. `"2020-10-30T15:26:48Z"`.
          type: string
      title: IncidentUpdate
      type: object
    DepositSwitchAltCreateRequest:
      description: DepositSwitchAltCreateRequest defines the request schema for `/deposit_switch/alt/create`
      example:
        target_user:
          address:
            country: country
            city: city
            street: street
            region: region
            postal_code: postal_code
          phone: phone
          given_name: given_name
          family_name: family_name
          email: email
          tax_payer_id: tax_payer_id
        secret: secret
        target_account:
          account_number: account_number
          account_name: account_name
          account_subtype: checking
          routing_number: routing_number
        client_id: client_id
      properties:
        client_id:
          description: Your Plaid API `client_id`.
          title: ClientID
          type: string
        secret:
          description: Your Plaid API `secret`.
          title: APISecret
          type: string
        target_account:
          $ref: '#/components/schemas/DepositSwitchTargetAccount'
        target_user:
          $ref: '#/components/schemas/DepositSwitchTargetUser'
      required:
      - target_account
      - target_user
      title: DepositSwitchAltCreateRequest
      type: object
    DepositSwitchAltCreateResponse:
      additionalProperties: true
      description: DepositSwitchAltCreateResponse defines the response schema for
        `/deposit_switch/alt/create`
      example:
        deposit_switch_id: deposit_switch_id
        request_id: request_id
      properties:
        deposit_switch_id:
          description: ID of the deposit switch. This ID is persisted throughout the
            lifetime of the deposit switch.
          type: string
        request_id:
          description: A unique identifier for the request, which can be used for
            troubleshooting. This identifier, like all Plaid identifiers, is case
            sensitive.
          title: RequestID
          type: string
      required:
      - deposit_switch_id
      - request_id
      title: DepositSwitchAltCreateResponse
      type: object
    DepositSwitchTargetAccount:
      additionalProperties: true
      example:
        account_number: account_number
        account_name: account_name
        account_subtype: checking
        routing_number: routing_number
      properties:
        account_number:
          description: Account number for deposit switch destination
          type: string
        routing_number:
          description: Routing number for deposit switch destination
          type: string
        account_name:
          description: The name of the deposit switch destination account, as it will
            be displayed to the end user in the Deposit Switch interface. It is not
            required to match the name used in online banking.
          type: string
        account_subtype:
          description: The account subtype of the account, either `checking` or `savings`.
          enum:
          - checking
          - savings
          type: string
      required:
      - account_name
      - account_number
      - account_subtype
      - routing_number
      title: DepositSwitchTargetAccount
      type: object
    DepositSwitchTargetUser:
      additionalProperties: true
      example:
        address:
          country: country
          city: city
          street: street
          region: region
          postal_code: postal_code
        phone: phone
        given_name: given_name
        family_name: family_name
        email: email
        tax_payer_id: tax_payer_id
      properties:
        given_name:
          description: The given name (first name) of the user.
          type: string
        family_name:
          description: The family name (last name) of the user.
          type: string
        phone:
          description: The phone number of the user. The endpoint can accept a variety
            of phone number formats, including E.164.
          type: string
        email:
          description: The email address of the user.
          type: string
        address:
          $ref: '#/components/schemas/DepositSwitchAddressData'
        tax_payer_id:
          description: The taxpayer ID of the user, generally their SSN, EIN, or TIN.
          type: string
      required:
      - email
      - family_name
      - given_name
      - phone
      title: DepositSwitchTargetUser
      type: object
    DepositSwitchAddressData:
      additionalProperties: true
      description: The user's address.
      example:
        country: country
        city: city
        street: street
        region: region
        postal_code: postal_code
      properties:
        city:
          description: The full city name
          type: string
        region:
          description: |-
            The region or state
            Example: `"NC"`
          type: string
        street:
          description: |-
            The full street address
            Example: `"564 Main Street, APT 15"`
          type: string
        postal_code:
          description: The postal code
          type: string
        country:
          description: The ISO 3166-1 alpha-2 country code
          type: string
      required:
      - city
      - country
      - postal_code
      - region
      - street
      title: DepositSwitchAddressData
      type: object
    AccountIdentity_allOf:
      properties:
        owners:
          description: Data returned by the financial institution about the account
            owner or owners. Only returned by Identity or Assets endpoints. Multiple
            owners on a single account will be represented in the same `owner` object,
            not in multiple owner objects within the array.
          items:
            $ref: '#/components/schemas/Owner'
          type: array
      required:
      - owners
      type: object
    AccountAssets_allOf:
      properties:
        days_available:
          description: The duration of transaction history available for this Item,
            typically defined as the time since the date of the earliest transaction
            in that account. Only returned by Assets endpoints.
          nullable: true
          type: number
        transactions:
          description: Transaction history associated with the account. Only returned
            by Assets endpoints. Transaction history returned by endpoints such as
            `/transactions/get` or `/investments/transactions/get` will be returned
            in the top-level `transactions` field instead.
          items:
            $ref: '#/components/schemas/AssetReportTransaction'
          nullable: true
          type: array
        owners:
          description: Data returned by the financial institution about the account
            owner or owners. Only returned by Identity or Assets endpoints. Multiple
            owners on a single account will be represented in the same `owner` object,
            not in multiple owner objects within the array.
          items:
            $ref: '#/components/schemas/Owner'
          type: array
        historical_balances:
          description: Calculated data about the historical balances on the account.
            Only returned by Assets endpoints.
          items:
            $ref: '#/components/schemas/HistoricalBalance'
          nullable: true
          type: array
      required:
      - owners
      type: object
    AssetReportTransaction_allOf:
      properties:
        date_transacted:
          description: The date on which the transaction took place, in IS0 8601 format.
          nullable: true
          type: string
        original_description:
          description: The string returned by the financial institution to describe
            the transaction
          type: string
      required:
      - original_description
      type: object
  securitySchemes:
    clientId:
      in: header
      name: PLAID-CLIENT-ID
      type: apiKey
    secret:
      in: header
      name: PLAID-SECRET
      type: apiKey
    plaidVersion:
      in: header
      name: Plaid-Version
      type: apiKey