Akoya APIs

By hovering on the code, a clipboard icon will appear on the top right. Use it to copy the code. Then paste into your favorite text or code editor and save as a YAML file.

openapi: 3.1.0
x-stoplight:
  id: 2cacdb936fc8c
info:
  title: Akoya APIs v2.2.2
  version: 2.2.2
  description: |-
    Akoya product APIs for data access. Default servers are set for the Akoya sandbox environment.

    Akoya APIs include the following updates:

    - v2.2.2
      - Added mode query parameter to Account Information, Balances, Investments, and Transactions to support standard mode.
    - v2.2.1
      - Fixed typo in `accountIds` query parameter for `/accounts-info`, `/balances`, `/accounts`
      - Added security method for `Account holder information` to bear token. Missing method defaulted to basic auth.
      - Added examples and descriptions to some schemas
      - Added HTTP status `429` FDX error `1207`.
    - v2.2 Additions
      - Added optional `x-akoya-interaction-type` header to all endpoints to specify if a request is part of a batch process
      - Update of tags to organize endpoints by Akoya product
      - `206` response added to `/accounts-info`, `/balances`, `/accounts`
    - v2.1 New Statements product and Customers product updated with additional endpoint, `Account holder information`.
    - v2.0 Launch of Akoya products: Account Info, Balances, Investments, Transactions, Payments, Customers.
  contact:
    name: API Support
    url: 'http://www.akoya.com'
    email: [email protected]
  license:
    name: Akoya Terms of Use
    url: 'https://recipient.ddp.akoya.com/terms-of-use'
tags:
  - name: Account information
    description: Account information
  - name: Balances
    description: Balances
  - name: Customers
    description: Customers
  - name: Investments
    description: Investments
  - name: Payments
    description: Payments
  - name: Statements
    description: Statements
  - name: Transactions
    description: Transactions
security:
  - basicAuth: []
servers:
  - url: 'https://sandbox-products.ddp.akoya.com'
    description: Sandbox server
  - url: 'https://products.ddp.akoya.com'
    description: Products server
paths:
  '/accounts-info/{version}/{providerId}':
    get:
      summary: Account information
      tags:
        - Account information
      operationId: get-accounts-info
      description: "Get basic account information including accountId, masked account number, type, description, etc.\n\nTo view the response schema, select the `200` response below. Then pick an option for annuity, deposit, insurance, investment, loan, and line of credit account types. \n\nFor an example payload response, see the `200` example response below the `Try it` feature. The example is from a deposit account but all account types are supported by this endpoint.\n\n> \U0001F6D1\n> \n> The *id_token* should be used as the bearer token with this call.\n\nUse the `mode` query param to receive FDX-aligned, standardized data values (Beta). For example:\n\n`https://sandbox-products.ddp.akoya.com/accounts-info/v2/mikomo?mode=standard`\n\n`mode` is available in both sandbox and production.\n\n`mode` is supported by a subset of providers. Log into the [Data Recipient Hub](https://recipient.ddp.akoya.com/login) and click [here](https://recipient.ddp.akoya.com/support/article/kA0Uw00000015GzKAI) to view a list of all providers supporting the `mode` parameter.\n\n"
      security:
        - bearerAuth: []
      responses:
        '200':
          description: OK
          headers:
            x-akoya-interaction-id:
              schema:
                type: string
              description: Akoya supplied interaction id used for logging and error tracking
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/account-info'
              examples:
                Accounts Info Example:
                  value:
                    accounts:
                      - investmentAccount:
                          accountId: '839502593'
                          accountType: College Savings
                          balanceType: ASSET
                          currency:
                            currencyCode: USD
                          nickname: 529 for Kid
                      - investmentAccount:
                          accountId: '5426873'
                          accountNumberDisplay: ...7054
                          accountType: BROKERAGE
                          allowedCheckWriting: false
                          currency:
                            currencyCode: USD
                          lastActivityDate: '2021-07-06T00:00:00Z'
                          margin: false
                          nickname: Self-Directed
                          status: OPEN
                          transactionsIncluded: false
                      - depositAccount:
                          accountId: g833202fb0866d0ad83472c429
                          accountNumberDisplay: xxxxxxxx0071
                          accountType: CHECKING
                          balanceType: ASSET
                          currency:
                            currencyCode: USD
                          description: Checking Plus
                          fiAttributes:
                            - name: accountOpenedDate
                              value: '2020-04-23'
                            - name: interestPaidLastYear
                              value: '3.20'
                          interestRate: 0.0125
                          interestRateAsOf: '2022-04-24T14:15:22Z'
                          interestRateType: FIXED
                          lastActivityDate: '2022-04-24T14:15:22Z'
                          lineOfBusiness: Personal
                          nickname: Nickname Checking Plus 0071
                          productName: Checking Plus
                          status: OPEN
                          transferIn: true
                          transferOut: true
                      - depositAccount:
                          accountId: 5dbda8de96eeff05f23934523a1fc258
                          accountNumberDisplay: xxxx0134
                          accountType: CHECKING
                          annualPercentageYield: 0
                          currency:
                            currencyCode: USD
                          description: Virtual Wallet Student Reserve
                          interestRateAsOf: '2022-04-24T14:15:22Z'
                          interestRateType: FIXED
                          lastActivityDate: '2022-04-01T10:05:00Z'
                          lineOfBusiness: LBRB
                          productName: Virtual Wallet Student Reserve
                          transactionsIncluded: false
                      - depositAccount:
                          accountId: 11719ae5-2399-1278-e43c-43f24abb3058
                          accountType: CD
                          annualPercentageYield: 0.75
                          balanceType: ASSET
                          currency:
                            currencyCode: USD
                            originalCurrencyCode: USD
                          description: Certificate of Deposit
                          fiAttributes:
                            - name: eStatements
                              value: 'False'
                            - name: interestPaidLastYear
                              value: '50.72'
                            - name: isTransactionsSupported
                              value: 'False'
                            - name: issueDate
                              value: '2019-03-21T00:00:00.000Z'
                            - name: interestPayoutFrequency
                              value: Semi-Annually (And At Maturity)
                          interestRate: 0.75
                          lineOfBusiness: CONSUMER
                          maturityDate: '2024-03-21T00:00:00Z'
                          nickname: Certificate of Deposit - 3691
                          parentAccountId: 11719ae5-2399-1278-e43c-43f24abb3058
                          status: OPEN
                          term: 60
                          transactionsIncluded: false
                          transferIn: false
                          transferOut: false
                      - depositAccount:
                          accountId: 33fbd9e5-9cc3-3d7d-15b3-70d97d87ca1d
                          accountType: SAVINGS
                          balanceType: ASSET
                          currency:
                            currencyCode: USD
                            originalCurrencyCode: USD
                          description: Savings
                          fiAttributes:
                            - name: eStatements
                              value: 'True'
                          interestRate: 0.01
                          lineOfBusiness: CONSUMER
                          nickname: Savings - 8537
                          parentAccountId: 33fbd9e5-9cc3-3d7d-15b3-70d97d87ca1d
                          status: OPEN
                          transactionsIncluded: false
        '206':
          description: Partial Content. Success searching for accounts. Some errors are being returned.
          headers:
            x-akoya-interaction-id:
              schema:
                type: string
              description: Akoya supplied interaction id used for logging and error tracking
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/account-info'
              examples:
                Example 1:
                  value:
                    value:
                      accounts:
                        - investmentAccount:
                            accountId: '839502593'
                            accountType: College Savings
                            balanceType: ASSET
                            currency:
                              currencyCode: USD
                            nickname: '529'
                        - investmentAccount:
                            error:
                              code: 704
                              message: Account type not supported
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '503':
          $ref: '#/components/responses/503'
      parameters:
        - $ref: '#/components/parameters/accountIdQuery'
        - schema:
            type: string
            example: batch
            enum:
              - user
              - batch
          in: header
          name: x-akoya-interaction-type
          description: |-
            Optional but recommended header to include with each data request. 
            Allowed values are `user` or `batch`. 
            `user` indicates a request is prompted by an end-user action.
            `batch` indicates the request is part of a batch process.
        - schema:
            type: string
            enum:
              - raw
              - standard
            example: raw
          in: query
          name: mode
          description: 'BETA. Default is raw. Use standard for FDX-aligned, standardized data values.'
      x-stoplight:
        id: f18mokkn0763v
    parameters:
      - $ref: '#/components/parameters/versionPath'
      - $ref: '#/components/parameters/providerIdPath'
  '/balances/{version}/{providerId}':
    get:
      summary: Balances
      tags:
        - Balances
      operationId: get-balances
      description: "Account information that includes balances and rates of bank accounts, credit cards, loans, investments, and more.\n\nTo view the response schema, select the `200` response below. Then pick an option for annuity, deposit, insurance, investment, loan, and line of credit account types. \n\nFor an example payload response, see the `200` example response below the `Try it` feature. The example is from a deposit account but all account types are supported by this endpoint.\n\n> \U0001F6D1\n> \n> The *id_token* should be used as the bearer token with this call.\n\nUse the `mode` query param to receive FDX-aligned, standardized data values (Beta). For example:\n\n`https://sandbox-products.ddp.akoya.com/balances/v2/mikomo?mode=standard`\n\n`mode` is available in both sandbox and production.\n\n`mode` is supported by a subset of providers. Log into the [Data Recipient Hub](https://recipient.ddp.akoya.com/login) and click [here](https://recipient.ddp.akoya.com/support/article/kA0Uw00000015GzKAI) to view a list of all providers supporting the `mode` parameter."
      security:
        - bearerAuth: []
      responses:
        '200':
          description: OK
          headers:
            x-akoya-interaction-id:
              schema:
                type: string
              description: Akoya supplied interaction id used for logging and error tracking
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/balances'
              examples:
                Balances example:
                  value:
                    accounts:
                      - investmentAccount:
                          accountId: '839502593'
                          accountType: College Savings
                          availableCashBalance: 0
                          balanceAsOf: '2022-03-16T04:00:00Z'
                          balanceType: ASSET
                          currency:
                            currencyCode: USD
                          currentValue: 52672.49
                          marginBalance: 0
                          nickname: 529 for Kid
                      - investmentAccount:
                          accountId: '5426873'
                          accountNumberDisplay: ...7054
                          accountType: BROKERAGE
                          allowedCheckWriting: false
                          availableCashBalance: 0
                          balanceList:
                            - balanceDate: '2021-07-06'
                              balanceDescription: Margin Call
                              balanceName: MARGINCALL
                              balanceType: AMOUNT
                              balanceValue: 0
                              currency:
                                currencyCode: USD
                            - balanceDate: '2021-07-06'
                              balanceDescription: Fed Call
                              balanceName: FEDCALL
                              balanceType: AMOUNT
                              balanceValue: 0
                              currency:
                                currencyCode: USD
                            - balanceDate: '2021-07-06'
                              balanceDescription: Intra Day
                              balanceName: INTRADAY
                              balanceType: AMOUNT
                              balanceValue: 0
                              currency:
                                currencyCode: USD
                            - balanceDate: '2021-07-05'
                              balanceDescription: Prior Day
                              balanceName: PRIORDAY
                              balanceType: AMOUNT
                              balanceValue: 0
                              currency:
                                currencyCode: USD
                          currency:
                            currencyCode: USD
                          lastActivityDate: '2021-07-06T00:00:00Z'
                          margin: false
                          marginBalance: 0
                          nickname: Self-Directed
                          shortBalance: 0
                          status: OPEN
                          transactionsIncluded: false
                      - depositAccount:
                          accountId: g833202fb0866d0ad83472c429
                          accountNumberDisplay: xxxxxxxx0071
                          accountType: CHECKING
                          availableBalance: 106717.06
                          balanceAsOf: '2022-04-24T14:15:22Z'
                          balanceType: ASSET
                          currency:
                            currencyCode: USD
                          currentBalance: 106717.06
                          description: Checking Plus
                          fiAttributes:
                            - name: accountOpenedDate
                              value: '2020-04-23'
                            - name: interestPaidLastYear
                              value: '3.20'
                          interestRate: 0.0125
                          interestRateAsOf: '2022-04-24T14:15:22Z'
                          interestRateType: FIXED
                          interestYtd: 20.33
                          lastActivityDate: '2022-04-24T14:15:22Z'
                          lineOfBusiness: Personal
                          nickname: Nickname Checking Plus 0071
                          productName: Checking Plus
                          status: OPEN
                          transferIn: true
                          transferOut: true
                      - depositAccount:
                          accountId: 5dbda8de96eeff05f23934523a1fc258
                          accountNumberDisplay: xxxx0134
                          accountType: CHECKING
                          annualPercentageYield: 0
                          availableBalance: 0
                          balanceAsOf: '2022-04-24T14:15:22Z'
                          currency:
                            currencyCode: USD
                          currentBalance: 0
                          description: Virtual Wallet Student Reserve
                          interestRateAsOf: '2022-04-24T14:15:22Z'
                          interestRateType: FIXED
                          lastActivityDate: '2022-04-01T10:05:00Z'
                          lineOfBusiness: LBRB
                          openingDayBalance: 0
                          productName: Virtual Wallet Student Reserve
                          transactionsIncluded: false
                      - depositAccount:
                          accountId: 11719ae5-2399-1278-e43c-43f24abb3058
                          accountType: CD
                          annualPercentageYield: 0.75
                          availableBalance: 6808.29
                          balanceAsOf: '2021-04-07T10:20:43.276Z'
                          balanceType: ASSET
                          currency:
                            currencyCode: USD
                            originalCurrencyCode: USD
                          currentBalance: 6808.29
                          description: Certificate of Deposit
                          fiAttributes:
                            - name: eStatements
                              value: 'False'
                            - name: interestPaidLastYear
                              value: '50.72'
                            - name: isTransactionsSupported
                              value: 'False'
                            - name: issueDate
                              value: '2019-03-21T00:00:00.000Z'
                            - name: interestPayoutFrequency
                              value: Semi-Annually (And At Maturity)
                          interestRate: 0.75
                          interestYtd: 25.24
                          lineOfBusiness: CONSUMER
                          maturityDate: '2024-03-21T00:00:00Z'
                          nickname: Certificate of Deposit - 3691
                          openingDayBalance: 2000
                          parentAccountId: 11719ae5-2399-1278-e43c-43f24abb3058
                          status: OPEN
                          term: 60
                          transactionsIncluded: false
                          transferIn: false
                          transferOut: false
                      - depositAccount:
                          accountId: 33fbd9e5-9cc3-3d7d-15b3-70d97d87ca1d
                          accountType: SAVINGS
                          availableBalance: 20608.9
                          balanceAsOf: '2021-04-07T10:08:11.833Z'
                          balanceType: ASSET
                          currency:
                            currencyCode: USD
                            originalCurrencyCode: USD
                          currentBalance: 20608.9
                          description: Savings
                          fiAttributes:
                            - name: eStatements
                              value: 'True'
                          interestRate: 0.01
                          interestYtd: 0.29
                          lineOfBusiness: CONSUMER
                          nickname: Savings - 8537
                          openingDayBalance: 20608.9
                          parentAccountId: 33fbd9e5-9cc3-3d7d-15b3-70d97d87ca1d
                          status: OPEN
                          transactionsIncluded: false
        '206':
          description: Partial Content. Success searching for accounts. Some errors are being returned.
          headers:
            x-akoya-interaction-id:
              schema:
                type: string
              description: Akoya supplied interaction id used for logging and error tracking
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/balances'
              examples:
                Balances 206 example:
                  value:
                    accounts:
                      - investmentAccount:
                          accountId: '839502593'
                          accountType: College Savings
                          availableCashBalance: 0
                          balanceAsOf: '2022-03-16T04:00:00Z'
                          balanceType: ASSET
                          currency:
                            currencyCode: USD
                          currentValue: 52672.49
                          marginBalance: 0
                          nickname: 529 for Kid
                      - depositAccount:
                          error:
                            code: 704
                            message: Account type not supported
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '503':
          $ref: '#/components/responses/503'
      parameters:
        - $ref: '#/components/parameters/accountIdQuery'
        - schema:
            type: string
            example: batch
            enum:
              - user
              - batch
          in: header
          name: x-akoya-interaction-type
          description: |-
            Optional but recommended header to include with each data request. 
            Allowed values are `user` or `batch`. 
            `user` indicates a request is prompted by an end-user action.
            `batch` indicates the request is part of a batch process.
        - schema:
            type: string
            enum:
              - raw
              - standard
            example: raw
          in: query
          name: mode
          description: 'BETA. Default is raw. Use standard for FDX-aligned, standardized data values.'
      x-stoplight:
        id: q0rscyj5pny8t
    parameters:
      - $ref: '#/components/parameters/versionPath'
      - $ref: '#/components/parameters/providerIdPath'
  '/transactions/{version}/{providerId}/{accountId}':
    get:
      summary: Transactions
      tags:
        - Transactions
      operationId: get-transactions
      description: "The transactions API allows you to retrieve transaction history of consumer-permissioned accounts.\n\n> \U0001F6D1\n> \n> The *id_token* should be used as the bearer token with this call.\n\nFor more information on how to paginate transaction results, please see: [Pagination](https://docs.akoya.com/v2/docs/pagination)\n\nUse the `mode` query param to receive FDX-aligned, standardized data values (Beta). For example:\n\n`https://sandbox-products.ddp.akoya.com/transactions/v2/mikomo?mode=standard`\n\n`mode` is available in both sandbox and production.\n\n`mode` is supported by a subset of providers. Log into the [Data Recipient Hub](https://recipient.ddp.akoya.com/login) and click [here](https://recipient.ddp.akoya.com/support/article/kA0Uw00000015GzKAI) to view a list of all providers supporting the `mode` parameter."
      security:
        - bearerAuth: []
      responses:
        '200':
          description: OK
          headers:
            x-akoya-interaction-id:
              schema:
                type: string
              description: Akoya supplied interaction id used for logging and error tracking
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/transactions'
              examples:
                Savings Transactions:
                  value:
                    links:
                      prev:
                        href: /transactions/v2/mikomo/33fbd9e5-9cc3-3d7d-15b3-70d97d87ca1d?endTime=2021-02-26T00%3A00%3A00Z&limit=5&offset=0&startTime=2019-02-26T00%3A00%3A00Z
                    transactions:
                      - depositTransaction:
                          accountId: 33fbd9e5-9cc3-3d7d-15b3-70d97d87ca1d
                          amount: 0.29
                          debitCreditMemo: CREDIT
                          description: Interest Paid This Period
                          postedTimestamp: '2021-01-27T00:00:00Z'
                          status: POSTED
                          transactionId: 22ef95ee-6127-382d-a28c-5b8b7a15d2eb
                          transactionTimestamp: '2021-01-27T00:00:00Z'
                          transactionType: INTEREST
                      - depositTransaction:
                          accountId: 33fbd9e5-9cc3-3d7d-15b3-70d97d87ca1d
                          amount: 0.13
                          debitCreditMemo: CREDIT
                          description: Interest Paid This Period
                          postedTimestamp: '2021-02-24T00:00:00Z'
                          status: POSTED
                          transactionId: f3fced9d-a7a2-4194-5a17-a2a9b09ff64a
                          transactionTimestamp: '2021-02-24T00:00:00Z'
                          transactionType: INTEREST
                Deposit trx - limit 5 with next & prev:
                  value:
                    links:
                      next:
                        href: /transactions/v2/mikomo/g833202fb0866d0ad83472c429?endTime=2021-02-26T00%3A00%3A00Z&limit=5&offset=5&startTime=2019-02-26T00%3A00%3A00Z
                      prev:
                        href: /transactions/v2/mikomo/g833202fb0866d0ad83472c429?endTime=2021-02-26T00%3A00%3A00Z&limit=5&offset=0&startTime=2019-02-26T00%3A00%3A00Z
                    transactions:
                      - depositTransaction:
                          accountId: g833202fb0866d0ad83472c429
                          amount: -449.07
                          checkNumber: 31505
                          description: CHECK
                          postedTimestamp: '2019-07-08T00:00:00Z'
                          status: POSTED
                          transactionId: '30191890000030'
                          transactionTimestamp: '2019-07-08T00:00:00Z'
                          transactionType: CHECK
                      - depositTransaction:
                          accountId: g833202fb0866d0ad83472c429
                          amount: -4000.4
                          checkNumber: 31528
                          description: CHECK
                          postedTimestamp: '2019-07-08T00:00:00Z'
                          status: POSTED
                          transactionId: '30191890000020'
                          transactionTimestamp: '2019-07-08T00:00:00Z'
                          transactionType: CHECK
                      - depositTransaction:
                          accountId: g833202fb0866d0ad83472c429
                          amount: 5048.13
                          description: DEPOSIT
                          postedTimestamp: '2019-07-08T00:00:00Z'
                          status: POSTED
                          transactionId: '30191890000010'
                          transactionTimestamp: '2019-07-08T00:00:00Z'
                          transactionType: DEPOSIT
                      - depositTransaction:
                          accountId: g833202fb0866d0ad83472c429
                          amount: -8.6
                          checkNumber: 31530
                          description: CHECK
                          postedTimestamp: '2019-07-09T00:00:00Z'
                          status: POSTED
                          transactionId: '30191900000030'
                          transactionTimestamp: '2019-07-09T00:00:00Z'
                          transactionType: CHECK
                      - depositTransaction:
                          accountId: g833202fb0866d0ad83472c429
                          amount: -42.94
                          checkNumber: 31525
                          description: CHECK##TRANINITDATE# 07/09
                          postedTimestamp: '2019-07-09T00:00:00Z'
                          status: POSTED
                          transactionId: '30191900000020'
                          transactionTimestamp: '2019-07-09T00:00:00Z'
                          transactionType: CHECK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              examples:
                702 - Invalid start or end date:
                  value:
                    code: 702
                    message: Invalid start or end date
                703 - Invalid date range:
                  value:
                    code: 703
                    message: Invalid date range
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '503':
          $ref: '#/components/responses/503'
      parameters:
        - $ref: '#/components/parameters/startTimeQuery'
        - $ref: '#/components/parameters/endTimeQuery'
        - $ref: '#/components/parameters/offsetQuery'
        - $ref: '#/components/parameters/limitQuery'
        - schema:
            type: string
            example: batch
            enum:
              - user
              - batch
          in: header
          name: x-akoya-interaction-type
          description: |-
            Optional but recommended header to include with each data request. 
            Allowed values are `user` or `batch`. 
            `user` indicates a request is prompted by an end-user action.
            `batch` indicates the request is part of a batch process.
        - schema:
            type: string
            enum:
              - raw
              - standard
            example: raw
          in: query
          name: mode
          description: 'BETA. Default is raw. Use standard for FDX-aligned, standardized data values.'
      x-stoplight:
        id: hcd859v07gzjz
    parameters:
      - $ref: '#/components/parameters/versionPath'
      - $ref: '#/components/parameters/providerIdPath'
      - $ref: '#/components/parameters/accountIdPath'
  '/accounts/{version}/{providerId}':
    get:
      summary: Accounts
      tags:
        - Investments
      operationId: get-accounts
      description: "Get detailed account information that includes Akoya products Account Info and Balances for all account types (annunity, deposit, insurance, investments, line of credit, and loan) and adds the Investments product to investment accounts including contributions, holdings, vesting information, and more.\n\nTo view the response schema, select the `200` response below. Then pick an option for annuity, deposit, insurance, investment, loan, and line of credit account types. \n\nFor an example payload response, see the `200` example response below the `Try it` feature. The example is from an investment account but all account types are supported and returned by this endpoint.\n\n> \U0001F6D1\n> \n> The *id_token* should be used as the bearer token with this call.\n\nUse the `mode` query param to receive FDX-aligned, standardized data values (Beta). For example:\n\n`https://sandbox-products.ddp.akoya.com/accounts/v2/mikomo?mode=standard`\n\n`mode` is available in both sandbox and production.\n\n`mode` is supported by a subset of providers. Log into the [Data Recipient Hub](https://recipient.ddp.akoya.com/login) and click [here](https://recipient.ddp.akoya.com/support/article/kA0Uw00000015GzKAI) to view a list of all providers supporting the `mode` parameter."
      security:
        - bearerAuth: []
      responses:
        '200':
          description: OK
          headers:
            x-akoya-interaction-id:
              schema:
                type: string
              description: Akoya supplied interaction id used for logging and error tracking
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/investments'
              examples:
                Investments example:
                  value:
                    accounts:
                      - investmentAccount:
                          accountId: '839502593'
                          accountType: College Savings
                          availableCashBalance: 0
                          balanceAsOf: '2022-03-16T04:00:00Z'
                          balanceType: ASSET
                          currency:
                            currencyCode: USD
                          currentValue: 52672.49
                          holdings:
                            - assetClasses:
                                - assetClass: DOMESTICBOND
                                  percent: 0
                              cashAccount: false
                              marketValue: 52672.49
                              mutualFundSecurity:
                                mutualFundType: OPENEND
                                reinvestCapitalGains: true
                                reinvestDividends: true
                                unitsStreet: 0
                                unitsUser: 0
                                yield: 0
                                yieldAsOfDate: '2019-08-24T14:15:22Z'
                              positionType: LONG
                              purchasedPrice: 18.42
                              securityIdType: ISIN
                              units: 2088.521
                          marginBalance: 0
                          nickname: 529 for Kid
                      - investmentAccount:
                          accountId: '5426873'
                          accountNumberDisplay: ...7054
                          accountType: BROKERAGE
                          allowedCheckWriting: false
                          availableCashBalance: 0
                          balanceList:
                            - balanceDate: '2021-07-06'
                              balanceDescription: Margin Call
                              balanceName: MARGINCALL
                              balanceType: AMOUNT
                              balanceValue: 0
                              currency:
                                currencyCode: USD
                            - balanceDate: '2021-07-06'
                              balanceDescription: Fed Call
                              balanceName: FEDCALL
                              balanceType: AMOUNT
                              balanceValue: 0
                              currency:
                                currencyCode: USD
                            - balanceDate: '2021-07-06'
                              balanceDescription: Intra Day
                              balanceName: INTRADAY
                              balanceType: AMOUNT
                              balanceValue: 0
                              currency:
                                currencyCode: USD
                            - balanceDate: '2021-07-05'
                              balanceDescription: Prior Day
                              balanceName: PRIORDAY
                              balanceType: AMOUNT
                              balanceValue: 0
                              currency:
                                currencyCode: USD
                          currency:
                            currencyCode: USD
                          lastActivityDate: '2021-07-06T00:00:00Z'
                          margin: false
                          marginBalance: 0
                          nickname: Self-Directed
                          shortBalance: 0
                          status: OPEN
                          transactionsIncluded: false
                      - depositAccount:
                          accountId: g833202fb0866d0ad83472c429
                          accountNumberDisplay: xxxxxxxx0071
                          accountType: CHECKING
                          availableBalance: 106717.06
                          balanceAsOf: '2022-04-24T14:15:22Z'
                          balanceType: ASSET
                          currency:
                            currencyCode: USD
                          currentBalance: 106717.06
                          description: Checking Plus
                          fiAttributes:
                            - name: accountOpenedDate
                              value: '2020-04-23'
                            - name: interestPaidLastYear
                              value: '3.20'
                          interestRate: 0.0125
                          interestRateAsOf: '2022-04-24T14:15:22Z'
                          interestRateType: FIXED
                          interestYtd: 20.33
                          lastActivityDate: '2022-04-24T14:15:22Z'
                          lineOfBusiness: Personal
                          nickname: Nickname Checking Plus 0071
                          productName: Checking Plus
                          status: OPEN
                          transferIn: true
                          transferOut: true
                      - depositAccount:
                          accountId: 5dbda8de96eeff05f23934523a1fc258
                          accountNumberDisplay: xxxx0134
                          accountType: CHECKING
                          annualPercentageYield: 0
                          availableBalance: 0
                          balanceAsOf: '2022-04-24T14:15:22Z'
                          currency:
                            currencyCode: USD
                          currentBalance: 0
                          description: Virtual Wallet Student Reserve
                          interestRateAsOf: '2022-04-24T14:15:22Z'
                          interestRateType: FIXED
                          lastActivityDate: '2022-04-01T10:05:00Z'
                          lineOfBusiness: LBRB
                          openingDayBalance: 0
                          productName: Virtual Wallet Student Reserve
                          transactionsIncluded: false
                      - depositAccount:
                          accountId: 11719ae5-2399-1278-e43c-43f24abb3058
                          accountType: CD
                          annualPercentageYield: 0.75
                          availableBalance: 6808.29
                          balanceAsOf: '2021-04-07T10:20:43.276Z'
                          balanceType: ASSET
                          currency:
                            currencyCode: USD
                            originalCurrencyCode: USD
                          currentBalance: 6808.29
                          description: Certificate of Deposit
                          fiAttributes:
                            - name: eStatements
                              value: 'False'
                            - name: interestPaidLastYear
                              value: '50.72'
                            - name: isTransactionsSupported
                              value: 'False'
                            - name: issueDate
                              value: '2019-03-21T00:00:00.000Z'
                            - name: interestPayoutFrequency
                              value: Semi-Annually (And At Maturity)
                          interestRate: 0.75
                          interestYtd: 25.24
                          lineOfBusiness: CONSUMER
                          maturityDate: '2024-03-21T00:00:00Z'
                          nickname: Certificate of Deposit - 3691
                          openingDayBalance: 2000
                          parentAccountId: 11719ae5-2399-1278-e43c-43f24abb3058
                          status: OPEN
                          term: 60
                          transactionsIncluded: false
                          transferIn: false
                          transferOut: false
                      - depositAccount:
                          accountId: 33fbd9e5-9cc3-3d7d-15b3-70d97d87ca1d
                          accountType: SAVINGS
                          availableBalance: 20608.9
                          balanceAsOf: '2021-04-07T10:08:11.833Z'
                          balanceType: ASSET
                          currency:
                            currencyCode: USD
                            originalCurrencyCode: USD
                          currentBalance: 20608.9
                          description: Savings
                          fiAttributes:
                            - name: eStatements
                              value: 'True'
                          interestRate: 0.01
                          interestYtd: 0.29
                          lineOfBusiness: CONSUMER
                          nickname: Savings - 8537
                          openingDayBalance: 20608.9
                          parentAccountId: 33fbd9e5-9cc3-3d7d-15b3-70d97d87ca1d
                          status: OPEN
                          transactionsIncluded: false
        '206':
          description: Partial Content. Success searching for accounts. Some errors are being returned.
          headers:
            x-akoya-interaction-id:
              schema:
                type: string
              description: Akoya supplied interaction id used for logging and error tracking
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/balances'
              examples:
                Accounts 206 example:
                  value:
                    accounts:
                      - investmentAccount:
                          accountId: '839502593'
                          accountType: College Savings
                          availableCashBalance: 0
                          balanceAsOf: '2022-03-16T04:00:00Z'
                          balanceType: ASSET
                          currency:
                            currencyCode: USD
                          currentValue: 52672.49
                          holdings:
                            - assetClasses:
                                - assetClass: DOMESTICBOND
                                  percent: 0
                              cashAccount: false
                              marketValue: 52672.49
                              mutualFundSecurity:
                                mutualFundType: OPENEND
                                reinvestCapitalGains: true
                                reinvestDividends: true
                                unitsStreet: 0
                                unitsUser: 0
                                yield: 0
                                yieldAsOfDate: '2019-08-24T14:15:22Z'
                              positionType: LONG
                              purchasedPrice: 18.42
                              securityIdType: ISIN
                              units: 2088.521
                          marginBalance: 0
                          nickname: 529 for Kid
                      - investmentAccount:
                          error:
                            code: 704
                            message: Account type not supported
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '503':
          $ref: '#/components/responses/503'
      parameters:
        - $ref: '#/components/parameters/accountIdQuery'
        - schema:
            type: string
            example: batch
            enum:
              - user
              - batch
          in: header
          name: x-akoya-interaction-type
          description: |-
            Optional but recommended header to include with each data request. 
            Allowed values are `user` or `batch`. 
            `user` indicates a request is prompted by an end-user action.
            `batch` indicates the request is part of a batch process.
        - schema:
            type: string
            enum:
              - raw
              - standard
            example: raw
          in: query
          name: mode
          description: 'BETA. Default is raw. Use standard for FDX-aligned, standardized data values.'
      x-stoplight:
        id: j5pktj8diaa6f
    parameters:
      - $ref: '#/components/parameters/versionPath'
      - $ref: '#/components/parameters/providerIdPath'
  '/customers/{version}/{providerId}/current':
    get:
      operationId: customer-info
      tags:
        - Customers
      description: "This product supports use cases such as payment enablement, account opening, or lending & credit enhancement. Responses return information about the authorized end-user, the customer associated with the `id_token` used in the call. This information may include, but is not limited to, the customer identifier, name, email, address, and phone number.\n\n<br>\n\nTo see the response schema, select the `200` response below. For an example payload response, see the `200` example response below the *Try it* feature. \n\n> \U0001F6D1\n> \n> The *id_token* should be used as the bearer token with this call."
      summary: Customer info
      parameters:
        - $ref: '#/components/parameters/versionPath'
        - $ref: '#/components/parameters/providerIdPath'
        - schema:
            type: string
            example: batch
            enum:
              - user
              - batch
          in: header
          name: x-akoya-interaction-type
          description: |-
            Optional but recommended header to include with each data request. 
            Allowed values are `user` or `batch`. 
            `user` indicates a request is prompted by an end-user action.
            `batch` indicates the request is part of a batch process.
      security:
        - bearerAuth: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/currentCustomer'
              examples: {}
          headers:
            x-akoya-interaction-id:
              schema:
                type: string
              description: Akoya tracking id for logging or support.
      x-stoplight:
        id: 50jrizdmqzo6q
  '/payments/{version}/{providerId}/{accountId}/payment-networks':
    get:
      tags:
        - Payments
      summary: Payments
      description: "This product supports use cases such as payment enablement or account opening. The response includes identifiers necessary to make ACH and RTP payments. Identifiers include account number, routing number, identifier type (actual or tokenized account number), and payment network type such as ACH or RTP.\n\n<br>\n\nTo see the response schema, select the `200` response below. For an example payload response, see the `200` example response below the *Try it* feature. \n\n> \U0001F6D1\n> \n> The *id_token* should be used as the bearer token with this call."
      operationId: payment-networks
      parameters:
        - $ref: '#/components/parameters/versionPath'
        - $ref: '#/components/parameters/providerIdPath'
        - $ref: '#/components/parameters/accountIdPath'
        - schema:
            type: string
            example: batch
            enum:
              - user
              - batch
          in: header
          name: x-akoya-interaction-type
          description: |-
            Optional but recommended header to include with each data request. 
            Allowed values are `user` or `batch`. 
            `user` indicates a request is prompted by an end-user action.
            `batch` indicates the request is part of a batch process.
      deprecated: false
      security:
        - bearerAuth: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/accountPaymentNetworkList'
              examples:
                paymentNetworks:
                  value:
                    paymentNetworks:
                      - bankId: '125000024'
                        identifier: '454992210071'
                        identifierType: ACCOUNT_NUMBER
                        type: US_ACH
                        transferIn: true
                        transferOut: true
                No paymentNetworks:
                  value:
                    paymentNetworks: []
          headers:
            x-akoya-interaction-id:
              schema:
                type: string
              description: Akoya tracking id for logging or support.
        '401':
          description: 602 - Customer does not have authorization to perform this action. The customer may have revoked access through provider and would need to reauthenticate.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              example:
                code: 602
                message: Customer not authorized
          headers:
            x-akoya-interaction-id:
              schema:
                type: string
              description: Akoya tracking id for logging or support.
        '403':
          description: 403 - The `providerId` is wrong or your app doesn't have a subscription to the provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              example:
                code: 403
                message: Subscription not found
          headers:
            x-akoya-interaction-id:
              schema:
                type: string
              description: Akoya tracking id for logging or support.
        '404':
          description: 701 - Account not found. The `accountId` may be wrong.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              example:
                code: 701
                message: Account not found
          headers:
            x-akoya-interaction-id:
              schema:
                type: string
              description: Akoya tracking id for logging or support.
      x-stoplight:
        id: 4giq9ne2lt4li
  '/statements/{version}/{providerId}/{accountId}':
    parameters:
      - $ref: '#/components/parameters/accountIdPath'
      - $ref: '#/components/parameters/versionPath'
      - $ref: '#/components/parameters/providerIdPath'
    get:
      summary: Statement list
      tags:
        - Statements
      operationId: get-statement-list
      description: |-
        Retrieve a list of available statements for the end-user's consented accounts. You may request a date range of up to two years of historical statements (maximum date ranges vary by provider).

        The paginated response includes an array of statement information with the end-user's account id and statement details such as statement id, date, description, and status. The results also include links to GET the statement image.
      security:
        - bearerAuth: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/statements'
        '400':
          description: Start or end date value is not in the ISO 8601 format
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              examples:
                702 - Invalid start or end date:
                  value:
                    code: 702
                    message: Invalid start or end date
                703 - Invalid date range:
                  value:
                    code: 703
                    message: Invalid date range
        '404':
          description: 404 - Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              examples:
                701 Account not found:
                  value:
                    code: 701
                    message: Account not found
                1107 Data not found for request parameters:
                  value:
                    code: 1107
                    message: Data not found for request parameters
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '503':
          $ref: '#/components/responses/503'
      parameters:
        - $ref: '#/components/parameters/startDateQuery'
        - $ref: '#/components/parameters/endDateQuery'
        - $ref: '#/components/parameters/offsetQuery'
        - $ref: '#/components/parameters/limitQuery'
        - schema:
            type: string
            example: batch
            enum:
              - user
              - batch
          in: header
          name: x-akoya-interaction-type
          description: |-
            Optional but recommended header to include with each data request. 
            Allowed values are `user` or `batch`. 
            `user` indicates a request is prompted by an end-user action.
            `batch` indicates the request is part of a batch process.
      x-stoplight:
        id: w1kdr2kwlj828
  '/statements/{version}/{providerId}/{accountId}/{statementId}':
    parameters:
      - $ref: '#/components/parameters/accountIdPath'
      - $ref: '#/components/parameters/versionPath'
      - $ref: '#/components/parameters/providerIdPath'
      - $ref: '#/components/parameters/statementIdPath'
    get:
      summary: Statement
      tags:
        - Statements
      operationId: get-statements
      description: |-
        Retrieve a specific account statement file. Use [HTTP Accept request-header](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html) to specify desired content types. 

        For the initial launch, only PDF statements are supported. PDFs are returned in the response.

        ### cURL request

        We recommend using the auto-generated cURL request with the {idToken}, accountId, providerId, statementId, and version with an added cURL parameter to return the output to a file. For example:

        ```curl
        curl --request GET --url https://sandbox-products.ddp.akoya.com/statements/v2/mikomo/513815781465/P9CvLPKDaFRMbNDkhu1 --header "accept: application/pdf" --header "authorization: Bearer {idtoken}" --output example.pdf
        ```
      security:
        - bearerAuth: []
      parameters:
        - schema:
            type: string
            example: batch
            enum:
              - user
              - batch
          in: header
          name: x-akoya-interaction-type
          description: |-
            Optional but recommended header to include with each data request. 
            Allowed values are `user` or `batch`. 
            `user` indicates a request is prompted by an end-user action.
            `batch` indicates the request is part of a batch process.
      responses:
        '200':
          description: OK - An image of an account statement
          content:
            application/pdf:
              schema:
                description: A pdf of an account statement
                type: string
                format: binary
            image/gif:
              schema:
                description: A gif image of an account statement
                type: string
                format: binary
            image/jpeg:
              schema:
                description: A jpeg image of an account statement
                type: string
                format: binary
            image/tiff:
              schema:
                description: A tiff image of an account statement
                type: string
                format: binary
            image/png:
              schema:
                description: A png image of an account statement
                type: string
                format: binary
          headers:
            Accept:
              schema:
                type: string
        '302':
          description: 302 - Statement is available at specified location. URL is returned via the `Location` HTTP header
        '400':
          description: Statement is processing and is not yet available
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              examples:
                1300 - Statement is Processing:
                  value:
                    code: 1300
                    message: Statement is Processing
        '404':
          description: When account is present with no statements in it
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              examples:
                1108 - Statements not found for given Account:
                  value:
                    code: 1108
                    message: Statements not found for given Account
                1104 - Statement id not found for Account:
                  value:
                    code: 1104
                    message: Statement id not found for Account
        '406':
          $ref: '#/components/responses/406'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '503':
          $ref: '#/components/responses/503'
      x-stoplight:
        id: l1xrmozaq69xu
  '/contacts/{version}/{providerId}/{accountId}':
    get:
      operationId: get-account-holder
      tags:
        - Customers
      description: "> \U0001F4CC Please note!\n>\n> This endpoint should only be used instead of _customer info_ when specific providers require it. Otherwise, please use _customer info_.\n\nGet account holder information. Based on FDX 5.2.1.\n\nThis product requires consumer consent to share all account holder information.\n"
      summary: Account holder information
      parameters:
        - $ref: '#/components/parameters/accountIdPath'
        - $ref: '#/components/parameters/versionPath'
        - $ref: '#/components/parameters/providerIdPath'
        - schema:
            type: string
            example: batch
            enum:
              - user
              - batch
          in: header
          name: x-akoya-interaction-type
          description: |-
            Optional but recommended header to include with each data request. 
            Allowed values are `user` or `batch`. 
            `user` indicates a request is prompted by an end-user action.
            `batch` indicates the request is part of a batch process.
      security:
        - bearerAuth: []
      responses:
        '200':
          description: OK
          headers:
            x-akoya-interaction-id:
              schema:
                type: string
              description: Akoya supplied interaction id used for logging and error tracking
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/accountContact'
              examples:
                Example 1:
                  value:
                    holders:
                      - customerId: string
                        name:
                          first: string
                          middle: string
                          last: string
                          prefix: string
                          suffix: string
                          company: string
                        businessCustomer:
                          name: string
                          registeredAgents:
                            - first: string
                              middle: string
                              last: string
                              prefix: string
                              suffix: string
                              company: string
                          registeredId: string
                          industryCode:
                            type: string
                            code: string
                          domicile:
                            region: string
                            country: string
                        addresses:
                          - line1: string
                            line2: string
                            line3: string
                            city: string
                            state: string
                            region: string
                            postalCode: string
                            country: string
                            type: string
                        telephones:
                          - number: string
                            type: HOME
                            country: string
                        email:
                          - string
                        accounts:
                          - accountId: string
                            relationship: AUTHORIZED_USER
                        relationship: AUTHORIZED_USER
                    emails:
                      - string
                    addresses:
                      - line1: string
                        line2: string
                        line3: string
                        city: string
                        state: string
                        region: string
                        postalCode: string
                        country: string
                        type: string
                    telephones:
                      - type: HOME
                        country: string
                        number: '8675309'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              examples:
                Example 1:
                  value:
                    code: 701
                    message: Account not found
      x-stoplight:
        id: z5ker835twgav
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      description: The `id_token` should be used as the bearer token in this call.
      type: http
      scheme: bearer
      bearerFormat: JWT
  schemas:
    accountContact:
      title: Account Contact entity
      description: Contact information for the account
      type: object
      properties:
        holders:
          type: array
          items:
            $ref: '#/components/schemas/accountHolder'
          description: Owners of the account
        emails:
          type: array
          items:
            type: string
          description: Email addresses associated with the account
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/deliveryAddress'
          description: Physical mail addresses associated with the account
        telephones:
          type: array
          items:
            $ref: '#/components/schemas/telephoneNumber'
          description: Telephone numbers associated with the account
      x-stoplight:
        id: jfcnbtwrrsqou
    accountHolder:
      title: Account Holder entity
      description: Extends `Customer` and adds a `relationship` field to define the customer's relationship with an account
      type: object
      allOf:
        - $ref: '#/components/schemas/customer'
        - type: object
          properties:
            relationship:
              $ref: '#/components/schemas/accountHolderRelationship'
              description: Customer's relationship to the account
      x-stoplight:
        id: xls97q4n5vf1j
    accountHolderRelationship:
      title: Account Holder Relationship
      description: Types of relationships between accounts and holders. Suggested values
      type: string
      enum:
        - AUTHORIZED_USER
        - BUSINESS
        - FOR_BENEFIT_OF
        - FOR_BENEFIT_OF_PRIMARY
        - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED
        - FOR_BENEFIT_OF_SECONDARY
        - FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED
        - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED
        - POWER_OF_ATTORNEY
        - PRIMARY_JOINT_TENANTS
        - PRIMARY
        - PRIMARY_BORROWER
        - PRIMARY_JOINT
        - SECONDARY
        - SECONDARY_JOINT_TENANTS
        - SECONDARY_BORROWER
        - SECONDARY_JOINT
        - SOLE_OWNER
        - TRUSTEE
        - UNIFORM_TRANSFER_TO_MINOR
      x-stoplight:
        id: zo3bpcu4qzpq7
    accountInfo:
      title: Account information
      type: object
      properties:
        accountId:
          description: Long-term persistent identity of the account. Not an account number. This identity must be unique to the owning institution.
          type: string
          example: 8e931a0c-ffac-40c5-88dd-528ee347feec
        accountType:
          description: 'The type of an account. For instance, CHECKING, SAVINGS, 401K, etc.'
          type: string
          example: CHECKING
        accountNumberDisplay:
          description: Account display number for the end user’s handle at owning institution. This is to be displayed by the Interface Provider.
          type: string
          example: xxx1414
        currency:
          $ref: '#/components/schemas/currency'
        description:
          type: string
          example: Bank Interest Checking
        error:
          $ref: '#/components/schemas/error'
          description: Present if an error was encountered while retrieving this account
        fiAttributes:
          type: array
          items:
            $ref: '#/components/schemas/fiAttribute'
        nickname:
          description: Name given by the user. Used in UIs to assist in account selection
          type: string
          example: My account (nickname)
        productName:
          type: string
          description: 'Marketed product name for this account.  Used in UIs to assist in account selection          '
          example: Interest Checking
        status:
          type: string
          enum:
            - OPEN
            - CLOSED
            - PENDINGOPEN
            - PENDINGCLOSE
            - DELINQUENT
            - PAID
            - NEGATIVECURRENTBALANCE
          description: The status of an account.
        lineOfBusiness:
          description: 'The line of business, such as consumer, consumer joint, small business, corporate, etc.'
          type: string
          example: CONSUMER
        balanceType:
          type: string
          description: 'ASSET (positive transaction amount increases balance), LIABILITY (positive transaction amount decreases balance)'
          enum:
            - ASSET
            - LIABILITY
        interestRate:
          description: Interest Rate of Account
          type: number
          example: 0.05
        interestRateType:
          type: string
          enum:
            - FIXED
            - VARIABLE
          description: The type of interest rate. FIXED or VARIABLE.
        interestRateAsOf:
          type: string
          description: Date of account’s interest rate
          format: date-time
        lastActivityDate:
          type: string
          description: Date that last transaction occurred on account
          format: date-time
        micrNumber:
          description: MICR Number. (Magnetic Ink Character Recognition)
          type: string
        parentAccountId:
          description: Long-term persistent identity of the parent account. This is used to group accounts.
          type: string
          example: 8e931a0c-ffac-40c5-88dd-528ee347feec
        priorInterestRate:
          description: Previous Interest Rate of Account
          type: number
          example: 0.06
        transferIn:
          type: boolean
          description: Account is eligible for incoming transfers
        transferOut:
          type: boolean
          description: Account is eligible for outgoing transfers
      required:
        - accountId
      x-stoplight:
        id: tu9in4wsiti6o
    account-info:
      title: Akoya Account Info product
      description: An optionally paginated array of accounts
      type: object
      allOf:
        - type: object
          properties:
            accounts:
              type: array
              description: 'An array of accounts with entity types dependent on the account type (deposit, investment, loan, line of credit, annuity or insurance)'
              items:
                anyOf:
                  - properties:
                      depositAccount:
                        $ref: '#/components/schemas/depositAccount'
                  - properties:
                      loanAccount:
                        $ref: '#/components/schemas/loanAccount'
                  - properties:
                      locAccount:
                        $ref: '#/components/schemas/locAccount'
                  - properties:
                      investmentAccount:
                        $ref: '#/components/schemas/investmentAccount'
                  - properties:
                      insuranceAccount:
                        $ref: '#/components/schemas/insuranceAccount'
                  - properties:
                      annuityAccount:
                        $ref: '#/components/schemas/annuityAccount'
      x-stoplight:
        id: 7y7d3d6xc6ty6
    accountPaymentNetworkList:
      title: Array of account payment networks
      description: An optionally paginated array of payment networks supported by the account
      allOf:
        - type: object
          properties:
            paymentNetworks:
              type: array
              items:
                $ref: '#/components/schemas/accountPaymentNetwork'
              description: Array of payment networks
      x-stoplight:
        id: 4dmrx4dkrid64
    accountPaymentNetwork:
      title: Payment Network Supported by Account
      description: This provides details required to execute a transaction against the account within the payment network
      type: object
      properties:
        bankId:
          type: string
          description: Bank identifier used by the payment network ie. Routing Number
        identifier:
          type: string
          description: 'The number used to identify the account within the payment network. If identifierType is ACCOUNT_NUMBER, this is the account number.'
        identifierType:
          type: string
          description: Type of identifier
        type:
          type: string
          description: Type of payment network
        transferIn:
          type: boolean
          description: Can transfer funds to the account using this information
        transferOut:
          type: boolean
          description: Can transfer funds from the account using this information
      x-stoplight:
        id: t0l9yqbek5jji
    address:
      title: Address
      description: Postal address
      type: object
      properties:
        line1:
          type: string
          description: Address line 1. May contain full address if not separated
        line2:
          type: string
          description: Address line 2
        line3:
          type: string
          description: Address line 3
        city:
          type: string
          description: City
        state:
          type: string
          description: 'State or province. Deprecated, will remove in FDX V6.0'
        region:
          type: string
          description: State or province or territory. Replaces "state" property
        postalCode:
          type: string
          description: Postal code
        country:
          type: string
          description: ISO 3166 Country Code
      x-stoplight:
        id: o03x026gp2hxq
    annuityAccount:
      title: AnnuityAccount
      description: Annuity Account
      allOf:
        - $ref: '#/components/schemas/accountInfo'
        - type: object
          properties:
            annuityProductType:
              enum:
                - CURRENCY
                - SHARES
              type: string
            annuityValueBasis:
              enum:
                - FIXED
                - VARIABLE
              type: string
            paymentFrequency:
              type: string
              enum:
                - ANNUALLY
                - QUARTERLY
                - MONTHLY
                - WEEKLY
      x-stoplight:
        id: n4xijrlpkhie0
    annuityBalance:
      title: Annuity balances
      description: Data elements included with balances specific to annuity accounts
      allOf:
        - $ref: '#/components/schemas/annuityAccount'
        - type: object
          properties:
            annualIncrease:
              description: Percent or dollar amount of annual payment increase
              type: number
            annualIncreaseType:
              type: string
              enum:
                - FIXED
                - PERCENT
                - DOLLAR
            netPresentValue:
              description: Surrender or cash balance value
              type: number
            paymentAmount:
              description: Amount of the recurring payment
              type: number
            paymentEndDate:
              type: string
              description: Date last payment will be made
              format: date-time
            paymentStartDate:
              type: string
              description: Date of first payment; could be a future date
              format: date-time
            periodCertainGuarantee:
              type: string
              enum:
                - NO PERIOD CERTAIN
                - 5-YEAR
                - 10-YEAR
                - 20-YEAR
                - 30-YEAR
            totalPaymentCount:
              description: Total number of payments that will be produced by the annuity
              type: number
      x-stoplight:
        id: 9qdmtzbug48ql
    balances:
      title: ''
      type: object
      allOf:
        - type: object
          properties:
            accounts:
              type: array
              description: 'An array of accounts with entity types dependent on the account type (deposit, investment, loan, line of credit, annuity or insurance)'
              items:
                anyOf:
                  - properties:
                      depositAccount:
                        $ref: '#/components/schemas/depositBalance'
                  - properties:
                      loanAccount:
                        $ref: '#/components/schemas/loanBalance'
                  - properties:
                      locAccount:
                        $ref: '#/components/schemas/locBalance'
                  - properties:
                      investmentAccount:
                        $ref: '#/components/schemas/investmentBalance'
                  - properties:
                      insuranceAccount:
                        $ref: '#/components/schemas/insuranceBalance'
                  - properties:
                      annuityAccount:
                        $ref: '#/components/schemas/annuityBalance'
      x-stoplight:
        id: fuatssv141370
    balanceList:
      title: Investment Balance List
      type: object
      properties:
        balanceName:
          type: string
          description: Name of the balance.
        balanceDescription:
          type: string
          description: Description of balance.
        balanceType:
          type: string
          enum:
            - AMOUNT
            - PERCENTAGE
          description: The type of an investment balance. AMOUNT or PERCENTAGE.
        balanceValue:
          type: number
          description: Value of balance name.
        balanceDate:
          type: string
          description: Date as of this balance.
          format: date-time
        currency:
          $ref: '#/components/schemas/currency'
      x-stoplight:
        id: dqm2nky3r2th0
    businessCustomer:
      title: Business Customer entity
      description: Customers that are commercial in nature are affiliated with a business entity
      type: object
      properties:
        name:
          type: string
          description: Name of business customer
        registeredAgents:
          type: array
          description: A list of registered agents who act on behalf of the business customer
          items:
            $ref: '#/components/schemas/customerName'
        registeredId:
          type: string
          description: The registered tax identification number (TIN) or other identifier of business customer
        industryCode:
          description: Industry code and type
          type: object
          properties:
            type:
              type: string
            code:
              type: string
        domicile:
          description: The country and region of the business customer's location
          type: object
          properties:
            region:
              type: string
            country:
              type: string
      x-stoplight:
        id: 6vsnf303rpl0b
    contribution:
      title: Contribution Entity
      type: object
      description: Describes how new contributions are distributed among the available securities.
      properties:
        securityId:
          type: string
          description: Unique identifier of security
        securityIdType:
          type: string
          description: Security identifier type
          enum:
            - CUSIP
            - ISIN
            - SEDOL
            - SICC
            - VALOR
            - WKN
        employerMatchPercentage:
          type: number
          description: Employer contribution match percentage
        employerMatchAmount:
          type: number
          description: Employer contribution match amount
        employeePreTaxAmount:
          type: number
          description: Employee pre‐tax contribution amount
        employeePreTaxPercentage:
          type: number
          description: Employee pre‐tax contribution percentage
        employeeAfterTaxAmount:
          type: number
          description: Employee after tax contribution amount
        employeeAfterTaxPercentage:
          type: number
          description: Employee after tax contribution percentage
        employeeDeferPreTaxAmount:
          type: number
          description: Employee defer pre‐tax contribution match amount
        employeeDeferPreTaxPercentage:
          type: number
          description: Employee defer pre‐tax contribution match percentage
        employeeYearToDate:
          type: number
          description: Employee total year to date contribution
        employerYearToDate:
          type: number
          description: Employer total year to date contribution
        rolloverContributionPercentage:
          type: number
          description: Rollover contribution percentage
        rolloverContributionAmount:
          type: number
          description: Rollover contribution Amount
      x-stoplight:
        id: 3pqfsyrv81huc
    currency:
      title: Currency Entity
      type: object
      description: Indicates the currency code used by the account. May also include currency rate.
      properties:
        currencyCode:
          description: Iso 4217 currency code.
          type: string
          default: USD
          example: USD
        currencyRate:
          description: Currency rate between original and converted currency.
          type: number
        originalCurrencyCode:
          description: Iso 4217 currency code.
          type: string
      x-stoplight:
        id: ial41yb11xydg
    customer:
      description: Represents a customer (end-user)
      type: object
      properties:
        customerId:
          type: string
          description: Long-term persistent identity of the end-user. This identity must be unique to the owning institution
        name:
          $ref: '#/components/schemas/customerName'
          description: The end-user's name
        businessCustomer:
          $ref: '#/components/schemas/businessCustomer'
          description: 'The business customer information, only used if ''type'' is ''BUSINESS''.'
        addresses:
          type: array
          description: An array of the customer's physical mail addresses
          items:
            $ref: '#/components/schemas/deliveryAddress'
        telephones:
          type: array
          uniqueItems: true
          minItems: 1
          items:
            type: object
            properties:
              number:
                type: string
              type:
                type: string
                enum:
                  - HOME
                  - BUSINESS
                  - CELL
                  - FAX
              country:
                type: string
                description: Country calling codes defined by ITU-T recommendations E.123 and E.164
        email:
          type: array
          description: An array of the end-user's electronic mail addresses
          items:
            type: string
        accounts:
          type: array
          uniqueItems: true
          minItems: 1
          description: List of accounts related to this end-user
          items:
            type: object
            properties:
              accountId:
                type: string
                description: Account ID of the related account
              relationship:
                type: string
                description: Types of relationships between accounts and holders. Suggested values
                enum:
                  - AUTHORIZED_USER
                  - BUSINESS
                  - FOR_BENEFIT_OF
                  - FOR_BENEFIT_OF_PRIMARY
                  - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED
                  - FOR_BENEFIT_OF_SECONDARY
                  - FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED
                  - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED
                  - POWER_OF_ATTORNEY
                  - PRIMARY_JOINT_TENANTS
                  - PRIMARY
                  - PRIMARY_BORROWER
                  - PRIMARY_JOINT
                  - SECONDARY
                  - SECONDARY_JOINT_TENANTS
                  - SECONDARY_BORROWER
                  - SECONDARY_JOINT
                  - SOLE_OWNER
                  - TRUSTEE
                  - UNIFORM_TRANSFER_TO_MINOR
      x-stoplight:
        id: fp6a28gkvuh7j
    customerName:
      title: customerName
      type: object
      properties:
        first:
          type: string
          description: First or given name. This data element may contain first & last name if not separated.
        middle:
          type: string
        last:
          type: string
        prefix:
          description: 'Name prefix, e.g. Mr.'
          type: string
        suffix:
          description: Generational or academic suffix
          type: string
        company:
          type: string
          description: Company name
      x-stoplight:
        id: tmuqe9cxyjah1
    currentCustomer:
      title: Current customer
      description: Currently authenticated end-user
      type: object
      properties:
        customer:
          $ref: '#/components/schemas/customer'
          description: current customer
      x-stoplight:
        id: 7rxzxnide77f6
    debtSecurity:
      title: DebtSecurity Entity
      description: Information about the debt security specific to the type of security
      type: object
      properties:
        parValue:
          type: number
          description: Par value amount
        debtType:
          type: string
          description: Debt type
          enum:
            - ASSET
            - COUPON
        debtClass:
          type: string
          description: Classification of debt
          enum:
            - TREASURY
            - MUNICIPAL
            - CORPORATE
            - OTHER
        couponRate:
          type: number
          description: Bond coupon rate for next closest call date
        couponDate:
          type: string
          format: date-time
          description: Maturity date for next coupon
        couponMatureFrequency:
          type: string
          description: When coupons mature
          enum:
            - MONTHLY
            - QUARTERLY
            - SEMIANNUAL
            - ANNUAL
            - OTHER
        callPrice:
          type: number
          description: Bond call price
        yieldToCall:
          type: number
          description: Yield to next call
        callDate:
          type: string
          format: date-time
          description: Next call date
        callType:
          type: string
          description: Type of next call
          enum:
            - CALL
            - PUT
            - PREFUND
            - MATURITY
        yieldToMaturity:
          type: number
          description: Yield to maturity
        bondMaturityDate:
          type: string
          format: date-time
          description: Bond Maturity date
      x-stoplight:
        id: sb4jmqzulwise
    deliveryAddress:
      allOf:
        - type: object
          $ref: '#/components/schemas/address'
        - type: object
          properties:
            type:
              type: string
              description: 'Type of address location. One of BUSINESS, HOME, MAILING'
      x-stoplight:
        id: r9uj0xv44b4og
    depositAccount:
      title: DepositAccount
      description: Deposit Account
      allOf:
        - $ref: '#/components/schemas/accountInfo'
        - type: object
          properties:
            annualPercentageYield:
              description: 'Annual Percentage Yield. If account type = CD, required.'
              type: number
            term:
              type: integer
              description: Term of CD in months
            maturityDate:
              type: string
              description: 'Maturity date for CDs. If account type = CD, required.'
              format: date-time
      x-stoplight:
        id: mkudzpgobk9i1
    depositBalance:
      title: Deposit balances
      description: Data elements included with balances specific to deposit accounts
      allOf:
        - $ref: '#/components/schemas/depositAccount'
        - type: object
          properties:
            balanceAsOf:
              type: string
              description: As-of date of balances
              format: date-time
            openingDayBalance:
              description: Day's opening fund balance
              type: number
            availableBalance:
              description: Balance of funds available for use
              type: number
            interestYtd:
              description: YTD Interest
              type: number
            currentBalance:
              description: Balance of funds in account
              type: number
      x-stoplight:
        id: zfw8gflvew2zt
    depositTransaction:
      description: Deposit transaction
      allOf:
        - $ref: '#/components/schemas/transaction'
        - type: object
          properties:
            payee:
              type: string
              description: Payee name
            checkNumber:
              type: integer
              description: Check Number
            transactionType:
              type: string
              description: DepositTransaction Type
              enum:
                - CHECK
                - WITHDRAWAL
                - TRANSFER
                - POSDEBIT
                - ATMWITHDRAWAL
                - BILLPAYMENT
                - FEE
                - DEPOSIT
                - ADJUSTMENT
                - INTEREST
                - DIVIDEND
                - DIRECTDEPOSIT
                - ATMDEPOSIT
                - POSCREDIT
      x-stoplight:
        id: 4wj9l52aegpzk
    equityGrant:
      title: equityGrant
      type: object
      properties:
        grantId:
          type: string
          description: Unique identifier of grant
        grantDate:
          type: string
          format: date-time
          description: Date grant was given
        grantType:
          type: string
          description: Type of grant
        seqNum:
          type: number
        grantPrice:
          type: number
          description: Grant price
        grantCurrencyCode:
          type: string
          description: 'Indicates the currency of grant USD vs AUD vs EUR etc (for share awards, you will still get a USD)'
        quantityGranted:
          type: number
          description: Number of options
        quantityOutstanding:
          type: number
        expirationDate:
          type: string
          format: date-time
          description: Date grant expires
        vestings:
          type: array
          description: 'An array of equityGrant vestings. Provides the past, present, and future vesting schedule and percentages.'
          items:
            type: object
            properties:
              vestedQuantity:
                description: Vested quantity (Vested shares total qty of vesting tranche)
                type: number
              vestedValue:
                type: number
                description: Vested balance at grant (aggregate of all vestings)
              vestingDate:
                type: string
                format: date-time
              vestExpireDate:
                type: string
                format: date-time
              vestedStatus:
                type: string
      x-stoplight:
        id: aucu90ex3cydu
    fiAttribute:
      title: FiAttribute Entity
      description: Data provider-specific attribute
      type: object
      properties:
        name:
          type: string
          description: Name of attribute
          example: openDate
        value:
          type: string
          description: Value of attribute
          example: '2011-07-20'
      x-stoplight:
        id: yvo8czhxx7ml5
    error:
      title: Error Entity
      description: An error entity which can be used at the API level for error responses or at the account level to indicate a problem specific to a particular account.
      type: object
      properties:
        code:
          type: integer
          description: Long term persistent identifier which can be used to trace error condition back to log information
        message:
          type: string
          description: End user displayable information which might help the customer diagnose an error
      x-stoplight:
        id: kp0jaesl5f0f9
    hateoasLink:
      title: HATEOAS Link
      description: REST application constraint (Hypermedia As The Engine Of Application State)
      type: object
      properties:
        href:
          type: string
          format: uri-reference
          description: URL to invoke the action on the resource
          example: 'https://api.fi.com/fdx/v4/accounts/12345'
        action:
          type: string
          enum:
            - GET
            - POST
            - PATCH
            - DELETE
            - PUT
          description: HTTP Method to use for the request
        types:
          type: array
          description: Content-types that can be used in the Accept header.
          items:
            type: string
            enum:
              - application/pdf
              - image/gif
              - image/jpeg
              - image/tiff
              - image/png
              - application/json
            example: application/json
      x-stoplight:
        id: az2t8defk8n2o
    holding:
      title: An investment holding
      allOf:
        - type: object
        - type: object
          properties:
            assetClasses:
              type: array
              uniqueItems: true
              minItems: 1
              description: Percent breakdown by asset class.
              items:
                type: object
                properties:
                  assetClass:
                    type: string
                    enum:
                      - DOMESTICBOND
                      - INTLBOND
                      - LARGESTOCK
                      - SMALLSTOCK
                      - INTLSTOCK
                      - MONEYMARKET
                      - OTHER
                  percent:
                    type: number
                    description: Percentage of asset class that falls under this asset
            averageCost:
              type: boolean
              description: Cost is average of all purchases for holding.
            cashAccount:
              type: boolean
              description: 'If true, indicates that this holding is used to maintain proceeds from sales, dividends, and other cash postings to the investment account.'
            changeInPrice:
              type: number
              description: Change in current price compared to previous day's close
            currency:
              $ref: '#/components/schemas/currency'
            currentUnitPrice:
              type: number
            currentUnitPriceDate:
              type: string
              format: date-time
              description: Current unit price as of date
            description:
              type: string
              description: Description of the holding
            expirationDate:
              type: string
              description: 'For CDs, bonds, and other time-based holdings.'
              format: date-time
            faceValue:
              type: number
              description: Required for bonds. Face value at the time of data retrieved.
            fiAssetClasses:
              type: array
              description: Percent breakdown by FI-specific asset class percentage breakdown
              items:
                type: object
                properties:
                  assetClass:
                    type: string
                    description: FI-specific asset class
                  percent:
                    type: number
                    description: Percentage of asset class that falls under this asset
            fiAttributes:
              type: array
              uniqueItems: true
              minItems: 1
              items:
                $ref: '#/components/schemas/fiAttribute'
            heldInAccount:
              type: string
              description: Sub-account
              enum:
                - CASH
                - MARGIN
                - SHORT
                - OTHER
            holdingId:
              type: string
              description: Long term persistent identity of the holding
            holdingName:
              type: string
              description: Holding name or security name
            holdingSubType:
              type: string
              enum:
                - MONEYMARKET
                - CASH
            holdingType:
              type: string
              enum:
                - STOCK
                - BOND
                - MUTUALFUND
                - CD
                - ANNUITY
                - OPTION
                - OTHER
            inv401kSurce:
              type: string
              description: 'Source for money for this security. '
              enum:
                - PRETAX
                - AFTERTAX
                - MATCH
                - PROFITSHARING
                - ROLLOVER
                - OTHERVEST
                - OTHERNONVEST
            marketValue:
              type: number
              description: Market value at the time of data retrieved
            originalPurchaseDate:
              type: string
              description: Date of original purchase
              format: date-time
            positionType:
              type: string
              enum:
                - LONG
                - SHORT
            purchasedPrice:
              type: number
              description: Price of holding at the time of purchase
            rate:
              type: number
              description: 'For CDs, bonds, and other rate based holdings.'
            securityId:
              type: string
              description: Unique identifier of security
            securityIdType:
              type: string
              description: Security identifier type
              enum:
                - CUSIP
                - ISIN
                - SEDOL
                - SICC
                - VALOR
                - WKN
            symbol:
              type: string
              description: Ticker / Market symbol
            taxLots:
              type: array
              uniqueItems: true
              minItems: 1
              description: Breakdown by tax lot.
              items:
                type: object
                properties:
                  costBasis:
                    type: number
                    description: Total amount of money spent acquiring this lot including any fees or commission expenses incurred.
                  currentValue:
                    type: number
                    description: Lot market value
                  originalPurchaseDate:
                    type: string
                    format: date-time
                    description: Lot acquired date.
                  postionType:
                    type: string
                    enum:
                      - LONG
                      - SHORT
                    description: 'LONG, SHORT.'
                  purchasedPrice:
                    type: number
                    description: Original purchase price.
                  quantity:
                    type: number
                    description: Lot quantity.
            units:
              type: number
              description: 'Required for stock, mutual funds. Number of shares (with decimals).'
        - oneOf:
            - type: object
              properties:
                mutualFundSecurity:
                  $ref: '#/components/schemas/mutualFundSecurity'
            - type: object
              properties:
                optionSecurity:
                  $ref: '#/components/schemas/optionSecurity'
            - type: object
              properties:
                otherSecurity:
                  $ref: '#/components/schemas/otherSecurity'
            - type: object
              properties:
                stockSecurity:
                  $ref: '#/components/schemas/stockSecurity'
            - type: object
              properties:
                sweepSecurity:
                  $ref: '#/components/schemas/sweepSecurity'
            - type: object
              properties:
                debtSecurity:
                  $ref: '#/components/schemas/debtSecurity'
      x-stoplight:
        id: omo6v1rnjqq91
    insuranceAccount:
      title: InsuranceAccount
      description: Insurance Account
      allOf:
        - $ref: '#/components/schemas/accountInfo'
        - type: object
          properties:
            accountCategory:
              type: string
              enum:
                - DEPOSIT_ACCOUNT
                - INVESTMENT_ACCOUNT
                - LOAN_ACCOUNT
                - LOC_ACCOUNT
                - INSURANCE_ACCOUNT
              description: 'The account category of the insurance account. Possible enums: DEPOSIT_ACCOUNT, INVESTMENT_ACCOUNT, LOAN_ACCOUNT, LOC_ACCOUNT, INSURANCE_ACCOUNT'
      x-stoplight:
        id: c9rre215u4m69
    insuranceBalance:
      title: Insurance balances
      description: Data elements included with balances specific to insurance accounts
      allOf:
        - $ref: '#/components/schemas/insuranceAccount'
        - type: object
          properties:
            policyCoverageAmount:
              description: Total amount of money the user is insured for.
              type: number
            policyEndDate:
              type: string
              format: date-time
              description: The premium end date.
            policyPremium:
              description: The amount of the user's premium.
              type: number
            policyPremiumTerm:
              type: string
              enum:
                - MONTHLY
                - ANNUAL
              description: he payment term for the premium. MONTHLY or ANNUAL.
            policyStartDate:
              type: string
              format: date-time
              description: The premium start date.
      x-stoplight:
        id: ctym7sn7w9o3n
    insuranceTransaction:
      description: Insurance transactions
      allOf:
        - $ref: '#/components/schemas/transaction'
        - type: object
          properties:
            transactionType:
              type: string
              description: InsuranceTransaction Type
              enum:
                - PAYMENT
                - FEE
                - ADJUSTMENT
                - INTEREST
      x-stoplight:
        id: s86n6kiyjt7y7
    investmentAccount:
      title: InvestmentAccount
      description: Investment Account
      allOf:
        - $ref: '#/components/schemas/accountInfo'
        - type: object
          properties:
            allowedCheckWriting:
              description: Check writing privileges
              type: boolean
            allowedOptionTrade:
              description: Allowed to trade options
              type: boolean
            brokerId:
              type: string
              description: Unique identifier FI
            calendarYearFor401K:
              description: Date for this calendar year for 401K account
              type: string
            employerName:
              type: string
              description: Name of the employer in investment 401k Plan
            margin:
              description: Margin trading is allowed
              type: boolean
            planId:
              type: string
              description: Plan number for Investment 401k plan
      x-stoplight:
        id: r2zttulmnv2zx
    investmentBalance:
      title: Investment balances
      description: Data elements included with balances specific to investment accounts
      allOf:
        - $ref: '#/components/schemas/investmentAccount'
        - type: object
          properties:
            availableCashBalance:
              description: Cash balance across all sub-accounts. Should include sweep funds.
              type: number
            balanceAsOf:
              type: string
              description: As-of date of balances
              format: date-time
            balanceList:
              type: array
              description: Balance List. Name value pair aggregate.
              items:
                $ref: '#/components/schemas/balanceList'
            currentValue:
              description: Total current value of all investments
              type: number
            dailyChange:
              description: Daily change
              type: number
            marginBalance:
              description: Margin balance
              type: number
            percentageChange:
              description: Percentage change
              type: number
            rolloverAmount:
              description: Rollover amount
              type: number
            shortBalance:
              description: Short balance
              type: number
      x-stoplight:
        id: 8qe08exxe9gkq
    investmentLoan:
      title: InvestmentLoan Entity
      properties:
        loanId:
          type: string
          description: Unique identifier for this loan
        loanDescription:
          type: string
          description: Description
        initialLoanBalance:
          type: number
          description: Initial loan balance amount
        loanStartDate:
          type: string
          format: date-time
          description: Start date of the loan
        currentLoanBalance:
          type: number
          description: Current loan principal balance amount
        dateAsOf:
          type: string
          format: date-time
          description: Date and time of current loan balance
        loanRate:
          type: number
          description: Loan annual interest rate for the loan
        loanPaymentAmount:
          type: number
          description: Loan payment amount
        loanPaymentFrequency:
          type: string
          enum:
            - WEEKLY
            - BIWEEKLY
            - TWICEMONTHLY
            - MONTHLY
            - FOURWEEKS
            - BIMONTHLY
            - QUARTERLY
            - SEMIANNUALLY
            - ANNUALLY
            - OTHER
        loanPaymentInitial:
          type: number
          description: Initial number of loan payments
        loanPaymentsRemaining:
          type: integer
          description: Remaining number of loan payments
        loanMaturityDate:
          type: string
          format: date-time
          description: Expected loan end date
        loanInterestToDate:
          type: number
          description: Total interest paid to date on this loan
        loanTotalProjectedInterest:
          type: number
          description: Total projected interest to be paid on this loan
        loanNextPaymentDate:
          type: string
          format: date-time
          description: The next payment date for the loan
      description: Information about an investment loan.
      x-stoplight:
        id: ctniw9efuctwg
    investments:
      title: ''
      type: object
      allOf:
        - type: object
          properties:
            accounts:
              type: array
              description: 'An array of accounts with entity types dependent on the account type (deposit, investment, loan, line of credit, annuity or insurance)'
              items:
                anyOf:
                  - properties:
                      investmentAccount:
                        $ref: '#/components/schemas/investmentDetails'
                  - properties:
                      depositAccount:
                        $ref: '#/components/schemas/depositBalance'
                  - properties:
                      loanAccount:
                        $ref: '#/components/schemas/loanBalance'
                  - properties:
                      locAccount:
                        $ref: '#/components/schemas/locBalance'
                  - properties:
                      insuranceAccount:
                        $ref: '#/components/schemas/insuranceBalance'
                  - properties:
                      annuityAccount:
                        $ref: '#/components/schemas/annuityBalance'
      x-stoplight:
        id: temcxf2ztm71f
    investmentDetails:
      title: Investment account with all details
      description: Data elements included with the investment product
      allOf:
        - $ref: '#/components/schemas/investmentBalance'
        - type: object
          properties:
            holdings:
              type: array
              description: Array of holdings
              items:
                $ref: '#/components/schemas/holding'
            openOrders:
              type: array
              description: Array of open orders
              items:
                $ref: '#/components/schemas/openOrder'
            contribution:
              type: array
              description: Array of contribution objects. Describes how new contributions are distributed among the available securities
              items:
                $ref: '#/components/schemas/contribution'
            vesting:
              type: array
              description: 'Array of vesting objects. Provides the past, present, and future vesting schedule and percentages'
              items:
                $ref: '#/components/schemas/vesting'
            investmentLoans:
              type: array
              description: Array of investment loans
              items:
                $ref: '#/components/schemas/investmentLoan'
            pensionSource:
              type: array
              description: Array of Pension Source
              items:
                $ref: '#/components/schemas/pensionSource'
            equityGrants:
              type: array
              description: 'Provides equity grant information on Restricted Stock Units, Restricted Stock Awards, Stock Appreciation Right, Stock Options, Performance Awards, and Total Share Return Units'
              items:
                $ref: '#/components/schemas/equityGrant'
      x-stoplight:
        id: 06fuirv8zgawv
    investmentTransaction:
      description: Investment Transactions
      allOf:
        - $ref: '#/components/schemas/transaction'
        - type: object
          properties:
            accruedInterest:
              type: number
              description: Accrued Interest.
            commission:
              type: number
              description: Transaction commission.
            confirmationNumber:
              type: string
              description: Confirmation number of the transaction.
            faceValue:
              type: number
              description: Cash value for bonds.
            fees:
              type: number
              description: Fees applied to the trade.
            fractionalCash:
              type: number
              description: Cash for fractional units (used for stock splits).
            gain:
              type: number
              description: For sales.
            incomeType:
              type: string
              description: 'Type of investment income. CGLONG (capital gains-long term), CGSHORT (capital gains-short term), MISC.'
              enum:
                - CGLONG
                - CGSHORT
                - MISC
            inv401kSource:
              type: string
              description: Source of money.
              enum:
                - PRETAX
                - AFTERTAX
                - MATCH
                - PROFITSHARING
                - ROLLOVER
                - OTHERVEST
                - OTHERNONVEST
            load:
              type: number
              description: Load on the transaction.
            loanId:
              type: string
              description: For 401k accounts only. This indicates the transaction was due to a loan or a loan repayment.
            loanInterest:
              type: number
              description: How much loan pre-payment is interest.
            loanPrincipal:
              type: number
              description: How much loan pre-payment is principal.
            markup:
              type: number
              description: Portion of unit price that is attributed to the dealer markup.
            newUnits:
              type: number
              description: Number of shares after split.
            oldUnits:
              type: number
              description: Number of shares before split.
            payrollDate:
              type: string
              description: The date for the 401k transaction was obtained in payroll.
            penalty:
              type: number
              description: Indicates amount withheld due to a penalty.
            positionType:
              type: string
              enum:
                - LONG
                - SHORT
            price:
              type: number
              description: Unit purchase price.
            priorYearContrib:
              type: boolean
              description: Indicates this buy was made using prior years contribution. TRUE or FALSE.
            runningBalance:
              type: number
              description: Running balance of the position.
            securityId:
              type: string
              description: Unique identifier of security.
            securityIdType:
              type: string
              description: Security identifier type.
              enum:
                - BUSIP
                - ISIN
                - SEDOL
                - SICC
                - VALOR
                - WKN
            securityType:
              type: string
              enum:
                - STOCK
                - MUTUALFUND
                - DEBT
                - OPTION
                - SWEEP
                - OTHER
                - BOND
            shares:
              type: number
              description: 'Required for stock, mutual funds. Number of shares (with decimals). Negative numbers indicate securities are being removed from the account.'
            splitRatioDenominator:
              type: number
              description: Split ratio denominator.
            splitRatioNumerator:
              type: number
              description: Split ratio numerator.
            stateWithholding:
              type: number
              description: State tax withholding.
            subAccountFund:
              type: string
              description: From which account money came in.
              enum:
                - CASH
                - MARGIN
                - SHORT
                - OTHERS
            subAccountSec:
              type: string
              description: Sub-account security type.
              enum:
                - CASH
                - MARGIN
                - SHORT
                - OTHERS
            symbol:
              type: string
              description: Ticker symbol.
            taxes:
              type: number
              description: Taxes on the trade.
            taxExempt:
              type: boolean
              description: Tax-exempt transaction TRUE or FALSE.
            transactionReason:
              type: string
              description: 'Reason for this transaction; CALL (the debt was called), SELL (the debt was sold), MATURITY (the debt reached maturity)'
              enum:
                - CALL
                - SELL
                - MATURITY
            transactionType:
              type: string
              description: InvestmentTransaction Type
              enum:
                - PURCHASED
                - SOLD
                - PURCHASEDTOCOVER
                - ADJUSTMENT
                - PURCHASETOOPEN
                - PURCHASETOCLOSE
                - SOLDTOOPEN
                - SOLDTOCLOSE
                - INTEREST
                - MARGININTEREST
                - REINVESTOFINCOME
                - RETURNOFCAPITAL
                - TRANSFER
                - CONTRIBUTION
                - FEE
                - OPTIONEXERCISE
                - OPTIONEXPIRATION
                - DIVIDEND
                - DIVIDENDREINVEST
                - SPLIT
                - CLOSURE
                - INCOME
                - EXPENSE
                - CLOSUREOPT
                - INVEXPENSE
                - JRNLSEC
                - JRNLFUND
                - OTHER
                - DIV
                - SRVCHG
                - DEP
                - DEPOSIT
                - ATM
                - POS
                - XFER
                - CHECK
                - PAYMENT
                - CASH
                - DIRECTDEP
                - DIRECTDEBIT
                - REPEATPMT
            transferAction:
              type: string
              description: Transfer direction.
              enum:
                - IN
                - OUT
            unitPrice:
              type: number
              description: 'Price per commonly-quoted unit. Does not include markup/markdown, unitprice. Share price for stocks, mutual funds, and others. Percentage of par for bonds. Per share (not contract) for options.'
            units:
              type: number
              description: 'For security-based actions other than stock splits, quantity. Shares for stocks, mutual funds, and others. Face value for bonds. Contracts for options.'
            unitType:
              type: string
              enum:
                - SHARES
                - CURRENCY
            withholding:
              type: number
              description: Federal tax withholding.
      x-stoplight:
        id: 2z0gon5ok9f2g
    lineItem:
      title: LineItem
      type: object
      properties:
        amount:
          type: number
          description: The amount of money attributable to this line item
        checkNumber:
          type: number
          description: Check number
        description:
          type: string
          description: The description of the line item
        imageIds:
          type: array
          description: Array of image identifiers (unique to transaction) used to retrieve images of check or transaction receipt
          items:
            type: string
        links:
          type: array
          items:
            $ref: '#/components/schemas/hateoasLink'
          description: 'Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs'
        memo:
          type: string
          description: Secondary item description
        reference:
          type: string
          description: A reference number
      x-stoplight:
        id: 96ex1o51jgmho
    loanAccount:
      title: LoanAccount
      description: Loan Account
      allOf:
        - $ref: '#/components/schemas/accountInfo'
        - type: object
          properties:
            compoundingPeriod:
              type: string
              enum:
                - DAILY
                - WEEKLY
                - BIWEEKLY
                - SEMIMONTHLY
                - MONTHLY
                - SEMIANNUALLY
                - ANNUALLY
            loanTerm:
              type: integer
              description: Term of loan in months
            maturityDate:
              type: string
              description: Maturity date is required for CDs
              format: date-time
            originatingDate:
              type: string
              description: Loan origination date
              format: date-time
            paymentFrequency:
              type: string
              enum:
                - DAILY
                - WEEKLY
                - BIWEEKLY
                - SEMIMONTHLY
                - MONTHLY
                - SEMIANNUALLY
                - ANNUALLY
            totalNumberOfPayments:
              type: integer
              description: Total number of payments
      x-stoplight:
        id: 7r0ur13avnhsy
    loanBalance:
      title: Loan balances
      description: Data elements included with balances specific to loan accounts
      allOf:
        - $ref: '#/components/schemas/loanAccount'
        - type: object
          properties:
            balanceAsOf:
              type: string
              description: As-of date of balances
              format: date-time
            escrowBalance:
              description: Escrow balance of loan
              type: number
            interestPaidYearToDate:
              description: Interest paid year to date
              type: number
            lastPaymentAmount:
              description: Last payment amount
              type: number
            lastPaymentDate:
              type: string
              description: Last payment date
              format: date-time
            nextPaymentAmount:
              description: Amount of next payment
              type: number
            nextPaymentDate:
              type: string
              description: Date of next payment
              format: date-time
            originalPrincipal:
              description: Original principal of loan
              type: number
            payOffAmount:
              description: Payoff amount
              type: number
            principalBalance:
              description: Principal balance of loan
              type: number
      x-stoplight:
        id: ghrcdwr9p4c6y
    loanTransaction:
      title: Loan Transaction
      allOf:
        - $ref: '#/components/schemas/transaction'
        - type: object
          properties:
            paymentDetails:
              $ref: '#/components/schemas/paymentDetails'
            transactionType:
              type: string
              description: LoanTransaction Type
              enum:
                - ADJUSTMENT
                - FEE
                - INTEREST
                - PAYMENT
      description: Loan Transaction
      x-stoplight:
        id: hlvxh4v410a9v
    locAccount:
      title: LocAccount
      description: Line of Credit Account
      allOf:
        - $ref: '#/components/schemas/accountInfo'
      x-stoplight:
        id: xyzxnkvwnfxgx
    locBalance:
      title: Line of credit balances
      description: Data elements included with balances specific to line of credit accounts
      allOf:
        - $ref: '#/components/schemas/locAccount'
        - type: object
          properties:
            balanceAsOf:
              type: string
              description: As-of date of balances
              format: date-time
            advancesApr:
              description: Advances APR
              type: number
            availableCash:
              description: Available cash
              type: number
            availableCredit:
              description: Available credit
              type: number
            cashAdvanceLimit:
              description: Cash advance limit
              type: number
            creditLine:
              description: Credit limit
              type: number
            currentBalance:
              description: Current balance LOC
              type: number
            currentRewardsBalance:
              description: Current rewards balance
              type: number
            financeCharges:
              description: Finance charges
              type: number
            lastPaymentAmount:
              description: Last payment amount
              type: number
            lastPaymentDate:
              type: string
              description: Last payment date
              format: date-time
            lastStmtBalance:
              description: Last Statement Balance
              type: number
            lastStmtDate:
              type: string
              description: Last Statement Date
              format: date-time
            minimumPaymentAmount:
              description: Minimum payment amount
              type: number
            nextPaymentAmount:
              description: Amount of next payment
              type: number
            nextPaymentDate:
              type: string
              description: Due date of next payment
              format: date-time
            pastDueAmount:
              description: Past Due Amount
              type: number
            pointsAccrued:
              description: Points accrued
              type: number
            principalBalance:
              description: Principal balance
              type: number
            pointsRedeemed:
              description: Points redeemed
              type: number
            purchasesApr:
              description: Purchases APR
              type: number
      x-stoplight:
        id: gxovayw0as8ji
    locTransaction:
      title: LocTransaction
      description: A line of credit transaction of type
      allOf:
        - $ref: '#/components/schemas/transaction'
        - type: object
          description: Additional data elements for line of credit transactions
          properties:
            checkNumber:
              type: integer
              description: Check number
            paymentDetails:
              $ref: '#/components/schemas/paymentDetails'
            transactionType:
              type: string
              description: LocTransaction Type
              enum:
                - CHECK
                - WITHDRAWAL
                - TRANSFER
                - POSDEBIT
                - ATMWITHDRAWAL
                - BILLPAYMENT
                - FEE
                - DEPOSIT
                - ADJUSTMENT
                - INTEREST
                - DIVIDEND
                - DIRECTDEPOSIT
                - ATMDEPOSIT
                - POSCREDIT
      x-stoplight:
        id: 8pc9akwsyokba
    mutualFundSecurity:
      title: MutualFundSecurity Entity
      description: Information about the mutual fund security specific to the type of security
      type: object
      properties:
        mutualFundType:
          type: string
          description: Mutual fund type
          enum:
            - OPENEND
            - CLOSEEND
            - OTHER
        unitsStreet:
          type: number
          description: 'Units in the FI''s street name, positive quantity'
        unitsUser:
          type: number
          description: 'Units in user''s name directly, positive  quantity'
        reinvestDividends:
          type: boolean
          description: Reinvest dividends
        reinvestCapitalGains:
          type: boolean
          description: Reinvest capital gains
        yield:
          type: number
          description: Current yield reported as portion of the fund's assets
        yieldAsOfDate:
          type: string
          format: date-time
          description: As-of date for yield value
      x-stoplight:
        id: o4jvu487ujlcm
    openOrder:
      title: OpenOrder Entity
      type: object
      description: Information on an open order.
      properties:
        orderId:
          type: string
          description: Long term persistent identity of the order. Id for this order transaction.
        securityId:
          type: string
          description: Unique identifier of the security.
        securityIdType:
          type: string
          description: Security identifier type
          enum:
            - CUSIP
            - ISIN
            - SEDOL
            - SICC
            - VALOR
            - WKN
        symbol:
          type: string
          description: Market symbol
        description:
          type: string
          description: Description of order
        units:
          type: number
          description: 'Number of units (shares, bonds, etc.)'
        orderType:
          type: string
          enum:
            - BUY
            - SELL
            - BUYTOCOVER
            - BUYTOOPEN
            - SELLTOCOVER
            - SELLTOOPEN
            - SELLSHORT
            - SELLCLOSE
          description: Type of order.
        orderDate:
          type: string
          format: date-time
          description: Order date
        unitPrice:
          type: number
          description: Unit price
        unitType:
          type: string
          enum:
            - CURRENCY
            - SHARES
          description: Type of unit.
        orderDuration:
          description: 'This order is good for DAY, GOODTILLCANCEL, IMMEDIATE'
          type: string
          enum:
            - DAY
            - GOODTILLCANCEL
            - IMMEDIATE
        subAccount:
          type: string
          enum:
            - CASH
            - MARGIN
            - SHORT
            - OTHER
        limitPrice:
          type: number
          description: Limit Price
        stopPrice:
          type: number
          description: Stop price
        inv401kSource:
          type: string
          enum:
            - AFTERTAX
            - MATCH
            - OTHERNONVEST
            - OTHERVEST
            - PRETAX
            - PROFITSHARING
            - ROLLOVER
          description: 'For 401(k) accounts, source of money for this order. Default if not present is OTHERNONVEST.'
      x-stoplight:
        id: mccfb0lbs6gpw
    optionSecurity:
      title: OptionSecurity Entity
      description: Information about the option security specific to the type of security
      type: object
      properties:
        secured:
          type: string
          enum:
            - COVERED
            - NAKED
          description: How the option is secured
        optionType:
          type: string
          enum:
            - CALL
            - PUT
        strikePrice:
          type: number
          description: Strike price / Unit price
        expireDate:
          type: string
          format: date-time
          description: Expiration date of option
        sharesPerContract:
          type: number
          description: Shares per contract
      x-stoplight:
        id: cbdk1sujvz4c5
    otherSecurity:
      title: OtherSecurity Entity
      description: Information about the security specific to the type of security
      type: object
      properties:
        typeDescription:
          type: string
          description: Description of Other Security
      x-stoplight:
        id: nmn3v1dwuw5rd
    paginatedArray:
      type: object
      properties:
        links:
          type: object
          properties:
            next:
              type: object
              properties:
                href:
                  type: string
            prev:
              type: object
              properties:
                href:
                  type: string
      x-examples:
        example-1:
          links:
            next:
              href: /fdx/v4/mikomo/accounts/g833202fb0866d0ad83472c429/transactions?endTime=2021-02-26T00%3A00%3A00Z&limit=5&offset=5&startTime=2019-02-26T00%3A00%3A00Z
            prev:
              href: /fdx/v4/mikomo/accounts/g833202fb0866d0ad83472c429/transactions?endTime=2021-02-26T00%3A00%3A00Z&limit=5&offset=0&startTime=2019-02-26T00%3A00%3A00Z
      x-stoplight:
        id: 8htwake3nuamr
    paymentDetails:
      title: PaymentDetails
      type: object
      description: Payment details for some transactions
      properties:
        escrowAmount:
          type: number
          description: The amount of payment applied to escrow
        feesAmount:
          type: number
          description: The amount of payment applied to fees
        insuranceAmount:
          type: number
          description: The amount of payment applied to life/health/accident insurance on the loan
        interestAmount:
          type: number
          description: The amount of payment applied to interest
        pmiAmount:
          type: number
          description: The amount of payment applied to PMI
        principalAmount:
          type: number
          description: The amount of payment applied to principal
      x-stoplight:
        id: k01nwtfvn6fjj
    pensionSource:
      title: PensionSource Entity
      properties:
        displayName:
          type: string
          description: Name of the Source
        amount:
          type: number
          description: Benefit Amount
        paymentOption:
          type: string
          description: Form of payment
        asOfDate:
          type: string
          format: date-time
          description: Date benefit was calculated
        frequency:
          type: string
          enum:
            - ANNUALLY
            - BIWEEKLY
            - DAILY
            - MONTHLY
            - SEMIANNUALLY
            - SEMIMONTHLY
            - WEEKLY
        startDate:
          type: string
          format: date-time
          description: Assumed retirement date ‐ As of date amount is payable
      description: Information about a pension source.
      x-stoplight:
        id: c3rph3t8c4ttm
    statement:
      title: Statement entity
      description: An account statement
      type: object
      properties:
        accountId:
          type: string
          description: Corresponds to accountId in Account entity
        statementId:
          type: string
          description: Long-term persistent identity of the statement
        statementDate:
          type: string
          description: Date of the statement in ISO 8601.
          format: date
        description:
          type: string
          description: 'Description of statement. Should include description of type of statement: monthly, quarterly, yearly.'
        links:
          description: 'The links to retrieve this account statement, or to invoke other APIs'
          type: array
          items:
            $ref: '#/components/schemas/hateoasLink'
        status:
          type: string
          description: Availability status of statement
          enum:
            - AVAILABLE
            - PROCESSING
            - FAILED
      x-stoplight:
        id: 92se3hu0784xf
    statements:
      title: An array of statements
      description: A paginated array of account statements
      type: object
      allOf:
        - $ref: '#/components/schemas/paginatedArray'
        - type: object
          properties:
            statements:
              type: array
              description: 'An array of Statement, each with its HATEOAS link to retrieve the account statement'
              items:
                $ref: '#/components/schemas/statement'
      x-stoplight:
        id: 9ieoghfwt64th
    stockSecurity:
      title: StockSecurity Entity
      description: Information about the stock security specific to the type of security
      type: object
      properties:
        unitsStreet:
          type: number
          description: 'Units in the FI''s street name, positive quantity'
        unitsUser:
          type: number
          description: 'Units in user''s name directly, positive  quantity'
        reinvestDividends:
          type: boolean
          description: Reinvest dividends
        stockType:
          type: string
          enum:
            - BOND
            - DEBT
            - MUTUALFUND
            - OPTION
            - OTHER
            - STOCK
            - SWEEP
        yield:
          type: number
          description: Current yield
        yieldAsOfDate:
          type: string
          format: date-time
          description: Yield as-of date
      x-stoplight:
        id: 915m8bnnqhdkf
    sweepSecurity:
      title: SweepSecurity Entity
      description: Information about the sweep security specific to the type of security
      type: object
      properties:
        currentBalance:
          type: number
          description: Balance of funds in account
        availableBalance:
          type: number
          description: Balance of funds available for use
        balanceAsOf:
          type: string
          format: date-time
          description: As-of date of balances
        checks:
          type: boolean
          description: Whether or not checks can be written on the account
      x-stoplight:
        id: d09044n67ri45
    telephoneNumber:
      title: Telephone Number
      description: Standard for international phone numbers
      type: object
      properties:
        type:
          type: string
          enum:
            - HOME
            - BUSINESS
            - CELL
            - FAX
          description: 'Type of phone number: HOME, BUSINESS, CELL, FAX'
        country:
          type: string
          description: Country calling codes defined by ITU-T recommendations E.123 and E.164
        number:
          type: string
          pattern: \d+
          description: Telephone subscriber number defined by ITU-T recommendation E.164
      x-stoplight:
        id: 342povrj0ckeh
    transaction:
      type: object
      description: Transaction elements
      properties:
        accountId:
          type: string
          description: Corresponds to AccountId in Account
        amount:
          type: number
          description: |-
            The amount of money in the account currency.

            If balanceType is `ASSET`:

              1. If `debitCreditMemo` = `DEBIT`, sign is "+" or not present
              2. If `CREDIT`, sign is "-"

            If balanceType is `LIABILITY`:

              1. If `debitCreditMemo` = `DEBIT`, sign is "-"
              2. If `CREDIT`, sign is "+" or not present
        category:
          type: string
          description: 'Transaction category, preferably MCC or SIC.'
        debitCreditMemo:
          type: string
          description: Akoya will ensure that this is correctly populated with one of DEBIT or CREDIT and matches the sign of the status field.
          enum:
            - DEBIT
            - CREDIT
        description:
          type: string
          description: The description of the transaction
        imageIds:
          type: array
          items:
            type: string
          description: Array of image identifiers (unique to transaction) used to retrieve images of check or transaction receipt.
        fiAttributes:
          type: array
          uniqueItems: true
          minItems: 1
          description: Array of FI-specific attributes
          items:
            $ref: '#/components/schemas/fiAttribute'
        foreignAmount:
          type: number
          description: The amount of money in the foreign currency
        foreignCurrency:
          type: string
          description: The ISO 4217 code of the foreign currency
        lineItem:
          type: array
          description: Breakdown of the transaction details
          items:
            $ref: '#/components/schemas/lineItem'
        links:
          type: array
          items:
            $ref: '#/components/schemas/hateoasLink'
          description: 'Links (unique to this Transaction) used to retrieve images of checks or transaction receipts, or invoke other APIs'
        memo:
          type: string
          description: Secondary transaction description
        postedTimestamp:
          type: string
          description: The date and time that the transaction was posted to the account. If not provided then TransactionTimestamp can be used as PostedTimeStamp.
          format: date-time
        reference:
          type: string
          description: A tracking reference identifier
        referenceTransactionId:
          type: string
          description: |-
            Akoya ensures that this field is populated for all transactions which are reversals, otherwise it is null. Either way it is always present.

            For reverse postings, the identity of the transaction being reversed. For the correction transaction, the identity of the reversing post. For credit card posting transactions, the identity of the authorization transaction.
        status:
          type: string
          description: 'AUTHORIZATION, MEMO, PENDING, or POSTED'
          enum:
            - PENDING
            - MEMO
            - POSTED
            - AUTHORIZATION
        subCategory:
          type: string
          description: Transaction category detail
        transactionId:
          type: string
          description: |-
            Long term persistent identity of the transaction (unique to account). 
            Transaction IDs should: 
              
              1. be the same for pending and posted 
              2. be different for reversed transactions 
              3. `referenceTransactionId` should be present for reversed transactions'
        transactionTimestamp:
          type: string
          description: |-
            The date and time that the transaction was added to the server backend systems.

            Akoya ensures that this field is populated for all transactions to which it applies, otherwise it is null. Either way it is always present.
          format: date-time
      x-stoplight:
        id: r7dre5ht3jahj
    transactions:
      title: Transactions Entity
      description: Optionally paginated array of transactions
      allOf:
        - $ref: '#/components/schemas/paginatedArray'
        - type: object
          properties:
            transactions:
              description: 'An array of transactions with entity types dependent on the account type (deposit, investment, loan, or line of credit)'
              type: array
              items:
                anyOf:
                  - properties:
                      depositTransaction:
                        $ref: '#/components/schemas/depositTransaction'
                  - properties:
                      loanTransaction:
                        $ref: '#/components/schemas/loanTransaction'
                  - properties:
                      locTransaction:
                        $ref: '#/components/schemas/locTransaction'
                  - properties:
                      investmentTransaction:
                        $ref: '#/components/schemas/investmentTransaction'
                  - properties:
                      insuranceTransaction:
                        $ref: '#/components/schemas/insuranceTransaction'
                type: object
      x-stoplight:
        id: 4i7i42fp8toe4
    vesting:
      title: Vesting Entity
      properties:
        vestingDate:
          type: string
          format: date-time
          description: Vesting date
        symbol:
          type: string
          description: Security symbol
        strikePrice:
          type: number
          description: Strike price
        vestingPercentage:
          type: number
          description: Vesting percentage
        otherVestAmount:
          type: number
          description: Other vest amount
        otherVestPercentage:
          type: number
          description: Other vest percentage
        vestedBalance:
          type: number
          description: Vested balance
        unVestedBalance:
          type: number
          description: Unvested balance
        vestedQuantity:
          type: number
          description: Vested qualtity
        unVestedQuantity:
          type: number
          description: Unvested quantity
      type: object
      description: 'Provides the past, present, and future vesting schedule and percentages.'
      x-stoplight:
        id: 13uij95awr3hq
  responses:
    '400':
      description: 401 - Invalid input
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          example:
            code: 401
            message: Invalid input
    '401':
      description: 602 - Customer not authorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          example:
            code: 602
            message: Customer not authorized
    '404':
      description: 701 - Account not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          example:
            code: 701
            message: Account not found
    '406':
      description: 1203 - Content Type not Supported
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          example:
            code: 1203
            message: Content Type not Supported
    '429':
      description: 1207 - Too many requests
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          example:
            code: 1207
            message: Too many requests
    '500':
      description: 500 - Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          example:
            code: 500
            message: Internal server error
    '501':
      description: 1106 - Version not supported or not implemented
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          example:
            code: 1106
            message: Version not supported or not implemented
    '503':
      description: 503 - System is down for maintenance
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          example:
            code: 503
            message: Scheduled Maintenance
  parameters:
    accountIdPath:
      name: accountId
      in: path
      description: Account Identifier
      required: true
      schema:
        type: string
        default: ':accountId'
    accountIdQuery:
      name: accountIds
      in: query
      description: Comma separated list of account ids
      schema:
        type: string
        default: ':accountId'
    endTimeQuery:
      name: endTime
      in: query
      description: 'ISO 8601 date format in UTC time zone. If blank, the default value (current date) is used. If a value is specified, startTime is required.'
      schema:
        type: string
        format: date-time
        example: '2021-03-30T04:00:00Z'
    startTimeQuery:
      name: startTime
      in: query
      description: 'ISO 8601 date format in UTC time zone. If blank, the default value (current date - 15 calendar days) is used. If a value is specified, endTime is required.'
      schema:
        type: string
        example: '2020-03-30T04:00:00Z'
        format: date-time
    statementIdPath:
      name: statementId
      in: path
      description: Statement Identifier
      required: true
      schema:
        type: string
        default: statementId
    versionPath:
      name: version
      in: path
      description: 'Akoya major version number. Do not use minor version numbers. For instance, use v2 and not v2.2'
      required: true
      schema:
        type: string
        default: v2
    providerIdPath:
      name: providerId
      in: path
      description: Id of provider
      schema:
        type: string
        default: mikomo
      required: true
    limitQuery:
      name: limit
      in: query
      description: The maximum number of items to be returned in the response. The default is 50.
      schema:
        type: integer
        default: 50
    offsetQuery:
      name: offset
      in: query
      description: The number of items to skip before the first in the response. The default is 0.
      schema:
        type: string
        default: '0'
    endDateQuery:
      name: endTime
      in: query
      description: End date for use in retrieval of statements (ISO 8601)
      schema:
        type: string
        format: date
        example: '2021-03-30'
    startDateQuery:
      name: startTime
      in: query
      description: Start date for use in retrieval of statements (ISO 8601)
      schema:
        type: string
        example: '2020-03-30'
        format: date
x-internal: true
x-readme:
  explorer-enabled: true
  proxy-enabled: true

Change log

DateUpdate
2024-Sept-11Original.

Need help?

Check out our Developer Community, or visit the Support Center in the Data Recipient Hub.

Looking for provider nuance documentation?

All provider nuance documentation is available in the Data providers section in the Data Recipient Hub.

Still stuck?

For all production issues, submit a support ticket through the Data Recipient Hub. Our support team is standing by 24/7. Questions and non-production issues will be answered during business hours.