openapi: 3.0.2 info: title: DriveWealth API description: >- DriveWealth is the pioneer of fractional equities trading and embedded investing. We are a visionary technology company that empowers more than 100 partners around the world to engage their customers by placing the markets in the palm of their hand. We believe the future is fractional, transactional and mobile. Every mobile device should be a gateway to accessing investing and savings products, services, advice, and assistance for global citizens of all ages, wealth stages, and levels of financial expertise. DriveWealth's unparalleled consultative support and cloud-based, industrial strength technology platform allow partners to seamlessly offer branded investing experiences to drive customer acquisition, loyalty, retention, and revenue growth. DriveWealth's commitment to continuous evolution and innovation makes it the partner of choice for powering the future of investing. For more information, please visit drivewealth.com or connect with us on Twitter @DriveWealth.‍ version: '1.0' x-konfig-ignore: object-with-no-properties: true potential-incorrect-type: true servers: - description: Sandbox server (Uses test data) url: https://bo-api.drivewealth.io/back-office - description: Production Server (Uses LIVE data) url: https://bo-api.drivewealth.net/back-office tags: - name: Accounts x-displayName: Accounts - name: Orders x-displayName: Orders - name: Settlements x-displayName: Settlements - name: Deposits x-displayName: Deposits - name: Withdrawals x-displayName: Withdrawals - name: Exchanges x-displayName: Exchanges - name: Instruments x-displayName: Instruments - name: Portfolios x-displayName: Portfolios - name: AutoPilot x-displayName: AutoPilot - name: Statements x-displayName: Statements - name: Asset Transfer x-displayName: Asset Transfer - name: Disclosures x-displayName: Disclosures - name: Users x-displayName: Users - name: Funds x-displayName: Funds - name: Trade Allocations x-displayName: Trade Allocations - name: Beneficiaries x-displayName: Beneficiaries - name: Cancel Rebill x-displayName: Cancel Rebill - name: Physical Documents x-displayName: Physical Documents - name: Subscriptions x-displayName: Subscriptions - name: Advisor Reports x-displayName: Advisor Reports - name: Violations x-displayName: Violations - name: Transactions x-displayName: Transactions - name: Positions x-displayName: Positions - name: Auth x-displayName: Auth - name: Quotes x-displayName: Quotes - name: Commission Schedules x-displayName: Commission Schedules - name: Virtual Bank Accounts x-displayName: Virtual Bank Accounts - name: Supported Countries x-displayName: Supported Countries - name: Charts x-displayName: Charts - name: Depth of Book x-displayName: Depth of Book - name: Linked Bank Accounts x-displayName: Linked Bank Accounts - name: Risk x-displayName: Risk paths: /managed/allocations: post: tags: - Trade Allocations summary: Create Trade Allocation operationId: TradeAllocations_createAllocation security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Create an allocation of securities to a User's Account. requestBody: content: application/json: schema: $ref: '#/components/schemas/AllocationRequest' required: true responses: '200': description: The creation of a Trade Allocation was Successful. content: application/json: schema: $ref: '#/components/schemas/AllocationResponse' /managed/allocations/{allocationID}: get: tags: - Trade Allocations summary: Retrieve Trade Allocation operationId: TradeAllocations_getDetails security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Retrieves Trade Allocation details by allocationID. parameters: - description: >- The unique identifier returned when a Trade Allocation request is made. in: path name: allocationID schema: type: string required: true example: JL.allocation.SomeRIACompany.9d6def3b-14d7-4934-8a64-57d443e67ce6 responses: '200': description: Retrieving Trade Allocation details by allocationID was Successful. content: application/json: schema: $ref: '#/components/schemas/AllocationDetails' /managed/funds: post: tags: - Funds summary: Create Fund operationId: Funds_createFundCollection security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Create a Fund containing a collection of securities. requestBody: content: application/json: schema: $ref: '#/components/schemas/fundsRequest' required: true responses: '200': description: Creating a fund was Successful content: application/json: schema: $ref: '#/components/schemas/fundsResponse' /managed/funds/{fundID}: get: tags: - Funds summary: Retrieve Fund operationId: Funds_getDetails security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetch the details of a fund using the unique fundID. parameters: - description: The unique identifier associated with the Fund. in: path name: fundID schema: type: string required: true example: fund_3d7d00d1-f08e-4f52-9cbf-893c75cf77fe responses: '200': description: Fetch fund details was Successful. content: application/json: schema: $ref: '#/components/schemas/fundsResponse' /managed/portfolios: post: tags: - Portfolios summary: Create Portfolio operationId: Portfolios_createPortfolioAllocation security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Create a Portfolio to hold an allocation of funds. requestBody: content: application/json: schema: $ref: '#/components/schemas/portfolioReq' required: true responses: '200': description: The creation of a Portfolio was Successful. content: application/json: schema: $ref: '#/components/schemas/portfolioRes' /managed/portfolios/{portfolioID}: get: tags: - Portfolios summary: Retrieve Portfolio operationId: Portfolios_getDetails security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Get the details of a specific Portfolio using the portfolioID. parameters: - description: A unique identifier associated with a specific Portfolio. in: path name: portfolioID schema: type: string required: true example: portfolio_4a22340a-31f8-4f0e-b5ee-24ddfbc66727 responses: '200': description: Fetch a portfolio by portfolioID was Successful. content: application/json: schema: $ref: '#/components/schemas/portfolioRes' patch: tags: - Portfolios summary: Update Portfolio operationId: Portfolios_updateHoldings security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Edit the holdings of an existing portfolio using the portfolioID. parameters: - description: A unique identifier associated with a specific Portfolio. in: path name: portfolioID schema: type: string required: true example: portfolio_4a22340a-31f8-4f0e-b5ee-24ddfbc66727 requestBody: content: application/json: schema: $ref: '#/components/schemas/holdingsObject' responses: '200': description: Edit a portfolio by portfolioID was Successful. content: application/json: schema: $ref: '#/components/schemas/portfolioRes' /managed/autopilot/{partnerID}: post: tags: - AutoPilot summary: Create Autopilot Run operationId: AutoPilot_createRun security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Create an Autopilot run for a users account. parameters: - description: >- This is the parentIBID or userID of the registered investment advisor. in: path name: partnerID schema: type: string required: true example: 66304da9-3h6f-2234-935f-ac6b7933d706 requestBody: content: application/json: schema: $ref: '#/components/schemas/autopilotReq' required: true responses: '200': description: The creation of an autopilot run was Successful. content: application/json: schema: $ref: '#/components/schemas/autopilotRes' /managed/autopilot/{rebalanceRunID}: get: tags: - AutoPilot summary: Retrieve Autopilot Run operationId: AutoPilot_getRunDetails security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: >- Fetch the details and run status for a re-balance using the unique rebalanceRunID. parameters: - description: >- The unique re-balance run identifier `rebalanceRunID` associated with a specific re-balance. in: path name: rebalanceRunID schema: type: string required: true example: ria_rebalance_ebf7e878-e2d6-4b3d-a333-b8ff05b92b83 responses: '200': description: Fetch autopilot run details by rebalanceRunID was Successful. content: application/json: schema: $ref: '#/components/schemas/runStatusRes' /accounts: post: tags: - Accounts summary: Create Account operationId: Accounts_createNewBrokerageAccount security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Create a new brokerage Account. requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountReq' examples: Self Directed Account: value: userID: cc07f91b-7ee1-4868-b8fc-823c70a1b932 accountType: LIVE accountManagementType: SELF tradingType: CASH Managed Account: value: userID: cc07f91b-7ee1-4868-b8fc-823c70a1b932 accountType: LIVE accountManagementType: MANAGED tradingType: CASH Robo Advisory Account: value: userID: cc07f91b-7ee1-4868-b8fc-823c70a1b932 accountType: LIVE accountManagementType: RIA_MANAGED tradingType: CASH riaProductID: product_b94c0b6a-5ac8-43e4-95d1-777051c0503b riaUserID: 80f9b672-120d-4b73-9ccv9-42fb3262c4b9 required: true responses: '200': description: Account creation was Successful. content: application/json: schema: $ref: '#/components/schemas/AccountRes' /accounts/{accountID}: get: tags: - Accounts summary: Retrieve Account operationId: Accounts_getDetails security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Retrieves Account details by accountID. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true responses: '200': description: Retrieving Account details was Successful. content: application/json: schema: $ref: '#/components/schemas/AccountDetailRes' patch: tags: - Accounts summary: Update Account operationId: Accounts_updateAccountDetails security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Update an Account details by accountID. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAcctReq' examples: Add Authorized User: value: authorizedUsers: - userID: f6fd0783-2fdb-4ddb-9fd5-2464d8abc267 permissions: - MINOR_GRADUATION_TRANSFER required: true responses: '200': description: Update account details was Successful. content: application/json: schema: $ref: '#/components/schemas/AccountsUpdateAccountDetailsResponse' examples: Account Summary: value: account: id: cc07f91b-7ee1-4868-b8fc-823c70a1b932.1407775317759 accountNo: DWBG000052 accountType: description: Live Account name: LIVE accountMgmtType: description: Self Directed Account name: SELF status: description: Open name: OPEN tradingType: description: Cash Account name: CASH leverage: 1 nickname: Steve's Robo Advisor Managed Account parentIB: id: 80f9b672-120d-4b73-9cc9-42fb3262c4b9 name: Tendies Trading Company taxProfile: taxStatusCode: W-9 taxRecipientCode: INDIVIDUAL commissionID: b3e985dd-9679-63dc-5dd5-9bd7982efecd beneficiaries: false userID: cc07f91b-7ee1-4868-b8fc-823c70a1b932 restricted: false goodFaithViolations: 0 patternDayTrades: 0 freeTradeBalance: 0 gfvPdtExempt: false buyingPowerOverride: false bod: moneyMarket: 0 equityValue: 0 cashAvailableForWithdrawal: 0 cashAvailableForTrading: 0 cashBalance: 0 ria: advisorID: 66304da9-3h6f-2234-935f-ac6b7933d706 productID: product_b94c0b6a-5ac8-43e4-95d1-777051c0503b sweepInd: true interestFree: false createdWhen: '2022-12-22T06:07:41.773Z' openedWhen: '2022-12-22T06:07:41Z' updatedWhen: '2022-12-11T22:28:21.810Z' ignoreMarketHoursForTest: false flaggedForACATS: false extendedHoursEnrolled: false accountFeatures: fixedIncome: enrolled: true /accounts/{accountID}/commissions: get: tags: - Commission Schedules summary: List all Commission Schedules operationId: CommissionSchedules_listAll security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: >- Fetch a list of all commissions available for a customers account associated to its parentIBID. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true responses: '200': description: Fetch a list of commissions was Successful. content: application/json: schema: $ref: '#/components/schemas/CommissionsRes' /accounts/{accountID}/beneficiaries: post: tags: - Beneficiaries summary: Create Beneficiaries operationId: Beneficiaries_createNewSet security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: >- Create a new set of Beneficiaries or contingent Beneficiaries on an existing Account. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/BeneficiaryReq' required: true responses: '200': description: Beneficiary creation was successful. content: application/json: schema: $ref: '#/components/schemas/BeneficiaryRes' get: tags: - Beneficiaries summary: Retrieve Beneficiaries by Account operationId: Beneficiaries_listByAccount security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: List all existing Beneficiaries on an Account. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true responses: '200': description: Fetch list of beneficiaries was Successful. content: application/json: schema: $ref: '#/components/schemas/BeneficiaryRes' delete: tags: - Beneficiaries summary: Delete Beneficiaries operationId: Beneficiaries_removeAll security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Removes all Beneficiaries from an account. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true responses: '202': description: Beneficiaries has been recorded for deletion. /accounts/{accountID}/funding/deposit-instructions: get: tags: - Virtual Bank Accounts summary: Retrieve Virtual Bank Account by Account operationId: VirtualBankAccounts_getDetails security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetch a customers virtual account details. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true responses: '200': description: Fetch virtual account details was Successful. content: application/json: schema: $ref: '#/components/schemas/VirtualAccountRes' /accounts/{accountID}/funding/deposits: get: tags: - Deposits summary: List Deposits by Account operationId: Deposits_listByAccount security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetch all Deposits associated with a specific Account. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true responses: '200': description: Fetching a list of an Account's Deposits was successful. content: application/json: schema: $ref: '#/components/schemas/depositsByUserIDObject' /accounts/{accountID}/funding/redemptions: get: tags: - Withdrawals summary: List Withdrawals by Account operationId: Withdrawals_listByAccount security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetch a list of Withdrawals associated to a specific Account. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true responses: '200': description: Fetching a list of Account's Withdrawals was successful. content: application/json: schema: $ref: '#/components/schemas/Redemptions' /accounts/{accountID}/summary/orders: get: tags: - Orders summary: Retrieve Orders by Account operationId: Orders_getByAccount security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetch a list of pending orders for a users account. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true responses: '200': description: Fetching a list of pending Orders was successful. content: application/json: schema: $ref: '#/components/schemas/PendingOrders' /accounts/{accountID}/reports/order-history: get: tags: - Orders summary: List Orders by Account operationId: Orders_listByAccount security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetch a list of all orders for a users account. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true - description: >- Date start time of data. Follow [ISO 8601 standard](https://en.wikipedia.org/wiki/ISO_8601) in: query name: from schema: type: string required: true example: '2022-06-16' - description: >- Date end time of data. Follow [ISO 8601 standard](https://en.wikipedia.org/wiki/ISO_8601) in: query name: to schema: type: string required: true example: '2022-07-16' - description: The number of orders to be returned per page. in: query name: limit schema: type: number required: false example: 25 - description: Follow [ISO 8601 standard](https://en.wikipedia.org/wiki/ISO_8601) in: query name: offset schema: type: string required: false example: '2022-07-16' - description: The direction of pagination. in: query name: direction schema: type: string enum: - prev - next required: false example: prev responses: '200': description: Fetching Order history was successful content: application/json: schema: $ref: '#/components/schemas/OrderHistoryRes' /accounts/{accountID}/portfolio: get: tags: - AutoPilot summary: Retrieve Portfolio by Account operationId: AutoPilot_getPortfolioByAccount security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Retrieve Portfolio details by accountID. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true responses: '200': description: Fetching Portfolio details was Successful. content: application/json: schema: $ref: '#/components/schemas/PortfolioStatusRes' /accounts/{accountID}/summary/money: get: tags: - Accounts summary: Retrieve Money by Account operationId: Accounts_getMoneyByAccount security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Retrieves a real time snapshot of cash balances by accountID. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true responses: '200': description: Retrieving Money details was Successful. content: application/json: schema: $ref: '#/components/schemas/MoneyDetailsRes' /accounts/{accountID}/statements: get: tags: - Statements summary: List Statements by Account operationId: Statements_listByAccount security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: List all statement files for a particular account. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true responses: '200': description: Fetching a list of Statements for an Account was successful. content: application/json: schema: $ref: '#/components/schemas/StatementListRes' /accounts/{accountID}/taxforms: get: tags: - Statements summary: List Tax Statements by Account operationId: Statements_listTaxStatementsByAccount security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetch a list of all the tax documents for a particular account. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true - $ref: '#/components/parameters/fromParams' - $ref: '#/components/parameters/toParams' responses: '200': description: Fetching a list of tax documents for an Account was successful. content: application/json: schema: $ref: '#/components/schemas/ListTaxDocsRes' /accounts/{accountID}/confirms: get: tags: - Statements summary: List Trade Confirmations by Account operationId: Statements_listTradeConfirmations security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: List all trade confirmation files for a particular account. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true - description: Filter, the date from which to start the search. in: query name: from schema: type: string required: false example: '2018-09-18' - description: Filter, the date to which to end the search. in: query name: to schema: type: string required: false example: '2019-09-18' responses: '200': description: Fetching a list of trade confirmations was successful. content: application/json: schema: $ref: '#/components/schemas/ListTradeConfirmsRes' /accounts/{accountID}/summary: get: tags: - Accounts summary: Retrieve summary by Account operationId: Accounts_getSummary security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: >- Fetch an account summary with the balance, orders, positions, violations and transactions of a particular Account. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true responses: '200': description: Fetching account summary details was successful. content: application/json: schema: $ref: '#/components/schemas/SummaryRes' deprecated: true /accounts/{accountID}/performance: get: tags: - Accounts summary: Retrieve Performance Metrics by Account operationId: Accounts_getPerformanceMetrics security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: >- Retrieves daily realized and unrealized profit/loss metrics by accountID. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true - description: >- Used for relative date range, accepts a number and a unit of time (E.g: 3d = 3 Days or 2w = 2 Weeks). in: query name: period schema: type: string enum: - 1d - '*d' - 1w - '*w' - 1m - '*m' - 1y - '*y' required: false example: 3d - description: >- Start date and time of requested time frame of the accounts performance. in: query name: from schema: type: string required: false example: '2018-09-18' - description: >- End date and time of requested time frame of the accounts performance. in: query name: to schema: type: string required: false example: '2019-09-18' responses: '200': description: Retrieving Performance Metrics by Account was Successful. content: application/json: schema: $ref: '#/components/schemas/PerformanceRes' /accounts/{accountID}/summary/positions: get: tags: - Positions summary: List Positions by Account operationId: Positions_listEquityPositions security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetch a list of all the equity positions related to an account. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true responses: '200': description: Fetching an Account's Positions was successful. content: application/json: schema: $ref: '#/components/schemas/PositionsRes' /accounts/{accountID}/summary/violations: get: tags: - Violations summary: Retrieve Violations by Account operationId: Violations_getByAccount security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetch the summary of all current account violations. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true responses: '200': description: Fetching an Account's violation summary was Successful. content: application/json: schema: $ref: '#/components/schemas/ViolationListRes' /accounts/{accountID}/violations: get: tags: - Violations summary: List Violations by Account operationId: Violations_listByAccount security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetch a list of all current Account Violations. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true responses: '200': description: Fetching a list of Violations for an Account was successful. content: application/json: schema: $ref: '#/components/schemas/ViolationDetailsRes' /accounts/{accountID}/summary/margin: get: tags: - Accounts summary: Retrieve Margin Details by Account operationId: Accounts_getMarginDetails security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Retrieves a list of Margin details by accountID. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true responses: '200': description: Fetching an Account's margin details was successful. content: application/json: schema: $ref: '#/components/schemas/MarginRes' /accounts/{accountID}/summary/transactions: get: tags: - Transactions summary: Retrieve Transaction Summary by Account operationId: Transactions_getSummaryByAccount security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetch a list of all recent Account Transactions. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true responses: '200': description: Fetching transaction summary details was successful. content: application/json: schema: $ref: '#/components/schemas/TransactionSummaryRes' /accounts/{accountID}/transactions: get: tags: - Transactions summary: List Transactions by Account operationId: Transactions_listByAccount security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetch a list of all Account Transactions in a given time range parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true - description: >- Date start time of data. Follow [ISO 8601 standard](https://en.wikipedia.org/wiki/ISO_8601) in: query name: from schema: type: string required: true example: '2022-06-16' - description: >- Date end time of data. Follow [ISO 8601 standard](https://en.wikipedia.org/wiki/ISO_8601) in: query name: to schema: type: string required: true example: '2022-07-16' - description: The number of transactions to be returned per page. in: query name: limit schema: type: number required: false example: 25 - description: Follow [ISO 8601 standard](https://en.wikipedia.org/wiki/ISO_8601) in: query name: offset schema: type: string required: false example: '2022-07-16' - description: The direction of pagination in: query name: direction schema: type: string enum: - prev - next required: false example: prev responses: '200': description: Fetching an Account's Transactions was successful. content: application/json: schema: $ref: '#/components/schemas/TransactionRes' /accounts/{accountID}/position-details: get: tags: - Accounts summary: Retrieve Account Position Lots operationId: Accounts_getPositionLots security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Retrieves Account Position Lots by accountID. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true responses: '200': description: Retrieving Account Position Lots by accountID was Successful. content: application/json: schema: $ref: '#/components/schemas/AccountPositionLots' examples: Account Lots: value: accountID: 0d1d686c-abe3-4203-82e5-62f1bd8266f3.1654094651810 accountNo: XYRR000001 positions: - instrumentID: 5b85fabb-d57c-44e6-a7f6-a3efc760226c symbol: TSLA currency: USD costBasis: 4 quantity: 0.01648699 currentMarketPrice: 253.76 currentMarketValue: 4.18 unrealizedPnL: 0.18 effectiveCostPerShare: 242.6155411 taxLots: - id: 3db27e74626adac3be7b549f2bbc0ab2480852a7 created: '2022-08-25T10:07:47.235Z' initialQuantity: 0.01240767 openQuantity: 0.01240767 effectiveCostPerShare: 241.79 side: B comment: SPLIT CAFB015132 TSLA... - id: 3db27e74626adac3be7b549f2bbc0ab2480852a7X created: '2023-09-25T15:28:12.120Z' initialQuantity: 0.00407932 openQuantity: 0.00407932 effectiveCostPerShare: 245.14 side: B comment: TSLA FRACK part TSLA KI... /accounts/{accountID}/options/positions: get: tags: - Positions summary: Retrieve Account Option Positions operationId: Positions_getAccountOption security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Retrieves Account Option Positions parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true - description: The expiration date of options; to filter by. in: query name: filterBy schema: type: string example: expirationDate - description: The start date of the range of option's expiration. in: query name: from schema: type: string example: '2023-02-16' - description: The end date of the range of option's expiration. in: query name: to schema: type: string required: false example: '2023-02-16' - description: The number of results to be returned. in: query name: limit schema: type: number default: 50 required: false example: 10 - description: The identifier of the page. in: query name: offset schema: type: string required: false example: >- 86572e14-84ae-4f0c-9533-3c9432637f8e.1627500314555#65d1aee9-9a6c-4720-9879-71c4fcf43060.2023-12-07T21:17:45.743Z responses: '200': description: Retrieving Account Option Positions was Successful. content: application/json: schema: $ref: '#/components/schemas/OptPositionRes' /asset-transfers/acats: post: tags: - Asset Transfer summary: Create ACATS Transfer operationId: AssetTransfer_createAcatsTransfer security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: >- The Automated Customer Account Transfer Service (ACATS) is a system that facilitates the transfer of securities from one trading account to another at a different brokerage firm or bank. requestBody: content: application/json: schema: $ref: '#/components/schemas/AcatsCreateRequestModel' responses: '200': description: Initiating a transfer was successful content: application/json: schema: $ref: '#/components/schemas/ACATSTransfer' examples: Automated Customer Transfer Full: value: id: acats_41eb5bdd-8ce2-4471-8fc6-9892da089cd1 source: BROKER0001 destination: DWXR001004 clearingNo: '0001' status: description: Asset transfer request is pending name: PENDING type: description: ACAT transfer name: ACAT acatType: description: Full Acats Transfer name: FULL sourceAccountType: description: Individual Account name: INDIVIDUAL positions: [] metadata: {} auditDetails: - timestamp: '2023-07-28T23:56:10.507Z' status: description: Asset transfer request has been initiated. name: STARTED comment: Transfer request has been submitted in queue - timestamp: '2023-07-28T23:56:10.645Z' status: description: Asset transfer request is pending name: PENDING comment: created: '2023-07-28T23:56:10.491Z' updated: '2023-07-28T23:56:10.667Z' Automated Customer Transfer Partial: value: id: acats_45dc50ac-3daa-484d-98cb-5264abb51d86 source: FOLIO123 destination: DWKN000094 clearingNo: '0001' status: description: Asset transfer request has been initiated. name: STARTED acatType: description: Partial Acats Transfer name: PARTIAL sourceAccountType: description: Individual Account name: INDIVIDUAL cash: 10 positions: - symbol: META instrumentID: 4312a85c-93ba-4adb-b50d-cc7973243a53 quantity: 1 Automated Customer Transfer: value: source: FOLIO12345 destination: DWST000077 clearingNo: '0001' sourceAccountType: description: Individual Account name: INDIVIDUAL acatType: description: Full Acats Transfer name: FULL cash: 0 positions: - symbol: AMZN instrumentID: 4312a85c-93ba-4adb-b50d-cc7973243a53 quantity: 1 comment: string metadata: {} '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/AssetTransferCreateAcatsTransferResponse' examples: Invalid accountNo on request body: value: errorCode: A012 message: >- A required accountNo is missing or invalid. Refer to the API documentation for details. errorDetails: field: destination type: STRING Source and Destination are same: value: errorCode: E032 message: >- Invalid or missing parameters in the request body. Refer to the API documentation for details. Details: Source can't be DW account Destination account is not approved: value: errorCode: T005 message: >- ACAT Transfer cannot initiate. Destination account is not approved. Invalid Symbol: value: errorCode: E032 message: >- Invalid or missing parameters in the request body. Refer to the API documentation for details. Details: Symbol is not active or invalid. errorDetails: field: positions.symbol type: ARRAY /asset-transfers/minor-graduation: post: tags: - Asset Transfer summary: Create Minor Graduation Transfer operationId: AssetTransfer_createMinorGraduationTransfer security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: >- If an Account is opened for the purpose of allowing a minor to invest, this API will allow for the transfer of assets from this account to the minor's own named account once they reach the age of majority. requestBody: content: application/json: schema: $ref: '#/components/schemas/GenericTransferRequest' examples: Minor Graduation: value: source: LKGE000001 destination: LKKZ000004 comment: Migrating Teen account to Individual account. metadata: {} responses: '200': description: Initiating a transfer was successful content: application/json: schema: $ref: '#/components/schemas/ACATSTransfer' examples: Minor Graduation: value: id: grad_28d08c72-3d0f-4c6e-8961-2dc6491c28a8 source: LKGE000001 destination: LKKZ000004 status: description: Asset transfer request has been initiated. name: STARTED type: description: Teen Account Transfer name: TEEN created: '2023-07-26T14:05:18.518Z' /asset-transfers/{assetTransferID}: parameters: - schema: type: string name: assetTransferID in: path required: true get: tags: - Asset Transfer summary: Retrieve Transfer operationId: AssetTransfer_getDetails security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Get a Transfer's current details. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ACATSTransfer' examples: Successful ACATS Transfer: value: id: acats_0a18eea2-c63d-447a-a0f1-1c7d9a08c9da source: TR6666 destination: FWCT000005 clearingNo: '1111' status: description: Asset transfer request has been successfully completed name: SUCCESSFUL type: description: ACAT transfer name: ACAT acatType: description: Partial Acats Transfer name: PARTIAL acatTransit: description: Incoming Acats Transfer name: ACAT_IN sourceAccountType: description: Individual Account name: INDIVIDUAL partner: id: 25f77a3e-2a4b-48bf-bea2-1b8bcd541621 name: Stark House positions: - symbol: ACHN instrumentID: 27673f0e-2219-40b0-9ecc-91c87266efaf quantity: 1 - symbol: SBSI instrumentID: 1c6c1625-8146-4dd3-a84b-c6a97cd74bcf quantity: 56 metadata: {} auditDetails: - timestamp: '2023-10-20T13:02:50.970Z' status: description: Asset transfer request has been initiated. name: STARTED comment: Transfer request has been submitted in queue - timestamp: '2023-10-20T15:00:04.185Z' status: description: Asset transfer request is pending name: PENDING comment: TIF has been created - timestamp: '2023-11-02T00:01:19.340Z' status: description: >- Asset transfer request has been successfully completed name: SUCCESSFUL comment: Transfer Settled created: '2023-10-20T13:02:50.960Z' updated: '2023-11-02T00:01:19.340Z' Failed ACATS Transfer: value: id: acats_d9faa000-9d97-4ab8-85f8-cbd856d31b79 source: TR6666 destination: FWRT000005 clearingNo: '1111' status: description: Asset transfer is failed. name: FAILED type: description: ACAT transfer name: ACAT acatType: description: Full Acats Transfer name: FULL sourceAccountType: description: Individual Account name: INDIVIDUAL partner: id: 25f77a3e-2a4b-48bf-bea2-1b8bcd541621X name: Stark House positions: [] metadata: customer_id: '12345' rejectionInfo: rejectionCode: ACCOUNT_NOT_MATCH rejectionReason: Account Title Mismatch auditDetails: - timestamp: '2023-08-28T11:30:26.367Z' status: description: Asset transfer request has been initiated. name: STARTED comment: Transfer request has been submitted in queue - timestamp: '2023-09-12T15:55:03.294Z' status: description: Asset transfer request is pending name: PENDING comment: Request has been submitted for ACAT transfer - timestamp: '2023-11-02T00:01:34.330Z' status: description: Asset transfer is failed. name: FAILED comment: >- Full Transfer Rejected. Contact Clearing Broker for further information created: '2023-08-28T11:30:25.805Z' updated: '2023-11-02T00:01:34.330Z' Minor Graduation: value: id: grad_28d08c72-3d0f-4c6e-8961-2dc6491c28a8X source: LKGE000001 destination: LKKZ000004 status: description: Asset transfer request has been initiated. name: STARTED acatType: description: Full ACATs Transfer name: FULL type: description: Teen Account Transfer name: TEEN partner: id: 25f77a3e-2a4b-48bf-bea2-1b8bcd541621X name: Stark House auditDetails: - timestamp: '2023-07-26T14:05:18.518Z' status: description: Asset transfer request has been initiated. name: STARTED comment: Transfer request has been submitted in queue created: '2023-07-26T14:05:18.518Z' /asset-transfers: get: tags: - Asset Transfer summary: List Transfers operationId: AssetTransfer_listTransfers security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: >- Lists all of your Transfers across all Accounts. This can be filtered by type of Transfer. parameters: - description: A status to filter by schema: $ref: '#/components/schemas/AssetTransferStatus' in: query name: status - description: A Transfer type to filter by schema: $ref: '#/components/schemas/AssetTransferType' in: query name: type required: true - description: Maximum number of records to be returned in: query name: limit schema: type: string - description: >- Specify an identifier from last API response to go to the next page or prev page in: query name: offset schema: type: string - description: Go to the next page or prev page in: query name: direction schema: type: string enum: - prev - next responses: '200': description: Listing Transfers was successful content: application/json: schema: $ref: '#/components/schemas/AssetTransferListTransfersResponse' examples: List Assets Transfers [TEEN]: value: data: - id: grad_ba9522d8-0f3a-43bd-bb16-9efc0ad1a913 source: DWCW001118 destination: DWYE001127 status: description: >- Asset transfer request has been successfully completed name: SUCCESSFUL type: description: Teen Account Transfer name: TEEN partner: id: 25f77a3e-2a4b-48bf-bea2-1b8bcd541621X name: Stark House auditDetails: - timestamp: '2023-10-25T16:00:42.126Z' status: description: Asset transfer request has been initiated. name: STARTED comment: Transfer request has been submitted in queue - timestamp: '2023-10-25T16:00:42.257Z' status: description: Asset transfer request is pending name: PENDING comment: Transfer process started - timestamp: '2023-10-27T21:00:07.959Z' status: description: Asset transfer request is on hold. name: ON_HOLD comment: >- Transfer is on hold for DWCW001118. Settlement is not finished yet. - timestamp: '2023-10-28T14:00:02.453Z' status: description: >- Asset transfer request has been successfully completed name: SUCCESSFUL comment: Transfer Completed created: '2023-10-25T16:00:42.126Z' updated: '2023-10-28T14:00:02.453Z' - id: grad_47edac5a-57f0-456a-83ca-128205fcdf3d source: DWXG000976 destination: DWHZ001105 status: description: Asset transfer request is on hold. name: ON_HOLD type: description: Teen Account Transfer name: TEEN partner: id: 25f77a3e-2a4b-48bf-bea2-1b8bcd541621X name: Stark House auditDetails: - timestamp: '2023-10-29T04:00:56.167Z' status: description: Asset transfer request has been initiated. name: STARTED comment: Transfer request has been submitted in queue - timestamp: '2023-10-29T04:00:56.309Z' status: description: Asset transfer request is pending name: PENDING comment: Transfer process started - timestamp: '2023-11-01T21:00:02.207Z' status: description: Asset transfer request is on hold. name: ON_HOLD comment: >- Transfer is on hold for DWXG000976. Settlement is not finished yet. created: '2023-10-29T04:00:56.167Z' updated: '2023-11-01T21:00:02.207Z' nextPageOffset: >- 25f77a3e-2a4b-48bf-bea2-1b8bcd541621#grad_47edac5a-57f0-456a-83ca-128205fcdf3d#2023-07-28T23:55:34.142Z prevPageOffset: '' List Assets Transfers [ACAT]: value: data: - id: acats_d83e92cb-ca72-4d0d-9576-ede66ffcee2b source: TR6666 destination: FWCT000005 clearingNo: '1111' status: description: Asset transfer request is pending name: PENDING type: description: ACAT transfer name: ACAT acatType: description: Partial Acats Transfer name: PARTIAL acatTransit: description: Incomming Acats Transfer name: ACAT_IN sourceAccountType: description: Individual Account name: INDIVIDUAL partner: id: 25f77a3e-2a4b-48bf-bea2-1b8bcd541621X name: Stark House cash: 12345.67 positions: - symbol: SBSI instrumentID: 1c6c1625-8146-4dd3-a84b-c6a97cd74bcf quantity: 213 metadata: {} auditDetails: - timestamp: '2023-10-20T13:18:42.383Z' status: description: Asset transfer request has been initiated. name: STARTED comment: Transfer request has been submitted in queue - timestamp: '2023-10-20T15:00:04.207Z' status: description: Asset transfer request is pending name: PENDING comment: TIF has been created created: '2023-10-20T13:18:42.347Z' updated: '2023-10-20T15:00:04.216Z' - id: acats_0a18eea2-c63d-447a-a0f1-1c7d9a08c9daX source: TR6666 destination: FWCT000005 clearingNo: '1111' status: description: >- Asset transfer request has been successfully completed name: SUCCESSFUL type: description: ACAT transfer name: ACAT acatType: description: Partial Acats Transfer name: PARTIAL sourceAccountType: description: Individual Account name: INDIVIDUAL partner: id: 25f77a3e-2a4b-48bf-bea2-1b8bcd541621X name: Stark House positions: - symbol: ACHN instrumentID: 27673f0e-2219-40b0-9ecc-91c87266efaf quantity: 1 - symbol: SBSI instrumentID: 1c6c1625-8146-4dd3-a84b-c6a97cd74bcf quantity: 56 metadata: {} auditDetails: - timestamp: '2023-10-20T13:02:50.970Z' status: description: Asset transfer request has been initiated. name: STARTED comment: Transfer request has been submitted in queue - timestamp: '2023-10-20T15:00:04.185Z' status: description: Asset transfer request is pending name: PENDING comment: TIF has been created - timestamp: '2023-11-02T00:01:19.340Z' status: description: >- Asset transfer request has been successfully completed name: SUCCESSFUL comment: Transfer Settled created: '2023-10-20T13:02:50.960Z' updated: '2023-11-02T00:01:19.340Z' - id: acats_d9faa000-9d97-4ab8-85f8-cbd856d31b79X source: TR6666 destination: FWRT000005 clearingNo: '1111' status: description: Asset transfer is failed. name: FAILED type: description: ACAT transfer name: ACAT acatType: description: Full Acats Transfer name: FULL sourceAccountType: description: Individual Account name: INDIVIDUAL partner: id: 25f77a3e-2a4b-48bf-bea2-1b8bcd541621X name: Stark House positions: [] metadata: customer_id: '12345' rejectionInfo: rejectionCode: ACCOUNT_NOT_MATCH rejectionReason: Account Title Mismatch auditDetails: - timestamp: '2023-08-28T11:30:26.367Z' status: description: Asset transfer request has been initiated. name: STARTED comment: Transfer request has been submitted in queue - timestamp: '2023-09-12T15:55:03.294Z' status: description: Asset transfer request is pending name: PENDING comment: Request has been submitted for ACAT transfer - timestamp: '2023-11-02T00:01:34.330Z' status: description: Asset transfer is failed. name: FAILED comment: >- Full Transfer Rejected. Contact Clearing Broker for further information created: '2023-08-28T11:30:25.805Z' updated: '2023-11-02T00:01:34.330Z' nextPageOffset: >- 25f77a3e-2a4b-48bf-bea2-1b8bcd541621#acats_d9faa000-9d97-4ab8-85f8-cbd856d31b79#2023-08-28T11:30:25.805Z prevPageOffset: '' /asset-transfers/cancel-rebills: post: tags: - Cancel Rebill summary: Create Cancel Rebill operationId: CancelRebill_create security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Create Cancel Rebill requestBody: description: Created Cancel Rebill required: true content: application/json: schema: $ref: '#/components/schemas/CancelRebillRequest' examples: 'Create Cancel ': value: orderNo: IKJL0000001 type: CANCEL reason: FRAUD approvedBy: John Doe comment: Fraud detected. metadata: - {} Create Price Adjustment: value: orderNo: IKJL0000001 type: PRICE_ADJUSTMENT reason: PRICE_ADJUSTMENT_PARTNER adjustedPrice: 22.99 approvedBy: John Doe comment: Incorrect price during execution. metadata: - {} Create Commission Adjustment: value: orderNo: IKJL0000001 type: COMMISSION_ADJUSTMENT reason: PARTNER_TECHNICAL_ERROR adjustedCommission: 2.99 approvedBy: John Doe comment: Incorrect commission during execution. metadata: - {} responses: '200': description: Creating a Cancel Rebill was Successful. content: application/json: schema: $ref: '#/components/schemas/CancelRebillResponse' examples: Cancel Rebill Response: value: id: cxl_rbl_497f6eca-6276-4993-bfeb-53cbbbba6f08 reason: description: Price Adjustment via Partner name: PRICE_ADJUSTMENT_PARTNER type: description: Price Adjustment name: PRICE_ADJUSTMENT orderNo: KJG000001 approvedBy: John Doe status: description: The cancel rebill has been started name: STARTED comment: reported NSF get: tags: - Cancel Rebill summary: List Cancel Rebills operationId: CancelRebill_listCancelRebills security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Get all the Cancel Rebills parameters: - description: The start date of the range of Cancel Rebill. name: from in: query required: true schema: type: string example: '2023-04-22' - description: The end date of the range of Cancel Rebill. name: to in: query required: true schema: type: string example: '2023-04-22' - name: partnerID in: query schema: type: string example: 5730ee28-78cb-4736-9c99-ede6dc1084a3 - description: The Cancel Rebill status code. name: status in: query required: true schema: type: string example: STARTED enum: - STARTED - PENDING - ON_HOLD - APPROVED - REJECTED - SUCCESSFUL - description: The number of records to be returned by the query. name: limit in: query required: false schema: type: integer example: 20 minimum: 1 maximum: 200 default: 50 - description: The offset of the last queried result. name: offset in: query required: false schema: type: string example: >- 5730ee28-78cb-4736-9c99-ede6dc1084a3#cxl_rbl_5730ee28-78cb-4736-9c99-ede6dc1084a3 - name: direction in: query required: false schema: type: string enum: - next - previous default: next example: next responses: '200': description: Retrieving Cancel Rebills was Successful. content: application/json: schema: $ref: '#/components/schemas/CancelRebillDetailResponse' /asset-transfers/cancel-rebills/{id}: get: tags: - Cancel Rebill summary: Retrieve Cancel Rebill operationId: CancelRebill_getDetailsById security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Get Cancel Rebill details by ID. parameters: - description: The identifier of the Cancel Rebill. name: id in: path required: true schema: type: string responses: '200': description: Retrieving Cancel Rebill was Successful. content: application/json: schema: $ref: '#/components/schemas/CancelRebillResponse' examples: Cancel Rebill Response: value: id: cxl_rbl_497f6eca-6276-4993-bfeb-53cbbbba6f08X reason: description: Price Adjustment via Partner name: PRICE_ADJUSTMENT_PARTNER type: description: Price Adjustment name: PRICE_ADJUSTMENT orderNo: KJG000001 approvedBy: John Doe status: description: The cancel rebill has been started name: STARTED comment: reported NSF /auth: post: tags: - Auth summary: Create Authentication Token operationId: Auth_tokenCreate security: [] description: >- Creates an authentication token for an implementer to utilize for subsequent API requests. requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAuthTokenReq' responses: '200': description: Creating Authentication Token was successful. content: application/json: schema: $ref: '#/components/schemas/CreateAuthToken' deprecated: true /auth/tokens: post: tags: - Auth summary: Create Session Token operationId: Auth_createSessionToken security: [] description: >- Creates a session token for an implementer to utilize for subsequent API requests. requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSessTokenReq' responses: '200': description: Creating Session Token was Successful. content: application/json: schema: $ref: '#/components/schemas/CreateSessToken' /countries: get: tags: - Supported Countries summary: List Supported Countries operationId: SupportedCountries_getList security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: >- Retrieves a list of allowed countries for which users can be onboard from. parameters: - description: >- Filters on the returned countries list has inactive or active countries inside it. in: query name: status schema: type: string enum: - ACTIVE - INACTIVE required: true example: ACTIVE responses: '200': description: Retrieving a list of Supported Countries was Successful. content: application/json: schema: $ref: '#/components/schemas/ListOfAllowedCountries' /funding/deposits: post: tags: - Deposits summary: Create Deposit operationId: Deposits_createUserDeposit security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Creates a Deposit for a User's Account. requestBody: content: application/json: schema: $ref: '#/components/schemas/DepositRequestReq' examples: Individual ACH Deposit: value: accountNo: DWFS001102 amount: 100.25 currency: USD type: ACH bankAccountID: bank_a4656e60-321e-425b-aa0d-a2e75c38885f Bulk Deposit: value: accountNo: DWFS001102 amount: 100.25 currency: USD type: BULK_FUNDING responses: '200': description: Creating a User's Account Deposit was successful. content: application/json: schema: $ref: '#/components/schemas/Deposit' /funding/deposits/{depositID}: get: tags: - Deposits summary: Retrieve Deposit operationId: Deposits_getById security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetches a deposit by the unique Deposit identifier. parameters: - description: A unique identifier for the user's account deposit. in: path name: depositID schema: $ref: '#/components/schemas/depositID' required: true responses: '200': description: Fetching a Deposit was successful. content: application/json: schema: $ref: '#/components/schemas/DepositByDepositID' /disclosures: get: tags: - Disclosures summary: List Disclosures operationId: Disclosures_listItems security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetches a list of disclosures. responses: '200': description: Fetching A List of Disclosures was Successful. content: application/json: schema: $ref: '#/components/schemas/ListOfDisclosures' /disclosures/{disclosureID}: get: tags: - Disclosures summary: Retrieve Disclosure operationId: Disclosures_getDetails security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetches a disclosure's details by disclosureID. parameters: - in: path name: disclosureID schema: $ref: '#/components/schemas/disclosureID' required: true responses: '200': description: Disclosure was retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/Disclosure' /users/{userID}/acknowledgments: post: tags: - Disclosures summary: Create Disclosure Acknowledgment operationId: Disclosures_acknowledgeUserDisclosure security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Creates a user's disclosure acknowledgment. parameters: - in: path name: userID schema: $ref: '#/components/schemas/userID' required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAcknowledgmentInput' responses: '200': description: Creating a disclosure acknowledgment was successful. content: application/json: schema: $ref: '#/components/schemas/Acknowledgment' get: tags: - Disclosures summary: List Disclosures Acknowledgments by User operationId: Disclosures_listUserAcknowledgments security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetches a list of disclosures acknowledgments for the given user. parameters: - in: path name: userID schema: $ref: '#/components/schemas/userID' required: true responses: '200': description: Fetching A List of Disclosure Acknowledgments was Successful. content: application/json: schema: $ref: '#/components/schemas/ListOfAcknowledgments' /exchanges: post: tags: - Exchanges summary: Create Exchange operationId: Exchanges_createExchange security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: >- Exchanges allow for the simultaneous sale of a held security and purchase of another. This can be used with Mutual Funds, as they only trade once per day. requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/ExchangesCreateExchangeRequest' examples: Example 1: value: accountNo: DWPH000003 sellSymbol: VTSMX buySymbol: VTSAX amountCash: 100 quantity: 10 responses: '200': description: Creating an Exchange was successful content: application/json: schema: $ref: '#/components/schemas/ExchangesCreateExchangeResponse' examples: Example 1: value: id: IC.0e352bb7-9869-4233-9861-1173544efedd exchangeNo: ICDU023727 patch: tags: - Exchanges summary: Update Exchange operationId: Exchanges_cancelPendingOrder security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: >- When an exchange is placed but has not yet been executed (order pending), the order can still be cancelled. This will automatically cancel the underlying buy and sell orders as well. It also produces an exchange.completed event for the exchange and order.completed events for the underlying buy and sell orders. requestBody: content: application/json: schema: $ref: '#/components/schemas/ExchangesCancelPendingOrderRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExchangesCancelPendingOrderResponse' examples: Example 1: value: id: IC.0e352bb7-9869-4233-9861-1173544efeddX exchangeNo: ICDU023727 /exchanges/{exchangeIdentifier}: parameters: - description: The Exchange ID (id) or Exchange Number (exchangeNo) schema: type: string name: exchangeIdentifier in: path required: true get: tags: - Exchanges summary: Retrieve Exchange operationId: Exchanges_getDetails security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: >- To retrieve specific exchange details the exchange endpoint can be used. In addition the underlying buy and sell trades, which make up the exchange order, will be available through the existing get order endpoint. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExchangesGetDetailsResponse' examples: Getting Exchange information by ID: value: id: GC.f7590a52-75c7-4f3a-92c7-6b03e02dc44f exchangeNo: ICDU023727 status: FILLED sellSymbol: VTSMX sellOrderId: GC.f7590a52-75c7-4f3a-92c7-6b03e02d111 sellOrderNo: EFXM000103 buySymbol: VTSAX buyOrderId: GC.f7590a52-75c7-4f3a-92c7-6b03e02d222 buyOrderNo: EFXM001102 sellAveragePrice: 10 sellCumulativeQuantity: 100 buyAveragePrice: 50 buyCumulativeQuantity: 20 amountCash: 1000 fees: 0 orderExpires: '2019-03-29T20:00:00.000Z' createdBy: b25f0d36-b4e4-41f8-b3d9-9249e46402cd userID: b25f0d36-b4e4-41f8-b3d9-9249e46402cd accountID: b25f0d36-b4e4-41f8-b3d9-9249e46402cd.1403540676095 accountNo: DWZR000001 created: '2019-03-28T22:40:03.240Z' /accounts/{accountID}/summary/exchanges: parameters: - description: The account id of the user where the order was placed schema: type: string name: accountID in: path required: true get: tags: - Exchanges summary: List Exchanges by Account operationId: Exchanges_listByAccount security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: >- To retrieve all pending exchanges for an account the below endpoint can be used. In addition the underlying buy and sell trades which make up the exchange order will be available through the existing account summary endpoint. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExchangesListByAccountResponse' examples: Getting all pending exchange: value: accountID: b25f0d36-b4e4-41f8-b3d9-9249e46402cd.1403540676095 accountNo: DWBG000052 tradingType: CASH updated: '2021-04-23T18:41:32.440Z' exchanges: - id: GC.f7590a52-75c7-4f3a-92c7-6b03e02dc11f exchangeNo: ICDU023727 status: NEW sellSymbol: VTSMX sellOrderId: GC.f7590a52-75c7-4f3a-92c7-6b03e02d112 sellOrderNo: EFXM000203 buySymbol: VTSAX buyOrderId: GC.f7590a52-75c7-4f3a-92c7-6b03e02d223 buyOrderNo: EFXM002102 amountCash: 0 sellAveragePrice: 0 sellCumulativeQuantity: 0 buyAveragePrice: 0 buyCumulativeQuantity: 0 fees: 0 orderExpires: '2019-03-29T20:00:00.000Z' createdBy: b25f0d36-b4e4-41f8-b3d9-9249e46402cd userID: b25f0d36-b4e4-41f8-b3d9-9249e46402cd accountID: b25f0d36-b4e4-41f8-b3d9-9249e46402cd.1403540676095 accountNo: DWZR000001 created: '2019-03-28T22:40:03.240Z' /accounts/{accountID}/reports/exchange-history: parameters: - description: The account id of the user where the order was placed schema: type: string name: accountID in: path required: true get: tags: - Exchanges summary: Retrieve Exchange History by Account operationId: Exchanges_getExchangeHistory security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: >- To retrieve ALL exchanges for an account the below endpoint can be used. In addition the underlying buy and sell trades which make up the exchange order will be available through the existing account summary endpoint. responses: '200': description: retrieving Exchange History by Account was Successful. content: application/json: schema: $ref: '#/components/schemas/ExchangesGetExchangeHistoryResponse' examples: Exchanges: value: accountID: b25f0d36-b4e4-41f8-b3d9-9249e46402cd.1403540676095 accountNo: DWBG000052 tradingType: CASH updated: '2021-04-23T18:41:32.440Z' exchanges: - id: GC.f7590a52-75c7-4f3a-92c7-6b03e02dc11fX exchangeNo: ICDU023727 status: FILLED sellSymbol: VTSMX sellOrderId: GC.f7590a52-75c7-4f3a-92c7-6b03e02d112 sellOrderNo: EFXM000203 buySymbol: VTSAX buyOrderId: GC.f7590a52-75c7-4f3a-92c7-6b03e02d223 buyOrderNo: EFXM002102 amountCash: 1000 sellAveragePrice: 10 sellCumulativeQuantity: 100 buyAveragePrice: 50 buyCumulativeQuantity: 20 fees: 0 orderExpires: '2019-03-29T20:00:00.000Z' createdBy: b25f0d36-b4e4-41f8-b3d9-9249e46402cd userID: b25f0d36-b4e4-41f8-b3d9-9249e46402cd accountID: b25f0d36-b4e4-41f8-b3d9-9249e46402cd.1403540676095 accountNo: DWZR000001 created: '2019-03-28T22:40:03.240Z' /bars: get: tags: - Charts summary: Retrieve Chart operationId: Charts_getBars security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetch historical bars for a given instrument over a given time period. parameters: - description: >- A unique ID created by DriveWealth to identify a specific instrument. in: query name: instrumentID schema: type: string required: true example: 3fb1e8a9-f7d5-4d90-95e2-43e7326b5636 - description: >- The compression number represents the time increments of the chart data. Refer to the Compression table above. in: query name: compression schema: type: string enum: - '0' - '1' - '4' - '8' - '9' - '10' required: true example: '9' - description: The start date of the chart data. Follow ISO-8601 format. in: query name: dateStart schema: type: string required: true example: '2022-11-10T00:00:00Z' - description: The end date of the chart data. Follow ISO-8601 format. in: query name: dateEnd schema: type: string required: true example: '2022-11-18T23:59:00Z' - description: >- TradingDays may be defined as 1-60 days in the past from the current date. If set do not use `dateStart` and `dateEnd` values. in: query name: tradingDays schema: type: string required: false example: '20' responses: '200': description: Fetching Chart details was successful. content: application/json: schema: $ref: '#/components/schemas/Bars' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ChartsGetBarsResponse' examples: Invalid request for daily bars: value: errorCode: B100 message: >- The number of bars requested has exceeded the maximum allowed of 10 Years for Daily bars. Invalid request for one minute bars: value: errorCode: B100 message: >- The number of bars requested has exceeded the maximum allowed of 1 Month for 1 minute bars. Invalid request for five minutes bars: value: errorCode: B100 message: >- The number of bars requested has exceeded the maximum allowed of 2 Months for 5 minutes bars. Invalid request for thirty minutes bars: value: errorCode: B100 message: >- The number of bars requested has exceeded the maximum allowed of 1 Year for 30 minutes bars. Invalid request for one hour bars: value: errorCode: B100 message: >- The number of bars requested has exceeded the maximum allowed of 2 Years for 1 hour bars. Invalid request for weekly bars: value: errorCode: B100 message: >- The number of bars requested has exceeded the maximum allowed of 20 Years for Weekly bars. '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ChartsGetBars500Response' examples: OneTick bars request exceeded: value: errorCode: OT002 message: >- The Number of Bars request has exceeded the maximum allowed Bars. Other OneTick Errors: value: errorCode: OT003 message: Unable to retrieve bars data. /instruments: get: tags: - Instruments summary: List Instruments operationId: Instruments_listAll security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: >- Fetch a list of all the available Instruments offered on the DriveWealth platform. This endpoint will return an array of over 6,500+ instrument objects. parameters: - description: The instrument status; to filter by. in: query name: status schema: type: string required: false example: ACTIVE - description: The ability to trade options for this instrument; to filter by. in: query name: isOptionsEnabled schema: type: boolean required: false example: true responses: '200': description: Fetching all Instruments was successful. content: application/json: schema: $ref: '#/components/schemas/Instruments' /instruments/{symbolOrInstrumentID}: get: tags: - Instruments summary: Retrieve Instrument operationId: Instruments_getDetails security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetch the details of a specific Instrument. parameters: - description: >- A unique ID created by DriveWealth to identify a specific Equity Instrument or Option Instrument, also accept the market symbols like Ticker for Equities and OSI for Options. in: path name: symbolOrInstrumentID schema: type: string required: true example: 3fb1e8a9-f7d5-4d90-95e2-43e7326b5636 - description: >- This query parameter will add an additional property; `fundamentalDataModel` to the response object for an Equity Instrument only. This data consists of financial data model specs for a specific Instrument. in: query name: options schema: type: string required: false example: Fundamentals responses: '200': description: Fetching Instrument details was successful. content: application/json: schema: $ref: '#/components/schemas/InstrumentsGetDetailsResponse' /instruments/{symbolOrInstrumentID}/options: get: tags: - Instruments summary: Retrieve Options Chain operationId: Instruments_getOptionsChain security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Retrieves a list of Options chain based on query parameters. parameters: - description: Symbol or instrumentID of the underlying equity security in: path name: symbolOrInstrumentID schema: type: string required: true example: AAPL - description: The expiration date of the option security; to filter by. in: query name: expirationDate schema: type: string required: true example: '2022-05-15' - in: query name: page schema: type: integer required: false example: 1 - description: The number of option instruments to be returned per page. in: query name: pageSize schema: type: integer required: false example: 20 - description: The sorting order of option instruments. in: query name: sortOrder schema: type: string enum: - asc - desc default: asc required: false example: asc - description: >- The number of option instruments to be returned above and below market price. in: query name: noOfStrikes schema: type: integer required: false example: 5 - description: The option instruments to be returned above the strike price. in: query name: minStrikePrice schema: type: integer required: false example: 20 - description: The option instruments to be returned below the strike price. in: query name: maxStrikePrice schema: type: integer required: false example: 100 - description: The type of option instruments to be returned. in: query name: optionType schema: type: string enum: - CALL - PUT required: false example: CALL - description: The instrument ID of the option security. in: query name: id schema: type: string required: false example: 3fb1e8a9-f7d5-4d90-95e2-43e7326b5636 - description: >- The expiration dates for the given underlying security; to filter by. in: query name: filterBy schema: type: string required: false example: expirationDate responses: '200': description: Retrieving Options chain was Successful. content: application/json: schema: $ref: '#/components/schemas/OptionsList' examples: Options Chain: value: symbol: AAPL options: - optionsData: rootSymbol: AAPL rootId: 3fb1e8a9-f7d5-4d90-95e2-43e7326b5636 expirationDate: '2018-09-18' optionType: PUT strikePrice: 16.5 deliverable: 100 multiplier: 100 id: 3fb1e8a9-f7d5-4d90-95e2-43e7326b5636 symbol: AAPL220517P00016000 type: OPTION name: Apple Computer September 9 $16.00 Put exchange: NYQ orderSizeMax: 20000 orderSizeMin: 1 orderSizeStep: 1 /instruments/{symbolOrInstrumentID}/options/expiration-dates: get: tags: - Instruments summary: Retrieve Option Expiration operationId: Instruments_getOptionExpiration security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Retrieve option expiration dates for an underlying security. parameters: - description: Symbol or instrumentID of the underlying equity security. in: path name: symbolOrInstrumentID schema: type: string required: true example: AAPL responses: '200': description: >- Retrieving all Options ExpirationDates based on Equity Symbol or Equity InstrumentID was successful content: application/json: schema: $ref: '#/components/schemas/ExpirationDateList' /instruments/filter: post: tags: - Instruments summary: Search Instruments by Filter operationId: Instruments_searchByFilter security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: >- Filters, Instruments using the provided filter criteria and return the list of matching. requestBody: content: application/json: schema: $ref: '#/components/schemas/FilterCriteria' examples: InBetweenOperatorSample: value: - field: spRating operator: '><' value1: A value2: AAA MultipleFiltersSample: value: - field: couponRate operator: '><' value1: '3.14' value2: '6' - field: maturityDate operator: '><' value1: '2023-08-24' value2: '2025-02-12' - field: maturityDate operator: '><' value1: '2028-01-24' value2: '2032-04-25' responses: '200': description: Filtering was successful and zero or more instruments are available content: application/json: schema: $ref: '#/components/schemas/Instruments' examples: InstrumentsFilterSuccess: value: - id: 2dd415f4-16f0-4df9-9a33-610f1531cb55 name: Amazon.com, Inc. 1.5% 2030-06-03 instrumentType: DEBT status: ACTIVE payFrequency: SEMI_ANNUALLY couponRate: 1.5 maturityDate: '2030-06-03' spRating: AA bondType: CORPORATE_BOND domicileCountry: US ISIN: US023135BS49 CUSIP: 023135BS4 - id: f8e3a175-5dfc-4d9b-bd1a-7db0e8b48703 name: Amazon.com, Inc. 3.8% 2024-12-05 instrumentType: DEBT status: ACTIVE payFrequency: SEMI_ANNUALLY couponRate: 3.8 maturityDate: '2024-12-05' spRating: AA bondType: CORPORATE_BOND domicileCountry: US ISIN: US023135AN60 CUSIP: 023135AN6 /orders: post: tags: - Orders summary: Create Order operationId: Orders_createSecurityOrder security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Create an Order to buy or sell a security. requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOrderRequest' examples: 'Market Cash Amount Order ': value: accountNo: DWFS001102 orderType: MARKET symbol: SBUX side: BUY amountCash: 100 Market Quantity Order: value: accountNo: DWFS001102 orderType: MARKET symbol: SBUX side: BUY quantity: 2 Market Quantity Order w/ Lot Disposition: value: accountNo: DWFS001102 orderType: MARKET symbol: SBUX side: SELL quantity: 2 taxLotDisposition: - taxLotID: 3db27e74626adac3be7b549f2bbc0ab2480852a7 Limit GTC Order: value: accountNo: DWFS001102 orderType: LIMIT symbol: AAPL price: 165.25 quantity: 10 timeInForce: GTC expiration: '2023-12-31' side: BUY Option Order: value: accountNo: DWFS001102 orderType: LIMIT timeInForce: GTC expiration: '2023-08-01' symbol: AAPL230818C00195000 side: BUY_OPEN quantity: 1 price: 3.42 Fixed Income Order: value: accountNo: DWFS001102 orderType: LIMIT side: SELL ISIN: US459058GX53 quantity: 3 salesCredit: currency: USD amount: 8 commission: 3.567 price: 4.5 currency: USD timeInForce: DAY limitType: YIELD required: true responses: '200': description: The Order creation was successful. content: application/json: schema: $ref: '#/components/schemas/CreateOrderResponse' /orders/{orderID}: get: tags: - Orders summary: Retrieve Order operationId: Orders_getStatus security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetch the status of an Order. parameters: - in: path name: orderID schema: $ref: '#/components/schemas/orderID' required: true responses: '200': description: Fetching Order status was successful. content: application/json: schema: $ref: '#/components/schemas/OrderStatusResponse' patch: tags: - Orders summary: Update Order operationId: Orders_updateInProgress security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Updates an Order in progress. parameters: - in: path name: orderID schema: $ref: '#/components/schemas/orderID' required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/CancelOrder' required: true responses: '200': description: The Order was Successfully Updated. content: application/json: schema: $ref: '#/components/schemas/CancelOrderResponse' /orders/byOrderNo/{orderNo}: get: tags: - Orders summary: Retrieve Order By OrderNo operationId: Orders_getByOrderNo security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Retrieves an Order by OrderNo parameters: - in: path name: orderNo schema: $ref: '#/components/schemas/orderNo' required: true responses: '200': description: ' Retrieving an Order by OrderNo was Successful.' content: application/json: schema: $ref: '#/components/schemas/OrderStatusResponse' /orders/crypto/rfq: post: tags: - Orders summary: Create a request-for-quote operationId: Orders_createRfqCrypto security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Create an a request-for-quote (RFQ) for a cryptocurrency. requestBody: content: application/json: schema: $ref: '#/components/schemas/RFQrequest' required: true responses: '200': description: The RFQ creation was successful. content: application/json: schema: $ref: '#/components/schemas/RDQresponse' /orders/crypto/execute: post: tags: - Orders summary: Create Order with request-for-quote operationId: Orders_executeRfqCrypto security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Creates a market order or executes a RFQ order requestBody: content: application/json: schema: $ref: '#/components/schemas/digitalAssetRequest' required: true responses: '200': description: The RFQ assets order creation was successful. content: application/json: schema: $ref: '#/components/schemas/digitalAssetResponse' /orders/options: get: tags: - Orders summary: Retrieve Option Orders operationId: Orders_getOptionOrders security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Retrieves Options Orders. parameters: - in: query name: type schema: description: The Transaction Batch type. type: string example: LIQUIDATION enum: - LIQUIDATION required: true - in: query name: status schema: description: The status of Transaction Batch. type: string example: COMPLETED enum: - COMPLETED required: true - in: query name: partnerIBID schema: $ref: '#/components/schemas/parentIBID' required: true - in: query name: fromDate schema: $ref: '#/components/schemas/from' required: false - in: query name: toDate schema: $ref: '#/components/schemas/to' required: false - description: The number of results to be returned. in: query name: pageSize schema: type: integer required: false example: 20 - in: query name: pageNo schema: type: integer required: false example: 1 responses: '200': description: Retrieving Option Orders was Successful. content: application/json: schema: $ref: '#/components/schemas/OrdersGetOptionOrdersResponse' /documents: post: tags: - Physical Documents summary: Create Physical Document operationId: PhysicalDocuments_uploadDriverLicense security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: >- Uploads a User's Physical Document, such as: a driver license, passport or government id. requestBody: content: application/json: schema: $ref: '#/components/schemas/UploadUserPhysicalDocumentReq' responses: '200': description: Physical Document uploading was successful. content: application/json: schema: $ref: '#/components/schemas/UploadUserPhysicalDocument' /{documentID}/url: get: tags: - Physical Documents summary: Retrieve Physical Document URL by Document operationId: PhysicalDocuments_getUrlByDocumentId security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetches a user's physical document by documentID. parameters: - description: The unique identifier of the document. in: path name: documentID schema: $ref: '#/components/schemas/physicalDocumentID' required: true responses: '201': description: Fetching a user's Physical Document URL was successful. content: application/json: schema: $ref: '#/components/schemas/GetUserPhysicalDocumentByID' /quotes: get: tags: - Quotes summary: Retrieve Quote (referential feed) operationId: Quotes_getReferentialDetails security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: >- Fetch the realtime or 15 minute delayed Referential quote details for a specific security. parameters: - in: header name: dw-customer-user-id schema: description: The unique identifier of the user, who is requesting the quote. type: string example: 66304da9-3h6f-2234-935f-ac6b7933d706 - description: >- The ticker symbol of the associated instrument. Multiple ticker symbols separated by a comma may also be used. in: query name: symbols schema: type: string required: true example: MS - description: The quote details will be 15 minutes delayed. in: query name: exchangeOverride schema: type: string required: false example: 15MinDelayed responses: '200': description: Fetch referential quote details was Successful. content: application/json: schema: $ref: '#/components/schemas/Referential' examples: Equity Quote: value: - symbol: SBUX bid: 95.59 ask: 95.6 lastTrade: 95.6 change: 0.32 open: 95.65 high: 96.2 low: 95.23 close: 0 priorClose: 95.28 volume: 3973709 marketCondition: NORMAL dataProvider: BATS Option Quote: value: - symbol: AAPL230818C00177500 bid: 0.01 ask: 0.03 lastTrade: 0 change: 0 close: 0.85 priorClose: 1.5 volume: 0 marketCondition: NORMAL dataProvider: OPRA - symbol: AAPL230818C00180000 bid: 0.01 ask: 0.02 lastTrade: 0.01 change: -0.22 close: 16.52 priorClose: 16.85 volume: 43512 marketCondition: NORMAL dataProvider: OPRA - symbol: AAPL230818C00182500 bid: 0.01 ask: 0.02 lastTrade: 0.01 change: -0.05 close: 0.06 priorClose: 0.14 volume: 16388 marketCondition: NORMAL dataProvider: OPRA - symbol: AAPL230818C00175000 bid: 0.01 ask: 0.02 lastTrade: 0.01 change: -0.45 close: 21.45 priorClose: 21.65 volume: 172163 marketCondition: NORMAL dataProvider: OPRA - symbol: AAPL230818C00172500 bid: 1.71 ask: 2.28 lastTrade: 1.9 change: -0.02 close: 4.3 priorClose: 5.5 volume: 33437 marketCondition: NORMAL dataProvider: OPRA - symbol: AAPL230818C00170000 bid: 4.4 ask: 5.2 lastTrade: 4.4 change: 0.32 close: 26.15 priorClose: 26.55 volume: 3230 marketCondition: NORMAL dataProvider: OPRA /quotes/vdr: get: tags: - Quotes summary: Retrieve Quote (consolidated feed) operationId: Quotes_getConsolidatedFeed security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetch the NBBO quote details for a specific security. parameters: - in: header name: dw-customer-user-id schema: description: The unique identifier of the user, who is requesting the quote. type: string example: 66304da9-3h6f-2234-935f-ac6b7933d706 - description: The ticker symbol of the associated instrument. in: query name: symbols schema: type: string required: true example: MS responses: '200': description: Fetch NBBO quote details was Successful. content: application/json: schema: $ref: '#/components/schemas/NBBO' /quotes/depth: post: tags: - Depth of Book summary: Retrieve Depth of Book operationId: DepthOfBook_getDebtDepth security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: >- Get the Depth of Book for an Instrument. For now, this API only works with debt instruments, but will expand in the future. requestBody: content: application/json: schema: $ref: '#/components/schemas/DepthOfBookGetDebtDepthRequest' examples: MarketQuoteRequestSample: value: - instrumentID: f6d3e213-4e6f-4ee3-8a9a-793027c62c57 quantity: 3.14 salesCredit: currency: USD amount: 8 required: true responses: '200': description: Fetching Market data was successful content: application/json: schema: $ref: '#/components/schemas/DepthOfBookGetDebtDepthResponse' examples: QuoteResponse: value: - id: f61b3240-6ab4-48bb-8f30-c160b7fba999 instrumentID: 206b06c2-6d46-4515-9340-678cb131f2cc ISIN: US105756BB58 CUSIP: 105756BB5 quantity: 3 salesCredit: currency: USD amount: 14 bidPrices: - bidPrice: 98.882 bidSize: 100000 bidYield: 4.799 minQty: 150 - bidPrice: 98.872 bidSize: 230000 bidYield: 4.812 minQty: 112 askPrices: - askPrice: 98.884 askSize: 1000 askYield: 4.793 minQty: 150 - askPrice: 98.889 askSize: 250000 askYield: 4.768 minQty: 150 effectiveBidPrices: - bidPrice: 99.022 bidSize: 100000 bidYield: 4.739 minQty: 112 - bidPrice: 99.012 bidSize: 230000 bidYield: 4.812 minQty: 112 effectiveAskPrices: - askPrice: 98.744 askSize: 1000 askYield: 4.793 minQty: 150 - askPrice: 98.749 askSize: 250000 askYield: 4.768 minQty: 150 recentTrades: - price: 98.992 quantity: 10000 yield: 4.799 side: buy dateTime: '2017-07-21T17:32:28Z' /funding/reconciliations: get: tags: - Settlements summary: List Cashless Reconciliations operationId: Settlements_getDailyReconciliations security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: >- Fetches a list of daily reconciliations for a firm using cashless settlement. parameters: - description: The date and time in which to end at. in: query name: to schema: type: string required: true example: '2022-12-25T18:36:40.609Z' - description: The date and time in which to start from. in: query name: from schema: type: string required: true example: '2022-12-08T18:36:40.609Z' - description: Filters the reconciliations reports by the type of reconciliation. in: query name: type schema: type: string required: false example: CRYPTO - description: Filters the reconciliations reports by the status of reconciliation. in: query name: status schema: $ref: '#/components/schemas/reconciliationStatus' required: false responses: '200': description: Fetching a list of daily reconciliations for a firm was successful. content: application/json: schema: $ref: '#/components/schemas/ListOfDailyReconciliations' /funding/reconciliations/{reconciliationID}: get: tags: - Settlements summary: Retrieve Cashless Reconciliation operationId: Settlements_getCashlessReconciliation security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetches reconciliations details for a firm using cashless settlement. parameters: - description: The unique identifier of the reconciliation report. in: path name: reconciliationID schema: $ref: '#/components/schemas/reconciliationID' required: true responses: '200': description: Fetching a firm's reconciliation details was successful. content: application/json: schema: $ref: >- #/components/schemas/SettlementsGetCashlessReconciliationResponse patch: tags: - Settlements summary: Update Cashless Reconciliation operationId: Settlements_updateCashlessReconciliation security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Updates a Cashless Reconciliation by reconciliationID. parameters: - in: path name: reconciliationID schema: $ref: '#/components/schemas/reconciliationID' required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/ReconciliationUpdate' responses: '200': description: Updating the Cashless Reconciliations was Successful. content: application/json: schema: $ref: >- #/components/schemas/SettlementsUpdateCashlessReconciliationResponse /funding/recurring-deposits/{recurringID}: get: tags: - Deposits summary: Retrieve Recurring Deposits operationId: Deposits_getScheduleByRecurringId security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetches the details of a recurring deposit schedule by the recurringID. parameters: - description: A unique identifier for the user's recurring bank deposit. in: path name: recurringID schema: type: string required: true example: recurring_98be6652-6361-4d4c-905b-06e9ec38d060 responses: '200': description: Fetching recurring deposit schedule was successful. content: application/json: schema: $ref: '#/components/schemas/RecurringDeposit' patch: tags: - Deposits summary: Update Recurring Deposit operationId: Deposits_updateRecurringDeposit security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Updates a user's external bank account recurring deposit. parameters: - description: A unique identifier for the user's recurring bank deposit. in: path name: recurringID schema: type: string required: true example: recurring_98be6652-6361-4d4c-905b-06e9ec38d060 requestBody: content: application/json: schema: $ref: '#/components/schemas/RecurringDepositUpdate' responses: '200': description: Updating a User's recurring deposit was successful. content: application/json: schema: $ref: '#/components/schemas/RecurringDepositUpdate' delete: tags: - Deposits summary: Delete Recurring Deposit operationId: Deposits_inactivateRecurring security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Inactivates a user's external bank account recurring deposit. parameters: - description: A unique identifier for the user's recurring bank deposit. in: path name: recurringID schema: type: string required: true example: recurring_98be6652-6361-4d4c-905b-06e9ec38d060 responses: '200': description: Inactivating a User's recurring deposit schedule was successful. content: application/json: schema: $ref: '#/components/schemas/RecurringDepositDeleteResponse' /funding/redemptions: post: tags: - Withdrawals summary: Create Withdrawal operationId: Withdrawals_createUserWithdrawal security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Creates a withdrawal from a User's Account. requestBody: content: application/json: schema: $ref: '#/components/schemas/WithdrawalFromUserAccountReq' responses: '200': description: Creating a User's Account Withdrawal was successful. content: application/json: schema: $ref: '#/components/schemas/WithdrawalFromUserAccount' get: tags: - Withdrawals summary: List Withdrawals operationId: Withdrawals_getAll security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Retrieves a list of all Withdrawals for the firm. parameters: - description: The current status of the withdrawal; to filter by. in: query name: status schema: $ref: '#/components/schemas/withdrawalStatus' required: true - description: The type of withdrawal; to filter by. in: query name: type schema: $ref: '#/components/schemas/withdrawalTypes' required: true responses: '200': description: Retrieving a list of all Withdrawals for the firm was Successful. content: application/json: schema: $ref: '#/components/schemas/ListAllWithdrawalsForTheFirm' /funding/redemptions/{redemptionID}: get: tags: - Withdrawals summary: Retrieve Withdrawal operationId: Withdrawals_getByRedemptionId security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetches a User's Withdrawal by redemptionID. parameters: - description: A unique identifier for the user's account redemption/withdrawal. in: path name: redemptionID schema: $ref: '#/components/schemas/redemptionID' required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 responses: '200': description: Fetching a User's Withdrawal by redemptionID was successful. content: application/json: schema: $ref: '#/components/schemas/WithdrawalByRedemptionID' /funding/settlements/instant-funding: get: tags: - Settlements summary: List Bulk Settlements operationId: Settlements_listBulkSettlements security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Retrieves a list of daily Bulk Settlements details. parameters: - description: The date and time in which to start from. in: query name: from schema: type: string required: true example: '2022-12-08T18:36:40.609Z' - description: The date and time in which to end at. in: query name: to schema: type: string required: true example: '2022-12-25T18:36:40.609Z' - description: Filters the settlements by the category of the settlement. in: query name: category schema: $ref: '#/components/schemas/category' required: false responses: '200': description: Retrieving a list of daily Bulk Settlements details was Successful. content: application/json: schema: $ref: '#/components/schemas/ListDailySettlementDetails' /funding/settlements/instant-funding/{settlementID}: get: tags: - Settlements summary: Retrieve Bulk Settlement operationId: Settlements_getBulkSettlementBySettlementId security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Retrieves a Bulk Settlement by settlementID. parameters: - description: The unique identifier that identifies the settlement report. in: path name: settlementID schema: $ref: '#/components/schemas/settlementID' required: true responses: '200': description: Retrieving a Bulk Settlement by settlementID was Successful. content: application/json: schema: $ref: '#/components/schemas/SettlementByID' patch: tags: - Settlements summary: Update Bulk Settlement operationId: Settlements_updateBulkSettlementBySettlementId security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Updates a Bulk Settlement by settlementID. parameters: - in: path name: settlementID schema: $ref: '#/components/schemas/settlementID' required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/SettlementUpdate' responses: '200': description: Updating a Bulk Settlement by settlementID was Successful. content: application/json: schema: $ref: '#/components/schemas/SettlementByID' /accounts/{accountID}/reports/daily-trade-summary: post: tags: - Settlements summary: Create DVP RVP Report operationId: Settlements_createDvpRvpReportJob security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Creates a job to generate a DVP RVP Report. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDVPRVP' responses: '200': description: Creating the job to generate a DVP/RVP Report was successful content: application/json: schema: $ref: '#/components/schemas/CreateDVPRVPRes' get: tags: - Settlements summary: List DVP RVP Reports operationId: Settlements_listDvpRvpReports security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Lists DVP RVP reports. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true - description: A filter, to filter on the status of the DVP/RVP. in: query name: status schema: $ref: '#/components/schemas/DVPRVPStatus' - in: query name: from schema: $ref: '#/components/schemas/from' required: true - in: query name: to schema: $ref: '#/components/schemas/to' required: true responses: '200': description: Fetching DVP/RVP List was Successful. content: application/json: schema: $ref: '#/components/schemas/ListDVPRVP' /accounts/{accountID}/reports/daily-trade-summary/{reportID}: get: tags: - Settlements summary: Retrieve DVP RVP operationId: Settlements_getDvpRvpByReportId security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Retrieves a DVP RVP by reportID. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true - in: path name: reportID schema: description: The DVP/RVP report identifier. type: string example: bsr_040fb9cc-84e8-4f20-bf09-d398dacd458d.1622745430469_20210604 required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/DVPRVPDetails' /statements/{accountID}/{fileKey}: get: tags: - Statements summary: Retrieve Document URL by Account and FileKey operationId: Statements_getDocumentUrlByAccountAndFileKey security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: >- Fetches a user's generated account document: monthly statement, tax statement or trade confirmation. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true - in: path name: fileKey schema: $ref: '#/components/schemas/fileKey' required: true responses: '200': description: Fetching a User's generated account document was successful. content: application/json: schema: $ref: '#/components/schemas/UserGeneratedAccountDocument' /subscriptions: post: tags: - Subscriptions summary: Create Subscription operationId: Subscriptions_createCharge security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Creates a Subscription charge for a User's Linked Bank Account. requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriptionRequest' responses: '200': description: >- Creating a Subscription for a User's Linked Bank Account was successful. content: application/json: schema: $ref: '#/components/schemas/Subscription' /subscriptions/{subscriptionID}: delete: tags: - Subscriptions summary: Delete Subscription operationId: Subscriptions_removeBySubscription security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Removes a User's Subscription by Subscription. parameters: - description: The unique identifier that identifies the user's subscription. in: path name: subscriptionID schema: $ref: '#/components/schemas/subscriptionID' required: true responses: '201': description: User's Subscription removal was Received. /users: post: tags: - Users summary: Create User operationId: Users_createProfile security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Create a User's profile on the DriveWealth platform. requestBody: content: application/json: schema: $ref: '#/components/schemas/UsersReq' responses: '200': description: User is Successfully Created. content: application/json: schema: $ref: '#/components/schemas/UserResponse' examples: {} /users/{userID}: get: tags: - Users summary: Retrieve User operationId: Users_getProfile security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Retrieves a User profile by userID. parameters: - description: Unique ID of the User to fetch. in: path name: userID schema: type: string required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 responses: '200': description: Retrieving a User profile was Successful. content: application/json: schema: $ref: '#/components/schemas/FetchUserResponse' patch: tags: - Users summary: Update User operationId: Users_updateProfile security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Update a user's profile by userID. parameters: - description: Unique ID of the User to update. in: path name: userID schema: type: string required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 requestBody: content: application/json: schema: $ref: '#/components/schemas/Documents' responses: '200': description: Fetching a User is Successful. content: application/json: schema: $ref: '#/components/schemas/UserObject' examples: User Creation: value: id: cc07f91b-7ee1-4868-b8fc-823c70a1b932 ackSignedWhen: '2022-12-11T22:28:21.666Z' addressLine1: 15 Exchange Place addressLine2: Suite 1000 city: Jersey City countryID: USA displayName: JSmith dob: 2000-12-3 email: jj@drivewealth.dev firstName: Justin gender: name: MALE languageID: en_US lastname: Smith parentIBID: id: 80f9b672-120d-4b73-9cc9-42fb3262c4b9X name: Tendies Trading Company phone: '18004612680' referralCode: 71J000 stateProvince: NJ wlpID: TTC zipPostalCode: '94105' idNo: '****-4444' status: description: User is pending approval. name: PENDING userType: description: Individual Trader name: INDIVIDUAL_TRADER usCitizen: true updatedWhen: '2022-12-11T22:28:21.810Z' brandAmbassador: false employerBusiness: FINANCE employementStatus: description: Employed name: EMPLOYED citizenship: US createdWhen: '2022-12-11T22:28:21.810Z' marginDefault: 0 maritalStatus: description: Single name: SINGLE ackCustomerAgreement: true ackFindersFee: false ackFixedIncomeAgreement: true ackForeignFindersFee: false ackJointCustomerAgreement: true ackJointFindersFee: false ackJointForeignFindersFee: false ackJointMarketData: false ackMarketData: false ackExtendedHoursAgreement: false dependents: 0 termsOfUse: true director: false employerCompany: DriveWealth LLC employerIsBroker: true employmentPosition: ENGINEER employmentYears: 0 jointEmployerIsBroker: false investmentObjectives: description: Frequent trader, depending on the market name: FREQUENT investmentExperience: description: 10+ yrs name: YRS_10_ politicallyExposed: false riskTolerance: HIGH userNoteQty: 0 validTaxForm: false taxTreatyWithUS: true avatarURL: >- https://secure.gravatar.com/avatar/2076105f6efe7c11e285add95f514b9a.jpg annualIncomeRange: $0 - $24,999 ackDisclosureRule14b: true ackJointDisclosureRule14b: false networthLiquidRange: $0 - $24,999 networthTotalRange: $0 - $24,999 /users/{userID}/kyc-status: get: tags: - Users summary: Retrieve KYC by User operationId: Users_getKycByUser security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetches a user's profile details & kyc status by userID. parameters: - description: Unique ID of the User to fetch their profile & kyc status. in: path name: userID schema: type: string required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 responses: '200': description: Fetching User's Profile Details & KYC is Successful. content: application/json: schema: $ref: '#/components/schemas/FetchUserKYCResponse' /users/{userID}/accounts: get: tags: - Accounts summary: List Accounts by User operationId: Accounts_listByUser security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Retrieves a list of Accounts by userID. parameters: - description: Unique ID of the User to fetch their accounts at DriveWealth. in: path name: userID schema: type: string required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 responses: '200': description: Fetching User Accounts was Successful. content: application/json: schema: $ref: '#/components/schemas/AccountDetails' /users/{userID}/bank-accounts: get: tags: - Linked Bank Accounts summary: List Linked Bank Accounts by User operationId: LinkedBankAccounts_listByUser security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetches a list of all external bank accounts stored at DriveWealth. parameters: - description: Unique ID of the User to fetch their stored bank accounts. in: path name: userID schema: type: string required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 responses: '200': description: Fetching User's stored Bank Accounts is successful. content: application/json: schema: $ref: '#/components/schemas/BankAccountsArray' /users/{userID}/documents: get: tags: - Physical Documents summary: List Physical Documents by User operationId: PhysicalDocuments_listByUser security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetches a list of all User's uploaded physical documents. parameters: - description: The User's unique identifier. in: path name: userID schema: type: string required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 responses: '200': description: Fetching User's Uploaded Physical Documents Was Successful. content: application/json: schema: $ref: '#/components/schemas/DocumentsArray' /users/{userID}/subscriptions: get: tags: - Subscriptions summary: List Subscriptions by User operationId: Subscriptions_listByUser security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Retrieves all User's Subscriptions by User parameters: - description: The User's unique identifier. in: path name: userID schema: type: string required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 responses: '200': description: Retrieving all User's Subscription was Successful. content: application/json: schema: $ref: '#/components/schemas/UserSubscriptions' /users/{userID}/recurring-deposits: get: tags: - Deposits summary: List Recurring Deposits by User operationId: Deposits_getUserRecurring security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetches all User's recurring deposit by userID. parameters: - description: The User's unique identifier. in: path name: userID schema: type: string required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 responses: '200': description: Fetching All User's Recurring Deposits was Successful. content: application/json: schema: $ref: '#/components/schemas/RecurringDepositsByUserID' /users/{userID}/funding/deposits: get: tags: - Deposits summary: List Deposits by User operationId: Deposits_listByUser security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetches a list of Deposits by userID. parameters: - description: The User's unique identifier. in: path name: userID schema: type: string required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 responses: '200': description: Fetching All User's Deposits was Successful. content: application/json: schema: $ref: '#/components/schemas/DepositsArray' /users/{userID}/funding/redemptions: get: tags: - Withdrawals summary: List Withdrawals by User operationId: Withdrawals_getUserRedemptions security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetches a list of all redemptions by the User's identifier. parameters: - description: The User's unique identifier. in: path name: userID schema: $ref: '#/components/schemas/userID' required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 responses: '200': description: Fetches A List Of All Redemptions by userID was Successful. content: application/json: schema: $ref: '#/components/schemas/Redemptions' /users/{userID}/managed/allocations: get: tags: - Trade Allocations summary: List Trade Allocations by Advisor operationId: TradeAllocations_listByAdvisor security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetches a list of an User's allocations. parameters: - description: The User's unique identifier. in: path name: userID schema: $ref: '#/components/schemas/userID' required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 responses: '200': description: Fetching A List Of A User's Allocation was Successful. content: application/json: schema: $ref: '#/components/schemas/Allocations' /users/{userID}/managed/orders/summary: get: tags: - Advisor Reports summary: List Orders by Advisor operationId: AdvisorReports_getUserOrdersSummary security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetches a User's sub account orders allocations summary by date. parameters: - description: The User's unique identifier. in: path name: userID schema: $ref: '#/components/schemas/userID' required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 - description: The specific request date in format YYYY-MM-DD. in: query name: date schema: type: string required: false example: '2022-12-25' responses: '200': description: >- Fetching A User's Sub Account Orders Allocations Summary By Date was Successful. content: application/json: schema: $ref: '#/components/schemas/OrdersAllocationSummary' /users/{userID}/managed/orders: get: tags: - Advisor Reports summary: List Allocations by Advisor operationId: AdvisorReports_listAllocationsByUserID security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetches a user's sub account orders allocations by userID parameters: - description: The User's unique identifier. in: path name: userID schema: $ref: '#/components/schemas/userID' required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 - description: The date and time in which to start from. in: query name: from schema: type: string required: true example: '2022-12-08T18:36:40.609Z' - description: The date and time in which to end at. in: query name: to schema: type: string required: true example: '2022-12-25T18:36:40.609Z' responses: '200': description: >- Fetching A user's Sub Account Orders Allocations By userID was Successful. content: application/json: schema: $ref: '#/components/schemas/ListOrdersAllocationsByUserID' /users/{userID}/managed/bod: get: tags: - Advisor Reports summary: Retrieve Beginning Of Day (BOD) by Advisor operationId: AdvisorReports_getBeginningOfDayHoldingsByUserId security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetches a list of sub accounts beginning of day holdings by userID parameters: - description: The User's unique identifier. in: path name: userID schema: $ref: '#/components/schemas/userID' required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 responses: '200': description: >- Fetching A List Of Sub Accounts Beginning Of Day Holding By userID was Successful. content: application/json: schema: $ref: '#/components/schemas/beginningOfDay' /users/{userID}/managed/funds: get: tags: - Funds summary: List Funds by Advisor operationId: Funds_listByAdvisor security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetches a list of funds by userID parameters: - description: The User's unique identifier. in: path name: userID schema: $ref: '#/components/schemas/userID' required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 responses: '200': description: Fetching A List of Funds By userID was Successful. content: application/json: schema: $ref: '#/components/schemas/FundsByUserID' /users/{userID}/managed/portfolio: get: tags: - Portfolios summary: List Portfolios by Advisor operationId: Portfolios_listByAdvisor security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetches a list of portfolios by userID parameters: - description: The User's unique identifier. in: path name: userID schema: $ref: '#/components/schemas/userID' required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 responses: '200': description: Fetching A List of Portfolios By userID was Successful. content: application/json: schema: $ref: '#/components/schemas/PortfoliosByUserID' /users/{userID}/managed/autopilot: get: tags: - AutoPilot summary: List AutoPilot Runs by Advisor operationId: AutoPilot_listByAdvisor security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] description: Fetches a list of autopilot runs by userID. parameters: - description: The User's unique identifier. in: path name: userID schema: $ref: '#/components/schemas/userID' required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 - description: The date and time in which to start from. in: query name: from schema: type: string required: false example: '2022-12-08T18:36:40.609Z' - description: The date and time in which to end at. in: query name: to schema: type: string required: false example: '2022-12-25T18:36:40.609Z' - in: query name: direction schema: type: string enum: - NEXT - PREVIOUS required: false example: NEXT - in: query name: offset schema: type: string required: false example: '2022-12-08T18:36:40.609Z' responses: '200': description: Fetching A List Of Autopilot Runs By userID was Successful. content: application/json: schema: $ref: '#/components/schemas/AutoPilotRunsByUserID' components: parameters: fromParams: description: The date to start the filter. in: query name: from schema: type: string required: false example: '2022-06-16' toParams: description: The date to end the filter. in: query name: to schema: type: string required: false example: '2022-07-16' schemas: version: description: Version of the disclosure type: string format: ^[0-9]{1,3}([.])[0-9]{1,3}([.])[0-9]{1,3}$ example: 1.1.0 AllocationRequest: type: object required: - userID - orders properties: userID: description: The unique identifier of the registered investment advisors account. type: string example: 66304da9-3h6f-2234-935f-ac6b7933d706 clientListID: $ref: '#/components/schemas/clientListID' note: $ref: '#/components/schemas/allocationNote' orders: description: >- An array of objects that hold the specific order and allocation details. type: array required: - orderID - allocations items: oneOf: - $ref: '#/components/schemas/order' AllocationResponse: type: object properties: id: description: >- The unique allocation identifier associated to a specific allocation. type: string example: JL.allocation.SomeRIACompany.9d6def3b-14d7-4934-8a64-57d443e67ce6 order: type: object properties: orderID: description: The orderID of a filled order being used in an allocation. type: string example: JL.562f3719-7c8f-50ee-b234-db7775715a99 allocations: description: >- An array that holds relevant information about how and where to distribute securities from a recent order. type: array required: - accountID - accountNo - qty - useClientFunds items: oneOf: - $ref: '#/components/schemas/allocation' allocation: type: object properties: accountID: description: >- The unique account identifier of the end user receiving an allocation. type: string example: cc07f91b-7ee1-4868-b8fc-823c70a1b932.1407775317759 accountNo: description: The account number of the end user receiving an allocation. type: string example: ZYXC000008 qty: description: The number of shares allocated to a users account. type: string example: '27' useClientFunds: description: True, if allocations should use client funds. type: boolean example: true comment: description: A note created by the RIA upon creating an allocation. type: string example: Suds boapi test to 1st allocationDetailObject: description: Contains details for a user associated with an allocation. type: object properties: accountID: description: >- The account identifier for an end user associated with an allocation. type: string example: 743a1018-e292-449c-a43f-58d657990db0.1671689261882 accountNo: description: The account number of an end user associated with an allocation. type: string example: ZYXC000008 status: description: The status of the allocation. type: string example: FILLED enum: - NEW - FILLED - REJECTED instrumentID: $ref: '#/components/schemas/instrumentID' symbol: $ref: '#/components/schemas/instrumentSymbol' side: $ref: '#/components/schemas/sideAbbreviated' clientComment: description: A note for the type of allocation happening. type: string example: Foo test allocation qtyRequested: description: Quantity of shares requested to allocate to a users account. type: number example: 10 qtyAllocated: description: Quantity of shares allocated to a users account. type: number example: 10 avgPx: description: The average price of the security being allocated. type: number example: 126.52 fees: $ref: '#/components/schemas/fees' fees: description: The fees associated with an allocation. type: object properties: total: description: The sum of all fees. type: number example: 0 sec: description: The Securities and Exchange Commission Fee. type: number example: 0 taf: description: The Trading Activity Fees. type: number example: 0 commission: description: The commissions for the allocation type: number example: 0 other: description: Any miscellaneous fees associated with the allocation. type: number example: 0 AllocationDetails: type: object properties: id: description: The unique allocationID associated with a specific allocation. type: string example: JL.allocation.SomeRIACompany.9d6def3b-14d7-4934-8a64-57d443e67ce6 status: description: Overall status of an allocation. type: string example: COMPLETE enum: - NEW - ACCEPTED - PART_COMPLETE - COMPLETE - REJECTED clientListID: $ref: '#/components/schemas/clientListID' accountID: description: The account identifier for the RIA master trading account. type: string example: 66304da9-3d6f-4253-935f-ac6b7933d701.1619201263789 accountNo: description: The account number for the RIA master trading account. type: string example: ZYXB000008 createdWhen: description: Date and time of allocation creation. type: string example: '2022-12-22T16:04:46.724Z' allocations: description: An array of allocation objects that hold details of the allocation. type: array items: oneOf: - $ref: '#/components/schemas/allocationDetailObject' comment: description: A note created by the RIA upon creating an allocation. type: string example: >- All allocated and accounted for. 1::1::0 client note[allocating via bo api 1st allocation test]. timeMs=423 ratePerSec=2.36 msPerItem=423.00 fundsRequest: type: object required: - userID - name - clientFundID - description - holdings - triggers properties: description: description: A short description for the fund. type: string example: Top 10 US Tech userID: description: The unique identifier of the registered investment advisors account. type: string example: 66304da9-3h6f-2234-935f-ac6b7933d706 name: description: A name given to the fund by the RIA. type: string example: TECH clientFundID: $ref: '#/components/schemas/clientListID' holdings: description: An array of objects that hold the type of securities in a fund. type: array items: $ref: '#/components/schemas/holdingsObject' triggers: description: >- An array of objects that hold information on when to trigger a rebalance in a fund. type: array items: $ref: '#/components/schemas/triggersObject' triggersObject: description: >- An object that holds the details of when to trigger a rebalance of the fund. type: object required: - type - child - maxAllowed - lowerBound - upperBound properties: type: description: The type of trigger specified to enable a rebalance. type: string example: TOTAL_DRIFT enum: - TOTAL_DRIFT - RELATIVE_DRIFT - ABSOLUTE_DRIFT maxAllowed: description: The maximum allowed drift for the Fund. type: number example: 0.05 child: type: string example: null lowerBound: description: The lowest bound range of the drift parameters. type: number example: 0.01 upperBound: description: The highest bound range of the drift parameter. type: number example: 0.02 fundsResponse: type: object properties: description: description: A short description for the fund. type: string example: Top 10 US Tech id: description: The unique identifier associated with the fund. type: string example: fund_3d7d00d1-f09e-4f86-9cbf-893c75cf77fe userID: $ref: '#/components/schemas/managedAccountsUserID' name: description: A name given to the fund by the RIA. type: string example: TECH type: type: string example: FUND clientFundID: $ref: '#/components/schemas/clientFundID' holdings: description: An array of objects that hold the type of securities in a fund. type: array items: $ref: '#/components/schemas/holdingsObject' triggers: description: >- An array of objects that hold information on when to trigger a rebalance. type: array items: $ref: '#/components/schemas/triggersObject' isInstrumentTargetsChanged: type: boolean example: false instrumentTargetsChanged: type: boolean example: false portfolioReq: type: object required: - userID - name - clientPortfolioID - description - holdings - triggers properties: description: description: A short description for the portfolio. type: string example: Mix of sectors userID: $ref: '#/components/schemas/managedAccountsUserID' name: description: A name given to the portfolio by the RIA. type: string example: Recession Proof clientPortfolioID: $ref: '#/components/schemas/clientPortfolioID' holdings: description: An array of objects that hold a list of funds in a portfolio. type: array items: $ref: '#/components/schemas/portfolioReqHoldings' triggers: description: >- An array of objects that hold a list if triggers associated with a portfolio. type: array items: $ref: '#/components/schemas/portfolioTriggers' portfolioRes: type: object properties: description: description: A short description for the portfolio. type: string example: A portifolio description id: description: The unique identifier associated with a portfolio. type: string example: portfolio_4a22340a-31f8-4f0e-b5ee-24ddfbc66727 name: description: A name given to the portfolio by the RIA. type: string example: Recession Proof clientPortfolioID: $ref: '#/components/schemas/clientPortfolioID' holdings: description: An array of objects that hold the type of Funds in the Portfolio. type: array items: $ref: '#/components/schemas/portfolioResHoldingsObject' userID: $ref: '#/components/schemas/managedAccountsUserID' triggers: description: >- An array of objects that hold information on when to trigger a rebalance in the portfolio. type: array items: $ref: '#/components/schemas/portfolioTriggers' isFundTargetsChanged: type: boolean example: false fundsTargetsChanged: type: boolean example: false portfolioReqHoldings: type: object required: - type - target properties: type: description: The type of asset in a portfolio. type: string example: FUND enum: - FUND - CASH_RESERVE id: description: |- The unique fundID. *⚠️ Not required if type is CASH_RESERVE. type: string example: fund_3d9d00d1-f06e-4f86-9cbf-893c75cf77fe target: description: The percentage of a fund within a portfolio. type: number example: 0.95 portfolioTriggers: description: >- An object that holds the details of when to trigger a rebalance of a portfolio. type: object required: - type - child - maxAllowed - lowerBound - upperBound properties: type: description: The type of trigger specified to enable a rebalance. type: string example: TOTAL_DRIFT enum: - TOTAL_DRIFT - RELATIVE_DRIFT - ABSOLUTE_DRIFT maxAllowed: description: The maximum allowed drift for the portfolio. type: number example: 0.05 child: type: string example: null lowerBound: description: The lowest bound range of the drift parameters. type: number example: 0.01 upperBound: description: The highest bound range of the drift parameter. type: number example: 0.02 portfolioResHoldingsObject: description: An array of objects that hold details of a fund in a portfolio. type: object properties: description: description: A short description for the fund. type: string example: Top 10 US Tech id: description: The unique fundID. type: string example: fund_3d9d00d1-f06e-4f86-9cbf-893c75cf77fe name: description: A name given to the fund by the RIA. type: string example: TECH type: description: The type of asset in the portfolio. type: string example: FUND enum: - FUND - CASH_RESERVE clientFundID: $ref: '#/components/schemas/clientFundID' target: description: The percentage of a fund within a portfolio. type: number example: 0.95 holdings: description: A list of the securities held in a fund. type: array items: $ref: '#/components/schemas/holdingsObject' triggers: description: The triggers associated with a Portfolio. type: array items: $ref: '#/components/schemas/triggersObject' autopilotReq: type: object required: - reviewOnly - forceRebalance properties: reviewOnly: description: True, if a review should occur without a forced rebalance. type: boolean example: true forceRebalance: description: True, if a forces rebalance should occur. type: boolean example: true subAccounts: description: A list of user's accountIDs to be rebalanced. type: array items: oneOf: - $ref: '#/components/schemas/accountID' autopilotRes: type: object properties: id: description: >- The unique re-balance run identifier `rebalanceRunID` associated with a specific re-balance. type: string example: ria_rebalance_ebf7e764-e2d6-4b3d-a333-b8ff05b92b89 created: description: A timestamp of when the re-balance run was created. type: string example: '2022-12-27T06:06:28.955Z' status: description: >- Status of the re-balance run. See [Autopilot Run Status](https://developer.drivewealth.com/reference/get-autopilot-run-status) for status values. type: string example: REBALANCE_NOT_STARTED riaID: $ref: '#/components/schemas/riaID' runStatusRes: type: object properties: id: description: >- The unique re-balance run identifier `rebalanceRunID` associated with a specific re-balance. type: string example: ria_rebalance_ebf7e764-e2d6-4b3d-a333-b8ff05b92b89 riaID: description: >- This is the parentIBID or userID of the registered investment advisor creating the re-balance run. type: string example: 66304da9-3h6f-2234-935f-ac6b7933d706 status: description: >- Status of the re-balance run. See [Autopilot Run Status](https://developer.drivewealth.com/reference/get-autopilot-run-status) for status values. type: string example: REBALANCE_NOT_STARTED updated: description: A timestamp of when the re-balance run was updated. type: string example: '2022-12-27T06:07:28.955Z' created: description: A timestamp of when the re-balance run was created. type: string example: '2022-12-27T06:06:28.955Z' moneyMovement: description: Was this run part of the regular AutoPilot money movement process? type: boolean example: true regularRebalance: description: Was this run part of the regular AutoPilot rebalancing process? type: boolean example: true reviewOnly: type: boolean example: true orders: description: >- An object containing the details of submitted orders for the re-balance. type: object properties: total: description: Total number of orders submitted. type: number example: 0 submitted: description: >- Amazon S3 download containing the details of each submitted order. type: string example: https://uat.drivewealth.autopilot.s3.amazonaws.com/44304da9.... outcome: description: >- Amazon S3 download containing the status and final outcome of the orders that were submitted. type: string example: https://uat.drivewealth.autopilot.s3.... amountBuys: description: An aggregate value of all buy orders. Expect a negative number. type: number example: -1059.35 amountSells: description: An aggregate value of all sell orders. type: number example: 862.69 cleanedUp: type: string example: null allocations: description: An object containing the details of the allocations in a re-balance. type: object properties: submitted: description: >- Amazon S3 download containing the details of each submitted allocation. type: string example: https://uat.drivewealth.autopilot.s3.... outcome: description: >- Amazon S3 download containing the status and final outcome of each allocation that was submitted. type: string example: https://uat.drivewealth.autopilot.s3.... subAccounts: description: An object containing details on user accounts and their holdings. type: object properties: total: description: The total number of user accounts under the advisor. type: number example: 4 rebalanced: description: The total number of user accounts that were rebalanced. type: number example: 3 error: description: >- The total number of allocation errors at the users account level during the rebalance. type: number example: 0 outcome: description: >- Amazon S3 download containing the final outcome of the rebalance, includes users account details and their holdings. type: string example: https://uat.drivewealth.autopilot.s3.... clientListID: description: An advisor created identifier for a specific allocation. type: string example: SUMS_CUSTOM_ALLOCATION_TEST allocationNote: description: A note for the type of allocation happening. type: string example: Allocating via api allocation test instrumentID: description: 'A unique ID created by DriveWealth to identify a specific instrument. ' type: string format: uuid example: 3fb1e8a9-f7d5-4d90-95e2-43e7326b5636 instrumentSymbol: description: >- The ticker symbol of the Instrument. Debt Instruments and Global Mutual Funds do not have symbols and are referred to buy their `instrumentID` or `ISIN`. type: string nullable: true example: MS sideAbbreviated: description: The side of the order. type: string example: B enum: - B - S - BUY_OPEN - BUY_CLOSE - SELL_OPEN - SELL_CLOSE holdingsObject: description: An object in the holdings array that holds the instrumentID and target. type: object properties: instrumentID: description: >- A unique ID created by DriveWealth to identify a specific instrument. type: string example: 5b85fabb-d57c-44e6-a7f6-a3efc760226c target: description: The target percentage for the specific instrumentID within a fund. type: number example: 0.5 managedAccountsUserID: description: The unique identifier of the registered investment advisors account. type: string example: 66304da9-3h6f-2234-935f-ac6b7933d706 clientFundID: description: A user defined identifier attached to the fund. type: string example: AAABBB-1222-3344.123456789 clientPortfolioID: description: A user defined identifier attached to the portfolio. type: string example: AAABBB-1222-3344.123456789 accountID: description: The user's unique account identifier. type: string example: cc07f91b-7ee1-4868-b8fc-823c70a1b932.1407775317759 riaID: description: >- This is the parentIBID or userID of the registered investment advisor creating the re-balance run. type: string example: 66304da9-3h6f-2234-935f-ac6b7933d706 AccountReq: type: object required: - userID - accountType - accountManagementType - tradingType properties: userID: $ref: '#/components/schemas/userID' accountType: $ref: '#/components/schemas/accountType' accountManagementType: $ref: '#/components/schemas/accountManagementType' tradingType: $ref: '#/components/schemas/tradingType' finra3210ComplianceEntity: $ref: '#/components/schemas/finra3210ComplianceEntity' riaUserID: $ref: '#/components/schemas/riaID' riaProductID: description: RIA product identifier (legacy) type: string example: '' riaPortfolioID: description: >- A unique ID associated with an RIA managed portfolio. If set, a portfolio will be assigned to this account for automatic rebalancing. $ref: '#/components/schemas/portfolioID' authorizedUsers: type: array items: oneOf: - $ref: '#/components/schemas/authorizedUser' ignoreBuyingPower: description: If true, the accounts cash balance can go negative. type: boolean example: false violationsExempt: description: Instruct the GFV/PDT system to not process for this account. type: boolean example: false ignoreMarketHoursForTest: description: >- If set to `true` trades will execute in DriveWealth's UAT environment after market hours. If you are attempting to test Mutual Fund orders this flag needs to be set to `false`. type: boolean example: true extendedHoursEnrolled: description: >- 'true or 'false' if the account is enrolled in and able to access Extended Hours Trading type: boolean example: false metadata: description: >- The metadata object allows for creating a maximum of 5 keys (max 36 characters) and each value cannot exceed more than 128 bytes. type: object example: myCustomKey: myCustomValue leverage: $ref: '#/components/schemas/leverage' accountFeatures: $ref: '#/components/schemas/accountFeatures' AccountRes: type: object properties: id: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' accountType: type: object properties: description: description: A description of the type of account. type: string example: Live Account name: description: The type of account. type: string example: LIVE accountMgmtType: $ref: '#/components/schemas/accountManagementTypeObject' status: type: object properties: description: description: A description of the account status. type: string example: Open name: $ref: '#/components/schemas/accountStatus' tradingType: type: object properties: description: description: A custom description about the type of account. type: string example: Cash Account name: description: The type of trading ocurring in the account. type: string example: CASH enum: - CASH - MARGIN - CRYPTO leverage: $ref: '#/components/schemas/leverage' nickname: $ref: '#/components/schemas/accountNickname' parentIB: $ref: '#/components/schemas/parentIBIDObject' taxProfile: $ref: '#/components/schemas/taxProfileObject' commissionID: $ref: '#/components/schemas/commissionID' beneficiaries: $ref: '#/components/schemas/beneficiariesOption' userID: description: >- The userID associated with the account. This will be the userID of your customer. $ref: '#/components/schemas/userID' restricted: $ref: '#/components/schemas/restricted' goodFaithViolations: $ref: '#/components/schemas/goodFaithViolations' patternDayTrades: $ref: '#/components/schemas/patternDayTrades' freeTradeBalance: $ref: '#/components/schemas/freeTradeBalance' gfvPdtExempt: $ref: '#/components/schemas/gfvPdtExempt' buyingPowerOverride: $ref: '#/components/schemas/buyingPowerOverride' bod: $ref: '#/components/schemas/bod' ria: $ref: '#/components/schemas/riaObject' sweepInd: $ref: '#/components/schemas/sweepInd' interestFree: $ref: '#/components/schemas/interestFree' openedWhen: $ref: '#/components/schemas/openedWhen' ignoreMarketHoursForTest: $ref: '#/components/schemas/ignoreMarketHoursForTest' flaggedForACATS: $ref: '#/components/schemas/flaggedForACATS' accountFeatures: $ref: '#/components/schemas/accountFeatures' AccountDetailRes: type: object properties: account: type: object properties: id: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' accountType: type: object properties: description: description: A description of the type of account. type: string example: Live Account name: description: The type of account. type: string example: LIVE accountMgmtType: $ref: '#/components/schemas/accountManagementTypeObject' finra3210ComplianceEntity: $ref: '#/components/schemas/finra3210ComplianceEntity' status: type: object properties: description: description: A description of the account status. type: string example: Open name: $ref: '#/components/schemas/accountStatus' tradingType: type: object properties: description: description: A custom description about the type of account. type: string example: Cash Account name: description: The type of trading ocurring in the account. type: string example: CASH enum: - CASH - MARGIN - CRYPTO leverage: $ref: '#/components/schemas/leverage' nickname: $ref: '#/components/schemas/accountNickname' parentIB: $ref: '#/components/schemas/parentIBIDObject' taxProfile: $ref: '#/components/schemas/taxProfileObject' commissionID: $ref: '#/components/schemas/commissionID' beneficiaries: $ref: '#/components/schemas/beneficiariesOption' userID: description: >- The userID associated with the account. This will be the userID of your customer. $ref: '#/components/schemas/userID' restricted: description: True, when the account cannot trade on unsettled funds. $ref: '#/components/schemas/restricted' deprecated: true gfvRestricted: $ref: '#/components/schemas/gfvRestricted' goodFaithViolations: $ref: '#/components/schemas/goodFaithViolations' pdtRestricted: $ref: '#/components/schemas/pdtRestricted' patternDayTrader: $ref: '#/components/schemas/patternDayTrader' patternDayTrades: $ref: '#/components/schemas/patternDayTrades' freeTradeBalance: $ref: '#/components/schemas/freeTradeBalance' gfvPdtExempt: $ref: '#/components/schemas/gfvPdtExempt' buyingPowerOverride: $ref: '#/components/schemas/buyingPowerOverride' bod: $ref: '#/components/schemas/bod' ria: $ref: '#/components/schemas/riaObject' sweepInd: $ref: '#/components/schemas/sweepInd' interestFree: $ref: '#/components/schemas/interestFree' accountFeatures: $ref: '#/components/schemas/accountFeatures' createdWhen: description: A timestamp of when the account was created. type: string example: '2022-12-22T06:07:41.773Z' openedWhen: $ref: '#/components/schemas/openedWhen' updatedWhen: description: A timestamp of when the account was last updated. type: string example: '2022-12-22T16:04:47.140Z' ignoreMarketHoursForTest: $ref: '#/components/schemas/ignoreMarketHoursForTest' flaggedForACATS: $ref: '#/components/schemas/flaggedForACATS' extendedHoursEnrolled: description: Is the account enrolled in extended hours trading? type: boolean example: false AccountDetailResMinorTransfer: type: object properties: account: type: object properties: id: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' accountType: type: object properties: description: description: A description of the type of account. type: string example: Live Account name: description: The type of account. type: string example: LIVE finra3210ComplianceEntity: $ref: '#/components/schemas/finra3210ComplianceEntity' accountMgmtType: $ref: '#/components/schemas/accountManagementTypeObject' status: type: object properties: description: description: A description of the account status. type: string example: Open name: $ref: '#/components/schemas/accountStatus' tradingType: type: object properties: description: description: A custom description about the type of account. type: string example: Cash Account name: description: The type of trading ocurring in the account. type: string example: CASH enum: - CASH - MARGIN - CRYPTO leverage: $ref: '#/components/schemas/leverage' nickname: $ref: '#/components/schemas/accountNickname' parentIB: $ref: '#/components/schemas/parentIBIDObject' taxProfile: $ref: '#/components/schemas/taxProfileObject' commissionID: $ref: '#/components/schemas/commissionID' beneficiaries: $ref: '#/components/schemas/beneficiariesOption' userID: description: >- The userID associated with the account. This will be the userID of your customer. $ref: '#/components/schemas/userID' restricted: $ref: '#/components/schemas/restricted' goodFaithViolations: $ref: '#/components/schemas/goodFaithViolations' patternDayTrades: $ref: '#/components/schemas/patternDayTrades' freeTradeBalance: $ref: '#/components/schemas/freeTradeBalance' gfvPdtExempt: $ref: '#/components/schemas/gfvPdtExempt' buyingPowerOverride: $ref: '#/components/schemas/buyingPowerOverride' bod: $ref: '#/components/schemas/bod' ria: $ref: '#/components/schemas/riaObject' sweepInd: $ref: '#/components/schemas/sweepInd' interestFree: $ref: '#/components/schemas/interestFree' authorizedUsers: type: array items: oneOf: - $ref: '#/components/schemas/authorizedUser' createdWhen: description: A timestamp of when the account was created. type: string example: '2022-12-22T06:07:41.773Z' openedWhen: $ref: '#/components/schemas/openedWhen' updatedWhen: description: A timestamp of when the account was last updated. type: string example: '2022-12-22T16:04:47.140Z' ignoreMarketHoursForTest: $ref: '#/components/schemas/ignoreMarketHoursForTest' flaggedForACATS: $ref: '#/components/schemas/flaggedForACATS' extendedHoursEnrolled: description: Is the account enrolled in extended hours trading? type: boolean example: false UpdateAcctReq: type: object properties: leverage: $ref: '#/components/schemas/leverage' nickname: $ref: '#/components/schemas/accountNickname' status: $ref: '#/components/schemas/accountStatus' statusComment: description: >- A reason for updating the account status, not required when editing other attributes. type: string example: Closing the Account. closingReason: description: >- Pass only when closing an account, ACAT and LEGAL_AML are for DriveWealth internal use only, an account closed due to either of those reasons can only be re-opened by DriveWealth. type: string example: DECEASED enum: - ACAT - LEGAL_AML - DUP_ACCOUNT - DECEASED - OTHER restricted: $ref: '#/components/schemas/restricted' ignoreMarketHoursForTest: $ref: '#/components/schemas/ignoreMarketHoursForTest' accountFeatures: $ref: '#/components/schemas/accountFeatures' authorizedUsers: type: array items: oneOf: - $ref: '#/components/schemas/authorizedUser' finra3210ComplianceEntity: $ref: '#/components/schemas/finra3210ComplianceEntity' CommissionsRes: type: array items: $ref: '#/components/schemas/CommissionObject' CommissionObject: type: object properties: description: description: A short description about the commission. type: string example: Free active: description: Commission group status. type: boolean example: true commissionID: $ref: '#/components/schemas/commissionID' assignmentCriteria: $ref: '#/components/schemas/assignmentCriteria' rates: description: This object contains the details of the commission rates. type: object properties: fractional: description: >- Object provides commission rates on order quantities between 0.0001 and 0.9999 (aka fractional shares). type: object properties: schema: $ref: '#/components/schemas/ratesObject' default: description: Object provided commission rates on full share order quantities. type: object properties: schema: $ref: '#/components/schemas/ratesObject' BeneficiaryReq: type: object properties: primary: description: An array of objects containing the primary beneficiary details type: array items: oneOf: - $ref: '#/components/schemas/beneficiariesObject' contingent: description: An array of objects containing the contingent beneficiary details. type: array items: oneOf: - $ref: '#/components/schemas/beneficiariesObject' BeneficiaryRes: type: object properties: primary: description: An array of objects containing the primary beneficiary details type: array items: oneOf: - $ref: '#/components/schemas/beneficiariesObject' contingent: description: An array of objects containing the contingent beneficiary details. type: array items: oneOf: - $ref: '#/components/schemas/beneficiariesObject' VirtualAccountRes: type: object properties: id: $ref: '#/components/schemas/bankAccountID' accountID: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' wireDetails: $ref: '#/components/schemas/wireDetails' achDetails: $ref: '#/components/schemas/achDetails' wireDomesticDetails: $ref: '#/components/schemas/wireDomesticDetails' PortfolioStatusRes: type: object properties: id: $ref: '#/components/schemas/portfolioID' equity: description: The account value of the customers account. type: number example: 11003.76 totalDrift: description: Total drift away from target. type: number example: 0.012 rebalanceRequired: description: >- A flag that determines if a re-balance is required based on total drift. type: boolean example: true nextPortfolioRebalance: description: The date of the next portfolio re-balance. type: string example: '2018-12-11T15:00:00.846Z' lastPortfolioRebalance: description: The date of the last portfolio rebalance. type: string example: '2017-12-11T15:00:00.846Z' holdings: type: array items: oneOf: - $ref: '#/components/schemas/portfolioHoldings' MoneyDetailsRes: type: object properties: accountID: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' tradingType: $ref: '#/components/schemas/tradingType' updated: description: Timestamp of the last time the deposit was updated. type: string example: '2021-04-23T18:41:32.440Z' cash: type: object properties: cashAvailableForTrade: description: >- An accounts buying power, this figure dictates the total amount of money that can be used for purchases. Will be reduced by pending orders. type: number example: 0 cashAvailableForWithdrawal: description: >- An accounts withdrawal balance, this property only contains settled funds, and money that has already seasoned. type: number example: 0 cashBalance: description: >- An accounts total cash balance, including both settled and un-settled money. type: number example: -12043.23 noBuyingPowerReason: description: Reasons for no buying power. type: array items: {} cashSettlement: description: >- An array of objects containing the time of when money settles as a result of a sale. type: array items: oneOf: - $ref: '#/components/schemas/cashSettlementTime' pendingPaymentsAmount: description: >- The total amount of money that is pending due to a recent deposit(s) type: number example: 0 payments: type: object properties: buyingPower: type: object properties: pendingDepositsAmountAvailable: description: >- The current buying power of an account based on recent deposit requests. type: number example: 20802.71 pendingDepositsAmountNotAvailable: description: Recent deposits that are not included in buying power. type: number example: 0 redemptions: type: object properties: amountWithheldFromRedemptions: description: >- Total dollar amount not included in `cashAvailableForWithdrawal` due to seasoning period on deposit type: number example: 60 StatementListRes: description: An array that holds the reference details to an accounts statements. type: array items: oneOf: - $ref: '#/components/schemas/statementObj' ListTaxDocsRes: description: An array that holds the reference details to an accounts tax documents. type: array items: oneOf: - $ref: '#/components/schemas/taxStatementObj' ListTradeConfirmsRes: description: >- An array that holds the reference details to an accounts trade confirmations. type: array items: oneOf: - $ref: '#/components/schemas/tradeConfirmObj' SummaryRes: type: object properties: accountSummary: type: object properties: accountID: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' tradingType: $ref: '#/components/schemas/tradingType' lastUpdated: description: Time of last update. type: string example: '2017-06-16T15:35:30.617Z' cash: $ref: '#/components/schemas/MoneyDetailsRes/properties/cash' margin: $ref: '#/components/schemas/marginObj' equity: type: object properties: equityValue: $ref: '#/components/schemas/equityValue' equityPositions: type: array items: oneOf: - $ref: '#/components/schemas/equityPositionsObj' orders: description: An array of pending orders. type: array items: oneOf: - $ref: '#/components/schemas/ordersObj' transactions: description: An array of account transactions type: array items: oneOf: - $ref: '#/components/schemas/transactionSumObj' PerformanceRes: type: object properties: accountID: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' startDate: description: >- Start date and time of requested time frame of the accounts performance. type: string example: '2017-09-18' endDate: description: >- End date and time of requested time frame of the accounts performance. type: string example: '2018-09-18' lastUpdated: description: Date and time of last performance update. type: string example: '2017-06-16T15:35:30.617Z' performance: description: Array of performance objects. type: array items: oneOf: - $ref: '#/components/schemas/performanceObj' PositionsRes: type: object properties: accountID: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' tradingType: $ref: '#/components/schemas/tradingType' updated: description: Time of last update. type: string example: '2017-06-16T15:35:30.617Z' equityValue: $ref: '#/components/schemas/equityValue' optionsValue: $ref: '#/components/schemas/optionsValue' debtValue: $ref: '#/components/schemas/debtValue' positionsValue: $ref: '#/components/schemas/positionsValue' equityPositions: description: An array of the positions in the account. type: array items: $ref: '#/components/schemas/equityPositionsObj' optionsPositions: description: An array of the options positions in the account. type: array items: $ref: '#/components/schemas/optionsPositionsObj' mutualFundsPositions: description: An array of the mutual funds positions in the account. type: array items: $ref: '#/components/schemas/mutualFundsPositionsObj' debtPositions: description: An array of the debt positions in the account. type: array items: $ref: '#/components/schemas/debtPositionsObj' ViolationListRes: type: object properties: accountID: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' tradingType: $ref: '#/components/schemas/tradingType' updated: description: Time of last update. type: string example: '2017-06-16T15:35:30.617Z' violations: $ref: '#/components/schemas/violationsObj' ViolationDetailsRes: type: object properties: goodFaithViolations: $ref: '#/components/schemas/properties-goodFaithViolations' patternDayTrades: description: An array of pattern day trade violations. type: array items: oneOf: - $ref: '#/components/schemas/patternDayTradesObj' accountEquityBreakdown: $ref: '#/components/schemas/accountEquityBreakdownObj' MarginRes: type: object properties: accountID: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' tradingType: $ref: '#/components/schemas/tradingType' updated: description: Time of last update. type: string example: '2017-06-16T15:35:30.617Z' margin: $ref: '#/components/schemas/marginObj' OrderHistoryRes: type: object properties: accountID: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' tradingType: $ref: '#/components/schemas/tradingType' updated: description: Time of last update. type: string example: '2017-06-16T15:35:30.617Z' orders: description: An array that holds a list of completed orders. type: array items: oneOf: - type: object properties: orderID: $ref: '#/components/schemas/orderID' orderNo: $ref: '#/components/schemas/orderNo' createdWhen: $ref: '#/components/schemas/created' symbol: $ref: '#/components/schemas/instrumentSymbol' cumQty: $ref: '#/components/schemas/orderCumulativeQuantity' orderStatus: $ref: '#/components/schemas/orderStatusNumber' orderType: $ref: '#/components/schemas/orderTypes' orderQty: $ref: '#/components/schemas/orderQuantity' isoTimeRestingOrderExpires: description: The time when the limit order expires. type: string example: null limitPrice: description: The price set for the limit order. type: number example: null side: $ref: '#/components/schemas/sideAbbreviated' mitTriggerPrice: description: Market If Touched trigger price. For MIT orders. type: number example: 0 triggered: description: The trigger price for limit orders. type: number example: 0 averagePriceRaw: description: The average price of purchase for the order. type: number example: 147.45 orderCashAmt: description: >- The amount of cash requested for an order (notional orders only). type: number example: null stopPrice: description: The stop price of a limit order. type: number example: 200 ISIN: $ref: '#/components/schemas/instrumentISIN' finra3210ComplianceEntity: description: The regulatory system that the account will be reported to. type: string example: COMPLYSCI enum: - '' - COMPLYSCI - MCO TransactionSummaryRes: type: object properties: accountID: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' tradingType: $ref: '#/components/schemas/tradingType' updated: description: Time of last update. type: string example: '2017-06-16T15:35:30.617Z' transactions: description: An Array of transactions. type: array items: oneOf: - $ref: '#/components/schemas/transactionObj' AccountPositionLots: type: object properties: accountID: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' positions: type: array items: oneOf: - $ref: '#/components/schemas/PositionLots' PositionLots: type: object properties: instrumentID: $ref: '#/components/schemas/instrumentID' symbol: $ref: '#/components/schemas/instrumentSymbol' currency: $ref: '#/components/schemas/currency' costBasis: description: The cost basis of the position. type: number example: 19 quantity: description: The total amount of securities held in this position. type: number example: 0.16707001 currentMarketPrice: description: The current market price of the instrument. type: number example: 90.16 currentMarketValue: description: The average price of the the total position. type: number example: 15.06 unrealizedPnL: description: The unrealized profit/loss of the position. type: number example: -3.94 effectiveCostPerShare: description: The effective cost per share of the position. type: number example: 1.09 taxLots: type: array items: oneOf: - $ref: '#/components/schemas/PositionLegs' PositionLegs: type: object properties: id: $ref: '#/components/schemas/taxLotID' created: description: The timestamp when the position was created. type: string example: '2017-06-16T15:35:30.617Z' initialQuantity: description: The initial quantity of shares for position leg. type: number example: 0.17583963 openQuantity: description: >- The total amount of shares that are currently held in this position leg. type: number example: 10.1 effectiveCostPerShare: description: The effective cost per share of the position leg. type: number example: 113.74 side: $ref: '#/components/schemas/sideAbbreviated' comment: $ref: '#/components/schemas/note' OptPosition: type: object properties: accountID: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' costBasis: description: The cost basis of the position. type: number example: 975.98 effectivePx: description: The effective price of the position. type: number example: 975.98 instrumentID: $ref: '#/components/schemas/instrumentID' side: $ref: '#/components/schemas/sideAbbreviated' openQty: description: The quantity of shares owned by the account. type: number example: 10 comment: description: A comment describing the position type: string example: TOP OptPositionRes: type: object properties: data: description: An array of the options positions in the account. type: array items: oneOf: - $ref: '#/components/schemas/OptPosition' nextPageOffset: description: The next page offset. type: string example: >- 86572e14-84ae-4f0c-9533-3c9432637f8e.1627500314555#65d1aee9-9a6c-4720-9879-71c4fcf43060.2023-12-07T21:17:45.743Z prevPageOffset: description: The previous page offset. type: string example: >- 86572e14-84ae-4f0c-9533-3c9432637f8e.1627500314555#65d1aee9-9a6c-4720-9879-71c4fcf43060.2023-12-07T21:17:45.743Z userID: description: A unique identifier created for each User on DriveWealth's platform. type: string example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 accountType: description: The type of account that has been created. type: string example: LIVE enum: - LIVE accountManagementType: description: The type of account who has trading authority. type: string example: SELF enum: - SELF - ADVISORY - MANAGED - RIA_MANAGED - CUSTODIAL - CUSTODIAL_MANAGED - RESERVED tradingType: description: The type of trading the account will participate in. type: string example: CASH enum: - CASH - MARGIN portfolioID: description: The unique identifier of a portfolio. type: string example: portfolio_87fec25f-c350-4a53-83a0-fc6be0c2989e permissions: type: string example: MINOR_GRADUATION_TRANSFER enum: - ORDERS_CREATE - MINOR_GRADUATION_TRANSFER authorizedUser: type: object properties: userID: $ref: '#/components/schemas/userID' permissions: description: Permission assigned to the authorized user. type: array example: - ORDERS_CREATE - MINOR_GRADUATION_TRANSFER items: oneOf: - $ref: '#/components/schemas/permissions' leverage: description: The amount of leverage an account is allowed to trade with. type: number example: 1 options: type: object properties: enrolled: description: User requested option trading be allowed for their account type: boolean example: true optionsLevel: description: The level of options trading the customer requested type: string example: LEVEL_1 enum: - LEVEL_1 - LEVEL_2 - LEVEL_3 - LEVEL_4 mutualFunds: type: object properties: dividendReinvestment: description: True, if dividends are reinvested. type: boolean example: true dividendReinvestmentOptInWhen: description: The timestamp when the account has opted for dividend reinvestment. type: string example: '2022-12-11T22:28:21.810Z' readOnly: true dividendReinvestmentOptOutWhen: description: >- The timestamp when the account has opted out of dividend reinvestment. type: string example: '2022-12-11T22:28:21.810Z' readOnly: true capitalGainsReinvestment: description: True, if capital gains are reinvested. type: boolean example: true capitalGainsReinvestmentOptInWhen: description: >- The timestamp when the account has opted for capital gains reinvestment. type: string example: '2022-12-11T22:28:21.810Z' readOnly: true capitalGainsReinvestmentOptOutWhen: description: >- The timestamp when the account has opted out of capital gains reinvestment type: string example: '2022-12-11T22:28:21.810Z' readOnly: true AccountFeatureFixedIncome: description: Account features related to Fixed Income type: object properties: enrolled: description: >- Indicates if this account is enrolled for trading fixed income assets type: boolean default: false example: true accountFeatures: type: object properties: options: $ref: '#/components/schemas/options' mutualFunds: $ref: '#/components/schemas/mutualFunds' fixedIncome: $ref: '#/components/schemas/AccountFeatureFixedIncome' accountNo: description: The user's unique account number, that is human readable. type: string example: DWBG000052 accountManagementTypeObject: type: object properties: description: description: A custom description of the account management type. type: string example: Self Directed Account name: description: The type of account who has trading authority. type: string example: SELF enum: - SELF - ADVISORY - RIA_MANAGED - CUSTODIAL - CUSTODIAL_MANAGED - RESERVED - RETIREMENT_TRADITIONAL_SELF - RETIREMENT_TRADITIONAL_ADVISORY - RETIREMENT_TRADITIONAL_RIA_MANAGED - RETIREMENT_ROTH_SELF - RETIREMENT_ROTH_ADVISORY - RETIREMENT_ROTH_RIA_MANAGED - TRUST_SELF - TRUST_ADVISORY - TRUST_RIA_MANAGED accountStatus: description: The current status of the user's account. type: string example: OPEN enum: - PENDING - OPEN - OPEN_NO_NEW_TRADES - FROZEN - CLOSED accountNickname: description: 'A description or nickname for an account. ' type: string example: Steve's Robo Advisor Managed Account parentIBIDObject: type: object properties: id: description: The unique identifier of an associated organization. type: string example: 80f9b672-120d-4b73-9cc9-42fb3262c4b9 name: description: The organization name. type: string example: Tendies Trading Company taxProfileObject: type: object properties: taxStatusCode: description: The tax code of the accounts associated user. type: string example: W-9 taxRecipientCode: description: The type of tax filing of the accounts associated user. type: string example: INDIVIDUAL commissionID: description: >- The unique identifier associated with a specific commission related to the account. type: string example: b3e985dd-9679-63dc-5dd5-9bd7982efecd beneficiariesOption: description: True if the account has associated beneficiaries. type: boolean example: false restricted: description: If true, the account cannot trade on unsettled funds. type: boolean example: false goodFaithViolations: description: The total number of good faith violations. type: number example: 0 patternDayTrades: description: The total number of pattern day trades. type: number example: 0 freeTradeBalance: description: The total number of free trades left for the account. type: number example: 0 gfvPdtExempt: description: True if the account exempt from trading violations. type: boolean example: false buyingPowerOverride: description: >- True if the account is required to have sufficient buying power to enter a trade. type: boolean example: false bod: description: Beginning of day balances in the account. type: object properties: moneyMarket: description: Beginning of day money market value. type: number example: 0 equityValue: description: Beginning of day equity value. type: number example: 0 cashAvailableForWithdrawal: description: Total amount of settled funds that can be withdrawn. type: number example: 0 cashAvailableForTrading: description: Total amount of settled funds that can be traded. type: number example: 0 cashBalance: description: The current account cash balance. type: number example: 0 productID: description: The unique identifier associated with an RIA managed product. type: string example: product_b94c0b6a-5ac8-43e4-95d1-777051c0503b riaObject: type: object properties: advisorID: $ref: '#/components/schemas/riaID' productID: $ref: '#/components/schemas/productID' sweepInd: description: Are the funds swept into a money market account? type: boolean example: true interestFree: description: Is the interest generated from money market deposited back into account? type: boolean example: false openedWhen: description: A timestamp of when the account was opened. type: string example: '2022-12-22T06:07:41Z' ignoreMarketHoursForTest: description: Can the account ignore market hours in the UAT environment? type: boolean example: false flaggedForACATS: description: >- True if the account is flagged for an Automated Customer Account Transfer (ACATS). type: boolean example: false gfvRestricted: description: True, when the account cannot trade on unsettled funds. type: boolean example: false pdtRestricted: description: True, when the account is PDT restricted, and can only sell. type: boolean example: false patternDayTrader: description: True, when the account is designated as a Pattern Day Trader. type: boolean example: false wlpID: description: >- The wlpID is a deep backoffice ID that identifies each partner from each other. type: string example: TTC assignmentCriteria: type: object properties: wplID: $ref: '#/components/schemas/wlpID' countries: description: Clients from this country will be assigned this commission. type: string example: USA defaultStatus: description: The default commission to be applied if no other criteria matches. type: boolean example: true accountMgmtType: description: NEEDS DESCRIPTION type: string example: null ratesObject: type: object properties: rate: description: Commission rate in USD. type: number example: 1.49 passThroughFees: description: If true, SEC and TAF fees are passed through to the client. type: boolean example: true shareAmountRounding: description: >- Share amount rounding method. Options:`FLOOR` - Share quantity rounded down `CEIL` - Share quantity rounded up `NEAREST` - Share quantity rounded to nearest integer. type: string example: CEIL enum: - FLOOR - CEIL - NEAREST minimumRate: description: Minimum commission rate. type: number example: 1.49 name: description: Full name or entity name of type. type: string example: Tom Ace beneficiariesObject: description: An object containing the information of a beneficiary. type: object properties: type: description: Type of beneficiary. type: string example: ENTITY enum: - PERSON - ENTITY name: $ref: '#/components/schemas/name' percentage: description: >- Percentage ownership beneficiary has in the account. Must total 1 (aka 100%) across all beneficiaries. type: number example: 0.25 email: description: The email of the entity. type: string example: tom@ac.com formationDate: description: >- Entity formation date. Must follow the YYYY-MM-DD format. Only required if type: `ENTITY`. type: string example: '2010-10-25' primaryContact: description: 'Primary phone contact of entity. Only required if type: `ENTITY`' type: string example: '5512478089' phone: description: Phone number of beneficiary. type: string example: '4153647890' created: description: The when the beneficiary was added to the account. type: string example: '2022-12-29T18:32:15.533Z' bankAccountID: description: >- The unique DriveWealth identifier that identifies each linked bank account. type: string example: bank_a4656e60-321e-425b-aa0d-a2e75c38885f bankAccountNumber: description: The account number of the user's external bank account. type: string example: '7442393174' bankName: description: The name of the user's bank. type: string example: JP Morgan Chase beneficiaryBankAddress: description: The user's external bank street address. type: string example: 222 BROADWAY beneficiaryBankCity: description: The user's external bank city. type: string example: New York City beneficiaryBankProvince: description: The user's external bank state or province. type: string example: New York beneficiaryBankZip: description: The user's external bank postal code. type: string example: '10038' beneficiaryBankCountry: description: The user's external bank country. type: string example: USA wireDetails: type: object properties: bankAccountNumber: $ref: '#/components/schemas/bankAccountNumber' bankName: $ref: '#/components/schemas/bankName' bankSwiftCode: description: Bank accounts swift code. type: string example: CHASUS33 bankAddress: type: object properties: addressLine1: $ref: '#/components/schemas/beneficiaryBankAddress' city: $ref: '#/components/schemas/beneficiaryBankCity' stateProvince: $ref: '#/components/schemas/beneficiaryBankProvince' zipPostalCode: $ref: '#/components/schemas/beneficiaryBankZip' country: $ref: '#/components/schemas/beneficiaryBankCountry' beneficiaryName: $ref: '#/components/schemas/name' beneficiaryAddress: type: object properties: addressLine1: $ref: '#/components/schemas/beneficiaryBankAddress' city: $ref: '#/components/schemas/beneficiaryBankCity' stateProvince: $ref: '#/components/schemas/beneficiaryBankProvince' zipPostalCode: $ref: '#/components/schemas/beneficiaryBankZip' country: $ref: '#/components/schemas/beneficiaryBankCountry' virtualAccountID: description: A unique DriveWealth virtual account identifier. type: string example: bfa2e... paymentType: description: The type of payment. type: string example: WIRE enum: - WIRE - ACH bankRoutingNumber: description: The routing number of the user's external bank. type: string example: '110000000' bankAddress: type: object properties: addressLine1: $ref: '#/components/schemas/beneficiaryBankAddress' city: $ref: '#/components/schemas/beneficiaryBankCity' stateProvince: $ref: '#/components/schemas/beneficiaryBankProvince' zipPostalCode: $ref: '#/components/schemas/beneficiaryBankZip' country: $ref: '#/components/schemas/beneficiaryBankCountry' achDetails: type: object properties: bankAccountNumber: $ref: '#/components/schemas/bankAccountNumber' bankRoutingNumber: $ref: '#/components/schemas/bankRoutingNumber' bankName: $ref: '#/components/schemas/bankName' bankAddress: $ref: '#/components/schemas/bankAddress' bankRoutingNumberType: description: The type of routing being used. type: string example: aba enum: - ABA - ACH beneficiaryName: $ref: '#/components/schemas/name' beneficiaryAddress: $ref: '#/components/schemas/bankAddress' virtualAccountID: description: A unique DriveWealth virtual account identifier. type: string example: bfa2e... paymentType: description: The type of payment. type: string example: ACH enum: - WIRE - ACH wireDomesticDetails: type: object properties: bankAccountNumber: $ref: '#/components/schemas/bankAccountNumber' bankRoutingNumber: $ref: '#/components/schemas/bankRoutingNumber' bankName: $ref: '#/components/schemas/bankName' bankAddress: $ref: '#/components/schemas/bankAddress' bankRoutingNumberType: description: The type of routing being used. type: string example: aba enum: - ABA - ACH beneficiaryName: $ref: '#/components/schemas/name' beneficiaryAddress: $ref: '#/components/schemas/bankAddress' virtualAccountID: description: A unique DriveWealth virtual account identifier. type: string example: bfa2e... paymentType: description: The type of payment. type: string example: WIRE enum: - WIRE - ACH depositID: description: A unique identifier for the Deposit. type: string example: CKDQ000001-1671085040913-DMIQY currency: description: The name of the currency in abbreviation form. type: string example: USD enum: - USD currencySymbol: description: The currency symbol. type: string example: $ enum: - $ currencyObject: type: object properties: description: description: A custom description about the currency. type: string example: US Dollar name: $ref: '#/components/schemas/currency' symbol: $ref: '#/components/schemas/currencySymbol' depositStatusNumber: description: The current status of the user's deposit in integer form. type: number example: 1 enum: - 0 - 1 - 2 - 3 - 4 - 14 - 15 - 16 - 5 - -1 depositStatus: description: The current status of the user's deposit. type: string example: PENDING enum: - STARTED - PENDING - SUCCESSFUL - FAILED - OTHER - APPROVED - REJECTED - ON_HOLD - RETURNED - '-' updated: description: '' type: string example: '2022-12-11T22:28:21.810Z' depositStatusObject: type: object properties: id: $ref: '#/components/schemas/depositStatusNumber' message: $ref: '#/components/schemas/depositStatus' updated: description: The last updated timestamp of the status of the user's deposit. $ref: '#/components/schemas/updated' accountTypeObject: type: object properties: description: description: A custom description of the account type. type: string example: Live Account name: description: The type of account that has been created. type: string example: LIVE wlpFinTranTypeID: description: A unique identifier to id different type of transactions. type: string example: c43bab85-2916-4831-a0db-66215150a6e4 note: description: A way to store a message/comment on the this object. type: string example: Hey! Welcome to DriveWealth Developer Docs! depositsByUserIDObject: type: object properties: id: $ref: '#/components/schemas/depositID' paymentID: $ref: '#/components/schemas/depositID' amount: description: The amount of the deposit type: number example: 125.22 currency: $ref: '#/components/schemas/currencyObject' status: $ref: '#/components/schemas/depositStatusObject' accountDetails: type: object properties: accountID: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' accountType: $ref: '#/components/schemas/accountTypeObject' accountManagementType: $ref: '#/components/schemas/accountManagementTypeObject' wlpFinTranTypeID: $ref: '#/components/schemas/wlpFinTranTypeID' note: $ref: '#/components/schemas/note' redemptionID: description: A unique identifier for the user's account redemption/withdrawal. type: string example: DWUV000006-1593451797743-R8CC7 redemptionStatusObject: type: object properties: id: description: >- The current status of the user's brokerage account withdraw in integer form. type: number example: 1 message: description: >- The current status of the user's brokerage account redemption/withdrawal. type: string example: PENDING enum: - STARTED - PENDING - SUCCESSFUL - FAILED - OTHER - RIA_PENDING - RIA_APPROVED - APPROVED - REJECTED - '-' updated: description: >- The last updated timestamp of the status of the user's brokerage account redemption/withdrawal. type: string example: '2022-12-11T22:28:21.810Z' transactionCode: type: string example: JOURNAL enum: - JOURNAL - FEE_ACH - DISBURSEMENT_ACH_SVB finTranReference: description: The unique identifier that references back to the specific transaction. type: string example: HG.cd22a78a-8a48-441c-89d2-ea400964a34b feeObject: type: object properties: description: description: A custom description that describes the fee type. type: string example: Fee - ACH type: description: The type of fee that is being applied. type: string example: FEE_ACH enum: - FEE_ACH amount: description: The amount of the fee that is being applied. type: number example: -5.99 wlpFinTranTypeID: $ref: '#/components/schemas/wlpFinTranTypeID' transactionCode: $ref: '#/components/schemas/transactionCode' finTranReference: $ref: '#/components/schemas/finTranReference' created: description: The timestamp of when the fee was charged. type: string example: '2022-12-11T22:28:21.810Z' currency: $ref: '#/components/schemas/currency' symbol: $ref: '#/components/schemas/currencySymbol' Redemption: type: object properties: id: $ref: '#/components/schemas/redemptionID' paymentID: $ref: '#/components/schemas/redemptionID' amount: description: The amount that will be withdraw from the user's brokerage account. type: number example: 250.25 currency: $ref: '#/components/schemas/currencyObject' status: $ref: '#/components/schemas/redemptionStatusObject' accountDetails: type: object properties: accountID: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' accountType: $ref: '#/components/schemas/accountTypeObject' accountManagementType: $ref: '#/components/schemas/accountManagementTypeObject' fees: type: array items: oneOf: - $ref: '#/components/schemas/feeObject' wlpFinTranTypeID: $ref: '#/components/schemas/wlpFinTranTypeID' finTranReference: $ref: '#/components/schemas/finTranReference' timestamp: description: The date and time of when the redemption was created. type: string example: '2022-12-11T22:28:21.810Z' Redemptions: type: array items: oneOf: - $ref: '#/components/schemas/Redemption' orderID: description: A unique DriveWealth order identifier created when an order is placed. type: string example: IC.0e352bb7-9869-4233-9861-9673544efedd orderNo: description: The unique order number that is human readable. type: string example: ICDU023727 created: description: '' type: string example: '2022-12-11T22:28:21.810Z' orderCumulativeQuantity: description: >- The amount of shares currently being transacted; larger orders may execute in chunks. type: number example: 0.7219 orderQuantity: description: The amount of the instrument in shares. type: number example: 0.7219 instrumentISIN: description: >- An `International Securities Identification Number` (ISIN) uniquely identifies a security. Its structure is defined in ISO 6166. ISINs are commonly used when an Instrument does not have a `symbol`, such as Debt Instruments and Global Mutual Funds. type: string minLength: 12 maxLength: 14 example: US023135BX34 SalesCredit: description: >- If set, the unit price will be marked up or marked down based on the prescribed amount. Only applicable to Orders for Debt Instruments. type: object properties: currency: $ref: '#/components/schemas/currency' amount: description: The sales credit amount in cents. type: integer example: 14 instrumentType: description: The classification of the instrument. type: string example: EQUITY enum: - EQUITY - ALTERNATIVE_ASSET - MUTUAL_FUND - DEBT - OPTION - CRYPTO PendingOrders: description: A list of pending orders. type: object properties: accountID: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' tradingType: $ref: '#/components/schemas/tradingType' updated: description: The time of the last update to the Pending Orders Object. type: string example: '2021-04-23T18:41:32.440Z' orders: description: An array that holds a list of currently pending orders. type: array items: oneOf: - type: object properties: orderID: $ref: '#/components/schemas/orderID' orderNo: $ref: '#/components/schemas/orderNo' createdWhen: $ref: '#/components/schemas/created' symbol: $ref: '#/components/schemas/instrumentSymbol' cumQty: $ref: '#/components/schemas/orderCumulativeQuantity' orderStatus: description: The current status of the order. type: string example: '2' enum: - '0' - '1' - '2' - '3' - '4' - '6' - '7' - '8' - '9' - A - B - C orderType: description: The type of order that is placed. type: string example: '1' enum: - '0' - '1' - '2' - '3' - '4' - '6' - '7' - m orderQty: $ref: '#/components/schemas/orderQuantity' isoTimeRestingOrderExpires: description: The time when the limit order expires. type: string example: null limitPrice: description: The price set for the limit order. type: number example: null side: $ref: '#/components/schemas/sideAbbreviated' orderCashAmt: description: >- The amount of cash requested for an order (fractional shares only). type: number example: null stopPrice: description: The stop price of a limit order. type: number example: 200 ISIN: $ref: '#/components/schemas/instrumentISIN' salesCredit: $ref: '#/components/schemas/SalesCredit' instrumentType: $ref: '#/components/schemas/instrumentType' orderStatusNumber: description: The current status of the order, represented as a number. type: number example: 2 enum: - 0 - 1 - 2 - 4 - 6 - 7 - 8 orderTypes: description: The type of order that is placed. type: string example: MARKET enum: - MARKET - LIMIT - STOP - MARKET_IF_TOUCHED fundID: description: The unique identifier of a fund. type: string example: fund_4c16152c-f8e7-4a5a-af6b-c36f4e5cc6e7 fundType: description: The type of fund. type: string example: FUND enum: - FUND - CASH_RESERVE fundName: description: A user defined name that describes the underlying fund. type: string example: Large Capitalization Fund fundTarget: description: The individual targeted weight of the instrument. type: number example: 0.75 holdings: description: A list of the securities held in a Fund. type: array items: oneOf: - $ref: '#/components/schemas/holdingsObject' portfolioHoldings: type: object properties: id: $ref: '#/components/schemas/fundID' type: $ref: '#/components/schemas/fundType' name: $ref: '#/components/schemas/fundName' target: $ref: '#/components/schemas/fundTarget' actual: description: The percentage weight of a Fund in a Portfolio. type: number example: 0.3054 value: description: The current value of the Fund in a Portfolio in USD. type: number example: 33604.12 rebalanceRequired: description: >- A flag that determines if a re-balance is required based on total drift. type: boolean example: true holdings: $ref: '#/components/schemas/holdings' cashSettlementTime: type: object properties: utcTime: description: >- Timestamp of when the pending cash amount is released due to settlement. type: string example: '2021-04-26T13:30:00.001Z' cash: description: The total amount of money that is settling on the provided utcTime. type: number example: 439.7 statementObj: type: object properties: displayName: description: Description of account statement file. type: string example: Apr 28, 2017 Statement fileKey: description: >- Key to be used to retrieve account statement PDF. Reference [Get Statement File](https://developer.drivewealth.com/reference/get-statement-file) for retrieving an account statement. type: string example: '2017042802' taxStatementObj: type: object properties: displayName: description: Description of account tax statement file. type: string example: 2015 Tax Year 1099-B fileKey: description: >- Key to be used to retrieve account tax statement PDF. Reference [Get Statement File](https://developer.drivewealth.com/reference/get-statement-file) for retrieving an account statement. type: string example: '2015123103' tradeConfirmObj: type: object properties: displayName: description: Description of trade confirmation file. type: string example: Jun 02, 2017 Trade Confirm fileKey: description: >- Key to be used to retrieve trade confirmation PDF. Reference [Get Statement File](https://developer.drivewealth.com/reference/get-statement-file) for retrieving an account statement. type: string example: '2017060201' marginObj: type: object properties: marginRequirement: description: Leverage amounts. 0.5 = 2:1 Leverage. 1 = 1:1 Leverage type: number example: 1 enum: - 0.5 - 1 longMarketValue: description: A real-time dollar value of current holdings. type: number example: 0 debitBalance: description: >- Real-time dollar value of debt; positive dollar amount is a debit balance, negative dollar amount is a credit balance. type: number example: 0 equity: description: >- Real-time dollar value of equity; calculated as longMarketValue – debitBalance. type: number example: 0 equityFraction: description: >- Equity as a fraction of long market value; calculated as equity ÷ longMarketValue. type: number example: 0 equityRequired: description: >- Minimum equity required to stay above a HOUSE margin call. If the account is in a margin call (HOUSE or EXCHANGE) this field will not appear here, but instead appear in the marginCall object. type: number example: 1 accruedInterest: description: NEEDS DESCRIPTION type: number example: 0 bodDTBP: description: >- The Day Trading Buying Power (DTBP) in dollars at the beginning of day. type: number example: 10000 nullable: true patternDayTrader: description: NEEDS DESCRIPTION type: boolean example: false restricted: description: >- Account becomes restricted (set to true) if equity is less than 50% of long market value (this is essentially a warning, at 35% the account will be in HOUSE margin call). type: boolean example: false daySMA: description: >- Current SMA using traditional calculations – Start with beginning of day SMA and update with deposits and withdrawals as well as stock buys and sells during the day. Deposits increase and withdrawals decrease SMA dollar for dollar. Buys increase and sells decrease SMA by 50% of trade dollar value. type: number example: 0 rtExcessEquity: description: >- Equity in excess of equityRequired calculated in real time (more is good). type: number example: 0 effectiveSMA: description: >- The lower of margin.daySMA and margin.rtExcessEquity. This is risk protection for the user as well as DriveWealth. Using only margin.daySMA for lending on margin has the disadvantage that the SMA can become inflated if the market drops from start of day. If user's were to use their entire daySMA to buy stock on a day when the market drops, they are immediately placed into a HOUSE CALL. The margin.rtExcessEquity prevents that from happening by lending them only a (reduced) amount that would place them above a HOUSE margin call. That is the risk protection provided to both parties. type: number example: 0 noBuyingPowerReason: description: >- Reason indicating why the user has no buying power: `MIN_MARGIN_EQUITY_NOT_MET` - margin.equity is less than $2,000 and margin.debitBalance is greater than $0 `EFFECTIVE_SMA_ZERO` - `SMA` is $0 `HOUSE_CALL` - margin.equityfFaction is less than 35% (required house equity) `EXCHANGE_CALL` - margin.equityfFaction is less than 25% (required exchange equity) * `RESTING_ORDERS_WILL_TRIGGER_HOUSE_MARGIN_CALL` - Market dropped after resting orders were placed, and will trigger house call if filled. type: string example: null marginCall: description: >- Object of margin call calculations. Will only appear if noBuyingPowerReason is equal to `MIN_MARGIN_EQUITY_NOT_MET` or `HOUSE_CALL` or `EXCHANGE_CALL` type: object properties: {} restingOrders: description: >- Total dollar value committed in resting orders that reduces the effectiveSMA type: number example: 0 equityValue: description: The current total market value of the account's open equity positions. type: number format: double example: 34275565.44 equityPositionsObj: type: object properties: symbol: $ref: '#/components/schemas/instrumentSymbol' instrumentID: $ref: '#/components/schemas/instrumentID' ISIN: $ref: '#/components/schemas/instrumentISIN' instrumentType: $ref: '#/components/schemas/instrumentType' openQty: description: Quantity of shares owned by the account. type: number example: 31.65120151 costBasis: description: Cost basis of the position. type: number example: 975.98 marketValue: description: Current market value of the position. type: number example: 4540.36 side: description: >- In this case, Side distinguishes the type of position. This will always return 'long'(B). type: string example: B enum: - B priorClose: description: The prior closing price of the security. type: number example: 144.29 availableForTradingQty: description: The quantity of the security available for sale. type: number example: 31.65120151 avgPrice: description: The average price of the position. type: number example: 30.84 mktPrice: description: The current market price of the position. type: number example: 143.45 unrealizedPL: description: Unrealized profit and loss for position. type: number example: 3564.38 unrealizedDayPLPercent: description: Unrealized day profit and loss for position in percent. type: number example: -0.58 unrealizedDayPL: description: Unrealized day profit and loss for position. type: number example: -26.59 orderStatus: description: The current status of the order. type: string example: FILLED enum: - NEW - FILLED - PARTIAL_FILL - PENDING_CANCEL - CANCELED - REJECTED limitPrice: description: The price set for the limit order. type: number example: null stopPrice: description: The stop price of a limit order. type: number example: 200 ordersObj: type: object properties: orderID: $ref: '#/components/schemas/orderID' orderNo: $ref: '#/components/schemas/orderNo' createdWhen: $ref: '#/components/schemas/created' symbol: $ref: '#/components/schemas/instrumentSymbol' cumQty: $ref: '#/components/schemas/orderCumulativeQuantity' orderStatus: $ref: '#/components/schemas/orderStatus' orderType: $ref: '#/components/schemas/orderTypes' orderQty: $ref: '#/components/schemas/orderQuantity' isoTimeRestingOrderExpires: description: The time when the limit order expires. type: string example: null limitPrice: $ref: '#/components/schemas/limitPrice' side: $ref: '#/components/schemas/sideAbbreviated' orderCashAmt: description: The amount of cash requested for an order (fractional shares only). type: number example: null stopPrice: $ref: '#/components/schemas/stopPrice' transactionSumObj: type: object properties: orderID: $ref: '#/components/schemas/orderID' orderNo: $ref: '#/components/schemas/orderNo' createdWhen: $ref: '#/components/schemas/created' symbol: $ref: '#/components/schemas/instrumentSymbol' cumQty: $ref: '#/components/schemas/orderCumulativeQuantity' orderStatus: $ref: '#/components/schemas/orderStatus' orderType: $ref: '#/components/schemas/orderTypes' orderQty: $ref: '#/components/schemas/orderQuantity' isoTimeRestingOrderExpires: description: The time when the limit order expires. type: string example: null limitPrice: description: The price set for the limit order. type: number example: null side: $ref: '#/components/schemas/sideAbbreviated' orderCashAmt: description: The amount of cash requested for an order (fractional shares only). type: number example: null stopPrice: description: The stop price of a limit order. type: number example: 200 realizedPL: description: Realized profit and loss for position. type: number example: 3564.38 executedWhen: description: The time when the transaction was executed. type: string example: 017-06-16T15:35:27.856Z updatedWhen: description: NEEDS DESCRIPTION type: string example: '2017-06-16T15:35:30.617Z' updatedReason: description: A reason for the update. type: string example: market_order-buy-new commissions: description: Commission for the transaction if applicable. type: number example: 0 commissionDesc: description: A short description about the commission. type: string example: Free performanceObj: type: object properties: realizedDayPL: description: The actual profit or loss on the day in USD. type: number example: 100.5 unrealizedDayPL: description: Current unrealized profit and loss for open positions in account. type: number example: 3564.38 cumRealizedPL: description: >- The cumulative realized profit/loss from inception of account, each day adds to previous days. type: number example: 10 date: description: the date of the performance arrays values. type: string example: '2018-09-18' equity: description: >- Invested equity (excluding cash) for this day (see performance.date). For Total `Equity` add performance.equity and performance.cash type: number example: 9941.59 cash: description: >- The total cash balance (settled and unsettled) for this day (see performance.date). type: number example: 439.7 deposits: description: >- The total amount of deposits calculated from 4pm of previous day until current time. type: number example: 0 withdrawals: description: >- The total amount of withdrawals calculated from 4pm of previous day until current time. type: number example: 0 fees: description: >- The total amount of fees calculated from 4pm of previous day until current time. type: number example: 0 optionsValue: description: The current total market value of the account's open option positions. type: number format: double example: 12345.67 debtValue: description: The current total market value of the account's open debt positions. type: number format: double example: 12345.67 positionsValue: description: The current total market value of the account's open positions. type: number format: double example: 34287911.11 optionsPositionsObj: type: object properties: symbol: $ref: '#/components/schemas/instrumentSymbol' instrumentID: $ref: '#/components/schemas/instrumentID' ISIN: $ref: '#/components/schemas/instrumentISIN' instrumentType: $ref: '#/components/schemas/instrumentType' openQty: description: Quantity of shares owned by the account. type: number example: 31.65120151 costBasis: description: Cost basis of the position. type: number example: 975.98 marketValue: description: Current market value of the position. type: number example: 4540.36 side: description: >- In this case, Side distinguishes the type of position. This will always return 'long'(B). type: string example: B enum: - B priorClose: description: The prior closing price of the security. type: number example: 144.29 availableForTradingQty: description: The quantity of the security available for sale. type: number example: 31.65120151 avgPrice: description: The average price of the position. type: number example: 30.84 mktPrice: description: The current market price of the position. type: number example: 440.75 unrealizedPL: description: The unrealized profit and loss for the position. type: number example: 14.24 unrealizedDayPLPercent: description: The unrealized day profit and loss for position in percent. type: number example: 1.65 unrealizedDayPL: description: The unrealized day profit and loss for the position. type: number example: 0.54 mutualFundsPositionsObj: type: object properties: symbol: $ref: '#/components/schemas/instrumentSymbol' instrumentID: $ref: '#/components/schemas/instrumentID' ISIN: $ref: '#/components/schemas/instrumentISIN' instrumentType: $ref: '#/components/schemas/instrumentType' openQty: description: Quantity of shares owned by the account. type: number example: 31.65120151 costBasis: description: Cost basis of the position. type: number example: 975.98 marketValue: description: Current market value of the position. type: number example: 4540.36 side: description: >- In this case, Side distinguishes the type of position. This will always return 'long'(B). type: string example: B enum: - B priorClose: description: The prior closing price of the security. type: number example: 144.29 availableForTradingQty: description: The quantity of the security available for sale. type: number example: 31.65120151 avgPrice: description: The average price of the position. type: number example: 30.84 debtPositionsObj: type: object properties: symbol: $ref: '#/components/schemas/instrumentSymbol' instrumentID: $ref: '#/components/schemas/instrumentID' ISIN: $ref: '#/components/schemas/instrumentISIN' instrumentType: $ref: '#/components/schemas/instrumentType' openQty: description: Quantity of shares owned by the account. type: number example: 31.65120151 costBasis: description: Cost basis of the position. type: number example: 975.98 marketValue: description: Current market value of the position. type: number example: 4540.36 side: description: >- In this case, Side distinguishes the type of position. This will always return 'long'(B). type: string example: B enum: - B priorClose: description: The prior closing price of the security. type: number example: 144.29 availableForTradingQty: description: The quantity of the security available for sale. type: number example: 31.65120151 avgPrice: description: The average price of the position. type: number example: 30.84 violationsObj: type: object properties: goodFaithViolations: type: object properties: count: $ref: '#/components/schemas/goodFaithViolations' patternDayTrades: type: object properties: count: $ref: '#/components/schemas/patternDayTrades' details: description: >- A string containing the direct path to the [violations API](https://developer.drivewealth.com/reference/list-all-account-violations) for further detail type: string example: >- /back-office/accounts/b5421694-65c6-4e48-9f8f-d90596e2f471.1616427127842/violations properties-goodFaithViolations: type: object properties: count: $ref: '#/components/schemas/goodFaithViolations' violationSells: type: object properties: qty: $ref: '#/components/schemas/orderQuantity' amount: description: The amount of shares being transacted. type: number example: 20 createdWhen: $ref: '#/components/schemas/created' orderID: $ref: '#/components/schemas/orderID' orderNo: $ref: '#/components/schemas/orderNo' side: $ref: '#/components/schemas/sideAbbreviated' patternDayTradesObj: type: object properties: id: $ref: '#/components/schemas/instrumentID' symbol: $ref: '#/components/schemas/instrumentSymbol' qty: $ref: '#/components/schemas/orderQuantity' amount: description: The amount of shares being transacted. type: number example: 100 side: $ref: '#/components/schemas/sideAbbreviated' createdWhen: $ref: '#/components/schemas/created' orderID: $ref: '#/components/schemas/orderID' orderNo: $ref: '#/components/schemas/orderNo' violationSells: description: An array which orders are in violation. type: array items: oneOf: - $ref: '#/components/schemas/violationSells' legacyGoodFaithViolations: description: NEEDS DESCRIPTION type: number example: 0 message: description: A description of the violation. type: string example: >- This transaction resulted in your third Pattern Day Trade. Note that pending orders (such as limits) may trigger a 4th Pattern Day Trade. If you have 4 or more day trades in a 5 day period, your account will be designated as a Pattern Day Trader and must maintain equity of at least $25,000. Failure to do so will put your account on 90-Restriction. You will receive an email notification with more details. accountEquityBreakdownObj: type: object properties: longMarketValue: description: The current long market value. type: number example: 30000 debitBalance: description: The current debit balance. type: number example: 2000 accountEquity: description: The current total account equity (longMarketValue - debitBalance). type: number example: 28000 instrumentCUSIP: description: > CUSIP stands for `Committee on Uniform Securities Identification Procedures`. A CUSIP number identifies most financial instruments, including: stocks of all registered U.S. and Canadian companies, commercial paper, and U.S. government and municipal bonds. The CUSIP system facilitates the clearance and settlement process of securities. CUSIP numbers consist of nine characters (including letters and numbers) that uniquely identify a company or issuer and the type of financial instrument. A similar system is used to identify foreign securities (`CUSIP International Numbering System or CINS`). CINS employs the same nine character identifier as CUSIP, but also contains a letter in the first position to signify the issuer's country or geographic region. type: string minLength: 9 maxLength: 9 example: E09876AA7 transactionObj: type: object properties: orderId: $ref: '#/components/schemas/orderID' orderNo: $ref: '#/components/schemas/orderNo' symbol: $ref: '#/components/schemas/instrumentSymbol' ISIN: $ref: '#/components/schemas/instrumentISIN' CUSIP: $ref: '#/components/schemas/instrumentCUSIP' instrumentType: $ref: '#/components/schemas/instrumentType' cumQty: $ref: '#/components/schemas/orderCumulativeQuantity' orderStatus: $ref: '#/components/schemas/orderStatusNumber' orderType: description: The type of order that is placed. type: string example: '1' enum: - '0' - '1' - '2' - '3' - '4' - '6' - '7' - m orderQty: $ref: '#/components/schemas/orderQuantity' limitPrice: $ref: '#/components/schemas/limitPrice' stopPrice: $ref: '#/components/schemas/stopPrice' executedPrice: description: The price at which the order was executed. type: number example: 122.47 side: $ref: '#/components/schemas/sideAbbreviated' createdWhen: $ref: '#/components/schemas/created' updatedWhen: description: NEEDS DESCRIPTION type: string example: '2017-06-16T15:35:30.617Z' updatedReason: description: A reason for the update. type: string example: market_order-buy-new commission: description: Commission for the transaction if applicable. type: number example: 0 commissionDesc: description: A short description about the commission. type: string example: Free isoTimeRestingOrderExpires: description: The time when the limit order expires. type: string example: null executedWhen: description: The time when the transaction was executed. type: string example: 017-06-16T15:35:27.856Z realizedPL: description: Realized profit and loss for position. type: number example: 3564.38 orderCashAmt: description: The amount of cash requested for an order (fractional shares only). type: number example: null salesCredit: $ref: '#/components/schemas/SalesCredit' currency: $ref: '#/components/schemas/currency' dividend: type: object properties: type: description: The dividend type, whether a cash or stock dividend. type: string example: CASH enum: - CASH - STOCK - RETURN_OF_CAPITAL - DISTRIBUTION_LONG - DISTRIBUTION_SHORT - OTHER amountPerShare: description: The amount of the dividend issued, per share. type: number example: 0.65 taxCode: description: Whether the dividend is taxable or not. type: string example: FULLY_TAXABLE enum: - FULLY_TAXABLE - NON_TAXABLE - TAX_EXEMPT - 'null' finTranID: description: The internal and unique transaction identification number. type: string example: EF.a935f686-5567-4e10-9e71-261314207c0b finTranTypeID: description: The abbreviated transaction type identifier. type: string example: JNLC enum: - CSR - CSD - FEE - JNLC - CADJ - INT - SPUR - SSAL - MERGER_ACQUISITION - DIV - DIVTAX - DIVNRA - STCK - COMM - SPINOFF - STOCK_SPLIT - ACATS_CASH - ACATS_STOCK - CCPUR - CCSAL - SLIP - DIVM - PTP_WITHHOLDING Transaction: type: object properties: accountAmount: description: The amount of the transaction. type: number example: -890.12 accountBalance: description: The equity value of the account at the time of the transaction. type: number example: 49984.44 accountType: $ref: '#/components/schemas/accountType' dividend: $ref: '#/components/schemas/dividend' dividendTax: description: An object containing details of a dividend withholding. type: object properties: rate: description: The Witholding rate associated with the dividend payment. type: number example: 0.15 type: description: The type of tax associated with the withholding type: string example: FOREIGN_TAX enum: - FOREIGN_TAX - NON_RESIDENTIAL_ALIEN - OTHER dnb: description: If false, the transaction was sent to inteliclear. Default is false. type: boolean example: false comment: description: A comment describing the transaction type: string example: Buy 0.0259 shares of AMZN at 1003.13 FULL fill finTranID: $ref: '#/components/schemas/finTranID' finTranTypeID: $ref: '#/components/schemas/finTranTypeID' feeSec: description: >- The sec fee charged to an applicable sell order. Reference your fee schedule for SEC fee amounts per share. type: number example: 0.01 feeTaf: description: >- Trading activity fee (TAF) for an applicable sell order. Reference your fee schedule for TAF fee amounts per share. type: number example: 0.01 feeBase: description: The net fee amount of TAF and SEC Fees for a given sell order. type: number example: 0.02 feeXtraShares: description: >- Commission charged when the share quantity is greater than the base share amount. Reference your commission schedule for more info. type: number example: 0.05 feeExchange: description: An Exchange Fee applied to an order. type: number example: 0.02 fillQty: description: The quantity of shares filled for a transaction. type: number example: 1.02387115 fillPx: description: The fill price of the order for the given transaction. type: number example: 17.44 orderID: $ref: '#/components/schemas/orderID' mergerAcquisition: description: >- An object containing details of a corporate event, such as a merger or an acquisition. type: object properties: type: description: The transaction result of the corporate event type: string example: EXCHANGE STOCK_CASH enum: - EXCHANGE_STOCK_CASH - ADD_SHARES - ADD_SHARES_CASH - ADD_SHARES_REMOVE_CASH - REMOVE_SHARES - REMOVE_SHARES_CASH - REMOVE_SHARES_ADD_CASH acquirer: description: Object containing details of the acquiring company type: object properties: id: $ref: '#/components/schemas/instrumentID' symbol: description: The instrument ticker symbol. type: string example: AAPL name: description: The name of the acquiring company type: string example: Apple acquiree: description: Object containing details of the company being acquired type: object properties: id: $ref: '#/components/schemas/instrumentID' symbol: description: The instrument ticker symbol. type: string example: TSLA name: description: The name of the company being acquired type: string example: TSLA positionDelta: description: The delta in the number of shares due to the corporate action. type: number example: 0.18 TransactionRes: description: A list of transactions. type: array items: oneOf: - $ref: '#/components/schemas/Transaction' taxLotID: description: A unique tax lot identifier. type: string example: 3db27e74626adac3be7b549f2bbc0ab2480852a7 parentIBID: description: The unique identifier of the firm. type: string example: 80f9b672-120d-4b73-9cc9-42fb3262c4b9 AssetTransferType: type: string enum: - ACAT - TEEN - CASH - PROMOTIONAL - REWARD - STOCK AssetTransferStatus: type: string enum: - STARTED - PENDING - FAILED - SUCCESSFUL - ON_HOLD AcatRejectionCode: description: The ACAT rejection reason. type: string enum: - UNKNOWN - SSN_NOT_MATCH - ACCOUNT_NOT_MATCH - DOC_REQUIRED - ACCOUNT_FLAT - BROKER_NOT_MATCH - DUPLICATE_REQUEST - ACCOUNT_IN_TRANSIT - BROKER_REJECTED - MISSING_AUTH_SIGN - MISSING_FUND - SYMBOL_NOT_SUPPORTED GenericTransferStatus: description: The status of the Transfer type: object properties: description: type: string name: $ref: '#/components/schemas/AssetTransferStatus' GenericTransferRequest: type: object properties: source: $ref: '#/components/schemas/accountNo' destination: description: >- The DriveWealth destination account number where all assets will be transferred to. type: string example: LKKZ000004 comment: $ref: '#/components/schemas/note' metadata: $ref: '#/components/schemas/metadata' AcatsCreateRequestModelWithoutEnums: type: object properties: clearingNo: description: The DTCC clearing number of the broker. type: string example: '0001' minLength: 1 maxLength: 4 cash: description: The amount of cash to be moved from the source account. type: number default: 0 positions: description: >- The positions to be moved from the source account to the destination account. type: array minItems: 0 items: $ref: '#/components/schemas/AcatPositionModel' AcatsTransferEnumValues_SourceAccountType: description: The type of account the sources account is. type: string enum: - INDIVIDUAL - CORPORATE - JOINT - CUSTODIAL - IRA - IRA_MANAGED AcatsType: description: The type of ACAT transfer to be performed. type: string enum: - FULL - PARTIAL AcatsTransitType: description: The transit type of ACAT transfer to be performed. type: string enum: - ACAT_IN - ACAT_OUT AcatsCreateRequestModel: title: AcatsRequestModel description: ACAT Request model type: object allOf: - $ref: '#/components/schemas/GenericTransferRequest' - $ref: '#/components/schemas/AcatsCreateRequestModelWithoutEnums' properties: sourceAccountType: $ref: '#/components/schemas/AcatsTransferEnumValues_SourceAccountType' acatType: $ref: '#/components/schemas/AcatsType' required: - source - destination - clearingNo - sourceAccountType - type ACATSTransfer: type: object allOf: - $ref: '#/components/schemas/GenericTransferRequest' - $ref: '#/components/schemas/AcatsCreateRequestModelWithoutEnums' properties: sourceAccountType: type: object properties: description: type: string name: $ref: '#/components/schemas/AcatsTransferEnumValues_SourceAccountType' acatType: type: object properties: description: type: string name: $ref: '#/components/schemas/AcatsType' acatTransit: type: object properties: description: type: string name: $ref: '#/components/schemas/AcatsTransitType' rejectionInfo: type: object properties: rejectionCode: $ref: '#/components/schemas/AcatRejectionCode' rejectionReason: type: string AcatPositionModel: title: AcatPosition description: Position Model. Symbol or InstrumentID is required. type: object properties: symbol: $ref: '#/components/schemas/instrumentSymbol' instrumentID: $ref: '#/components/schemas/instrumentID' quantity: description: >- The quantity of shares to be transferred. Assets that are moving to or from an account outside of DriveWealth, can only be whole shares. type: number minimum: 1 required: - quantity CancelRebillRequest: type: object required: - orderNo - type - reason properties: orderNo: $ref: '#/components/schemas/orderNo' type: description: The adjustment classification. type: string example: CANCEL enum: - CANCEL - PRICE_ADJUSTMENT - COMMISSION_ADJUSTMENT reason: description: The cause of the request. type: string example: FRAUD enum: - FRAUD - PRICE_ADJUSTMENT_PARTNER - PRICE_ADJUSTMENT_VENUE - DRIVEWEALTH_TECHNICAL_ERROR - PARTNER_TECHNICAL_ERROR - VENDOR_ERROR approvedBy: $ref: '#/components/schemas/userID' adjustedPrice: description: >- The *updated* price that should be set; from the original transaction. type: number example: 125.3 adjustedCommission: description: >- The *updated* commission that should be set; from the original transaction. type: number example: 2.49 comment: description: The comment on the reason for Cancellation or an Adjustment. type: string minLength: 1 maxLength: 100 metadata: description: >- Any metadata field which needs to be part of cancel rebill transaction. type: array items: type: object CancelRebillIdentifer: description: A unique identifier generated for the Cancel Rebill. type: string format: string CancelRebillResponse: type: object properties: id: $ref: '#/components/schemas/CancelRebillIdentifer' reason: $ref: '#/components/schemas/CancelRebillReason' type: $ref: '#/components/schemas/CancelRebillType' orderNo: $ref: '#/components/schemas/orderNo' status: $ref: '#/components/schemas/CancelRebillStatus' approvedBy: description: The user who approved the Cancel Rebill Request. type: string minLength: 1 maxLength: 50 comment: $ref: '#/components/schemas/note' CancelRebillReason: type: object properties: description: description: The description of the reason for the Cancel Rebill. type: string name: description: The Cancel Rebill reason. example: PRICE_ADJUSTMENT_PARTNER enum: - FRAUD - PRICE_ADJUSTMENT_PARTNER - PRICE_ADJUSTMENT_VENUE - DRIVEWEALTH_TECHNICAL_ERROR - PARTNER_TECHNICAL_ERROR - VENDOR_ERROR type: string CancelRebillType: type: object properties: description: description: The description of the cancel rebill type. type: string name: description: The type of Cancel Rebill. example: CANCEL enum: - CANCEL - PRICE_ADJUSTMENT - COMMISSION_ADJUSTMENT type: string CancelRebillStatus: type: object properties: description: description: The description of the Cancel Rebill status. type: string name: description: The status of the Cancel Rebill. enum: - STARTED - APPROVED - ON_HOLD - REJECTED - PENDING - SUCCESSFUL type: string code: type: integer CancelRebillDetailResponse: title: CancelRebillDetailResponse type: object properties: data: type: array items: $ref: '#/components/schemas/CancelRebillDetail' responseMetadata: $ref: '#/components/schemas/ResponseMetadata' CancelRebillDetail: title: CancelRebillDetail description: Model object to list all the cancel rebill transaction attributes. type: object properties: id: $ref: '#/components/schemas/CancelRebillIdentifer' partner: $ref: '#/components/schemas/parentIBIDObject' reviewRequired: description: >- Flag which suggests whether the cancel rebill request require manual processing. example: true type: boolean orderNo: $ref: '#/components/schemas/orderNo' accountNo: $ref: '#/components/schemas/accountNo' accountID: $ref: '#/components/schemas/accountID' errorAccountNo: description: >- Error Account against which the Cancel rebill transaction was booked. $ref: '#/components/schemas/accountNo' errorAccountID: $ref: '#/components/schemas/accountID' type: $ref: '#/components/schemas/CancelRebillType' reason: $ref: '#/components/schemas/CancelRebillReason' symbol: description: The instrument symbol for which the original trade was booked. $ref: '#/components/schemas/instrumentSymbol' quantity: description: The order quantity of original transaction. type: number example: 4 price: description: The price of original transaction. type: number example: 100.01 adjustedPrice: description: New price when adjusting the price of original transaction. type: number example: 100.03 adjustedCommission: description: >- The new commission when adjusting the commission of original transaction. type: number example: 2.49 status: $ref: '#/components/schemas/CancelRebillStatus' statusComment: description: Comment while approving rejecting the Cancel Rebill transaction. type: string approvedBy: description: The approver of the Cancel Rebill Request. type: string example: John Doe minLength: 1 maxLength: 50 updated: description: The last updated date of the Cancel Rebill transaction. type: string comment: $ref: '#/components/schemas/note' auditDetails: type: array items: $ref: '#/components/schemas/AuditDetails' AuditDetails: type: object properties: status: {} comment: $ref: '#/components/schemas/note' updatedBy: description: The user who updated the status. type: string updated: description: The date when the status was last updated. type: string ResponseMetadata: title: ResponseMetadata type: object properties: lastKey: type: string example: >- 5730ee28-78cb-4736-9c99-ede6dc1084a3#cxl_rbl_9ee1379f-2d18-433f-a2b4-0d523afe4007 count: type: integer example: 1 metadata: description: >- The metadata object allows for creating a maximum of 5 keys (max 36 characters) and each value cannot exceed more than 128 bytes. type: object example: myCustomKey: myCustomValue assetTransferID: description: The unique identifier of the asset transfer. type: string example: c85b231a-2bc9-11ee-be56-0242ac120002 partnerID: description: The partner's unique identifier. type: string example: 80f9b672-120d-4b73-9ccv9-42fb3262c4b9 CreateAuthToken: type: object properties: security: type: object properties: description: description: A custom description that describes the permission set. type: string example: Partner Principal permissionSet: description: A list of the permissions the back office permissions assigned. type: array example: - ACCOUNTS_CREATE_LIVE - ACCOUNTS_CREATE_MANAGED - ACCOUNTS_CREATE_MARGIN - ACCOUNTS_CREATE_PRACTICE - ACCOUNTS_CREATE_RIA_MANAGED - ACCOUNTS_EDIT items: description: >- WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema. permissionID: description: A unique identifier for the permission set. type: string example: 4380ee75-5acd-f5af-4347-04146bb3f61a username: description: The B2B (business to business) back office username. type: string example: bo.sample.api authToken: description: The B2B (business to business) back office session token. type: string example: acb33c99-3a6f-4494-85bf-8dae70977552.2018-07-26T14:45:47.391Z expiresAt: description: The date and time the session token expires. type: string example: '2022-12-28T01:09:33.714Z' userID: $ref: '#/components/schemas/userID' firstName: description: The Firm Name. type: string example: Tendies Trading Company lastName: description: The Firm Type. type: string example: LLC parentIBID: $ref: '#/components/schemas/userID' CreateAuthTokenReq: type: object required: - username - password - appTypeID properties: username: description: The B2B (business to business) back office username. type: string example: bo.sample.api password: description: The B2B (business to business) back office password. type: string example: 188ff5b0-8f13-4676-8bb2-305b9e08a3ba appTypeID: description: The version type identifier. type: number example: 4 CreateSessToken: type: object properties: token_type: description: The type of token that was generated. type: string example: Bearer enum: - Bearer expires_in: description: The length of time in seconds for which the session token is valid. type: string example: '3600' access_token: description: The session token. type: string example: >- eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c scope: description: The scope of permission set for the JSON Web Token (JWT). type: string example: all_trading CreateSessTokenReq: type: object required: - clientID - clientSecret properties: clientID: description: The identifier of the client accessing the DriveWealth system. type: string example: 0oafccTendies67BTx113 clientSecret: description: The secret of the client accessing the DriveWealth system. type: string example: 8WfNzC4oTendiesTradingCompanyPuQNwg7BPByWqQOj ListOfAllowedCountry: type: object properties: id: description: The abbreviated identifier of a country. type: string example: ALA name: description: The full name of the country type: string example: Aland Islands code2: description: An alternative abbreviated identifier of a country. type: string example: AX code3: description: An alternative abbreviated identifier of a country. type: string example: ALA active: description: True, if a user can be onboarded from this country. type: boolean example: true expatsAllowed: description: >- True, if a user who resides outside of their country can be onboarded from the listed country. type: boolean example: false foreignTINNotRequired: description: True, if a user's tax identifier is NOT required during onboarding. type: boolean example: false fpslProhibited: type: boolean example: false supportDomicile: type: boolean example: false taxTreatyCountry: description: True, if the country has a tax treaty with the United States. type: boolean example: false ListOfAllowedCountries: description: A list of allowed countries. type: array items: oneOf: - $ref: '#/components/schemas/ListOfAllowedCountry' DepositRequestReq: type: object required: - accountNo - amount - currency - type properties: accountNo: $ref: '#/components/schemas/accountNo' amount: description: The amount that will be deposited into the user's account. type: number example: 250.25 currency: $ref: '#/components/schemas/currency' type: $ref: '#/components/schemas/depositTypes' bankAccountID: $ref: '#/components/schemas/bankAccountID' note: $ref: '#/components/schemas/note' iraContribution: $ref: '#/components/schemas/iraContribution' recurringFrequency: $ref: '#/components/schemas/recurringFrequency' startDate: description: >- The start date of the recurring deposit. The date should be in the future and within 90 days. type: string example: '2017-09-18' settlementProfileID: $ref: '#/components/schemas/settlementProfileID' originatorBankDetails: type: object properties: bankAccountNumber: $ref: '#/components/schemas/bankAccountNumber' bankRoutingNumber: $ref: '#/components/schemas/bankRoutingNumber' bankName: $ref: '#/components/schemas/externalBankName' bankAddress: $ref: '#/components/schemas/externalBankAddress' bankAccountCountry: $ref: '#/components/schemas/externalBankCountry' accountHolderName: $ref: '#/components/schemas/accountHolderName' accountHolderAddress: $ref: '#/components/schemas/externalAccountHolderAddress' accountHolderCountry: $ref: '#/components/schemas/externalAccountHolderCountry' metadata: description: >- The metadata object allows for creating a maximum of 5 keys (max 36 characters) and each value cannot exceed more than 128 bytes. type: object example: myCustomKey: myCustomValue Deposit: type: object properties: id: $ref: '#/components/schemas/depositID' accountNo: $ref: '#/components/schemas/accountNo' category: type: string example: DEPOSIT currency: $ref: '#/components/schemas/currency' amount: description: The amount of cash that is being deposited into the user's account. type: number example: 250.25 status: $ref: '#/components/schemas/depositStatus' source: type: object properties: id: $ref: '#/components/schemas/depositTypes' brand: description: A custom description about the type of deposit. type: string example: ACH meta_info: description: A way to store a message/note on the deposit object. type: string example: Hey! Welcome to DriveWealth Developer Docs! created: description: The date and time the deposit was created for the user's account. $ref: '#/components/schemas/created' accountID: $ref: '#/components/schemas/accountID' userID: $ref: '#/components/schemas/userID' transactionCode: $ref: '#/components/schemas/transactionCode' wlpFinTranTypeID: $ref: '#/components/schemas/wlpFinTranTypeID' batch: type: boolean example: true recurring: type: object properties: id: $ref: '#/components/schemas/recurringID' nextDeposit: description: The date of when the next recurring deposit will be triggered. type: string example: '2019-01-15' active: description: True, if the recurring deposit is active. type: boolean example: false frequency: $ref: '#/components/schemas/recurringFrequency' DepositStatusHistory: type: object properties: status: $ref: '#/components/schemas/depositStatusNumber' statusMessage: $ref: '#/components/schemas/depositStatus' updatedBy: $ref: '#/components/schemas/updatedBy' comment: description: A custom comment generated by the system. type: string example: Valid request. Auto-move to Pending DepositByDepositID: type: object properties: id: $ref: '#/components/schemas/userID' category: type: string example: DEPOSIT amount: description: The amount of cash that is being deposited into the user's account. type: number example: 250.25 currency: $ref: '#/components/schemas/currencyObject' status: $ref: '#/components/schemas/depositStatus' created: description: The date and time the deposit was created for the user's account. $ref: '#/components/schemas/created' userDetails: $ref: '#/components/schemas/UserDetails' accountDetails: $ref: '#/components/schemas/AccountDetails' batch: $ref: '#/components/schemas/batch' transactionCode: $ref: '#/components/schemas/transactionCodeObject' note: $ref: '#/components/schemas/note' details: type: object properties: country: $ref: '#/components/schemas/bankAccountCountry' bankAccountNumber: $ref: '#/components/schemas/bankAccountNumberLastFour' bankRoutingNumber: $ref: '#/components/schemas/bankRoutingNumberLastFour' accountHolderName: $ref: '#/components/schemas/accountHolderName' wlpFinTranTypeID: $ref: '#/components/schemas/wlpFinTranTypeID' statusHistory: description: A list of the different historical status of the deposit type: array items: oneOf: - $ref: '#/components/schemas/DepositStatusHistory' depositTypes: description: >- The method/form in which the funds will be arriving to the user's account. type: string example: ACH enum: - ACH - WIRE - BULK_FUNDING - CASH_PROMOTION - CASH_TRANSFER iraContribution: description: The type of contribution deposit for retirement accounts. type: string example: CURRENT_YEAR enum: - CURRENT_YEAR - PRIOR_YEAR - ROLLOVER recurringFrequency: description: The recurring deposit frequency. type: string example: MONTHLY_FIRST enum: - BIWEEKLY - DAILY - MONTHLY - MONTHLY_FIRST - MONTHLY_MIDDLE - QUARTERLY settlementProfileID: description: >- A settlement profile identifier that links to a specific bank account for fund settlement. type: string example: settlement-profile-bank-account-1 externalBankName: description: The bank name of the linked account. type: string example: Bank of America externalBankAddress: description: The full address of the bank where the account is linked. type: string example: 222 Broadway, New York City, NY, 10038 externalBankCountry: description: The country of the bank where the account is linked. type: string example: USA accountHolderName: description: The full name of the user on the external bank account. type: string example: Justin Smith externalAccountHolderAddress: description: The home address of the linked account holder. type: string example: 15 Exchange Place, Jersey City, NJ, 07302 externalAccountHolderCountry: description: The country of the linked account holder. type: string example: USA recurringID: description: A unique identifier of the recurring deposit. type: string example: recurring_98be6652-6361-4d4c-905b-06e9ec38d060 username: description: The username of the user. type: string example: ttc.user.justin firstName: description: The first name of the user. type: string example: Justin lastName: description: The last (family) name of the user. type: string example: Smith email: description: The user's email address. type: string example: jj@drivewealth.dev firmName: description: The firm name. type: string example: Tendies Trading Company UserDetails: type: object properties: userID: $ref: '#/components/schemas/userID' username: $ref: '#/components/schemas/username' firstName: $ref: '#/components/schemas/firstName' lastName: $ref: '#/components/schemas/lastName' email: $ref: '#/components/schemas/email' parentIBID: type: object properties: id: $ref: '#/components/schemas/parentIBID' name: $ref: '#/components/schemas/firmName' wlpID: $ref: '#/components/schemas/wlpID' Account: type: object properties: id: description: The user's unqiue account identifier. type: string example: 8b8ba3fd-74dc-45dc-b2dc-7de683bd713c.1556222995391 accountNo: description: The user's unqiue account number, that is human readable. type: string example: DWBG000052 nickname: type: string example: Justin's Self Directed Account status: type: object properties: description: description: A custom description about status of the user's account. type: string example: Pending name: description: The status of the user's account. type: string example: PENDING accountType: description: The type of account that has been created. type: string example: LIVE accountManagementType: description: The type of account who has trading authority. type: string example: SELF enum: - SELF - ADVISORY - RIA_MANAGED - CUSTODIAL - CUSTODIAL_MANAGED - RESERVED tradingType: type: object properties: description: description: A custom description about the type of account. type: string example: Cash Account name: description: The type of trading ocurring in the account. type: string example: CASH enum: - CASH - MARGIN - CRYPTO leverage: description: The leverage that is applied to the user's account. type: number example: 1 commissionID: description: The unique identifier for the assiocated commission schedule. type: string example: 449d41b9-3940-41ff-b0e6-334adfb443f8 userID: description: The user's unique identifier. type: string example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 restricted: description: True, if the user is restricted from trading. type: boolean example: false goodFaithViolations: description: >- The amount of times that a user buy a security and sell it before paying for the inital purchase in full with settled funds. type: number example: 0 patternDayTrades: description: >- The amount of times that a user buy and sells the same security in the same day over a seven day period. type: number example: 0 freeTradeBalance: type: number example: 0 gfvPdtExempt: type: boolean example: false buyingPowerOverride: description: True, if buying power check turned off. type: boolean example: false bod: description: >- Beginning of Day Information, *⚠️ Only updated at the beginning of day, this information will not change interaday.* type: object properties: moneyMarket: description: >- The amount of money the user's has in money market for this account. type: number example: 3028.98 equityValue: description: The value of the sum of all equities in the account. type: number example: 12071.5 cashAvailableForWithdrawal: description: The amount of money available for withdrawal. type: number example: 3028.98 cashAvailableForTrading: description: The amount of money available for trading. type: number example: 3028.98 updatedWhen: description: The date and time the dob job was run. type: string example: '2022-12-12T21:13:12.391Z' cashBalance: description: The amount of settled cash in the account. type: number example: 3028.98 sweepInd: description: >- True, if the user's account cash is set to move into a bank sweep or money market account. type: boolean example: true interestFree: description: >- True, if the user will not be paid interest on the money in a bank sweep or money market account. type: boolean example: false createdWhen: description: The createdWhen is the date and time the user's account was created. type: string example: '2022-12-11T22:28:21.810Z' updatedWhen: description: >- The updatedWhen is the last date and time the user's account was updated. type: string example: '2022-12-11T22:28:21.810Z' AccountDetails: description: A list of all the user's accounts at DriveWealth. type: array items: oneOf: - $ref: '#/components/schemas/Account' batch: type: boolean example: true transactionCodeType: type: string example: CSR enum: - CSR - CSD transactionCodeObject: type: object properties: description: description: A custom description about the transaction code. type: string example: Cash Receipt - ACH code: $ref: '#/components/schemas/transactionCode' type: $ref: '#/components/schemas/transactionCodeType' bankAccountCountry: description: The country where the user's external bank is located. type: string example: USA bankAccountNumberLastFour: description: The last four digits of the user's external bank account number. type: string example: '****3174' bankRoutingNumberLastFour: description: The last four digits of the user's external bank routing number. type: string example: '****0000' updatedBy: type: string example: SYSTEM enum: - SYSTEM REPORT SERVICE - INSTANT FUNDING BREAKDOWN JOB disclosureID: description: The id of a disclosure type: string format: uuid example: 31b087cc-4a74-41ad-b0f2-57acca333de6 disclosureName: description: The name of the disclosure type: string pattern: ^[a-zA-Z0-9_]+$ example: OPTIONS_AGREEMENT_V1 documentID: description: The id of a document type: string format: uuid example: 31b087cc-4a74-41ad-b0f2-57acca333de6 url: description: The url of the disclosure document type: string format: url example: >- https://dandbndiekfkx.cloudfront.net/xxxxcxxx-yyyy-zzzz-b0f2-57acca333de6.jpeg?Policy=eyJTdGF0ZW1lbnQiOiBbeyJSZXNvdXJjZSI6Imh0dHBzOi8vZG56cXZuMjgxazc0bS5jbG91ZGZyb250Lm5ldC8zMWIwOD obligation: description: Indicates the legal obligation of the disclosure type: string example: DELIVERY enum: - ACKNOWLEDGE - DELIVERY effectiveDate: description: Indicates the effective date of the disclosure type: string format: date pattern: yyyy-MM-dd example: '2023-06-14' product: description: The applicable product if the disclosure is product specific type: string example: EQUITY enum: - ALL - EQUITY - CRYPTO - MUTUAL_FUNDS - DRIVEHUB subProduct: description: >- The applicable sub product within the product if the disclosure is sub product specific type: string example: OPTIONS enum: - ALL - OPTIONS - REINVESTMENT - OMNI_OPTIONS - TERMS status: description: A disclosure can be active or no longer supported type: string example: ACTIVE enum: - ACTIVE - INACTIVE acknowledged: description: >- Indicates whether the end user acknowledged or declined the disclosure agreement type: boolean example: true signedAt: description: >- Timestamp of when the customer acknowledged or declined the disclosure agreement type: string format: timestamp example: '2023-06-14T15:07:24Z' Disclosure: type: object properties: version: $ref: '#/components/schemas/version' disclosureID: $ref: '#/components/schemas/disclosureID' name: $ref: '#/components/schemas/disclosureName' documentID: $ref: '#/components/schemas/documentID' url: $ref: '#/components/schemas/url' obligation: $ref: '#/components/schemas/obligation' effectiveDate: $ref: '#/components/schemas/effectiveDate' product: $ref: '#/components/schemas/product' subProduct: $ref: '#/components/schemas/subProduct' status: $ref: '#/components/schemas/status' created: $ref: '#/components/schemas/created' updated: $ref: '#/components/schemas/updated' Acknowledgment: type: object properties: disclosureID: $ref: '#/components/schemas/disclosureID' acknowledged: $ref: '#/components/schemas/acknowledged' signedAt: $ref: '#/components/schemas/signedAt' CreateAcknowledgmentInput: required: - disclosureID - signedAt - acknowledged $ref: '#/components/schemas/Acknowledgment' ListOfDisclosures: description: A list of disclosures type: object properties: disclosures: type: array items: $ref: '#/components/schemas/Disclosure' ListOfAcknowledgments: description: A list of disclosure acknowledgments type: object properties: acknowledgments: type: array items: $ref: '#/components/schemas/Acknowledgment' Exchange: type: object required: - id - exchangeNo - status - sellSymbol - sellOrderId - sellOrderNo - buySymbol - buyOrderId - buyOrderNo - sellAveragePrice - sellCumulativeQuantity - buyAveragePrice - buyCumulativeQuantity - amountCash - fees - createdBy - userID - accountID - accountNo - created - orderExpires properties: id: description: The specific id of the exchange type: string exchangeNo: description: The specific exchange number type: string status: description: The state of the exchange. type: string enum: - NEW - FILLED - REJECTED - PENDING_CANCEL - CANCELED sellSymbol: description: This will be the ticker of the mutual fund you will be liquidating type: string sellOrderId: description: The order ID corresponding to the sell transaction type: string sellOrderNo: description: The order number corresponding to the sell transaction type: string buySymbol: description: >- This will be the ticker of the mutual fund you will be purchasing with the proceeds of the liquidation type: string buyOrderId: description: The order ID corresponding to the buy transaction type: string buyOrderNo: description: The order number corresponding to the buy transaction type: string sellAveragePrice: description: The price the sell order was filled at. type: number sellCumulativeQuantity: description: The total quantity the sell was for. type: number buyAveragePrice: description: The price the buy order was filled at. type: number buyCumulativeQuantity: description: The total quantity the buy was for. type: number amountCash: description: >- This is the total notional amount you exchange from the sellSymbol to the buySymbol. type: integer fees: description: The total fees for both the buy and sell order of the exchange. type: integer createdBy: description: The user, who created the order. type: string userID: $ref: '#/components/schemas/userID' accountID: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' created: description: The timestamp the order was created. type: string example: '2019-03-29T20:00:00.000Z' orderExpires: description: The timestamp the exchange expires. type: string example: '2019-03-29T20:00:00.000Z' Bars: type: object properties: instrumentID: $ref: '#/components/schemas/instrumentID' compression: description: >- The compression value represents the time increments of the chart data. Refer to the compression table for the value descriptions. type: number example: 9 enum: - 0 - 1 - 4 - 8 - 9 - 10 dateStart: description: The start date of the chart data. type: string example: '2022-11-10T00:00:00Z' dateEnd: description: The end date of the chart data. type: string example: '2022-11-18T23:59:00Z' data: description: >- The `data` attribute holds each chart value separated by a pipe '|'. Each data set is preceded by the date, followed by the pricing data in the following order: Open, High, Low, Close, Volume. type: string example: >- 2022-11-10T15:00:00Z,86.87,87.96,86.78,87.91,95568|2022-11-10T16:00:00Z,87.875,87.96,86.9,87.36,107004|2022-11-10T17:00:00Z,87.41,88.09,87.27,88.03,85171|2022-11-10T18:00:00Z,88.03,88.12,87.755,87.755,44808|2022-11-10T19:00:00Z,87.74,88.35,87.74,88.28,45755|2022-11-10T20:00:00Z,88.27,88.47,88.12,88.46,44391|2022-11-10T21:00:00Z,88.44,88.98,88.4,88.79,177251|2022-11-11T15:00:00Z,89.15,90.22,89.13,90.19,65167|2022-11-11T16:00:00Z,90.15,91.68,89.81,91.35,122906|2022-11-11T17:00:00Z,91.47,91.51,90.01,90.26,60692|2022-11-11T18:00:00Z,90.22,90.31,89.895,90.28,34462|2022-11-11T19:00:00Z,90.28,90.9,90.28,90.9,33509|2022-11-11T20:00:00Z,90.93,91.44,90.91,91.38,72687|2022-11-11T21:00:00Z,91.37,91.37,90.7,90.79,123926|2022-11-14T15:00:00Z,90.11,90.62,89.97,90.23,28369|2022-11-14T16:00:00Z,90.4,90.62,90.02,90.45,50923|2022-11-14T17:00:00Z,90.47,90.63,90.05,90.33,37863|2022-11-14T18:00:00Z,90.4,90.9,90.27,90.86,34006|2022-11-14T19:00:00Z,90.85,91.345,90.85,91.345,28538|2022-11-14T20:00:00Z,91.33,91.35,90.7,90.77,40253|2022-11-14T21:00:00Z,90.72,90.85,89.79,89.82,52283|2022-11-15T15:00:00Z,91.06,91.83,90.77,91.49,67238|2022-11-15T16:00:00Z,91.5,91.69,91.06,91.06,67885|2022-11-15T17:00:00Z,91.01,91.35,90.9,90.97,36514|2022-11-15T18:00:00Z,91.02,91.06,90.68,90.89,33116|2022-11-15T19:00:00Z,90.88,90.96,89.39,90.03,68627|2022-11-15T20:00:00Z,89.99,90.82,89.82,90.585,71247|2022-11-15T21:00:00Z,90.63,90.71,90.2,90.485,81118|2022-11-16T15:00:00Z,90.22,90.34,89.81,89.89,34416|2022-11-16T16:00:00Z,89.915,90.31,89.42,89.43,55055|2022-11-16T17:00:00Z,89.43,89.83,89.08,89.83,40326|2022-11-16T18:00:00Z,89.82,90.08,89.6,89.86,24222|2022-11-16T19:00:00Z,89.77,89.77,89.56,89.56,22107|2022-11-16T20:00:00Z,89.54,89.82,89.47,89.77,28389|2022-11-16T21:00:00Z,89.75,89.91,89.43,89.82,65605|2022-11-17T15:00:00Z,88.6,88.76,87.58,87.58,27525|2022-11-17T16:00:00Z,87.56,88.24,87.53,87.83,77796|2022-11-17T17:00:00Z,87.81,88.46,87.78,88.43,49492|2022-11-17T18:00:00Z,88.59,89.06,88.52,89.05,25378|2022-11-17T19:00:00Z,89.07,89.07,88.75,88.78,21474|2022-11-17T20:00:00Z,88.79,88.9,88.56,88.68,27020|2022-11-17T21:00:00Z,88.66,88.97,88.37,88.95,62714|2022-11-18T15:00:00Z,90.27,90.28,89.49,89.55,21160|2022-11-18T16:00:00Z,89.57,89.57,89.16,89.21,44798|2022-11-18T17:00:00Z,89.23,89.46,89.06,89.17,28915|2022-11-18T18:00:00Z,89.18,89.18,88.6,88.82,38268|2022-11-18T19:00:00Z,88.85,89.23,88.81,88.94,19097|2022-11-18T20:00:00Z,89.0,89.39,89.0,89.2,45037|2022-11-18T21:00:00Z,89.19,89.53,88.96,89.23,93566 Instruments: type: array items: anyOf: - $ref: '#/components/schemas/InstrumentInList' - $ref: '#/components/schemas/DebtInstrumentDetails' InstrumentInList: type: object required: - id - status properties: id: $ref: '#/components/schemas/instrumentID' symbol: description: The ticker symbol of the associated Instrument. type: string example: MS name: description: The official name of the company associated to the Instrument. type: string example: Morgan Stanley enableExtendedHoursNotionalStatus: description: >- The Instrument's eligibility for extended hours notional trading. This will default to INACTIVE type: string example: INACTIVE instrumentType: $ref: '#/components/schemas/instrumentType' type: description: The classification of the Instrument. deprecated: true type: string example: EQUITY enum: - EQUITY - ETF - ETN - ADR - ALTERNATIVE_ASSET - MUTUAL_FUND - INTEREST_RATE status: description: The current status of the instrument. type: string example: ACTIVE enum: - ACTIVE - INACTIVE - CLOSE_ONLY - HALTED ISIN: $ref: '#/components/schemas/instrumentISIN' isOptionsEnabled: description: The ability to trade options for this equity instrument. type: boolean example: true default: false CUSIP: $ref: '#/components/schemas/instrumentCUSIP' payFrequency: $ref: '#/components/schemas/PayFrequency' couponRate: $ref: '#/components/schemas/CouponRate' maturityDate: $ref: '#/components/schemas/MaturityDate' spRating: $ref: '#/components/schemas/SpRating' bondType: $ref: '#/components/schemas/BondType' domicileCountry: $ref: '#/components/schemas/country' InstrumentBase: type: object properties: symbol: $ref: '#/components/schemas/instrumentSymbol' name: description: >- A friendly name of the Instrument, like the Company name for an equity type: string example: Morgan Stanley orderSizeMax: description: The maximum share amount for any order of this Instrument. type: number example: 20000 orderSizeMin: description: The minimum share amount for any order of this Instrument. type: number example: 0.1 orderSizeStep: description: Increment amount on order of this Instrument. type: number example: 0.01 id: $ref: '#/components/schemas/instrumentID' instrumentType: $ref: '#/components/schemas/instrumentType' exchange: description: The stock exchange the instrument is listed on. type: string example: NYQ status: $ref: '#/components/schemas/instrumentStatus' ISIN: $ref: '#/components/schemas/instrumentISIN' settlementDays: description: Number of days for the instrument to settle type: integer example: 1 OptionInstrumentBase: type: object properties: id: $ref: '#/components/schemas/instrumentID' symbol: description: The Option OSI symbol type: string example: AAPL220517P00016000 type: $ref: '#/components/schemas/instrumentType' name: description: >- A friendly name of the Instrument, like the Company name for an equity type: string example: Morgan Stanley exchange: description: The stock exchange the instrument is listed on. type: string example: NYQ orderSizeMax: description: The maximum share amount for any order of this Instrument. type: number example: 20000 orderSizeMin: description: The minimum share amount for any order of this Instrument. type: number example: 0.1 orderSizeStep: description: Increment amount on order of this Instrument. type: number example: 0.01 InstrumentsProperties: type: object properties: description: description: A comprehensive description of the Instrument in English. type: string example: >- Morgan Stanley is a global financial services company. The Company, through its subsidiaries, provides a range of investment banking, securities, wealth management and investment management services. Its segments include Institutional Securities, Wealth Management and Investment Management. Its Institutional Securities segment provides investment banking, sales and trading, and other services to corporations, governments, financial institutions and high net worth clients. Its Wealth Management segment provides financial services and solutions to individual investors and small-to-medium sized businesses and institutions covering: brokerage and investment advisory services; financial and wealth planning services; workplace services; annuity and insurance products; residential real estate loans and other lending products; banking; and retirement plan services. Its Investment Management segment provides a range of investment strategies and products to a diverse group of clients. reutersPrimaryRic: description: >- Reuters instrument code, or RIC, is a ticker-like code similar to the ticker symbol of a security. type: string example: MS marketTier: type: string example: Q enum: - Q - G sector: description: The categorization of the sector pertaining to the Instrument. type: string example: Financial Services enum: - Services - Industrials - Energy - Technology - Healthcare - Financial - Consumer Cyclical - Real Estate - Capital Goods - Utilities - Consumer Defensive - Basic Materials - Financial Services - Transportation - Communication Services industry: description: The categorization of the industry pertaining to the Instrument. type: string example: Retail (Apparel) enum: - Retail (Apparel) - Coal - Scientific & Technical Instr. - Biotechnology & Drugs - Business Services - Medical Equipment & Supplies - Oil & Gas Operations - Electronic Instr. & Controls - Misc. Financial Services - Software & Programming - Real Estate Operations - Aerospace & Defense - Water Utilities - Food Processing - Computer Services - Semiconductors - Auto & Truck Parts - Investment Services - Misc. Transportation - Construction - Raw Materials - Airline - Construction Services - Recreational Activities - Schools - Consumer Financial Services - Money Center Banks - Retail (Specialty) - Misc. Capital Goods - Apparel/Accessories - Oil Well Services & Equipment - Retail (Department & Discount) - Rental & Leasing - Constr. - Supplies & Fixtures - Fabricated Plastic & Rubber - Printing & Publishing - Fish/Livestock - Furniture & Fixtures - Retail (Grocery) - Healthcare Facilities - Major Drugs - Auto & Truck Manufacturers - Gold & Silver - Broadcasting & Cable TV - Misc. Fabricated Products - Chemical Manufacturing - Insurance (Prop. & Casualty) - Textiles - Non Apparel - Restaurants - Communications Equipment - Hotels & Motels - Computer Hardware - Footwear - Retail (Home Improvement) - Paper & Paper Products - Insurance (Life) - Personal & Household Prods. - Crops - Iron & Steel - Personal Services - Casinos & Gaming - Communications Services - Insurance (Miscellaneous) - Mobile Homes & RVs - Advertising - Trucking - Appliance & Tool - Constr. & Agric. Machinery - Metal Mining - Natural Gas Utilities - Audio & Video Equipment - Retail (Drugs) - Electric Utilities - Regional Banks - Railroads - Waste Management Services - Water Transportation - Recreational Products - Printing Services - Beverages (Nonalcoholic) - Office Supplies - Containers & Packaging - Chemicals - Plastics & Rubber - Forestry & Wood Products - Motion Pictures - Air Courier - Tobacco - Insurance (Accident & Health) - Computer Storage Devices - Beverages (Alcoholic) - Non-Metallic Mining - Tires - Security Systems & Services - Jewelry & Silverware trbc2012: type: string example: Apparel & Accessories Retailers (NEC) enum: - Apparel & Accessories Retailers (NEC) - Coal (NEC) - Heavy Electrical Equipment (NEC) - Biotechnology & Medical Research (NEC) - Management Consulting Services - Executive Search Services - Medical Equipment, Supplies & Distribution (NEC) - Oil & Gas Exploration and Production (NEC) - Oil & Gas Refining and Marketing (NEC) - Electronic Components - Bio Therapeutic Drugs - Investment Management & Fund Operators (NEC) - Enterprise Software - Entertainment Production (NEC) - Aerospace & Defense (NEC) - Biopharmaceuticals - Water Supply & Irrigation Systems - Fruit & Vegetable Processing - IT Services & Consulting (NEC) - Food Processing (NEC) - Photovoltaic Solar Systems & Equipment - Internet Gaming - Engine & Powertrain Systems - Commercial REITs (NEC) - Securities & Commodity Exchanges - Investment Banking & Brokerage Services (NEC) - Ground Freight & Logistics (NEC) - Online Services (NEC) - Social Media & Networking - Construction Materials (NEC) - Advanced Medical Equipment & Technology (NEC) - Airlines (NEC) - Construction & Engineering (NEC) - Gyms, Fitness and Spa Centers - Advertising & Marketing (NEC) - Miscellaneous Educational Service Providers - Transaction & Payment Services - Banks (NEC) - Real Estate Services (NEC) - Appliances, Tools & Housewares (NEC) - Apparel & Accessories (NEC) - Shell Companies - Oil Related Services and Equipment (NEC) - General Department Stores - Real Estate Rental, Development & Operations (NEC) - Iron & Steel (NEC) - Plastic Containers & Packaging - Professional Information Services (NEC) - Poultry Farming - Furniture - Business Support Services (NEC) - Gasoline stations - Display Screens - Internet & Mail Order Department Stores - Bio Diagnostics & Testing - Renewable Energy Equipment & Services (NEC) - Closed End Funds - Server & Database Software - Pharmaceuticals Wholesale - Consumer Leasing - Corporate Banks - Electric (Alternative) Vehicles - Non-Gold Precious Metals & Minerals (NEC) - Broadcasting (NEC) - Pest Control Services - Heavy Machinery & Vehicles (NEC) - Office REITs - Home Furnishings (NEC) - Financial Technology (Fintech) (NEC) - Semiconductors (NEC) - Agricultural Chemicals (NEC) - Commodity Chemicals (NEC) - Property & Casualty Insurance (NEC) - Commercial Printing Services (NEC) - Testing & Measuring Equipment - Integrated Circuits - Software (NEC) - Venture Capital - Integrated Hardware & Software - Blockchain & Cryptocurrency (NEC) - Auto Vehicles, Parts & Service Retailers (NEC) - Medical Diagnostic & Testing Equipment - Programming Software & Testing Tools - Industrial Machinery - Batteries & Uninterruptable Power supplies - Quick Service Restaurants - Auto, Truck & Motorcycle Parts (NEC) - Laboratory Diagnostic & Testing Substances - Phones & Smart Phones - Footwear (NEC) - Aircraft Parts Manufacturing - Home Improvement Products & Services Retailers (NEC) - Paper Mills & Products - Industrial REITs - Pharmaceuticals (NEC) - Investment Holding Companies (NEC) - Industrial Machinery & Equipment (NEC) - Industrial Equipment Rental - Personal Products (NEC) - Vegetable, Fruit & Nut Farming - Semiconductor Equipment & Testing (NEC) - Specialty Mining & Metals (NEC) - Biodiesel - Application Software - System Software - Travel Agents - Gold Mining - Casinos & Gaming (NEC) - Heating, Ventilation & Air Conditioning Systems - Handbags & Luggage - Restaurants & Bars (NEC) - Financial Information Providers - Child Care & Family Services - Life Insurance - Integrated Telecommunications Services (NEC) - Television Broadcasting - Consumer Repair Services - Education & Training Information Providers - Computer Hardware (NEC) - Machine Tools - Used Car Dealers - Insurance Brokers - Courier Services - Network Equipment - Prefabricated Homes - Consumer Credit Cards Services - Outdoor Advertising - Radio Broadcasting - Freight Trucking - Recreational Products (NEC) - Telemedicine Services - Communications & Networking (NEC) - Advanced Electronic Equipment - Oil Exploration & Production - Onshore - Residential Builders - Single Homes - Agricultural Machinery - Investment Banking - Uranium (NEC) - Building Contractors - Personal Services (NEC) - Silver Mining - Electrical Components & Equipment (NEC) - Security Software - Food Retail & Distribution (NEC) - Discount Stores (NEC) - Children's & Infants' Clothing Retailers - Oil & Gas Transportation Services (NEC) - Agricultural Biotechnology - E-commerce & Auction Services - Home Audio - Integrated Oil & Gas - Courier, Postal, Air Freight & Land-based Logistics (NEC) - Professional & Business Education - Paints & Coatings - Retail REITs - Frozen Food Manufacturing - Biomass & Waste to Energy Electric Utilities - Specialty Chemicals (NEC) - Employment Services (NEC) - Supermarkets & Convenience Stores - Commercial Aircraft Manufacturing - Healthcare Facilities & Services (NEC) - Multiline Utilities - Mortgage REITs - Memory Chips (RAM) - Scientific & Super Computers - Electric Utilities (NEC) - Environmental Services & Equipment (NEC) - Homebuilding (NEC) - Gambling & Gaming Machine Manufacturers - Women's Footwear - Petroleum Product Wholesale - Cruise Lines - Investment Management - Consumer Lending (NEC) - Sporting Goods Stores - Diversified REITs - Oil Related Equipment - Cryptocurrency Mining - Non-Alcoholic Beverages (NEC) - Toys & Children's Products (NEC) - Regional Airlines - Healthcare REITs - Satellite Design & Manufacture - Residential REITs - Hotels, Motels & Cruise Lines (NEC) - Diversified Chemicals - Business Support Supplies (NEC) - Passenger Car rental - Grain (Crop) Production - Paper Packaging (NEC) - Construction Supplies & Fixtures Wholesale - Sea-Borne Tankers - Household Products (NEC) - Highway & Bridge Construction - Hotels & Motels - Plastics - Sugar & Artificial Sweeteners - UK Investment Trusts - Pet Food Manufacturing - Self-Storage REITs - Retail - Drugs without Grocery - Medical Equipment Wholesale - Household Appliances - Optical Goods Stores - Dairy Products - Testing Laboratories - Natural Gas Distribution - Multiline Insurance & Brokers (NEC) - Stationary Fuel Cells - Special Foods & Wellbeing Products - Retail & Mortgage Banks - Specialized REITs (NEC) - Managed Healthcare (NEC) - Gaming Machine Operators - Personal Care Products Retailers - Technology Consulting & Outsourcing Services - Food Ingredients - Electronic Equipment & Parts (NEC) - Meat Processing - Office Real Estate Rental & Development - Portable Motors & Generators - Industrial Machinery & Equipment Wholesale - Sporting & Outdoor Goods - Private Equity - Corporate Financial Services (NEC) - Non-Paper Containers & Packaging (NEC) - Airport Operators - Agriculture Support Services - Trade & Business Publishing - Pump & Pumping Equipment - Cosmetics & Perfumes - Personal Care Services - Hospitals, Clinics & Primary Care Services - Power Charging Stations - Home Furnishings Retailers (NEC) - Tobacco (NEC) - Uranium Mining - Cable Service Providers - School, College & University (NEC) - Spacecraft Manufacturing - Financial & Commodity Market Operators & Service Providers (NEC) - Wireless Telecommunications Services (NEC) - Electric Scooters & Bicycles - Casinos - Sports & Outdoor Footwear - Waste Management, Disposal & Recycling Services - Broadcasting Equipment - New Car Dealers - Water & Related Utilities (NEC) - Proprietary & Advanced Pharmaceuticals - Residential Real Estate Rental & Development - Hedge Funds - Automotive Parts & Accessories Retailers - Property & Casualty Reinsurance - Miscellaneous Specialty Retailers (NEC) - Scientific & Precision Equipment - Doors & Window Frames - Coffee & Tea - Internet Security & Transactions Services - Veterinary Drugs - Generic Pharmaceuticals - Storage Devices - NFC & RFID Systems - Construction Machinery - Construction Supplies & Fixtures (NEC) - Renewable IPPs - Cloud Computing Services - Medical Equipment - Office Furniture - Brewers (NEC) - Heavy Machinery & Vehicles Wholesale - Hospitality REITs - Property Insurance - Medical Software & Technology Services - Metal Service Centers - Household Electronics (NEC) - Solar Electric Ultilities - Life & Health Insurance (NEC) - Aluminum (NEC) - Marine Freight & Logistics (NEC) - Doctor's Office - Commercial Food Services - Distillers & Wineries (NEC) - Petroleum Refining - Residential & Long-Term Care - Wealth Management - Market Research - Bio Medical Devices - Wireless Telecoms Service Providers - Lottery Operators - Semiconductor Testing Equipment & Service - Consumer Goods Conglomerates - Diversified Mining - Health Insurance - Rare Earth Minerals - Output Devices - Health Food Stores - Diversified Industrial Goods Wholesale - Alternative Medicine - Watches - Veterinary Medical Equipment & Supplies - Wires & Cables - Photographic Equipment - Movie Theaters & Movie Products - 3D Printers - Computer & Electronics Retailers (NEC) - Portable Satellite Navigation - Cement & Concrete Manufacturing - Iron, Steel Mills & Foundries - Automotive Batteries - Satellite Service Operators - Sailing Yachts & Motorboats - Arms & Ammunitions Manufacturing - Newspaper Publishing - Oil Pipeline Transportation - Alternative Electric Utilities - Commercial Leasing - Blockchain Technology (Software) - Food Wholesale - Bread & Bakery Product Manufacturing - Auto & Truck Manufacturers (NEC) - Drone Manufacturing - Nursery & Garden Centers - Oil & Gas Drilling (NEC) - Air Freight - Heavy Trucks - Snack Food & Non-chocolate Confectionary - Deep Sea Freight - Fertilizers - Personal & Car Loans - Medical & Diagnostic Laboratories - Forest & Wood Products (NEC) - Consumer Publishing (NEC) - Airport Operators & Services (NEC) - Diversified Investment Services - Carbonated Soft Drinks - Switchgear - Commodity Chemicals Wholesale - Welding & Soldering Equipment - Compliance & Investor Communication - Leisure & Recreation (NEC) - Online Job portals - Tires & Rubber Products (NEC) - Women's Apparel Retailers - Commercial Loans - Adventure Sports Facilities & Ski Resorts - Brokerage Services - Freight Logistics - Mobile Application Software - Book & Magazine Retailers - Copper Ore Mining - Cafés - Fire - Semiconductor Machinery Manufacturing - Wind Systems & Equipment - Ethanol Fuels - Lighting Fixtures - Toys & Games Retailers - Recreational Pharmaceuticals - Floor Covering Retailers - Industrial Valve Manufacturing - Energy Drinks - Search Engines - Electrical Transmission & Grid Equipment - Commercial Equipment - Pet & Pet Supplies Retailers - Natural Gas Utilities (NEC) - Glass Containers & Packaging - Cleaning Services - Footwear Wholesale - Cigars & Cigarette Manufacturing - Medical Monitoring Systems - Security & Surveillance - Consumer Goods Rental - Locomotive Engines & Rolling Stock - Home Healthcare Services - Medical Prosthetics - Residential Real Estate Services - Purification & Treatment Equipment - Maintenance & Repair Services - Timber REITs - Metal Containers & Packaging - Glasses, Spectacles & Contact lenses - Container & Packaging Material Wholesale - LNG Transportation & Storage - Heavy Buses & Coaches - Insurance - Automobile - Data Processing Services - Content & Site Management Services - Auto & Truck Parts Wholesale - Coke Coal Mining - Builder Merchants - Coloring Agents - Appliance & Houseware Wholesale - Nonferrous Metal Processing - Professional Sports Venues - Footwear Retailers - Discount Stores without Grocery - Amusement Parks and Zoos - Servers & Systems - Medical Devices & Implants - Life & Health Reinsurance - Kitchen Cabinets - Adhesive & Epoxy - Automotive Body Parts - Universities - Branding & Naming - Civil Engineers & Architects - Construction Supplies - Leisure Products Wholesale - Funeral Services - Oil Related Services - Natural Gas Pipeline Transportation - Motorcycles & Scooters - Sanitary Products - Medical Farming - Pubs, Bars & Night Clubs - Advertising Agency - Microfinancing - Independent Power Producers (NEC) - Accounting & Tax Preparation - Fishing & Farming (NEC) - Internet & Mail Order Discount Stores - Knitwear - Vegan & Vegetarian Food Manufacturing - Automotive Accessories - Industrial Components - Breakfast Cereal Manufacturing - Medical Supplies - Telecommunication Construction - Rating Agencies - Ball & Roller Bearings - Electrical Components - Gold (NEC) - Marketing Consulting Services - Auto & Truck Wholesale - Wineries - Outsourcing & Staffing Services - Chocolate & Confectionery - VOIP Services - Exhibition & Conference Services - Elevator & Conveying Equipment - Department Stores (NEC) - Land Division & Subdivision - Plays & Concert Production - Reinsurance (NEC) - Movie, TV Production & Distribution - Resort Operators - Computer Hardware & Software Retailers - Jewelry & Watch Retailers - Machine Learning & Artificial Intelligence (AI) Services - Interior Design Services - Wood Products - Entertainment Production Equipment & Services - Security Services - Drug Retailers (NEC) - Men's Apparel Retailers - Iron Ore Mining - Plumbing Fixtures & Fittings - Office Equipment (NEC) - Point of Sale Systems - Human Resources Consulting Services - Railway Freight Operators - Automobiles & Multi Utility Vehicles - Parking Lot Operators - Birth Control Products - Electric Power Plant Construction - Laser Equipment - Men's Clothing - Office Supplies & Stationery Stores - Industrial Gases - Bottled Water & Ice - Casualty Insurance - Fishing & Farming Wholesale - Sports & Outdoors Retailers - Carpets & Curtains - Unconventional Oil & Gas Production - Oil & Gas Storage - Geophysical Surveying & Mapping Services - Primary Aluminum Production - Power & Communications Network Construction - Yarn Goods - Pulp Mills - Inland Water Freight - Water & Sewage Construction - Electric Equipment Wholesale - Organic Farming - Medical Imaging Systems - Residential Builders - Multifamily Homes - Renewable Energy Services - Book Publishing indexMemberships: type: array example: - NASDAQ 100 Index - S&P 500 items: oneOf: - $ref: '#/components/schemas/indexMembers' incorporatedCountry: description: The country code of the incorporated company's Instrument. type: string example: USA enum: - USA - ARG - CYM - AUS - MEX - FRA - LUX - GBR - CAN - TWN - VGB - CHL - BMU - ISR - NLD - IND - IRL - ESP - DEU - BRA - ZAF - JPN - PRI - CHN - BHS - JEY - MHL - PAN - SWE - SGP - KOR - ITA - BGD - CHE - CUW - TUR - PER - IDN - CYP - DNK - BEL - COL - FIN - MUS - GGY - NOR - PHL - LBR - GRC isOptionsEnabled: description: >- The ability to trade options for this equity instrument. Default is false, meaning it is not possible to trade options for this instrument. type: boolean example: true longOnly: description: >- The ability to short an Instrument. Default is true, meaning it is not possible to short the instrument. type: boolean example: true exchangeNickelSpread: description: >- If true, a limit order for this Instrument must be in increments of $0.05 type: boolean example: false close: description: The most recent closing price of the Instrument. type: number example: 87.79 enableExtendedHoursNotionalStatus: description: >- The instruments eligibility for extended hours notional trading. This will default to INACTIVE. type: string example: INACTIVE fundamentalDataModel: $ref: '#/components/schemas/fundamentalDataModel' type: description: The classification of the Instrument. deprecated: true type: string example: EQUITY enum: - EQUITY - ETF - ETN - ADR - ALTERNATIVE_ASSET - MUTUAL_FUND url: description: URL for the investor site of the instrument. type: string example: http://investor.apple.com closePrior: description: The instruments closing price of the prior trading day. type: number example: 90.5 image: description: A publicly hosted image of the instruments logo. type: string example: http://syscdn.drivewealth.net/images/symbols/ms.png isPTP: description: True, if the Instrument is a publicly traded partnership (PTP). type: boolean example: false EquityInstrumentDetails: type: object allOf: - $ref: '#/components/schemas/InstrumentBase' - $ref: '#/components/schemas/InstrumentsProperties' fundamentalDataModel: type: object nullable: true properties: id: $ref: '#/components/schemas/instrumentID' symbol: $ref: '#/components/schemas/instrumentSymbol' openPrice: $ref: '#/components/schemas/openPrice' bidPrice: $ref: '#/components/schemas/bidPrice' askPrice: $ref: '#/components/schemas/askPrice' lowPrice: $ref: '#/components/schemas/lowPrice' highPrice: $ref: '#/components/schemas/highPrice' fiftyTwoWeekLowPrice: description: The lowest price of the instrument in the past 52 weeks. type: number example: 72.05 fiftyTwoWeekHighPrice: description: The highest price of the instrument in the past 52 weeks. type: number example: 109.73 cumulativeVolume: description: >- Cumulative Volume is a running total of daily trade volume. This measures the cumulative inflow and outflow of trading volume for the instrument. Measured in quantity of shares. type: number example: 3970567 marketCap: description: The total market cap of the instrument measured in USD. type: number example: 148374700000 peRatio: description: The Price-earnings ratio for the instrument. type: number example: 12.7434 dividendYield: description: >- The percentage of a company's share price that is payed out in dividends each year. type: number example: 3.5312 earningsPerShare: description: >- The earnings per share of the instrument measured in USD. EPS is company's profit divided by the outstanding shares of its common stock. type: number example: 6.889 dividend: description: The annual dividend amount paid out per share measured in USD. type: number example: 3.1 sharesOutstanding: description: >- The total shares outstanding for the instrument. Shares outstanding are all the shares of an instrument that have been authorized, issued and purchased by investors. type: number example: 1307993346 timeLastUpdate: description: The last time the instruments data was updated. type: string example: '18:28:00' bookValuePerShare: description: >- The book value per share of the instrument measured in USD. The BVPS is the ratio of equity available to common shareholders divided by the number of outstanding shares. type: string example: '59.49634' cashFlowPerShare: description: >- The cash flow per share measured in USD. Cash flow per share is the after-tax earnings plus depreciation on a per-share basis that functions as a measure of a firm's financial strength. type: string example: '10.40132' operatingIncome: description: >- The operating income of an instrument measured in USD. Operating income is an accounting figure that measures the amount of profit realized from a business's operations after deducting operating expenses such as wages, depreciation, and cost of goods sold. type: string example: '19668000000' pbRatio: description: >- The Price-to-Book ratio of the instrument measured USD per share. The Price-to-Bok ratio measures the market valuation of an Instrument relative to its book value. type: string example: '1.61196' volumeMovingAverage10Day: description: >- The volume moving average of the last 10 days for the instrument measured in quantity of shares. type: number example: 7791905 volumeMovingAverage25Day: description: >- The volume moving average of the last 25 days for the instrument measured in quantity of shares. type: number example: 6768708 volumeMovingAverage50Day: description: >- The volume moving average of the last 50 days for the instrument measured in quantity of shares. type: number example: 7307176 priceMovingAverage50Day: description: >- The price moving average of the last 50 days for the instrument measured in (USD) per share. type: number example: 85.3034 priceMovingAverage150Day: description: >- The price moving average of the last 150 days for the instrument measured in (USD) per share. type: number example: 83.6295 priceMovingAverage200Day: description: >- The price moving average of the last 200 days for the instrument measured in (USD) per share. type: number example: 84.3036 roe: description: >- Return on equity of the instrument measured as a fraction, multiply by 100 to get percentage value. ROE is a measure of financial performance calculated by dividing net income by shareholders' equity. type: string example: '0.15315' percentchangeWTD: description: >- The percentage change between the most recent market closing price and the closing price at the week start. type: number example: 2.31 percentchangeMTD: description: The price percentage change for the instrument Month to Date. type: number example: 2.3 percentchangeYTD: description: The price percentage change for the instrument Year to Date. type: number example: 10.11 percentchange4week: description: The price percentage change for the instrument in last 4 Weeks. type: number example: 21.22 percentchange13week: description: The price percentage change for the instrument in last 13 Weeks. type: number example: 6.67 percentchange26week: description: The price percentage change for the instrument in last 26 Weeks. type: number example: 8.26 percentchange52week: description: The price percentage change for the instrument in last 52 Weeks. type: number example: 12.1 percentchange5day: description: >- The 5 Day Price Percent Change is the percentage change in the company's stock price over the last 5 tradable (business) days. type: number example: 10.11 percentchangeYTDrelsnp: description: >- The percentage change in price since the close of the last trading day of the previous year as compared to the change in price of the S&P 500 during that same period. type: number example: 9.11 percentchange5weekrelsnp: description: >- The percentage change in price over the last four weeks as compared to the change in price of the S&P 500 during that same period type: number example: 16.62 percentchange13weekrelsnp: description: >- The percentage change in price over the last thirteen weeks as compared to the change in price of the S&P 500 during that same period type: number example: 5.67 percentchange26weekrelsnp: description: >- The percentage change in price over the last twenty six weeks as compared to the change in price of the S&P 500 during that same period. type: number example: 2.66 percentchange52weekrelsnp: description: >- The percentage change in price over the last fifty two weeks as compared to the change in price of the S&P 500 during that same period. type: number example: 11.12 DebtInstrumentDetails: type: object allOf: - $ref: '#/components/schemas/InstrumentBase' - $ref: '#/components/schemas/DebtReferenceData' ExpirationDateList: type: object properties: symbol: description: The Symbol of the underlying equity security. type: string example: AAPL expiration: description: The date the Option Contract will expire. type: array example: - '2022-05-10' - '2022-05-11' items: type: string OptionsList: type: object properties: symbol: description: Option OSI symbol type: string example: AAPL220517P00016000 options: type: array items: $ref: '#/components/schemas/OptionInstrumentBase' PayFrequency: description: >- The anticipated frequency of scheduled interest payments under the Bonds. type: string enum: - ANNUALLY - SEMI_ANNUALLY - QUARTERLY - MONTHLY - WEEKLY - DAILY - EVERY_X_DAYS - EVERY_X_MONTHS - EVERY_X_WEEKS - EVERY_X_YEARS - AT_MATURITY - SINGLE_DATE - SINGLE_INTEREST_PAYMENT - FLEXIBLE - NOT_APPLICABLE example: SEMI_ANNUALLY readOnly: true CouponRate: description: The annual rate of interest currently applicable to the instrument. type: number format: double example: 0.05 readOnly: true MaturityDate: description: >- The date on which the principal amount of the debt instrument becomes due. type: string format: date example: '2022-05-10' readOnly: true SpRating: description: The long term S&P Rating of the issuer. type: string example: AAA readOnly: true BondType: description: The type of bond. type: string enum: - OTHER - CORPORATE_BOND - GOVERNMENT/AGENCY_BOND - US_MUNICIPAL_BOND - COLLATERALIZED_MORTGAGE_OBLIGATION/ASSET-BACKED_SECURITY - MORTGAGE-BACKED_SECURITY - MONEY_MARKET - COMMON_EQUITY - PREFERRED_EQUITY - RIGHT - WARRANT - OPTION - FUTURE - SWAP - CURRENCY - COMMODITY - INDEX - MUTUAL_FUND/UNIT_INVESTMENT_TRUST - MONEY_MARKET_FUND - EXCHANGE_TRADED_FUND - HYBRID - NON-US_MORTGAGE-BACKED_SECURITY - COMPOSITE_UNIT - DEBT/EQUITY_HYBRID - STRATEGY - OVER-THE-COUNTER_(OTC) - BANK_LOAN - MBS_GENERIC example: CORPORATE_BOND readOnly: true DebtReferenceData: type: object properties: payFrequency: $ref: '#/components/schemas/PayFrequency' couponRate: $ref: '#/components/schemas/CouponRate' maturityDate: $ref: '#/components/schemas/MaturityDate' spRating: $ref: '#/components/schemas/SpRating' minimumInvestmentAmount: description: The minimum initial investment in the security. type: integer format: int64 example: 1000 readOnly: true incrementalInvestmentAmount: description: The minimum additional investment in the security. type: integer format: int64 example: 1000 readOnly: true issueDate: description: >- The date on which the instrument was first made available to the market. type: string format: date example: '2018-05-10' readOnly: true datedDate: description: The date of a Bond Issue from which Interest begins to accrue. type: string format: date example: '2018-05-10' readOnly: true issueAmount: description: The total value of the security at issue. type: number format: double example: 1000000 readOnly: true issuePrice: description: >- The nominal value associated with a financial instrument at the time of issuance. type: number format: double example: 100 readOnly: true accruedInterest: description: >- The amount of interest that has accumulated since the last coupon payment. type: number format: double example: 0.05 readOnly: true bondType: $ref: '#/components/schemas/BondType' debtType: description: The description for the type fixed income instrument. type: string enum: - NONE - BANK_LOAN - ASSET-BACKED_SECURITY_(ABS) - BOND - CERTIFICATE_OF_DEPOSIT_(CD) - DEMAND_NOTE - EMPLOYEE_STOCK_OWNERSHIP_PLAN_(ESOP) - FHLMC_REFERENCE_NOTES - GUARANTEED_INVESTMENT_CERTIFICATE_(GIC) - SCHULDSCHEIN - INCOME - MORTGAGE-BACKED_SECURITY_(MBS) - BANKER'S_ACCEPTANCE - COLLATERALISED_LOAN_OBLIGATION_(CLO) - COLLATERALIZED_MORTGAGE_OBLIGATION_(CMO) - NOTE - COLLATERALISED_BOND_OBLIGATION_(CBO) - COMMERCIAL_PAPER - PFANDBRIEF - PROMISSORY_NOTES - STRUCTURED_ASSETS - TRUST_CERTIFICATE - PARTICIPATION_UNIT - SAVINGS_BOND - PASS_THRU_CERTIFICATES - UNKNOWN - STRIP - ANNUITY - BILL - CERTIFICATE - DEPOSIT_NOTE - EQUIPMENT_TRUST_CERTIFICATE - FNMA_BENCHMARK_ISSUES - MORTGAGE/UK_DEBENTURE - SCHATZANWEISUNGEN - DISCOUNT_NOTE - PERMANENT_INTEREST_BEARING_SECURITY - OTHER_MONEY_MARKETS - LOAN_NOTE - MERCHANT_MARINE - MORTGAGE_NOTE - COLLATERALIZED_DEBT_OBLIGATION_(CDO) - PRIVATE_PLACEMENT - EXCHANGE_TRADED_NOTE - PREMIUM_BOND - SECURITY - UNIT - SAVINGS_NOTES - PARTICIPATION_CERTIFICATES - DISCOUNT_DEBENTURE - DEBENTURE_-_UNSECURED - EXCHANGE_TRADED_COMMODITY - ASSET-BACKED_COMMERCIAL_PAPER - SUKUK - DEBENTURE_-_SECURED - LETTER_OF_CREDIT - GLOBAL_DEPOSITORY_NOTE example: BOND readOnly: true coupon: $ref: '#/components/schemas/Coupon' issuer: $ref: '#/components/schemas/Issuer' Coupon: description: >- A coupon or coupon payment is the annual interest rate paid on a bond, expressed as a percentage of the face value and paid from issue date until maturity. type: object properties: couponType: description: The method by which the coupon rate of the instrument is determined. type: string enum: - UNKNOWN - SHORT_TERM_DISCOUNT - FIXED_RATE_-_UNCONFIRMED - ADJUSTABLE_RATE - ZERO_COUPON - FLOATING_RATE - INDEX_LINKED - STEPPED_COUPON - FIXED_RATE - STRIPPED_CONVERTIBLE - DEFERRED_INTEREST - FLOATING_RATE_@_FLOOR - STRIPPED_TAX_CREDIT - INVERSE_FLOATING - STRIPPED_COUPON_PRINCIPAL - LINKED_INVERSE_FLOATER - FLEXIBLE_RATE - ORIGINAL_ISSUE_DISCOUNT - STRIPPED_PRINCIPAL - RESERVE_CUSIP - VARIABLE_RATE - STRIPPED_COUPON - FLOATING_AUCTION_RATE - TAX_CREDIT - TAX_CREDIT_OID - STRIPPED_COUPON_PAYMENT - STEPPED_UP_STEPPED_DOWN - CREDIT_SENSITIVE - PAY_IN_KIND - RANGE - DIGITAL - RESET example: FIXED_RATE readOnly: true currentRateDate: description: The annual rate of interest currently applicable to the instrument. type: string format: date minLength: 0 maxLength: 10 example: '2018-05-10' readOnly: true dayCount: description: >- The method of calculating interest accrual associated with the instrument. type: string enum: - UNKNOWN_INTEREST_CALCULATION_METHOD - ACTUAL/ACTUAL - ACTUAL/360 - 30/360 - 30_DAYS_PER_MONTH_/_ACTUAL - ACTUAL/365_(FIXED) - CHANGEABLE - ACTUAL/365_(366_LEAP_YEAR_-_ISDA) - 30/360_(COMPOUNDED_INTEREST) - 30/365 - FUTURE_DATA_-_NOT_AVAILABLE - HISTORICAL_DATA_-_NOT_AVAILABLE - 30/360_(ICMA) - ACTUAL/365_(366_LEAP_YEAR) - ACTUAL/364 - BUS/252 - 365/365 - ACTUAL/ACTUAL_(ICMA) - 28/360 - 30/360_US - 30/360_US_(NASD) - 30/360_BMA - 30/360_(ISDA) - 30/360_IT - 30/360_SIA - 30E/360 - 30E/360_(ISDA) - 30E+/360 - NL/365_(NO_LEAP_YEAR) - 7/360 - 30/360_WITH_GROSS_UP - NOT_APPLICABLE example: 30/360 readOnly: true benchmark: description: >- The identifier the index against which the interest rate for an Index Linked Bond is reset. type: string example: US CPI readOnly: true benchmarkFormula: description: >- The multiple in the floating rate formula that is applied to the benchmark in order to calculate the reset rate on a floating rate instrument. type: string example: '1.5' readOnly: true nextResetDate: description: The date of the next interest rate reset of the instrument type: string format: date example: '2018-05-10' readOnly: true minimumRate: description: The minimum interest rate that an instrument will pay. type: number format: double example: 0.05 readOnly: true maximumRate: description: The maximum interest rate that an instrument will pay. type: number format: double example: 0.05 readOnly: true firstCouponDate: description: The date on which the first payment of interest is made. type: string format: date example: '2018-05-10' readOnly: true nextCouponDate: description: The next date on which a payment of interest will be made. type: string format: date example: '2018-05-10' readOnly: true finalCouponDate: description: >- The date on which the final interest payment is scheduled to be made to owners of the security. type: string format: date example: '2018-05-10' readOnly: true Issuer: description: >- The entity name (in the XML/Web Service) or organization_id (in the Database) of the insurer who has been contracted to provide payments to bondholders in the event of a default by the issuer. In the Database, the entity name can be looked up by using the organization_id in conjunction with the Organization_Master.primary_name field' type: object properties: primaryName: description: >- A field containing the root symbol assigned by an exchange to the derivative product. type: string example: Coca Cola Corp readOnly: true country: $ref: '#/components/schemas/country' domicileCountry: $ref: '#/components/schemas/country' FilterCriterion: type: object required: - field - operator - value1 properties: field: description: The name of the field to be filtered on. type: string example: spRating enum: - ISIN - CUSIP - payFrequency - couponRate - maturityDate - spRating - bidPrice - askPrice - askYieldToMaturity - bidYieldToMaturity - status - bondType - issuer.primaryName - issuer.domicileCountry - coupon.dayCount - coupon.couponType - coupon.nextCouponDate operator: description: >- Filters, operator`= equal to``!= not equal to``< less than``<= less than or equal to``> greater than``>= greater than or equal to``>< in between``() contains` type: string enum: - '=' - '!=' - < - <= - '>=' - '>' - '><' - () value1: description: The value of the field that should be filtered type: string example: AA value2: description: >- The value of the field that should be filtered. Should be provided when filtering ranges (between "><") type: string example: A FilterCriteria: description: >- The filter criteria, Criterion with different field names are ANDed. Criterion with same field names are ORed. type: array items: $ref: '#/components/schemas/FilterCriterion' indexMembers: description: The index members of the instrument. type: string example: S&P 500 enum: - TR Equity United States Index - S&P 600 Small Cap - S&P 500 - S&P 400 Mid Cap - NASDAQ 100 Index - Dow Transportation - Toronto SE 300 Composite Index - Dow Industry - TR Equity Israel Index - Safrica-JSE-FTSE-AllShare-Index - Shanghai SE Composite Index - Dow Utility - SX All Share PI Market Index - OSL All-share Index - CAC 40 Index - DAX Index - Swiss Market Index - FTSE 100 Index - FTSE All Share Index - Denmark-OMX-Copenhagen-All-Share-Index - ASE Main General Index country: description: The ISO standard country alpha-2 code. type: string example: US instrumentStatus: description: The current status of the instrument. type: string example: ACTIVE enum: - ACTIVE - INACTIVE - CLOSE_ONLY - HALTED openPrice: description: Most recent opening price of the instrument. type: number example: 86.53 bidPrice: description: The current price buyers are prepared to pay for a security. type: number example: 86.12 askPrice: description: The current price sellers are prepared to sell a security. type: number example: 85.14 lowPrice: description: The lowest price in the current trading day. type: number example: 85.83 highPrice: description: The highest price in the current trading day. type: number example: 86.85 CreateOrderRequest: type: object required: - accountNo - orderType - side properties: accountNo: description: The user's assiocated account number. type: string example: CSSW000001 orderType: description: >- The type of order that is being placed. For Options orders, only “LIMIT” orders will be supported type: string example: MARKET enum: - MARKET - LIMIT - STOP - MARKET_IF_TOUCHED limitType: description: >- Whether the limit price represents a unit price, or a yield. Only applicable to Orders for debt Instruments. type: string enum: - PRICE - YIELD example: PRICE symbol: $ref: '#/components/schemas/instrumentSymbol' side: description: >- Whether an order is to purchase or sell. Generally, the value should be set to `BUY` or `SELL`. For Options orders, `BUY_OPEN`, `BUY_CLOSE`, `SELL_OPEN`, `SELL_CLOSE` should be used. type: string example: BUY enum: - BUY - SELL - BUY_OPEN - BUY_CLOSE - SELL_OPEN - SELL_CLOSE instrumentID: $ref: '#/components/schemas/instrumentID' ISIN: $ref: '#/components/schemas/instrumentISIN' quantity: description: >- The unit quantity to purchase or sell. Required if `amountCash` is null. type: number format: double example: 5 amountCash: $ref: '#/components/schemas/amountCash' price: description: >- The price for non-`MARKET` Order types. This would be required if placing a `LIMIT`, `STOP`, or `MARKET_IF_TOUCHED` order. type: number format: double example: 160.12 currency: $ref: '#/components/schemas/currency' commission: description: >- A USD amount to charge as commission for an Order. This defaults to using an Account's assigned Commission Schedule if unset. For example, `4` will result in a $4.00 commission charge, regardless of the assigned Commission Schedule. type: number format: double example: 4 clientNotes: description: Client facing notes that can be added to a request. type: string example: Manual limit order. preventQueuing: description: >- If set to `true`, Orders received when the market is closed will not be queued for the next market open, and will be rejected. Please pay attention to the spelling of queuing as there are two valid spellings of this word. type: boolean example: false enum: - true - false extendedHours: description: >- Whether the order is eligible for Extended Hours Trading. The `timeInForce` must be set to `GTX` when this field is `true`. Only applicable to Equity Orders. type: boolean example: false enum: - true - false metadata: $ref: '#/components/schemas/metadata' timeInForce: description: >- Set to "GTC" for a good-til-canceled order. Set to "GTX" for extended hours orders. When this property is not set, market and limit orders will be good-for-day by default, while stops and market-if-touched orders will be assumed good-til-canceled. type: string example: GTC enum: - GTC - GTX - DAY - FILL_OR_KILL expiration: description: >- The date of expiration for a good-til-canceled order, in “YYYY-MM-DD” format. The order will be canceled if not executed by the market close on this date. If not set, a good-til-canceled Stop and MIT order will be assumed to expire 90 days after creation. If not set, a limit order will be considered GTD and will cancel at the end of the trading day. type: string format: date example: YYYY-MM-DD salesCredit: $ref: '#/components/schemas/SalesCredit' dccs: $ref: '#/components/schemas/dccs' taxLotDisposition: $ref: '#/components/schemas/LotDisposition' LotDisposition: type: array items: $ref: '#/components/schemas/TaxLot' CreateOrderResponse: type: object properties: orderId: description: A unique identifier for the order. type: string example: EF.418a5506-256c-4c3c-9d4d-f491522cf7f2 orderNo: description: A human readable order identifier. type: string example: EFXM000103 OrderStatusResponse: description: Order details for a fixed income asset trade type: object properties: id: description: Unique ID created when an order is placed. type: string example: EF.418a5506-256c-4c3c-9d4d-f491522cf7f2 orderNo: description: A human readable order identifier. type: string example: EFXM000103 type: description: The type of order placed. type: string example: MARKET side: {} status: $ref: '#/components/schemas/localOrderStatus' instrumentID: $ref: '#/components/schemas/instrumentID' ISIN: $ref: '#/components/schemas/instrumentISIN' CUSIP: $ref: '#/components/schemas/instrumentCUSIP' symbol: $ref: '#/components/schemas/instrumentSymbol' averagePrice: description: Average price of the security being transacted in the order. type: number format: double example: 160 currency: $ref: '#/components/schemas/currency' totalOrderAmount: description: Total amount paid for the order. type: number format: double example: 800 cumulativeQuantity: description: >- The number of shares currently being transacted. Larger orders may execute in chunks. E.g A BUY order of 1,000 shares may get filled in 5 executions of 200 orders. type: number format: double example: 5 quantity: description: Total number of shares the order is submitted for. type: number format: double example: 5 fees: description: Cost of the order. type: number format: double example: 0.01 ptpWithholdingFee: description: The publicly traded partnership (PTP) withholding fee for the order. type: number format: double example: 0.01 createdBy: description: userID of the individual creating the order. type: string example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 userID: description: userID of the account holder the order relates to. type: string example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 accountID: description: accountID for the account the order relates to. type: string example: cc07f91b-7ee1-4868-b8fc-823c70a1b932.1407776996299 accountNo: description: accountNo for the account the order related to. type: string example: CSSW000001 created: description: The time at which the order was created. type: string example: '2019-02-14T18:56:07.411Z' statusMessage: description: >- If the Order was unsuccessful, this object will be present with additional details regarding why. type: object properties: errorCode: description: A DriveWealth error code. type: object example: null message: description: Description of the error code. type: string example: null reason: description: A longer reason for the error. type: string example: null amountCash: description: Displays the cash amount requested for the order. type: number example: 800 OrderExpires: description: >- The date of expiration for a good-til-canceled order, in “YYYY-MM-DD” format. The order will be canceled if not executed by the market close on this date. If not set, a good-til-canceled Stop and MIT order will be assumed to expire 90 days after creation. If not set, a limit order will be considered GTD and will cancel at the end of the trading day. type: string example: null salesCredit: $ref: '#/components/schemas/SalesCredit' instrumentType: $ref: '#/components/schemas/instrumentType' dccs: $ref: '#/components/schemas/dccs' openQuantity: $ref: '#/components/schemas/openQuantity' availableForTradingQuantity: $ref: '#/components/schemas/availableForTradingQuantity' CancelOrder: type: object required: - method properties: method: description: The method in which is requested. type: string example: CANCEL enum: - CANCEL CancelOrderResponse: type: object properties: orderId: description: A unique identifier for the order. type: string example: EF.418a5506-256c-4c3c-9d4d-f491522cf7f2 orderNo: description: A human readable order identifier. type: string example: EFXM000103 RFQrequest: type: object required: - accountID - symbol - side - quotedCurrency - ipAddress properties: accountID: $ref: '#/components/schemas/accountID' symbol: description: The symbol of the cryptocurrency. type: string example: BTC side: $ref: '#/components/schemas/sideAbbreviated' quantity: $ref: '#/components/schemas/orderQuantity' amountCash: description: >- Order quantity in USD cash amount for "MARKET" and "STOP" order types. Only required if `quantity` is null. type: number example: null quotedCurrency: description: The currency symbol of the requested quote. Must be in USD. type: string example: USD ipAddress: description: IP address of the user that is sending this request. type: string example: '' RDQresponse: type: object properties: expires: description: The time at which the RFQ will expire yyyy-mm-dd. type: string example: '2019-06-12T23:59:59Z' id: description: A unique identifier associated with the quote. type: string example: 465c5ab3-f61d-4dcc-a799-9167173ac433 digitalAssetRequest: type: object properties: accountID: $ref: '#/components/schemas/accountID' type: description: Order type of the order being placed. type: string example: MARKET enum: - MARKET symbol: description: The symbol of the cryptocurrency. type: string example: BTC side: $ref: '#/components/schemas/sideAbbreviated' quantity: $ref: '#/components/schemas/orderQuantity' amountCash: description: >- Order quantity in USD cash amount for "MARKET" and "STOP" order types. Only required if `quantity` is null. type: number example: null quotedID: description: A unique identifier associated with the quote. type: string example: 465c5ab3-f61d-4dcc-a799-9167173ac433 ipAddress: description: IP address of the user that is sending this request. type: string example: '' digitalAssetResponse: type: object properties: orderID: $ref: '#/components/schemas/orderID' orderNO: $ref: '#/components/schemas/orderNo' openQuantity: description: >- The number of units currently represented by the position in the Account. type: number example: 1 availableForTradingQuantity: description: The number of units that can currently be traded by the Account holder. type: number example: 1 amountCash: description: The USD-denominated amount to purchase or sell. type: number format: double example: null localOrderStatus: description: The current status of the order. type: string example: FILLED enum: - NEW - FILLED - PARTIAL_FILL - REJECTED - CANCELED - PENDING_CANCEL side: description: The side of the order. type: string example: BUY enum: - BUY - SELL dccs: description: >- True, when the Mutual Fund HSA is classified as Defined Contribution Clearing and Settlement (DCC&S) order. type: boolean example: true OptionsLiquidationResponse: type: object properties: id: $ref: '#/components/schemas/orderID' orderNo: $ref: '#/components/schemas/orderNo' type: $ref: '#/components/schemas/orderTypes' side: $ref: '#/components/schemas/side' status: $ref: '#/components/schemas/localOrderStatus' instrumentID: $ref: '#/components/schemas/instrumentID' ISIN: $ref: '#/components/schemas/instrumentISIN' CUSIP: $ref: '#/components/schemas/instrumentCUSIP' symbol: $ref: '#/components/schemas/instrumentSymbol' averagePrice: description: The average price of the security being transacted in the order. type: number format: double example: 160 currency: $ref: '#/components/schemas/currency' totalOrderAmount: description: The total amount paid for the order. type: number format: double example: 800 cumulativeQuantity: description: The number of shares currently being transacted. type: number format: double example: 5 quantity: description: The total number of shares requested. type: number format: double example: 5 fees: description: The cost of the order. type: number format: double example: 0.01 ptpWithholdingFee: description: The publicly traded partnership (PTP) withholding fee for the order. type: number format: double example: 0.01 createdBy: $ref: '#/components/schemas/userID' userID: $ref: '#/components/schemas/userID' accountID: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' created: description: The time at which the order was created. type: string example: '2019-02-14T18:56:07.411Z' statusMessage: type: object properties: errorCode: description: The error code produced. type: object example: '0802' message: description: The description of the error code. type: string example: System market data unavailable reason: description: The reason for the error. type: string example: >- 0105 Order quantity exceeds quantity available for sale. Cannot SELL SHORT. null amountCash: description: The cash amount requested for the order. type: number example: 800 OrderExpires: description: The ending period of when the order will/has expired. type: string example: null salesCredit: $ref: '#/components/schemas/SalesCredit' instrumentType: $ref: '#/components/schemas/instrumentType' dccs: $ref: '#/components/schemas/dccs' openQuantity: $ref: '#/components/schemas/openQuantity' availableForTradingQuantity: $ref: '#/components/schemas/availableForTradingQuantity' partnerIBID: $ref: '#/components/schemas/parentIBID' partnerName: $ref: '#/components/schemas/wlpID' TaxLot: type: object properties: taxLotID: $ref: '#/components/schemas/taxLotID' from: description: A filter, the start date. type: string format: date pattern: yyyy-MM-dd example: '2022-12-25' to: description: A filter, the end date. type: string format: date pattern: yyyy-MM-dd example: '2022-12-26' UploadUserPhysicalDocument: type: object properties: id: $ref: '#/components/schemas/physicalDocumentID' type: $ref: '#/components/schemas/physicalDocumentTypes' status: $ref: '#/components/schemas/physicalDocumentStatusObject' side: $ref: '#/components/schemas/physicalDocumentSides' UploadUserPhysicalDocumentReq: type: object required: - userID - type - document properties: userID: $ref: '#/components/schemas/userID' type: $ref: '#/components/schemas/physicalDocumentTypes' document: $ref: '#/components/schemas/physicalDocumentBase64' side: $ref: '#/components/schemas/physicalDocumentSides' GetUserPhysicalDocumentByID: type: object properties: url: $ref: '#/components/schemas/physicalDocumentUrl' physicalDocumentTypes: description: The type of physical document. type: string example: DRIVER_LICENSE enum: - DRIVER_LICENSE - PASSPORT - NATIONAL_ID_CARD - VOTER_ID - WORK_PERMIT - VISA - RESIDENCE_PERMIT - ACATS_IN - ACATS_OUT - TRANSFER_ON_DEATH - BENEFICIARY_DOCUMENT physicalDocumentBase64: description: The Base64 encoded string of the document. type: string example: data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAASABIAAD/4QCMR maximum: 10 physicalDocumentSides: description: The actual side of the physical document. type: string example: FRONT physicalDocumentID: description: The unique identifier of the document. type: string example: 532e1b7d-09fd-4a1b-956f-d4e91ad71b4f physicalDocumentStatus: description: The current status of the physical document. type: string example: NOT_SUBMITTED enum: - NOT_SUBMITTED - PENDING - APPROVED - REJECTED physicalDocumentStatusObject: type: object properties: description: description: A custom description that describes the document current status. type: string example: Document has not been submitted for approval. name: $ref: '#/components/schemas/physicalDocumentStatus' physicalDocumentUrl: description: A Temporary Uniform Resource Locator (URL) to access the file. type: string example: >- https://d1gfu8yyntzl2k.cloudfront.net/532e1b7d-09fd-4a1b-956f-d4e91ad71b4f.jpeg?Policy=eyJTdGF0ZW1lbnQiOiBbeyJSZXNvdXJjZSI6Imh0dHBzOi8vZDFnZnU4eXludHpsMmsuY2xvdWRmcm9udC5uZXQvNTMyZTFiN2QtMDlmZC00YTFiLTk1NmYtZDRlOTFhZDcxYjRmLmpwZWciLCJDb25kaXRpb24iOnsiRGF0ZUxlc3NUaGFuIjp7IkFXUzpFcG9jaFRpbWUiOjE2NzIxNjA4MDl9LCJJcEFkZHJlc3MiOnsiQVdTOlNvdXJjZUlwIjoiMC4wLjAuMC8wIn19fV19&Signature=CB-NL9bncBFNCPZG3m6a7iTgTqvEpqMhY0UnutMl2ysCm1uDS8~zZpuINUioNv7caPeuwIVWJvVTSyZF863j58CPeRYxK2Hlrg4A-JO-nb9oL1nc91Wft2PkUM39WWJsvGWzwGv4nTVlhY~9yP3ZD277LGHKnTnMFFV~07dumA3E7EOR1ygMf8aHkvUecCsGuiH2SjGaCKtqi-fcvAXHx9uk21C3Oy5Z2e8EwQ2xX9cytmMASBwyspxPe~4h1zBDZGO47JBGrjhskTllK6wPcUXt6N8qu~iRsdYaZyPvw4w9MbH2CPj3L6dUChpUjYdC2btkzsAWfkXC08t5iQTUjA__&Key-Pair-Id=APKAJD7VLH4OKOE2R73Q NBBO: type: object properties: symbol: $ref: '#/components/schemas/instrumentSymbol' bid: $ref: '#/components/schemas/bidPrice' ask: $ref: '#/components/schemas/askPrice' open: $ref: '#/components/schemas/openPrice' high: $ref: '#/components/schemas/highPrice' low: $ref: '#/components/schemas/lowPrice' timeOffset: type: number example: 1671208571982 volume: description: >- The total trading volume of the security for the current day in quantity of shares. type: number example: 2779731 askSize: description: >- The ask size is the number of shares investors are trying to sell at a given price for a particular security. type: number example: 3 bidSize: description: >- The bid size is the number of shares investors are trying to buy at a given price for a particular security. type: number example: 4 change: description: >- The percentage change in trade price relative to the previous days close. type: number example: -1.33 lastTradeExchange: description: The last exchange the symbol was traded on. type: string example: DX bestBidExchange: description: The exchange that is offering the best bid for the current symbol. type: string example: 'N' bestAskExchange: description: The exchange that is offering best ask for the symbol. type: string example: Q lastTrade: description: The NBBO quote of the most recent trade. type: number example: 86.47 lastTradeSize: description: The quantity of shares of the last trade. type: number example: 2 marketCondition: description: The trading status of the symbol. type: string example: NORMAL enum: - NORMAL - TRADING_HALT - UNKNOWN tradeCount: description: >- The number of trades placed for the symbol during the current trading day. type: number example: 29565 close: description: >- The close price populated after market close, price updates overnight if a corporate action occurs. type: number example: 0 priorClose: description: The closing price of the current symbol for the prior trading day. type: number example: 86.86 Referential: type: array items: oneOf: - $ref: '#/components/schemas/EquityQuote' EquityQuote: type: object properties: symbol: $ref: '#/components/schemas/instrumentSymbol' bid: $ref: '#/components/schemas/bidPrice' ask: $ref: '#/components/schemas/askPrice' lastTrade: description: The NBBO quote of the most recent trade. type: number example: 86.47 change: description: >- The percentage change in trade price relative to the previous days close. type: number example: -1.33 open: $ref: '#/components/schemas/openPrice' high: $ref: '#/components/schemas/highPrice' low: $ref: '#/components/schemas/lowPrice' close: description: >- The close price populated after market close, price updates overnight if a corporate action occurs. type: number example: 0 priorClose: description: The closing price of the current symbol for the prior trading day. type: number example: 86.86 volume: description: >- The total trading volume of the security for the current day in quantity of shares. type: number example: 2779731 marketCondition: description: The trading status of the symbol. type: string example: NORMAL enum: - NORMAL - TRADING_HALT - UNKNOWN dataProvider: description: The exchange venue providing the quote type: string example: BATS BidPrice: description: Bid Price type: object example: bidPrice: 98.992 bidSize: 10000 bidYield: 4.799 minQty: 150 properties: bidPrice: description: Bid value type: number format: double example: 130.529 readOnly: true bidSize: description: Bid size type: number format: double example: 150 readOnly: true bidYield: description: Bid yield type: number format: double example: 4.799 readOnly: true minQty: description: Minimum quantity type: number format: double example: 150 readOnly: true AskPrice: description: Ask Price type: object example: askPrice: 98.992 askSize: 10000 askYield: 4.799 minQty: 150 properties: askPrice: description: Ask value type: number format: double example: 98.884 readOnly: true askSize: description: Ask size type: number format: double example: 150 readOnly: true askYield: description: Ask yield type: number format: double example: 4.793 readOnly: true minQty: description: Minimum quantity type: number format: double example: 150 readOnly: true RecentTrade: description: Recent Trade type: object properties: price: description: Trade price type: number format: double example: 98.884 quantity: description: Trade size/quantity type: number format: double example: 150 yield: description: Trade yield type: number format: double example: 4.793 dateTime: description: Asset's trade time. type: string format: date-time example: '2017-07-21T17:32:28Z' side: description: The side of order that is being placed. type: string example: sell enum: - buy - sell example: price: 98.992 size: 10000 yield: 4.799 side: buy dateTime: '2017-07-21T17:32:28Z' MarketQuoteRequest: description: Trade Quote Request for Fixed Income Securities type: object properties: instrumentID: $ref: '#/components/schemas/instrumentID' quantity: description: The quantity of bonds user wishes to trade. type: number format: double example: 3.14 minimum: 0 salesCredit: $ref: '#/components/schemas/SalesCredit' MarketQuoteResponse: description: Trade Quote Response for Fixed Income Orders type: object example: MarketQuoteResponseSuccess: id: bba6ecf0-9831-45ee-af0b-447077d82c2c instrumentID: f6d3e213-4e6f-4ee3-8a9a-793027c62c57 ISIN: US459058GX53 CUSIP: US6174464486 salesCredit: currency: USD amount: 14 bidPrices: - bidPrice: 98.992 bidSize: 10000 bidYield: 4.799 askPrices: - askPrice: 98.992 askSize: 10000 askYield: 4.799 minQty: 150 effectiveBidPrices: - bidPrice: 98.992 bidSize: 10000 bidYield: 4.799 minQty: 112 effectiveAskPrices: - askPrice: 98.992 askSize: 10000 askYield: 4.799 minQty: 150 recentTrades: - price: 98.992 size: 10000 yield: 4.799 side: buy dateTime: '2017-07-21T17:32:28Z' properties: id: description: Quote id in the DriveWealth System type: string format: uuid example: bba6ecf0-9831-45ee-af0b-447077d82c2c readOnly: true instrumentID: $ref: '#/components/schemas/instrumentID' ISIN: $ref: '#/components/schemas/instrumentISIN' readOnly: true CUSIP: $ref: '#/components/schemas/instrumentCUSIP' readOnly: true quantity: description: Trade size/quantity type: number format: double example: 150 salesCredit: $ref: '#/components/schemas/SalesCredit' bidPrices: description: bid prices without sales credit type: array items: $ref: '#/components/schemas/BidPrice' askPrices: description: ask prices without sales credit type: array items: $ref: '#/components/schemas/AskPrice' effectiveBidPrices: description: prices include any sales credit provided in the request type: array items: $ref: '#/components/schemas/BidPrice' effectiveAskPrices: description: prices include any sales credit provided in the request type: array items: $ref: '#/components/schemas/AskPrice' recentTrades: description: Recent Trades type: array items: $ref: '#/components/schemas/RecentTrade' DailyReconciliation: type: object properties: id: $ref: '#/components/schemas/reconciliationID' date: description: The date of when the reconciliation report was generated for. type: string example: '2022-12-25' status: $ref: '#/components/schemas/reconciliationStatus' statusComment: description: A custom comment about the status. type: string example: Finished processing breakdown totalAmount: description: The total amount due or owed to the firm. type: number example: 12001.01 created: description: The date and time the reconciliation report was created. $ref: '#/components/schemas/created' updated: description: The date and time the reconciliation report was last updated. $ref: '#/components/schemas/updated' updatedBy: $ref: '#/components/schemas/updatedBy' ListOfDailyReconciliations: description: A list of daily reconciliations for a firm. type: array items: oneOf: - $ref: '#/components/schemas/DailyReconciliation' ReconciliationUpdate: type: object properties: status: description: The status to update the reconciliation report to. type: string example: SUCCESSFUL enum: - SUCCESSFUL statusComment: description: A custom comment about the status. type: string example: Manually approving reconciliation for testing purposes. ReconciliationDetails: type: object properties: id: $ref: '#/components/schemas/reconciliationID' date: description: The date of when the reconciliation report was generated for. type: string example: '2022-12-25' status: $ref: '#/components/schemas/reconciliationStatus' statusComment: description: A custom comment about the status. type: string example: Finished processing breakdown amounts: type: object properties: total: description: The total amount due or owed to the firm. type: number example: -1263.56 purchases: description: >- The total amount in purchases of equity instruments, that are due to DriveWealth. type: number example: -1680.07 sales: description: >- The total amount in sales of equity instruments, that are owed to the firm. type: number example: 416.51 dividends: description: The total amount of dividends, that are owed to the firm. type: number example: 0 fees: description: The total amount of fees, that are due to DriveWealth. type: number example: 0 other: description: The total amount of other payments, that are owed to the firm. type: number example: 0 reconciliationBreakdown: type: string properties: JSON: description: >- A URL that contains the breakdown of all the transactions that are settling in the reconciliation report. type: string example: >- https://d3k101jzh5wilt.cloudfront.net/reconciliation_2e901d48-dd17-42fe-8225-32d2ca6b633e_20190322.json?Policy=eyJTdGF0ddiOiBbeyJSZXNvdXJjZSI6Imh0dHBzOi8vZDNrMTAxanpoNXdpbHQuY2xvdWRmcm9udC5uZXQvcmVjb25jaWxpYXRpb25fMmU5ffdasdamA17ggVl6C40gHkKsr2HLfmjTd9BevcYRPh-QDKA1J~76INZ3nfada4ROS6OUR66A%22 partnerID: $ref: '#/components/schemas/parentIBID' created: description: The date and time when the reconciliation report was created. $ref: '#/components/schemas/created' updated: description: The date and time when the reconciliation report was last updated. $ref: '#/components/schemas/updated' updatedBy: $ref: '#/components/schemas/updatedBy' reconciliationStatus: description: The current status of the reconciliation report. type: string example: APPROVED enum: - PENDING - APPROVED - PROCESSING - SUCCESSFUL - FAILED reconciliationID: description: The unique identifier of the reconciliation report. type: string example: 2b37a45d-341e-48a2-b838-0f9912ac8598_20220118 RecurringDeposit: type: object properties: id: $ref: '#/components/schemas/recurringID' currency: $ref: '#/components/schemas/currency' amount: description: The amount of the recurring deposit. type: number example: 1075.25 frequency: $ref: '#/components/schemas/recurringFrequency' bankAccountID: $ref: '#/components/schemas/bankAccountID' active: description: True, if the recurring deposit is active. type: boolean example: true nextDeposit: description: The date of when the next recurring deposit will be triggered. type: string example: '2019-01-15' depositHistory: description: A list of all the past deposit processed. type: array items: oneOf: - $ref: '#/components/schemas/DepositHistory' RecurringDepositUpdate: type: object properties: amount: description: The amount of the recurring deposit will be updated to. type: number example: 330.25 frequency: $ref: '#/components/schemas/recurringFrequency' RecurringDepositDeleteResponse: type: object properties: id: $ref: '#/components/schemas/recurringID' currency: $ref: '#/components/schemas/currency' amount: description: The amount of the recurring deposit. type: number example: 1075.25 frequency: $ref: '#/components/schemas/recurringFrequency' bankAccountID: $ref: '#/components/schemas/bankAccountID' active: description: True, if the recurring deposit is active. type: boolean example: false nextDeposit: description: The date of when the next recurring deposit will be triggered. type: string example: null depositHistory: description: A list of all the past deposit processed. type: array items: $ref: '#/components/schemas/DepositHistory' accountID: $ref: '#/components/schemas/accountID' userID: $ref: '#/components/schemas/userID' created: description: >- The date and time the recurring deposit was created for the user's external bank account. type: string example: '2022-12-11T22:28:21.810Z' updated: description: >- The date and time the recurring deposit was updated for the user's external bank account. type: string example: '2022-12-11T22:28:21.810Z' createdBy: description: The user identifier whom created the recurring deposit. type: string example: b25f0d36-b4e4-41f8-b3d9-9249e46402cd DepositHistory: type: object properties: depositID: $ref: '#/components/schemas/depositID' currency: $ref: '#/components/schemas/currency' status: $ref: '#/components/schemas/depositStatus' created: description: >- The date and time the recurring deposit was created for the user's external bank account. $ref: '#/components/schemas/created' updated: description: >- The date and time the recurring deposit was updated for the user's external bank account. $ref: '#/components/schemas/updated' createdBy: description: The user identifier whom created the recurring deposit. type: string example: b25f0d36-b4e4-41f8-b3d9-9249e46402cd metaAccountInfo: description: A custom message about the processing of the recurring deposit. type: string example: >- Automated DAILY recurring deposit for b25f0d3... |MyBank Premier Checking|****5204 WithdrawalFromUserAccount: type: object properties: id: $ref: '#/components/schemas/withdrawalID' accountNo: $ref: '#/components/schemas/accountNo' category: description: The category of the withdrawal. type: string example: REDEMPTION currency: $ref: '#/components/schemas/currency' amount: description: The amount of the withdrawal. type: number example: -560.36 status: $ref: '#/components/schemas/redemptionStatusObject' source: type: object properties: id: $ref: '#/components/schemas/withdrawalTypes' meta_info: $ref: '#/components/schemas/note' paymentRef: $ref: '#/components/schemas/withdrawalID' created: description: The date and time the when the withdrawal was created. type: string example: '2022-12-08T18:36:40.609Z' accountID: $ref: '#/components/schemas/accountID' userID: $ref: '#/components/schemas/userID' transactionCode: $ref: '#/components/schemas/transactionCode' wlpFinTranTypeID: $ref: '#/components/schemas/wlpFinTranTypeID' batch: description: True, if the withdrawal will be batched. type: boolean example: true account_number: $ref: '#/components/schemas/accountNo' WithdrawalFromUserAccountReq: type: object required: - accountNo - amount - currency - type - details properties: accountNo: $ref: '#/components/schemas/accountNo' amount: description: The amount of the withdrawal type: number example: 125.92 currency: $ref: '#/components/schemas/currency' type: $ref: '#/components/schemas/withdrawalTypes' bankAccountID: $ref: '#/components/schemas/bankAccountID' details: deprecated: true $ref: '#/components/schemas/withdrawalDetailsObject' iraDistribution: $ref: '#/components/schemas/iraDistribution' iraTaxWithholdings: $ref: '#/components/schemas/iraTaxWithHoldings' liquidate: description: >- True, if the account is a managed account and a full liquidation is requested from the user. type: boolean example: false note: $ref: '#/components/schemas/note' settlementProfileID: $ref: '#/components/schemas/settlementProfileID' WithdrawalByRedemptionID: type: object properties: id: $ref: '#/components/schemas/withdrawalID' category: $ref: '#/components/schemas/withdrawalCategories' currency: $ref: '#/components/schemas/currencyObject' status: $ref: '#/components/schemas/redemptionStatusObject' created: description: The date and time the redemption/withdrawal was created. $ref: '#/components/schemas/created' userDetails: $ref: '#/components/schemas/withdrawalUserDetails' accountDetails: $ref: '#/components/schemas/withdrawalAccountDetails' batch: $ref: '#/components/schemas/batch' transactionCode: $ref: '#/components/schemas/transactionCodeObject' statusHistory: description: A list of the status history of the withdrawal. type: array items: oneOf: - $ref: '#/components/schemas/withdrawalStatusHistoryObject' details: $ref: '#/components/schemas/withdrawalDetailsObject' wlpFinTranTypeID: $ref: '#/components/schemas/wlpFinTranTypeID' fees: description: A list of fees associated to the withdrawal. type: array items: oneOf: - $ref: '#/components/schemas/feeObject' note: $ref: '#/components/schemas/note' type: $ref: '#/components/schemas/withdrawalTypes' WithdrawalForTheFirm: type: object properties: id: $ref: '#/components/schemas/withdrawalID' paymentID: $ref: '#/components/schemas/withdrawalID' type: $ref: '#/components/schemas/withdrawalTypes' amount: description: The amount of the withdrawal type: number example: 125.92 currency: $ref: '#/components/schemas/currencyObject' status: $ref: '#/components/schemas/redemptionStatusObject' userDetails: $ref: '#/components/schemas/withdrawalUserDetails' accountDetails: $ref: '#/components/schemas/withdrawalAccountDetails' fees: description: A list of fees associated to the withdrawal. type: array items: oneOf: - $ref: '#/components/schemas/feeObject' wlpFinTranTypeID: $ref: '#/components/schemas/wlpFinTranTypeID' transactionCode: $ref: '#/components/schemas/transactionCodeObject' ListAllWithdrawalsForTheFirm: description: A list of all redemptions for the firm. type: array items: oneOf: - $ref: '#/components/schemas/WithdrawalForTheFirm' withdrawalStatus: description: The current status of the user's redemption/withdrawal. type: string example: PENDING enum: - STARTED - PENDING - SUCCESSFUL - FAILED - OTHER - RIA_PENDING - RIA_APPROVED - RIA_REJECTED - APPROVED - REJECTED - '-' withdrawalTypes: description: >- The method/form in which the redemption/withdrawal will be sent back to the user's external account. type: string example: ACH enum: - ACH - WIRE - CASH_TRANSFER - BULK_FUNDING withdrawalID: description: The unique identifier of the redemption/withdrawal. type: string example: ZYNN000001-1672169822525-RIUIN withdrawalUserDetails: type: object properties: userID: $ref: '#/components/schemas/userID' username: $ref: '#/components/schemas/username' firstName: $ref: '#/components/schemas/firstName' lastName: $ref: '#/components/schemas/lastName' email: $ref: '#/components/schemas/email' parentIBID: $ref: '#/components/schemas/parentIBIDObject' wlpID: $ref: '#/components/schemas/wlpID' withdrawalAccountDetails: type: object properties: accountID: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' accountType: $ref: '#/components/schemas/accountTypeObject' accountManagementType: $ref: '#/components/schemas/accountManagementTypeObject' withdrawalDetailsObject: type: object properties: beneficiaryName: description: The full name of the user at the external bank. type: string example: Justin Smith beneficiaryAccountNumber: description: The user's external bank account number. type: string example: '00257596002028990212396' beneficiaryAccountType: description: The user's external bank account type. type: string example: CHECKING enum: - CHECKING - SAVINGS beneficiaryRoutingNumber: description: The user's external bank account routing number. type: string example: '021000322' beneficiarySwiftABA: description: The user's external bank SWIFT code or ABA number. type: string example: BOFAUS3NXXX beneficiaryBankName: description: The user's external bank name. type: string example: Bank of America beneficiaryBankAddress: $ref: '#/components/schemas/beneficiaryBankAddress' beneficiaryBankCity: $ref: '#/components/schemas/beneficiaryBankCity' beneficiaryBankProvince: $ref: '#/components/schemas/beneficiaryBankProvince' beneficiaryBankZip: $ref: '#/components/schemas/beneficiaryBankZip' beneficiaryBankCountry: $ref: '#/components/schemas/beneficiaryBankCountry' intermediarySwift: description: >- The SWIFT code of the intermediary bank that is facilitating the international wire transfer. type: string example: CHASUS3AXXX intermediaryBankName: description: >- The full name of the intermediary bank that is facilitating the international wire transfer. type: string example: J.P Morgan Chase & Co. iraDistribution: description: The type of redemption/withdrawal from an IRA type of account. type: string example: PREMATURE enum: - PREMATURE - QUALIFIED - RMD deprecated: true iraTaxWithHoldings: type: object properties: federalTaxPercentage: description: The percentage amount that should be withheld for federal taxes. type: number example: 0.1 withdrawalCategories: description: The category of the withdrawal. type: string example: REDEMPTION withdrawalStatusNumber: description: The current status of the user's redemption/withdrawal in integer form. type: number example: 1 enum: - 1 - 2 - 3 - 4 - 11 - 12 - 13 - 14 - 15 - 16 - -1 withdrawalStatusHistoryObject: type: object properties: status: $ref: '#/components/schemas/withdrawalStatusNumber' statusMessage: $ref: '#/components/schemas/withdrawalStatus' created: description: The date and time the withdrawal move into this step. $ref: '#/components/schemas/created' updatedBy: $ref: '#/components/schemas/updatedBy' comment: description: >- A custom description that describes the current status of the redemption/withdrawal. type: string example: New redemption request from the back-office DailySettlementDetails: type: object properties: id: $ref: '#/components/schemas/settlementID' date: description: The date the settlement report was run for. $ref: '#/components/schemas/date' partnerID: $ref: '#/components/schemas/parentIBID' status: $ref: '#/components/schemas/settlementStatus' statusComment: description: A custom comment about the current status of the settlement. type: string example: Finished processing breakdown totalAmount: description: The total aggregated sum of instant deposit across sub accounts. type: number example: -14250 created: description: The date and time the settlement report was created. $ref: '#/components/schemas/created' updated: description: The date and time the settlement report was last updated. $ref: '#/components/schemas/updated' updatedBy: $ref: '#/components/schemas/updatedBy' category: $ref: '#/components/schemas/category' settlementProfileID: $ref: '#/components/schemas/settlementProfileID' ListDailySettlementDetails: description: A list of daily settlement details. type: array items: oneOf: - $ref: '#/components/schemas/DailySettlementDetails' SettlementUpdate: type: object properties: status: description: The status to update the settlement to. type: string example: SUCCESSFUL enum: - SUCCESSFUL statusComment: description: A custom comment about the current status of the settlement. type: string example: Updated settlement status for testing purposes. SettlementByID: type: object properties: id: $ref: '#/components/schemas/settlementID' date: description: The date the settlement report was run for. $ref: '#/components/schemas/date' category: $ref: '#/components/schemas/category' status: $ref: '#/components/schemas/settlementStatus' statusComment: description: A custom comment about the current status of the settlement. type: string example: Finished processing breakdown amount: type: object properties: total: description: The total amount due to DriveWealth, or owed to the firm. type: number example: 100 deposits: description: >- The total amount of deposits or withdrawals across sub accounts made on the settlement date. type: number example: 100 breakdown: type: object properties: JSON: description: >- A breakdown of all the deposits or withdrawals across sub accounts over the course of the settlement date. type: string example: >- https://d2qswopkglay13.cloudfront.net/ifaSettlementReport_f211f5bf-3ddd-49b9-94c6-d912946acb31_20210601.json?Policy=eyJTd GF0ZW1lbnQiOiBbeyJSZXNvdXJjZSI6Imh0dHBzOi8vZDJxc3dvcGtnbGF5MTMuY2xvdWRmcm9udC5uZXQvaWZhU2V0dGxlbWVu dFJlcG9ydF9mMjExZjViZi0zZGRkLTQ5YjktOTRjNi1kOTEyOTQ2YWNiMzFfMjAyMTA2MDEuanNvbiIsIkNvbmRpdGlvbiI6eyJEYXRlT GVzc1RoYW4iOnsiQVdTOkVwb2NoVGltZSI6MTYyNDU1Nzg2NH0sIklwQWRkcmVzcyI6eyJBV1M6U291cmNlSXAiOiIwLjAuMC4wL zAifX19XX0_&Signature=d7SmaaDK-WQyiJ6C0R70Ql75MiUynC0cXJE0X4kqjUeB9sxK8hXhmPWrqVHpP~sXFkbX10pDg8llCAsMBL1EEzmFi6BDIfTg6afNWRwr4a5xGzyOuAlA6xCjK4L3xVPhcKi99aN97VhyDx7fPFvXyXgxa4Qlua04XcjZmL0t0YCkxmoW5WyAy8iiO UDKMrTosLcEi~6F2BYwpY9F9mDRD2PQTec6bGUXI~6JNMGPbH9PH-1-ow-5vgpczfIb4dWRPoNROjSKZMnPZvJqFmtwmt6mfNE Y6wOIUzqqyylLgP-83rwCfPz7OzSdnwpAuyex9WTFOaocJ3dUIzcS2Wxp-w__&Key-Pair-Id=APKAJD7VLH4OKOE2R73Q transactions: type: object properties: total: description: >- The total number of deposits or withdrawals across sub accounts. type: string example: 2 failed: description: >- The total of failed deposits or withdrawals across sub accounts. type: string example: 0 succeeded: description: >- The total amount of successful deposits or withdrawals across sub accounts. type: string example: 2 partnerID: $ref: '#/components/schemas/parentIBID' created: description: The date and time of when the settlement report was created. $ref: '#/components/schemas/created' updated: description: The date and time of when the settlement was last updated. $ref: '#/components/schemas/updated' updatedBy: $ref: '#/components/schemas/updatedBy' settlementProfileID: $ref: '#/components/schemas/settlementProfileID' CreateDVPRVP: type: object required: - tradeDate properties: tradeDate: description: The date to generate the DVP/RVP report for. type: string format: date example: '2021-06-04' pattern: yyyy-MM-dd note: $ref: '#/components/schemas/note' CreateDVPRVPRes: type: object properties: id: description: The DVP/RVP report identifier. type: string example: bsr_040fb9cc-84e8-4f20-bf09-d398dacd458d.1622745430469_20210604 accountID: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' tradeDate: description: The date for which the DVP/RVP was run for. type: string format: date example: '2021-06-04' pattern: yyyy-MM-dd note: $ref: '#/components/schemas/note' partnerID: $ref: '#/components/schemas/partnerID' DVPRVPStatus: type: string example: Processing enum: - Processing - Successful DVPRVP: type: object properties: id: description: The DVP/RVP report identifier. type: string example: bsr_040fb9cc-84e8-4f20-bf09-d398dacd458d.1622745430469_20210604 tradeDate: description: The date for which the DVP/RVP was run for. type: string format: date example: '2021-06-04' pattern: yyyy-MM-dd status: description: The status of the generated report. type: string example: SUCCESSFUL enum: - PROCESSING - SUCCESSFUL note: $ref: '#/components/schemas/note' partnerID: $ref: '#/components/schemas/partnerID' created: $ref: '#/components/schemas/created' updated: $ref: '#/components/schemas/updated' updatedBy: $ref: '#/components/schemas/updatedBy' source: description: The method type in which the report was generated. type: string example: MANUAL enum: - MANUAL - SYSTEM ListDVPRVP: type: array items: oneOf: - $ref: '#/components/schemas/DVPRVP' DVPRVPDetails: type: object allOf: - $ref: '#/components/schemas/DVPRVP' - type: object properties: amount: type: object properties: totalBuy: type: object properties: quantity: description: The amount of shares that were purchased. type: number example: 10.71358941 notional: description: The total amount in USD value of the instruments. type: number example: 144.26 orders: description: >- The total amount of orders assiocated to the amount of shares purchased. type: number example: 30 totalSell: type: object properties: quantity: description: The amount of shares that were sold. type: number example: 0 notional: description: The total amount in USD value of the instruments. type: number example: 0 orders: description: >- The total amount of orders assiocated to the amount of shares sold. type: number example: 0 breakdownJson: description: >- A json file of the trade breakdown of all the purchases and sale transactions. type: string format: url example: https://du2c4wzqz90h1.cloudfront.net/buySellTradesReport.... category: type: string example: DEPOSIT enum: - DEPOSIT - WITHDRAWAL settlementID: description: The unique identifier that identifies the settlement report. type: string example: DP_63ccb073-a7b6-4b33-af77-5baec5cc4494_20220118 date: description: '' type: string example: '2022-12-25' settlementStatus: description: The current status of the settlement report. type: string example: APPROVED enum: - PENDING - APPROVED - PROCESSING - SUCCESSFUL - FAILED UserGeneratedAccountDocument: type: object properties: accountID: $ref: '#/components/schemas/accountID' url: $ref: '#/components/schemas/accountDocumentUrl' fileKey: description: A unique identifier for the specific account document. type: string example: '2022122502' accountDocumentUrl: description: A Temporary Uniform Resource Locator (URL) to access the file. type: string example: >- https://dzb6emi8pracf.cloudfront.net/5a013513-8af1-4078-be75-36a5250953f7.1488219178676/Stmt_DRVW_001_DWJM000019_Apr2017.pdf?Policy=eyJTdGF0ZW1lbnQiOiBbeyJSZXNvdXJjZSI6Imh0dHBzOi8vZHpiNmVtaThwcmFjZi5jbG91ZGZyb250Lm5ldC81YTAxMzUxMy04YWYxLTQwNzgtYmU3NS0zNmE1MjUwOTUzZjcuMTQ4ODIxOTE3ODY3Ni9TdG10X0RSVldfMDAxX0RXSk0wMDAwMTlfQXByMjAxNy5wZGYiLCJDb25kaXRpb24iOnsiRGF0ZUxlc3NUaGFuIjp7IkFXUzpFcG9jaFRpbWUiOjE0OTk3MTc1NDV9LCJJcEFkZHJlc3MiOnsiQVdTOlNvdXJjZUlwIjoiMC4wLjAuMC8wIn19fV19&Signature=UWZRPku4IWoqkp4fyQ179auFVrImZUYDXswjjO-zPGW9-XKno3-TG9O2OHxWG-j7NfEHMXtZbCha~lQwpjt~g58YpL1NYk9xhlp7~HR-skC3J3W8GFVWxbR5TQUXPFOdU-KNwYlTnlE1Wr81nUyoNWrrF-8afyiHVnfm2w35GpZavAKhOiKNDHn7kTorQz3rbkYDks9u1CGPU7TCeZ-GzupVqsUN7xDOxPUnH0KCVGY86PT8bEpPkhpc3jNmtLnB~WB3YdrFg0bSbrbU4M-sVyp49AqK~xq5uDu3Bx22vdyJlKUClEsVvKhQLOArkpMdHYwyPZC~Kz85sroGqnP3oQ__&Key-Pair-Id=APKAJP3MFGZ6DRA4CW4Q SubscriptionRequest: type: object required: - accountID - bankAccountID - planID properties: accountID: $ref: '#/components/schemas/accountID' bankAccountID: $ref: '#/components/schemas/bankAccountID' planID: description: The unique identifier that identifies the plan schedule. type: string example: plan_1d3e1630-9107-47c2-a9c4-6cca93821cb7 Subscription: type: object properties: subscriptionID: $ref: '#/components/schemas/subscriptionID' subscriptionID: description: The unique identifier that identifies the user's subscription. type: string example: subscription_4451b62e-0e88-46ce-9eab-f0a54ccdc599 BankAccount: type: object properties: id: $ref: '#/components/schemas/bankAccountID' bankAccountDetails: type: object properties: bankAccountNickName: $ref: '#/components/schemas/bankAccountNickName' bankAccountNumber: $ref: '#/components/schemas/bankAccountNumberLastFour' bankRoutingNumber: $ref: '#/components/schemas/bankRoutingNumber' default: description: True, if this is the default bank account set by the customer. type: string example: true status: $ref: '#/components/schemas/bankAccountStatus' created: description: The date and time the User's bank account was linked. $ref: '#/components/schemas/created' updated: description: The date and time the User's bank account was updated. $ref: '#/components/schemas/updated' UsersReq: required: - userType - documents type: object properties: userType: $ref: '#/components/schemas/userType' wlpID: description: >- The wlpID is a deep backoffice ID that identifies each partner from each other. *⚠️ Only require to pass if your existing partner before **10/1/22**. type: string example: TTCC deprecated: true parentIBID: description: >- The parentIBID is a identifier that identifies a partners different business segments. *⚠️ Only require to pass if your existing partner before **10/1/22**. type: string example: 95c98ed5-e29e-4d55-90bf-8898fcf6af85 deprecated: true documents: description: The personal identifiable information & digital signatures. type: array items: anyOf: - $ref: '#/components/schemas/Basic_Info' - $ref: '#/components/schemas/Identification_Info' - $ref: '#/components/schemas/Tax_Info' - $ref: '#/components/schemas/Personal_Info' - $ref: '#/components/schemas/Address_Info' - $ref: '#/components/schemas/KYCVerificationInfo' - $ref: '#/components/schemas/Employment_Info' - $ref: '#/components/schemas/Investor_Profile_Info' - $ref: '#/components/schemas/Disclosures' - $ref: '#/components/schemas/MarginDisclosure' - $ref: '#/components/schemas/CustodianInfo' - $ref: '#/components/schemas/DirectorInfo' - $ref: '#/components/schemas/InstitutionalInfo' - $ref: '#/components/schemas/TrustInfo' metadata: description: >- The metadata object allows for creating a maximum of 5 keys (max 36 characters) and each value cannot exceed more than 128 bytes. type: object example: myCustomKey: myCustomValue KYCVerificationInfo: type: object properties: type: type: string example: KYC_VERIFICATION_INFO data: type: object properties: verification: type: string example: APPROVED enum: - APPROVED - FAILED verificationIDType: type: string example: DRIVER_LICENSE enum: - DRIVER_LICENSE - NATIONAL_ID - RESIDENCE_PERMIT - PASSPORT - VISA - TAX_ID - VOTER_ID - WORK_PERMIT - TRUST - TRUST_CORP - CORPORATE verificationFullName: description: >- The name of the customer that was passed during the KYC verification. type: string example: Justin Smith verificationTimestamp: description: >- The ISO 8601 timestamp of when the KYC verification was completed by the partner. type: string example: '2022-12-22T16:04:46.724Z' verificationTransactionID: description: >- A unique identifier passed to reference the KYC verification was completed by the partner. type: string example: '' customField1: example: customFieldValue1 customField2: example: customFieldValue2 customField3: example: customFieldValue3 customField4: example: customFieldValue4 customField5: example: customFieldValue5 TrustInfo: type: object properties: type: type: string example: TRUST_INFO data: type: object properties: name: description: The name of the trust. type: string example: Justin's Trust dateEstablished: description: The inception date of the trust. type: string example: '2014-09-29' stateEstablished: description: The state or provience where the trust was established. type: string example: NJ street1: description: The physical street address where the institution is located. type: string example: 15 Exchange Place street2: type: string example: Unit 1100 city: description: The institutuion physical city. type: string example: NJ provience: description: The institutuion physical state or province. type: string example: New Jersey postalCode: description: The institutuion physical postal or zip code. type: string example: '07302' primaryTrusteeAuthority: description: The permissions the primary trustee has over the trust. type: string example: TRUSTEE_ONLY enum: - TRUSTEE_ONLY - TRUSTEE_AND_GRANTOR - MODIFY_TRUSTEES - MODIFY_TRUST tin: description: The tax identification number of the trust. type: string example: '123456789' MarginDisclosure: type: object properties: type: type: string example: MARGIN_DISCLOSURE data: type: object properties: marginAgreement: description: A User's acceptance of DriveWealth's Margin Agreement. type: boolean example: true CustodianInfo: type: object properties: type: type: string example: CUSTODIAN_INFO data: type: object properties: userID: $ref: '#/components/schemas/userID' DirectorInfo: type: object properties: type: type: string example: DIRECTOR_INFO data: type: object properties: directorList: type: array oneOf: - $ref: '#/components/schemas/directors' items: description: >- WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema. directors: type: object properties: title: description: The title of the director. type: string example: Chief Innovation Officer controlContact: description: True, if the director has control over the account. type: boolean example: true institutionalID: description: >- The unique identifier of the institution director should assioacted with.. type: string example: fa1336af-02a3-2a82-d1a8-ccf11ecea398 InstitutionalInfo: type: object properties: type: type: string example: INSTITUTIONAL_INFO data: type: object properties: physicalAddressLine1: description: The physical street address where the institution is located. type: string example: 15 Exchange Place physicalAddressLine2: type: string example: Unit 1100 physicalCity: description: The institutuion physical city. type: string example: Jersey City physicalStateProvince: description: The institutuion physical state or province. type: string example: New Jersey physicalZipPostalCode: description: The institutuion physical postal or zip code. type: string example: '07302' physicalCountryID: description: The institutuion physical country of origin. type: string example: USA companyOrganizedAs: description: The institutuion orginizational structure. type: string example: LLC enum: - NON_CORP - INC - CLUB - LLC - LLLP - LLP - LP - PARTNERSHIP - SOLE_PROPRIETOR usaBranch: description: >- True, if the institutuion is registered in side of the United States. type: boolean example: true foreignBank: description: True, if the institution is a foreign bank. type: boolean example: false foreignFinancialInstitution: description: >- True, if the institution is maintained for a foreign finanical institution. type: boolean example: false directorCount: description: The number of directors to be added to institutional account. type: number example: 15 Basic_Info: type: object required: - type - data properties: type: description: The type of data object. type: string example: BASIC_INFO enum: - BASIC_INFO - IDENTIFICATION_INFO - TAX_INFO - PERSONAL_INFO - ADDRESS_INFO - EMPLOYMENT_INFO - INVESTOR_PROFILE_INFO - DISCLOSURES - MARGIN_DISCLOSURE - CUSTODIAN_INFO - DIRECTOR_INFO - INSTITUTIONAL_INFO - TRUST_INFO data: type: object required: - firstName - lastName - country - phone - emailAddress - language properties: firstName: $ref: '#/components/schemas/firstName' lastName: $ref: '#/components/schemas/lastName' country: description: The country where the User is residing. type: string example: USA phone: $ref: '#/components/schemas/phoneNumber' emailAddress: $ref: '#/components/schemas/email' language: $ref: '#/components/schemas/language' Identification_Info: type: object required: - type - data properties: type: description: The type of data object. type: string example: IDENTIFICATION_INFO enum: - BASIC_INFO - IDENTIFICATION_INFO - TAX_INFO - PERSONAL_INFO - ADDRESS_INFO - EMPLOYMENT_INFO - INVESTOR_PROFILE_INFO - DISCLOSURES - MARGIN_DISCLOSURE - CUSTODIAN_INFO - DIRECTOR_INFO - INSTITUTIONAL_INFO - TRUST_INFO data: type: object required: - value - type - citizenship - usTaxPayer properties: value: $ref: '#/components/schemas/userTaxID' type: $ref: '#/components/schemas/userTaxIDType' citizenship: description: The country where the User has citizenship. $ref: '#/components/schemas/userCountry' usTaxPayer: description: True, the User is a United States tax payer. type: boolean example: true Tax_Info: type: object required: - type - data properties: type: description: The type of data object. type: string example: TAX_INFO enum: - BASIC_INFO - IDENTIFICATION_INFO - TAX_INFO - PERSONAL_INFO - ADDRESS_INFO - EMPLOYMENT_INFO - INVESTOR_PROFILE_INFO - DISCLOSURES - MARGIN_DISCLOSURE - CUSTODIAN_INFO - DIRECTOR_INFO - INSTITUTIONAL_INFO - TRUST_INFO data: type: object required: - taxTreatyWithUS properties: taxTreatyWithUS: description: >- True, if the User's country has a tax treaty with the United States. type: boolean example: true Personal_Info: type: object required: - type - data properties: type: description: The type of data object. type: string example: PERSONAL_INFO enum: - BASIC_INFO - IDENTIFICATION_INFO - TAX_INFO - PERSONAL_INFO - ADDRESS_INFO - EMPLOYMENT_INFO - INVESTOR_PROFILE_INFO - DISCLOSURES - MARGIN_DISCLOSURE - CUSTODIAN_INFO - DIRECTOR_INFO - INSTITUTIONAL_INFO - TRUST_INFO data: type: object required: - birthDay - birthMonth - birthYear - politicallyExposedNames properties: birthDay: description: The User's born day. type: number example: 3 birthMonth: description: The User's born month. type: number example: 12 birthYear: description: The User's born year. type: number example: 2000 politicallyExposedNames: description: >- The names of the people whom are political exposes, separated by a comma. type: string example: Nancy Pelosi irsBackupWithholdings: description: True, if the type of account will be a retirement account. type: boolean example: false gender: description: The gender of the User. type: string example: Male enum: - Male - Female martial: $ref: '#/components/schemas/userMartialStatus' Address_Info: type: object required: - type - data properties: type: description: The type of data object. type: string example: ADDRESS_INFO enum: - BASIC_INFO - IDENTIFICATION_INFO - TAX_INFO - PERSONAL_INFO - ADDRESS_INFO - EMPLOYMENT_INFO - INVESTOR_PROFILE_INFO - DISCLOSURES - MARGIN_DISCLOSURE - CUSTODIAN_INFO - DIRECTOR_INFO - INSTITUTIONAL_INFO - TRUST_INFO data: type: object required: - street1 - city - province - postalCode - country properties: street1: $ref: '#/components/schemas/userStreet1' street2: $ref: '#/components/schemas/userStreet2' city: $ref: '#/components/schemas/userCity' province: $ref: '#/components/schemas/userProvince' postalCode: $ref: '#/components/schemas/userPostalCode' country: $ref: '#/components/schemas/userCountry' Employment_Info: type: object required: - type - data properties: type: type: string example: EMPLOYMENT_INFO data: type: object required: - status properties: status: description: The User current employment status. type: string example: EMPLOYED enum: - EMPLOYED - RETIRED - STUDENT - UNEMPLOYED - SELF_EMPLOYED company: description: |- The User's current employer name. *⚠️ Only required when status equal to EMPLOYED or SELF_EMPLOYED* type: string example: DriveWealth LLC type: description: |- The User's current employer type. *⚠️ Only required when status equal to EMPLOYED or SELF_EMPLOYED* type: string example: FINANCE enum: - AGRICULTURE - MINING - UTILITIES - CONSTRUCTION - MANUFACTURING - WHOLESALE - RETAIL - TRANSPORT - INFORMATION - FINANCE - REAL_ESTATE - PROFESSIONAL - MANAGEMENT - EDUCATION - HEALTH - ART - FOOD - PUBLIC - WASTE position: description: |2- The User's current role at the employment. *⚠️ Only required when status equal to EMPLOYED or SELF_EMPLOYED* type: string example: ENGINEER enum: - ACCOUNTANT - ACTUARY - ADJUSTER - ADMINISTRATOR - ADVERTISER - AGENT - ATC - AMBASSADOR - ANALYST - APPRAISER - ARCHITECT - ARTIST - ASSISTANT - ATHLETE - ATTENDANT - ATTORNEY - AUCTIONEER - AUDITOR - BARBER - BROKER - BUSINESS_EXEC - BUSINESS_OWNER - CAREGIVER - CARPENTER - CASHIER - CHEF - CHIROPRACTOR - CIVIL - CLERGY - CLERK - COMPLIANCE - CONSULTANT - CONTRACTOR - COUNSELOR - CUSTOMER_SERVICE - DEALER - DEVELOPER - DISTRIBUTOR - DOCTOR - DRIVER - ENGINEER - EXAMINER - EXTERMINATOR - FACTORY - FARMER - FINANCIAL - FISHERMAN - FLIGHT - HR - IMPEX - INSPECTOR - INTERN - INVESTMENT - INVESTOR - IT - JANITOR - JEWELER - LABORER - LANDSCAPER - LENDING - MANAGER - MECHANIC - MILITARY - MORTICIAN - NURSE - NUTRITIONIST - OFFICE - PHARMACIST - PHYSICAL - PILOT - POLICE - POLITICIAN - PM - REP - RESEARCHER - SAILOR - SALES - SCIENTIST - SEAMSTRESS - SECURITY - SOCIAL - TEACHER - TECHNICIAN - TELLER - TRADESPERSON - TRAINER - TRANSPORTER - UNDERWRITER - WRITER broker: description: |- True, if the User's current employer is broker. *⚠️ Only required when status equal to EMPLOYED or SELF_EMPLOYED* type: boolean example: true directorOf: description: >- The company name, ticker of the company; if the user is a director or owns more than 10% of a publicly traded company. type: string example: AAPL, SQ Investor_Profile_Info: type: object required: - type - data properties: type: type: string example: INVESTOR_PROFILE_INFO data: type: object required: - investmentExperience - annualIncome - networthTotal - riskTolerance - investmentObjectives - networthLiquid properties: investmentExperience: description: The User's current investment expertise. type: string example: YRS_10_ enum: - NONE - YRS_1_2 - YRS_3_5 - YRS_5_10 - YRS_10_ annualIncome: description: The User's current annalized income over one year. type: number example: 1000000 networthTotal: description: >- The user's current networth. This calculation is the User's assets - liabilities. type: number example: 2500000 riskTolerance: description: The User's risk ceiling. type: string example: HIGH enum: - LOW - MODERATE - SPECULATION - HIGH investmentObjectives: description: The User's current investment objectives. type: string example: LONG_TERM enum: - LONG_TERM - INFREQUENT - FREQUENT - ACTIVE_DAILY - NEW networthLiquid: description: >- The user's liquid net worth. The amount of cash or near cash equivalents of the User's net worth. type: number example: 300000 dependents: description: Total number of dependents the account holder has. type: number example: 4 suitabilityEquities: description: An object containing required fields for options approval $ref: '#/components/schemas/investmenetsSuitability' suitabilityOptions: description: An object containing required fields for options approval $ref: '#/components/schemas/investmenetsSuitability' Disclosures: type: object required: - type - data properties: type: type: string example: DISCLOSURES data: type: object required: - termsOfUse - marketDataAgreement - rule14b - privacyPolicy - dataSharing properties: extendedHoursAgreement: description: >- True, if the User accepts DriveWealth's Extended Hours Agreement. type: boolean example: false termsOfUse: description: True, if the User accepts DriveWealth's Terms of Use. type: boolean example: true customerAgreement: description: >- True, if the User accepts DriveWealth's Customer Agreement. *⚠ Only for opening regular brokerage accounts.* type: boolean example: true iraAgreement: description: >- True, if the User accepts DriveWealth's Individual Retirement Account (IRA) Agreement. *⚠ Only for opening IRA accounts.* type: boolean example: false marginAgreement: description: >- True, if the User accepts DriveWealth's Margin Agreement. *⚠ Only for opening Margin (leveraged) accounts.* type: boolean example: false cryptoAgreements: description: >- True, if the User accepts DriveWealth's Digital Assets Agreement. type: boolean example: false marketDataAgreement: description: True, if the User accepts DriveWealth's Market Data Agreement. type: boolean example: true optionsAgreement: description: >- True, if the User accepts DriveWealth's Options trading Agreement. type: boolean example: true rule14b: description: True, if the User accepts DriveWealth's Rule 14b1(c). type: boolean example: true finderFee: description: >- True, if the User accepts DriveWealth Finder's Fee Disclosure. *⚠ Only required for foreign finder relationships.* type: boolean example: false privacyPolicy: description: True, if the User accepts DriveWealth's Privacy Policy. type: boolean example: true dataSharing: description: True, if the User accepts DriveWealth's Data Sharing Policy. type: boolean example: true signedBy: description: The User's digital signature (full name). type: string example: Justin Smith Basic_Info_Optional: type: object required: - type - data properties: type: type: string example: BASIC_INFO data: type: object properties: firstName: description: The first name of the User. type: string example: Justin lastName: description: The last (family) name of the User. type: string example: Smith country: description: The country where the User is residing. type: string example: USA phone: description: The phone number of the User. type: string example: '18004612680' emailAddress: description: The email address of the User. type: string example: jj@drivewealth.dev language: description: The lanaguage the User read/speaks. type: string example: en_US enum: - en_US - zh_CN - es_ES - pt_BR Identification_Info_Optional: type: object required: - type - data properties: type: type: string example: IDENTIFICATION_INFO data: type: object properties: value: description: >- The User's national identification number or tax identification number. type: string example: '1223334444' type: description: The type of national identification number. type: string example: SSN enum: - SSN - EIN - FTIN - FTNLO citizenship: description: The country where the User has citizenship. type: string example: USA usTaxPayer: description: True, the User is a United States tax payer. type: boolean example: true Tax_Info_Optional: type: object required: - type - data properties: type: type: string example: TAX_INFO data: type: object properties: taxTreatyWithUS: description: >- True, if the User's country has a tax treaty with the United States. type: boolean example: true Personal_Info_Optional: type: object required: - type - data properties: type: type: string example: PERSONAL_INFO data: type: object properties: birthDay: description: The User's born day. type: number example: 3 birthMonth: description: The User's born month. type: number example: 12 birthYear: description: The User's born year. type: number example: 2000 politicallyExposedNames: description: >- The names of the people whom are politicaly exposes, separated by a comma. type: string example: Nancy Pelosi irsBackupWithholdings: description: True, if the type of account will be a retirement account. type: boolean example: false gender: description: The gender of the User. type: string example: Male enum: - Male - Female martial: description: The marital status of the User. type: string example: SINGLE enum: - SINGLE - DIVORCED - MARRIED - WIDOWED - PARTNER Address_Info_Optional: type: object required: - type - data properties: type: type: string example: ADDRESS_INFO data: type: object properties: street1: description: The User's current street address, where they live. type: string example: 15 Exchange Place street2: description: >- The User's additional details of an address i.e. an apartment number. type: string example: Suite 1000 city: description: The User's current city, where they live. type: string example: Jersey City provience: description: The User's current state/provience/territory, where they live. type: string example: NJ postalCode: description: The User's current postal code (zip code). type: string example: 7302 country: description: The User's current country, where they live. type: string example: USA Employment_Info_Optional: type: object required: - type - data properties: type: type: string example: EMPLOYMENT_INFO data: type: object properties: status: description: The User's current employment status. type: string example: EMPLOYED enum: - EMPLOYED - RETIRED - STUDENT - UNEMPLOYED - SELF_EMPLOYED company: description: |- The User's current employer name. *⚠️ Only required when status equal to EMPLOYED or SELF_EMPLOYED* type: string example: DriveWealth LLC type: description: |- The User's current employer type. *⚠️ Only required when status equal to EMPLOYED or SELF_EMPLOYED* type: string example: FINANCE enum: - AGRICULTURE - MINING - UTILITIES - CONSTRUCTION - MANUFACTURING - WHOLESALE - RETAIL - TRANSPORT - INFORMATION - FINANCE - REAL_ESTATE - PROFESSIONAL - MANAGEMENT - EDUCATION - HEALTH - ART - FOOD - PUBLIC - WASTE position: description: ' The User''s current role at the employment. *⚠️ Only required when staus equal to EMPLOYED or SELF_EMPLOYED*' type: string example: ENGINEER enum: - ACCOUNTANT - ACTUARY - ADJUSTER - ADMINISTRATOR - ADVERTISER - AGENT - ATC - AMBASSADOR - ANALYST - APPRAISER - ARCHITECT - ARTIST - ASSISTANT - ATHLETE - ATTENDANT - ATTORNEY - AUCTIONEER - AUDITOR - BARBER - BROKER - BUSINESS_EXEC - BUSINESS_OWNER - CAREGIVER - CARPENTER - CASHIER - CHEF - CHIROPRACTOR - CIVIL - CLERGY - CLERK - COMPLIANCE - CONSULTANT - CONTRACTOR - COUNSELOR - CUSTOMER_SERVICE - DEALER - DEVELOPER - DISTRIBUTOR - DOCTOR - DRIVER - ENGINEER - EXAMINER - EXTERMINATOR - FACTORY - FARMER - FINANCIAL - FISHERMAN - FLIGHT - HR - IMPEX - INSPECTOR - INTERN - INVESTMENT - INVESTOR - IT - JANITOR - JEWELER - LABORER - LANDSCAPER - LENDING - MANAGER - MECHANIC - MILITARY - MORTICIAN - NURSE - NUTRITIONIST - OFFICE - PHARMACIST - PHYSICAL - PILOT - POLICE - POLITICIAN - PM - REP - RESEARCHER - SAILOR - SALES - SCIENTIST - SEAMSTRESS - SECURITY - SOCIAL - TEACHER - TECHNICIAN - TELLER - TRADESPERSON - TRAINER - TRANSPORTER - UNDERWRITER - WRITER broker: description: >- True, if the User's current employer is broker.*⚠️ Only required when staus equal to EMPLOYED or SELF_EMPLOYED* type: boolean example: true directorOf: description: >- The company name, ticker of the company; if the user is a director or owns more than 10% of a publicly traded company. type: string example: Apple Inc, AAPL Investor_Profile_Info_Optional: type: object required: - type - data properties: type: type: string example: INVESTOR_PROFILE_INFO data: type: object properties: investmentExperience: description: The User's current investment expertise. type: string example: YRS_10_ enum: - NONE - YRS_1_2 - YRS_3_5 - YRS_5_10 - YRS_10_ annualIncome: description: The User's current annalized income over one year. type: number example: 1000000 networthTotal: description: >- The user's current networth. This calculation is the User's assets - liabilities. type: number example: 2500000 riskTolerance: description: The User's risk ceiling. type: string example: HIGH enum: - LOW - MODERATE - SPECULATION - HIGH investmentObjectives: description: The User's current investment objectives. type: string example: LONG_TERM enum: - LONG_TERM - INFREQUENT - FREQUENT - ACTIVE_DAILY - NEW networthLiquid: description: >- The user's liquid net worth. The amount of cash or near cash equivalents of the User's net worth. type: number example: 300000 dependents: description: Total number of dependents the account holder has. type: number example: 4 suitabilityEquities: description: An object containing required fields for options approval $ref: '#/components/schemas/investmenetsSuitability' suitabilityOptions: description: An object containing required fields for options approval $ref: '#/components/schemas/investmenetsSuitability' Disclosures_Optional: type: object required: - type - data properties: type: type: string example: DISCLOSURES data: type: object properties: extendedHoursAgreement: description: The User accepts DriveWealth's Extended Hours Agreement. type: boolean example: false termsOfUse: description: The User accepts DriveWealth's Terms of Use. type: boolean example: true customerAgreement: description: |- The User accepts DriveWealth's Customer Agreement. *⚠ Only for opening regular brokerage accounts.* type: boolean example: true iraAgreement: description: >- The User accepts DriveWealth's Individual Retirement Account (IRA) Agreement. *⚠ Only for opening IRA accounts.* type: boolean example: false marginAgreement: description: |- The User accepts DriveWealth's Margin Agreement. *⚠ Only for opening Margin (leveraged) accounts.* type: boolean example: false cryptoAgreements: description: |- The User accepts DriveWealth's Digital Assets Agreement. *⚠ Only for opening Digital Assets accounts.* type: boolean example: false marketDataAgreement: description: The User accepts DriveWealth's Market Data Agreement. type: boolean example: true rule14b: description: The User accepts DriveWealth's Rule 14b1(c). type: boolean example: true foreignFindersFee: type: boolean example: false finderFee: type: boolean example: false privacyPolicy: description: The User accepts DriveWealth's Privacy Policy. type: boolean example: true dataSharing: description: The User accepts DriveWealth's Data Sharing Policy. type: boolean example: true signedBy: description: The User's digital signature (full name). type: string example: Justin Smith UserResponse: type: object properties: id: $ref: '#/components/schemas/userID' userType: type: object properties: description: description: A custom description of the User type. type: string example: Individual Trader name: $ref: '#/components/schemas/userType' status: type: object properties: description: description: A custom description of the User's status. type: string example: User is pending approval. name: $ref: '#/components/schemas/userStatus' parentIBID: type: object properties: id: $ref: '#/components/schemas/parentIBID' name: $ref: '#/components/schemas/firmName' documents: description: The personal identifiable information & digital signatures. type: array items: anyOf: - $ref: '#/components/schemas/Basic_Info' - $ref: '#/components/schemas/Identification_Info' - $ref: '#/components/schemas/Tax_Info' - $ref: '#/components/schemas/Personal_Info' - $ref: '#/components/schemas/Address_Info' - $ref: '#/components/schemas/Employment_Info' - $ref: '#/components/schemas/Investor_Profile_Info' - $ref: '#/components/schemas/Disclosures' wlpID: $ref: '#/components/schemas/wlpID' referralCode: description: The associated referral program associated to the User. type: string example: 71J000 createdWhen: description: The createdWhen is the date and time the User was created. type: string example: '2022-12-11T22:28:21.810Z' updatedWhen: description: The updatedWhen is the last date and time the User was updated. type: string example: '2022-12-11T22:28:21.810Z' UserObject: type: object properties: id: $ref: '#/components/schemas/userID' ackSignedWhen: description: The date and time the User signed the digital documents. type: string example: '2022-12-11T22:28:21.666Z' addressLine1: $ref: '#/components/schemas/userStreet1' addressLine2: $ref: '#/components/schemas/userStreet2' city: $ref: '#/components/schemas/userCity' countryID: $ref: '#/components/schemas/userCountry' displayName: description: >- The User's display name. *By default this is firstName inital followed by last name.* type: string example: JSmith dob: description: The User's date of birth in this format YYYY-MM-DD type: string example: 2000-12-3 email: $ref: '#/components/schemas/email' firstName: $ref: '#/components/schemas/firstName' gender: description: The description of the User's gender. type: object properties: name: type: string example: MALE enum: - MALE - FEMALE languageID: $ref: '#/components/schemas/language' lastname: $ref: '#/components/schemas/lastName' parentIBID: type: object properties: id: $ref: '#/components/schemas/parentIBID' name: $ref: '#/components/schemas/firmName' phone: $ref: '#/components/schemas/phoneNumber' referralCode: description: The assiocated referral program assiocated to the User. type: string example: 71J000 stateProvince: $ref: '#/components/schemas/userProvince' wlpID: $ref: '#/components/schemas/wlpID' zipPostalCode: description: The User's current postal code (zip code). type: string example: 7302 idNo: $ref: '#/components/schemas/userTaxIDLastFour' status: type: object properties: description: description: A custom description of the User's status. type: string example: User is pending approval. name: description: The user's current know your User (KYC) status. type: string example: PENDING enum: - PENDING - APPROVED userType: type: object properties: description: description: A custom description of the User type. type: string example: Individual Trader name: description: The name that describes the type of User. type: string example: INDIVIDUAL_TRADER enum: - INDIVIDUAL_TRADER - CUSTODIAL usCitizen: description: True, if a the User is a United States Citizen type: boolean example: true updatedWhen: description: The updatedWhen is the last date and time the User was updated. type: string example: '2022-12-11T22:28:21.810Z' brandAmbassador: type: boolean example: false employerBusiness: description: The User's current employer type. type: string example: FINANCE employementStatus: type: object properties: description: description: A description of the employement status. type: string example: Employed name: description: The User's current employement status. type: string example: EMPLOYED citizenship: $ref: '#/components/schemas/userCountry' createdWhen: description: The createdWhen is the date and time the User was created. type: string example: '2022-12-11T22:28:21.810Z' marginDefault: type: number example: 0 maritalStatus: type: object properties: description: description: A description of the martial status of the User. type: string example: Single name: $ref: '#/components/schemas/userMartialStatus' ackCustomerAgreement: description: True, if the User accepted DriveWealth's Customer Agreement. type: boolean example: true ackFixedIncomeAgreement: description: True, if the User accepted DriveWealth's Fixed Income Agreement. type: boolean example: false ackFindersFee: description: True, if the User accepted DriveWealth's Finders Fee Agreement. type: boolean example: false ackForeignFindersFee: description: >- True, if the User accepted DriveWealth's Foreign Finders Fee Agreement. type: boolean example: false ackJointCustomerAgreement: description: True, if the User accepted DriveWealth's Customer Agreement. type: boolean example: true ackJointFindersFee: description: >- True, if the User has accepted a Joint Finder's Fee Agreement with DriveWealth & the partner. type: boolean example: false ackJointForeignFindersFee: description: >- True, if the User has accepted a Joint Foreign Finder's Fee Agreement with DriveWealth & the partner. type: boolean example: false ackJointMarketData: description: >- True, if the User has accepted a Joint Market Data Agreement with DriveWealth & the partner. type: boolean example: false ackMarketData: description: True, if the User has accepted DriveWealth's Market Data Agreement. type: boolean example: false ackExtendedHoursAgreement: description: >- True, if the User has accepted DriveWealth's Extended Hours Agreement. type: boolean example: false dependents: description: The amount of children or dependents assiocated with the User. type: number example: 0 termsOfUse: description: True, if the User has accepted DriveWealth's Terms of Use Agreement. type: boolean example: true badPasswordCount: type: boolean example: false director: description: >- True, if the User is a director at a public traded company or owns 10% or more of a public company. type: boolean example: false employerCompany: description: The name of the User's employer. type: string example: DriveWealth LLC employerIsBroker: description: True, if the User's employer is a brokerage firm. type: boolean example: true employmentPosition: description: The User's current employment job type. type: string example: ENGINEER employmentYears: description: The amount of years the User has been employed with the employer. type: number example: 0 jointEmployerIsBroker: type: boolean example: false investmentObjectives: type: object properties: description: description: A custom description of the investment objective. type: string example: Frequent trader, depending on the market name: description: The User's current investment objectives. type: string example: FREQUENT investmentExperience: type: object properties: description: description: A custom description of investment expertise. type: string example: 10+ yrs name: description: The User's current investment expertise. type: string example: YRS_10_ politicallyExposed: description: True, if the User is politically exposed to another person. type: boolean example: false riskTolerance: description: The User's risk ceiling. type: string example: HIGH enum: - LOW - MODERATE - SPECULATION - HIGH userNoteQty: description: Total number of notes on the user. type: number example: 0 validTaxForm: description: True, if the user has verified/updated tax information. type: boolean example: true taxTreatyWithUS: description: True, if the User's country has a tax treaty with the United States. type: boolean example: true avatarURL: description: The User's avatar. type: string example: >- https://secure.gravatar.com/avatar/2076105f6efe7c11e285add95f514b9a.jpg annualIncomeRange: description: The User's annual income range, in dollar form. type: string example: $0 - $24,999 ackDisclosureRule14b: description: True, if the User has accepted DriveWealth's Rule 14b Agreement. type: boolean example: true ackJointDisclosureRule14b: description: >- True, if the User has accepted a Joint Rule 14b Agreement with DriveWealth & the parnter. type: boolean example: false networthLiquidRange: description: >- The user's liquid net worth range. The amount of cash or near cash equivalents of the User's net worth. type: string example: $0 - $24,999 networthTotalRange: description: The User's net total net worth range. type: string example: $0 - $24,999 investmentEquitiesExperience: description: Trading experience level. type: string example: LIMITED enum: - LIMITED - NONE - GOOD - EXCELLENT investmentEquitiesYears: description: Number of years equity trading experience. type: string example: YRS_10_PLUS enum: - YRS_1_2 - YRS_3_5 - YRS_6_9 - YRS_10_PLUS investmentEquitiesTradesPerYear: description: Total number of trades per year. type: string example: YRS_10_14 enum: - YRS_0_9 - YRS_10_14 - YRS_15_24 - YRS_25_74 - YRS_75_PLUS investmentEquitiesAverageTradeSize: description: 'Average per trade size ' type: string example: AVG_0_9999 enum: - AVG_0_9999 - AVG_10000_24999 - AVG_5000_PLUS investmentOptionsExperience: description: Trading experience level. type: string example: LIMITED enum: - LIMITED - NONE - GOOD - EXCELLENT investmentOptionsYears: description: Number of years equity trading experience. type: string example: YRS_10_PLUS enum: - YRS_1_2 - YRS_3_5 - YRS_6_9 - YRS_10_PLUS investmentOptionsTradesPerYear: description: Total number of trades per year. type: string example: YRS_10_14 enum: - YRS_0_9 - YRS_10_14 - YRS_15_24 - YRS_25_74 - YRS_75_PLUS investmentOptionsAverageTradeSize: description: A unique identifier for the Deposit. type: string example: AVG_0_9999 enum: - AVG_0_9999 - AVG_10000_24999 - AVG_5000_PLUS FetchUserResponse: type: object properties: user: $ref: '#/components/schemas/UserObject' Documents: type: object properties: documents: description: >- The personal identifiable information & digital signatures that will be updated. type: array items: oneOf: - $ref: '#/components/schemas/Basic_Info_Optional' - $ref: '#/components/schemas/Identification_Info_Optional' - $ref: '#/components/schemas/Tax_Info_Optional' - $ref: '#/components/schemas/Personal_Info_Optional' - $ref: '#/components/schemas/Address_Info_Optional' - $ref: '#/components/schemas/Employment_Info_Optional' - $ref: '#/components/schemas/Investor_Profile_Info_Optional' - $ref: '#/components/schemas/Disclosures_Optional' FetchUserKYCResponse: type: object properties: userID: $ref: '#/components/schemas/userID' firstName: $ref: '#/components/schemas/firstName' lastName: $ref: '#/components/schemas/lastName' identity: type: object properties: number: $ref: '#/components/schemas/userTaxIDLastFour' dob: description: The User's date of birth in this format YYYY-MM-DD type: string example: '2000-12-03' accounts: description: A list of all the User's accounts. type: array items: oneOf: - $ref: '#/components/schemas/AccountsRequest' kyc: type: object properties: status: type: object properties: description: description: A custom description about the User's KYC status. type: string example: User's PII not matched. Please revisit user's PII Info. name: description: The current kyc status of the User. type: string example: KYC_INFO_REQUIRED enum: - KYC_NOT_READY - KYC_READY - KYC_PROCESSING - KYC_APPROVED - KYC_INFO_REQUIRED - KYC_DOC_REQUIRED - KYC_MANUAL_REVIEW - KYC_DENIED code: type: string example: K102 approved: type: object properties: timestamp: description: The date and time the User's KYC was approved. type: string example: '2022-12-12T21:13:12.391Z' approvedBy: description: >- The identifier of the backoffice user that approved the User's KYC. type: string example: 0ef9ef36-3720-4b76-a938-dac4501a7f95 accepted: type: object properties: acceptedBy: description: The name of the role who approved the User's kyc. type: string example: SYSTEM PRINCIPAL APPROVER timeStamp: description: The date and time the role who approved the User's kyc. type: string example: '2022-12-12T21:13:12.391Z' status: type: object properties: description: description: A custom description of the User's status. type: string example: User approved. name: description: The User's current status. type: string example: APPROVED enum: - PENDING - APPROVED partnerID: type: object properties: id: $ref: '#/components/schemas/parentIBID' name: $ref: '#/components/schemas/firmName' documents: description: Please call the user's endpoint to get the User's documents. type: array example: [] items: {} AccountsRequest: type: object properties: id: description: The User's unqiue account identifier. type: string example: 8b8ba3fd-74dc-45dc-b2dc-7de683bd713c.1556222995391 accountNo: description: The User's unqiue account number, that is human readable. type: string example: DWBG000052 nickname: type: string example: Justin's Self Directed Account accountStatus: type: object properties: description: description: A custom description about status of the User's account. type: string example: Pending name: description: The status of the User's account. type: string example: PENDING accountType: description: The type of account that has been created. type: string example: LIVE accountManagementType: description: The type of account who has trading authority. type: string example: SELF enum: - SELF - ADVISORY - RIA_MANAGED - CUSTODIAL - CUSTODIAL_MANAGED - RESERVED tradingType: description: The type of trading ocurring in the account. type: string example: CASH enum: - CASH - MARGIN - CRYPTO leverage: description: The leverage that is applied to the User's account. type: number example: 1 Allocation: type: object properties: id: $ref: '#/components/schemas/allocationID' clientListID: $ref: '#/components/schemas/note' status: $ref: '#/components/schemas/allocationStatus' allocationsRequested: $ref: '#/components/schemas/allocationsRequested' allocationsCompleted: $ref: '#/components/schemas/allocationsCompleted' unallocatedNotional: $ref: '#/components/schemas/unallocatedNotional' unallocatedQuantity: $ref: '#/components/schemas/unallocatedQuantity' comment: description: A custom comment generated by DriveWealth. type: string example: >- All allocated and accounted for. 1::1::0 client note[empty], . timeMs=667 ratePerSec=1.50 msPerItem=667.00 createdWhen: description: The date and time of the allocation creation. type: string example: '2022-12-22T16:04:46.724Z' Allocations: description: A list of a User's sub account allocations. type: array items: oneOf: - $ref: '#/components/schemas/Allocation' OrdersAllocationSummary: type: object properties: id: $ref: '#/components/schemas/allocationID' accountNo: $ref: '#/components/schemas/accountNo' date: description: The specific date requested in the inbound API request. type: string example: '2022-12-25' orders: description: A list of order and allocations. type: array items: oneOf: - $ref: '#/components/schemas/OrdersAllocationsSummary' ListOrdersAllocationsByUserID.Orders: type: object properties: riaID: $ref: '#/components/schemas/userID' orderID: $ref: '#/components/schemas/orderID' orderNo: $ref: '#/components/schemas/orderNo' orderType: $ref: '#/components/schemas/orderTypes' createdWhen: description: The createdWhen is the date and time the order was created. type: string example: '2022-12-11T22:28:21.810Z' instrumentID: $ref: '#/components/schemas/instrumentID' symbol: $ref: '#/components/schemas/instrumentSymbol' side: $ref: '#/components/schemas/sideAbbreviated' orderQty: $ref: '#/components/schemas/orderQuantity' cumQty: $ref: '#/components/schemas/orderCumulativeQuantity' avgPx: $ref: '#/components/schemas/orderAveragePrice' allocations: description: A list of a User's sub account allocations. type: array items: oneOf: - $ref: >- #/components/schemas/ListOrdersAllocationsByUserID.Orders.Allocation ListOrdersAllocationsByUserID.Orders.Allocation: type: object properties: id: $ref: '#/components/schemas/allocationID' status: $ref: '#/components/schemas/allocationStatus' unallocatedNotional: $ref: '#/components/schemas/unallocatedNotional' unallocatedQuantity: $ref: '#/components/schemas/unallocatedQuantity' ListOrdersAllocationsByUserID: type: array items: oneOf: - $ref: '#/components/schemas/ListOrdersAllocationsByUserID.Orders' FundByUserID.Triggers: type: object properties: child: $ref: '#/components/schemas/instrumentID' maxAllowed: $ref: '#/components/schemas/fundMaxAllowed' lowerBound: $ref: '#/components/schemas/fundLowerBound' upperBound: $ref: '#/components/schemas/fundUpperLowerBound' type: $ref: '#/components/schemas/triggerTypes' FundByUserID.Holdings: type: object properties: instrumentID: $ref: '#/components/schemas/instrumentID' target: $ref: '#/components/schemas/fundTarget' FundByUserID: type: object properties: description: $ref: '#/components/schemas/fundDescription' id: $ref: '#/components/schemas/fundID' userID: $ref: '#/components/schemas/userID' name: $ref: '#/components/schemas/fundName' type: $ref: '#/components/schemas/fundType' clientFundID: $ref: '#/components/schemas/clientFundID' holdings: description: A list of instruments to make up the fund. type: array items: oneOf: - $ref: '#/components/schemas/FundByUserID.Holdings' triggers: description: A list of the individual triggers for each instrument. type: array items: oneOf: - $ref: '#/components/schemas/FundByUserID.Triggers' FundsByUserID: description: A list of individual funds holdings. type: array items: oneOf: - $ref: '#/components/schemas/FundByUserID' PortfolioByUserID.Holdings.CashReserve: type: object properties: type: description: The type of collection making up the portfolio type: string example: CASH_RESERVE enum: - CASH_RESERVE - FUND target: description: The individual targeted weight of the cash portion of the portfolio. type: string example: 0.25 PortfolioByUserID.Triggers: type: object properties: child: $ref: '#/components/schemas/fundID' maxAllowed: $ref: '#/components/schemas/portfolioMaxAllowed' lowerBound: $ref: '#/components/schemas/portfolioLowerBound' upperBound: $ref: '#/components/schemas/portfolioUpperLowerBound' type: $ref: '#/components/schemas/triggerTypes' PortfolioByUserID: type: object properties: description: $ref: '#/components/schemas/portfolioDescription' id: $ref: '#/components/schemas/portfolioID' name: $ref: '#/components/schemas/portfolioName' clientPortfolioID: $ref: '#/components/schemas/clientPortfolioID' holdings: description: A list of all the individual funds making up the portfolio. type: array items: oneOf: - $ref: '#/components/schemas/PortfolioByUserID.Holdings.CashReserve' - $ref: '#/components/schemas/FundByUserID' userID: $ref: '#/components/schemas/userID' triggers: description: A list of the individual triggers for each fund and or cash. type: array items: $ref: '#/components/schemas/PortfolioByUserID.Triggers' PortfoliosByUserID: description: A list of portfolios by userID. type: array items: oneOf: - $ref: '#/components/schemas/PortfolioByUserID' AutoPilotRunByUserID: type: object properties: id: $ref: '#/components/schemas/autoPilotRebalanceID' created: description: The date and time that the autopilot re-balance was created. type: string example: '2022-12-11T22:28:21.810Z' status: $ref: '#/components/schemas/autoPilotStatus' moneyMovement: description: >- True, if the re-balance was apart of a funding or withdrawal process. type: string example: true regularRebalance: description: >- True, if the re-balance was apart of the regularly scheduled re-balancing cycle. type: string example: false AutoPilotRunsByUserID: description: A list of autopilot runs by userID. type: array items: oneOf: - $ref: '#/components/schemas/AutoPilotRunByUserID' OrdersAllocationsSummary: type: object properties: id: $ref: '#/components/schemas/orderID' orderNo: $ref: '#/components/schemas/orderNo' type: $ref: '#/components/schemas/orderTypes' status: $ref: '#/components/schemas/orderStatus' created: description: The date and time the order was created. type: string example: '2022-12-11T22:28:21.810Z' instrument: type: object properties: id: $ref: '#/components/schemas/instrumentID' symbol: $ref: '#/components/schemas/instrumentSymbol' side: $ref: '#/components/schemas/sideAbbreviated' averagePrice: $ref: '#/components/schemas/orderAveragePrice' orderQuantity: $ref: '#/components/schemas/orderQuantity' cumulativeQuantity: $ref: '#/components/schemas/orderCumulativeQuantity' allocatedQuantity: $ref: '#/components/schemas/allocatedQuantity' unallocatedQuantity: $ref: '#/components/schemas/unallocatedQuantity' unallocatedNotional: $ref: '#/components/schemas/unallocatedNotional' allocations: description: A list of sub account allocations. type: array items: oneOf: - $ref: '#/components/schemas/OrderAllocations' BankAccountsArray: description: A list of all the User's linked bank accounts. type: array items: oneOf: - $ref: '#/components/schemas/BankAccount' beginningOfDay: type: object properties: url: description: The url to the beginning of day json file. type: string example: '''https://dtygu59lw0as9.cloudfront.net/_bod...' format: url userType: description: The type of user being onboarded. type: string example: INDIVIDUAL_TRADER enum: - INDIVIDUAL_TRADER - CUSTODIAL phoneNumber: description: The phone number of the user. type: string example: '18004612680' language: description: The language the user read/speaks. type: string example: en_US enum: - en_US - zh_CN - es_ES - pt_BR userTaxID: description: The user's national identification number or tax identification number. type: string example: '1223334444' userTaxIDType: description: The type of national identification number or tax identification number. type: string example: SSN enum: - SSN - EIN - FTIN - FTNLO - '*' userCountry: description: The user's country. type: string example: USA userMartialStatus: description: The marital status of the user. type: string example: SINGLE enum: - SINGLE - DIVORCED - MARRIED - WIDOWED - PARTNER userStreet1: description: The user's current street address, where they live. type: string example: 15 Exchange Place userStreet2: description: The user's additional details of an address i.e. an apartment number. type: string example: Suite 1000 userCity: description: The user's current city, where they live. type: string example: Jersey City userProvince: description: The user's current state/province/territory, where they live. type: string example: NJ userPostalCode: description: The user's current postal code (zip code), where they live. type: string example: 7302 investmenetsSuitability: type: object properties: experience: description: Trading experience level. type: string example: LIMITED enum: - LIMITED - NONE - GOOD - EXCELLENT years: description: Number of years equity trading experience. type: string example: YRS_10_PLUS enum: - YRS_1_2 - YRS_3_5 - YRS_6_9 - YRS_10_PLUS tradesPerYear: description: Total number of trades per year. type: string example: YRS_10_14 enum: - YRS_0_9 - YRS_10_14 - YRS_15_24 - YRS_25_74 - YRS_75_PLUS averageTradeSize: description: Average per trade size. type: string example: AVG_0_9999 enum: - AVG_0_9999 - AVG_10000_24999 - AVG_5000_PLUS userStatus: description: The user's current status. type: string example: PENDING enum: - PENDING - APPROVED userTaxIDLastFour: description: >- The user's last 4 digits of their national identification number or tax identification number. type: string example: '****-4444' bankAccountNickName: description: The linked bank account nickname defined by the user. type: string example: PREFERRED CHECKING bankAccountStatus: description: The current status of the user's external linked bank account. type: string example: ACTIVE enum: - ACTIVE - DELETED schemas-Documents: type: object properties: id: $ref: '#/components/schemas/physicalDocumentID' type: type: object properties: description: description: A custom description about the classification of the document. type: string example: Driver License name: $ref: '#/components/schemas/physicalDocumentTypes' status: type: object properties: description: description: A custom description to describe the status. type: string example: The document has not been submitted for approval. name: $ref: '#/components/schemas/physicalDocumentStatus' DocumentsArray: description: An array of uploaded documents type: array items: oneOf: - $ref: '#/components/schemas/schemas-Documents' subscriptionStatus: description: The current status of the user's subscription. type: string example: ACTIVE enum: - ACTIVE - CANCELLED UserSubscription: type: object properties: id: $ref: '#/components/schemas/subscriptionID' accountDetails: type: object properties: accountID: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' accountType: $ref: '#/components/schemas/accountType' accountManagementType: $ref: '#/components/schemas/accountManagementTypeObject' status: $ref: '#/components/schemas/subscriptionStatus' paymentSource: type: object properties: source: type: string sourceType: $ref: '#/components/schemas/bankAccountID' plan: type: object properties: planID: description: The unique identifier that identifies the plan schedule. type: string example: plan_1d3e1630-9107-47c2-a9c4-6cca93821cb7 name: description: The name of the global name of the planned subscription. type: string example: Monthly Subscription interval: description: >- The interval in which the user's linked bank account will be charged. type: string example: MONTH enum: - MONTHLY - QUARTERLY intervalCount: description: >- The interval in which the user's linked bank account will be charged represented as an integer value. type: number example: 1 enum: - 1 - 3 amount: description: The amount the user's linked bank account will be charged. type: number example: 4.99 currency: $ref: '#/components/schemas/currency' created: description: >- The date and time that the subscription was created for the user's linked bank account. $ref: '#/components/schemas/created' started: description: The date and time that the subscription started. type: string example: '2022-12-11T22:28:21.810Z' expires: description: >- The date and time that the subscription will expire; and stop charging the user's linked bank account. type: string example: '2022-12-11T22:28:21.810Z' transactionHistory: description: >- A list of all this historical subscriptions transactions charged to the user's linked bank account. type: array example: [] items: oneOf: - $ref: '#/components/schemas/TransactionRes' UserSubscriptions: description: A list of the user's current subscriptions. type: array items: oneOf: - $ref: '#/components/schemas/UserSubscription' DepositByUserID: type: object properties: id: $ref: '#/components/schemas/recurringID' currency: $ref: '#/components/schemas/currency' amount: description: The amount of the recurring deposit. type: number example: 1075.25 frequency: $ref: '#/components/schemas/recurringFrequency' bankAccountID: $ref: '#/components/schemas/bankAccountID' active: description: True, if the recurring deposit is active. type: boolean example: true nextDeposit: description: The date of when the next recurring deposit will be triggered. type: string example: '2019-01-15' accountID: $ref: '#/components/schemas/accountID' created: description: >- The date and time the recurring deposit was created for the user's external bank account. type: string example: '2022-12-11T22:28:21.810Z' updated: description: >- The date and time the recurring deposit was updated for the user's external bank account. type: string example: '2022-12-11T22:28:21.810Z' createdBy: description: The user identifier whom created the recurring deposit. type: string example: b25f0d36-b4e4-41f8-b3d9-9249e46402cd RecurringDepositsByUserID: description: A list of the all the user's recurring deposits. type: array items: oneOf: - $ref: '#/components/schemas/DepositByUserID' DepositsByUserID: type: object properties: id: $ref: '#/components/schemas/depositID' paymentID: $ref: '#/components/schemas/depositID' amount: description: The amount of the deposit type: number example: 125.22 currency: $ref: '#/components/schemas/currencyObject' status: $ref: '#/components/schemas/depositStatusObject' accountDetails: type: object properties: accountID: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' accountType: $ref: '#/components/schemas/accountTypeObject' accountManagementType: $ref: '#/components/schemas/accountManagementTypeObject' wlpFinTranTypeID: $ref: '#/components/schemas/wlpFinTranTypeID' note: $ref: '#/components/schemas/note' DepositsArray: description: A list of deposits type: array items: oneOf: - $ref: '#/components/schemas/DepositsByUserID' allocationID: description: The unique identifier that identifies the lot of the allocation. type: string example: JF.allocation.TendiesTradingCo.e61f512a-ed9c-4047-9ccf-224a5864158d allocationStatus: description: The current status of the lot of allocation. type: string example: NEW enum: - NEW - ACCEPTED - PART_COMPLETE - COMPLETED - REJECTED allocationsRequested: description: The amount of sub account allocations passed to the system. type: number example: 500 minimum: 1 maximum: 10000 allocationsCompleted: description: The amount of completed sub account allocations. type: number example: 25 minimum: 1 maximum: 10000 unallocatedNotional: description: >- The notional value of the shares that have not been allocated to sub accounts. type: number example: 5320 unallocatedQuantity: description: >- The remaining amount of shares that have not been allocated to the sub accounts. type: number example: 302 orderAveragePrice: description: The average price of the security being transacted in the order. type: number example: 1038.81 allocatedQuantity: description: The amount of allocated shares. type: number example: 0.7219 allocationUrl: description: A specific URL that contains the full break down of the allocation. type: string example: >- /back-office/managed/allocations/JF.TENDIESTRADINGCO_20221225_120000_MOD_AUTO_LIQUIDATE OrderAllocations: type: object properties: id: $ref: '#/components/schemas/allocationID' url: $ref: '#/components/schemas/allocationUrl' created: description: The date and time of the allocation creation. type: string example: '2022-12-22T16:04:46.724Z' status: $ref: '#/components/schemas/allocationStatus' allocationsRequested: $ref: '#/components/schemas/allocationsRequested' allocationsCompleted: $ref: '#/components/schemas/allocationsCompleted' unallocatedQuantity: $ref: '#/components/schemas/unallocatedQuantity' unallocatedNotional: $ref: '#/components/schemas/unallocatedNotional' comment: description: A custom comment generated by DriveWealth. type: string example: >- All allocated and accounted for. 1::1::0 client note[empty], . timeMs=667 ratePerSec=1.50 msPerItem=667.00 fundDescription: description: A user defined description that describes the underlying fund. type: string example: This fund is comprised of large cap stocks weight like the S&P 500. fundMaxAllowed: description: The total drift amount for this instrument. type: number example: 0.05 fundLowerBound: type: number example: 0.1 fundUpperLowerBound: type: number example: 0.25 triggerTypes: description: >- The type of trigger associated to the fund as a whole or an individual instrument. type: string example: TOTAL_DRIFT enum: - TOTAL_DRIFT - RELATIVE_DRIFT - ABSOLUTE_DRIFT portfolioName: description: A user defined name that describes the underlying portfolio. type: string example: Go Getter Portfolio portfolioDescription: description: A user defined description that describes the underlying portfolio. type: string example: >- This portfolio is comprised different funds that make up an aggressive portfolio. portfolioMaxAllowed: description: The total drift amount for this fund or cash. type: number example: 0.05 portfolioLowerBound: type: number example: 0.1 portfolioUpperLowerBound: type: number example: 0.25 autoPilotRebalanceID: description: The unique identifier of the auto pilot re-balance run. type: string example: ria_rebalance_721ff5c3-f6f2-48d8-aaa3-41a49a044f2c autoPilotStatus: description: The current status of the re-balance run. type: string example: REBALANCE_NOT_STARTED enum: - REBALANCE_NOT_STARTED - REBALANCE_ABORTED - REBALANCE_REVIEW_COMPLETED - REBALANCE_NO_ORDERS_GENERATED - REBALANCE_10 - REBALANCE_20 - REBALANCE_30 - REBALANCE_40 - REBALANCE_50 - REBALANCE_60 - REBALANCE_70 - REBALANCE_80 - REBALANCE_90 - REBALANCE_COMPLETED - REBALANCE_FAILED - AMOUNTCASH_ORDERS_AGGREGATED - ORDERQTY_ORDERS_AGGREGATED - ORDERQTY_ORDERS_PREPARED - AMOUNTCASH_ORDERS_PREPARED - SELL_ORDERQTY_ORDERS_SUBMITTED - SUBACCOUNT_ORDERS_ADJUSTED - SELL_AMOUNTCASH_ORDERS_SUBMITTED - SELL_AMOUNTCASH_ORDERS_COMPLETED - SELL_AMOUNTCASH_ORDERS_FAILED - SELL_AMOUNTCASH_ORDERS_TIMEDOUT - SELL_ORDERQTY_ORDERS_COMPLETED - SELL_ORDERQTY_ORDERS_FAILED - SELL_ORDERQTY_ORDERS_TIMEDOUT - BUY_ORDERQTY_ORDERS_SUBMITTED - BUY_ORDERQTY_ORDERS_COMPLETED - BUY_ORDERQTY_ORDERS_FAILED - BUY_ORDERQTY_ORDERS_TIMEDOUT - BUY_AMOUNTCASH_ORDERS_SUBMITTED - BUY_AMOUNTCASH_ORDERS_COMPLETED - BUY_AMOUNTCASH_ORDERS_FAILED - BUY_AMOUNTCASH_ORDERS_TIMEDOUT - ORDERS_CLEANEDUP - RIA_NEXT_REBALANCE_UPDATED - ALLOCATION_PREPARED - ALLOCATION_SUBMITTED - ALLOCATION_NOT_STARTED - ALLOCATION_10 - ALLOCATION_20 - ALLOCATION_30 - ALLOCATION_40 - ALLOCATION_50 - ALLOCATION_60 - ALLOCATION_70 - ALLOCATION_80 - ALLOCATION_90 - ALLOCATION_COMPLETED - ALLOCATION_FAILED - ALLOCATION_TIMEDOUT - SUBACCOUNT_HOLDINGS_UPDATED - SUBACCOUNT_HOLDINGS_UPDATE_FAILED - SUCCESS ExchangesCancelPendingOrderRequest: type: object properties: method: type: string example: CANCEL required: - method ExchangesCreateExchangeRequest: type: object properties: accountNo: $ref: '#/components/schemas/accountNo' sellSymbol: description: This will be the ticker of the mutual fund you will be liquidating. type: string example: VTSMX buySymbol: description: >- This will be the ticker of the mutual fund you will be purchasing with the proceeds of the liquidation. type: string example: VTSAX amountCash: description: >- This is the total notional amount you exchange from the sellSymbol to the buySymbol. This field is populated if quantity is null type: number example: 100 quantity: description: >- This is the total quantity being sold of the sellSymbol. The proceeds, less any fees, will be used to purchase the buySymbol. This field is only required if amountCash is null. type: number example: 100.503 required: - accountNo - sellSymbol - buySymbol - amountCash - quantity DepthOfBookGetDebtDepthRequest: type: array items: $ref: '#/components/schemas/MarketQuoteRequest' AccountsUpdateAccountDetailsResponse: oneOf: - $ref: '#/components/schemas/AccountDetailRes' - $ref: '#/components/schemas/AccountDetailResMinorTransfer' AssetTransferCreateAcatsTransferResponse: type: object properties: errorCode: type: string message: type: string errorDetails: type: object properties: field: description: Json field name in request body type: string type: description: | DataType of the field type: string enum: - STRING - ARRAY - INT - DECIMAL - BOOL - TEXT - UUID - DATE - MAP - OBJECT allowedValues: description: Example values which are allowed in the field type: string AssetTransferListTransfersResponse: type: object properties: data: type: array items: anyOf: - $ref: '#/components/schemas/ACATSTransfer' nextPageOffset: description: The next page offset. type: string prevPageOffset: description: The previous page offset. type: string ExchangesCancelPendingOrderResponse: type: object properties: id: description: The ID of the Exchange type: string exchangeNo: description: A human-readable number that represents the Exchange type: string required: - id - exchangeNo ExchangesCreateExchangeResponse: type: object properties: id: description: 'The specific id of the exchange. ' type: string exchangeNo: description: The specific exchange number type: string required: - id - exchangeNo ExchangesGetDetailsResponse: type: object properties: id: description: The specific id of the exchange type: string exchangeNo: description: The specific exchange number type: string status: description: The state of the exchange. type: string enum: - NEW - FILLED - REJECTED - PENDING_CANCEL - CANCELED sellSymbol: description: This will be the ticker of the mutual fund you will be liquidating type: string sellOrderId: description: The order ID corresponding to the sell transaction type: string sellOrderNo: description: The order number corresponding to the sell transaction type: string buySymbol: description: >- This will be the ticker of the mutual fund you will be purchasing with the proceeds of the liquidation type: string buyOrderId: description: The order ID corresponding to the buy transaction type: string buyOrderNo: description: The order number corresponding to the buy transaction type: string sellAveragePrice: description: The price the sell order was filled at type: number sellCumulativeQuantity: description: The total quantity the sell was for type: number buyAveragePrice: description: The price the buy order was filled at type: number buyCumulativeQuantity: description: The total quantity the buy was for type: number amountCash: description: >- This is the total notional amount you exchange from the sellSymbol to the buySymbol. This field is populated if quantity is null. type: number fees: description: The total fees for both the buy and sell order of the exchange type: number orderExpires: description: The date the exchange expires type: string createdBy: description: The user that created the exchange type: string userID: description: The id of the user by whom the exchange was placed type: string accountID: description: The account id of the user where the exchange was placed type: string accountNo: description: The account number of the user where the exchange was placed type: string created: description: The time the exchange was created type: string cancelledWhen: description: The date and time the exchange was cancelled type: string cancelledBy: description: The user that cancelled the exchange. type: string rejectedWhen: description: The timestamp when the exchange was rejected. type: string rejectedReason: description: Reason exchange was rejected type: string required: - id - exchangeNo - status - sellSymbol - sellOrderId - sellOrderNo - buySymbol - buyOrderId - buyOrderNo - sellAveragePrice - sellCumulativeQuantity - buyAveragePrice - buyCumulativeQuantity - amountCash - fees - orderExpires - createdBy - userID - accountID - accountNo - created ExchangesListByAccountResponse: type: object properties: accountID: description: The account id of the user where the order was placed type: string accountNo: description: |+ The account number of the user where the order was placed type: string tradingType: type: string example: CASH updated: type: string exchanges: type: array items: type: object properties: id: description: 'The specific id of the exchange. ' type: string exchangeNo: description: The specific exchange number type: string status: description: The state of the exchange. type: string enum: - NEW - FILLED - REJECTED - PENDING_CANCEL - CANCELED sellSymbol: description: >- This will be the ticker of the mutual fund you will be liquidating. type: string sellOrderId: description: The order ID corresponding to the sell transaction. type: string sellOrderNo: description: The order number corresponding to the sell transaction. type: string buySymbol: description: >- This will be the ticker of the mutual fund you will be purchasing with the proceeds of the liquidation. type: string buyOrderId: description: The order ID corresponding to the buy transaction. type: string buyOrderNo: description: The order number corresponding to the buy transaction. type: string sellAveragePrice: description: The price the sell order was filled at. type: number sellCumulativeQuantity: description: The total quantity the sell was for. type: number buyCumulativeQuantity: description: The total quantity the buy was for. type: number buyAveragePrice: description: The price the buy order was filled at. type: number amountCash: description: >- This is the total notional amount you exchange from the sellSymbol to the buySymbol. type: number fees: description: >- The total fees for both the buy and sell order of the exchange. type: number orderExpires: description: The timestamp the exchange expires. type: string createdBy: description: Who the orders were created by type: string userID: $ref: '#/components/schemas/userID' accountID: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' created: description: The time the order was created type: string required: - id - exchangeNo - status - sellSymbol - sellOrderId - sellOrderNo - buySymbol - buyOrderId - buyOrderNo - sellAveragePrice - sellCumulativeQuantity - buyCumulativeQuantity - buyAveragePrice - amountCash - fees - orderExpires - createdBy - userID - accountID - accountNo - created required: - accountID - accountNo - tradingType - updated - exchanges ExchangesGetExchangeHistoryResponse: type: object properties: accountID: description: The account id of the user where the order was placed type: string accountNo: description: The account number of the user where the order was placed type: string tradingType: type: string updated: type: string exchanges: type: array items: oneOf: - $ref: '#/components/schemas/Exchange' required: - accountID - accountNo - tradingType - updated - exchanges ChartsGetBarsResponse: type: object properties: errorCode: type: string message: type: string ChartsGetBars500Response: type: object properties: errorCode: type: string message: type: string InstrumentsGetDetailsResponse: oneOf: - $ref: '#/components/schemas/EquityInstrumentDetails' - $ref: '#/components/schemas/OptionInstrumentBase' - $ref: '#/components/schemas/InstrumentBase' - $ref: '#/components/schemas/DebtInstrumentDetails' discriminator: propertyName: instrumentType mapping: EQUITY: '#/components/schemas/EquityInstrumentDetails' OPTION: '#/components/schemas/OptionInstrumentDetails' MUTUAL_FUND: '#/components/schemas/MutualFundInstrumentDetails' DEBT: '#/components/schemas/DebtInstrumentDetails' OrdersGetOptionOrdersResponse: type: object properties: type: description: The Transaction Batch type. type: string example: OPTIONS_LIQUIDATION pageNo: description: The index (i.e. page number) of where the result set is located. type: number example: 1 totalPages: description: he total amount of pages for the search result. type: number example: 1 pageSize: description: The number of results. type: number example: 20 results: type: array items: $ref: '#/components/schemas/OptionsLiquidationResponse' DepthOfBookGetDebtDepthResponse: type: array items: $ref: '#/components/schemas/MarketQuoteResponse' SettlementsGetCashlessReconciliationResponse: oneOf: - $ref: '#/components/schemas/ReconciliationDetails' SettlementsUpdateCashlessReconciliationResponse: oneOf: - $ref: '#/components/schemas/ReconciliationDetails' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT dwAppKey: type: apiKey in: header name: dw-client-app-key sessionToken: type: apiKey in: header name: dw-auth-token