openapi: 3.0.2 info: title: DriveWealth API version: '1.0' servers: - url: https://bo-api.drivewealth.io/back-office description: Sandbox server (Uses test data) - url: https://bo-api.drivewealth.net/back-office description: Production Server (Uses LIVE data) tags: - name: Funds x-displayName: Funds - name: Trade Allocations x-displayName: Trade Allocations - name: Portfolios x-displayName: Portfolios - name: AutoPilot x-displayName: AutoPilot - name: Commission Schedules x-displayName: Commission Schedules - name: Beneficiaries x-displayName: Beneficiaries - name: Virtual Bank Accounts x-displayName: Virtual Bank Accounts - name: Statements x-displayName: Statements - name: Violations x-displayName: Violations - name: Transactions x-displayName: Transactions - name: Accounts x-displayName: Accounts - name: Deposits x-displayName: Deposits - name: Withdrawals x-displayName: Withdrawals - name: Orders x-displayName: Orders - name: Positions x-displayName: Positions - name: Asset Transfer x-displayName: Asset Transfer - name: Auth x-displayName: Auth - name: Correspondent Reports x-displayName: Correspondent Reports - name: Supported Countries x-displayName: Supported Countries - name: Disclosures x-displayName: Disclosures - name: Escheatment x-displayName: Escheatment - name: Exchanges x-displayName: Exchanges - name: Charts x-displayName: Charts - name: Instruments x-displayName: Instruments - name: Physical Documents x-displayName: Physical Documents - name: Quotes x-displayName: Quotes - name: Depth of Book x-displayName: Depth of Book - name: Settlements x-displayName: Settlements - name: Risk x-displayName: Risk - name: Subscriptions x-displayName: Subscriptions - name: Users x-displayName: Users - name: Linked Bank Accounts x-displayName: Linked Bank Accounts - name: Advisor Reports x-displayName: Advisor Reports paths: /managed/allocations: post: tags: - Trade Allocations summary: Create Trade Allocation description: Create a Trade Allocation. requestBody: content: application/json: schema: $ref: '#/components/schemas/AllocationRequest' required: true responses: '200': description: Creating a Trade Allocation was Successful. content: application/json: schema: $ref: '#/components/schemas/AllocationResponse' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /managed/allocations/{allocationID}: get: tags: - Trade Allocations parameters: - in: path name: allocationID schema: type: string required: true example: JL.allocation.SomeRIACompany.9d6def3b-14d7-4934-8a64-57d443e67ce6 description: The unique identifier returned when a Trade Allocation request is made. summary: Retrieve Trade Allocation description: Retrieves Trade Allocation by allocationID. responses: '200': description: Retrieving Trade Allocation by allocationID was Successful. content: application/json: schema: $ref: '#/components/schemas/AllocationDetails' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /managed/funds: post: deprecated: true tags: - Funds summary: Create Fund description: Creates a Fund. 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' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /managed/funds/{fundID}: get: deprecated: true tags: - Funds parameters: - in: path name: fundID schema: type: string required: true example: fund_3d7d00d1-f08e-4f52-9cbf-893c75cf77fe description: The unique identifier associated with the Fund. summary: Retrieve Fund description: Retrieves a Fund by fundID. responses: '200': description: Retrieving a Fund by fundID was Successful. content: application/json: schema: $ref: '#/components/schemas/fundsResponse' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /managed/portfolios: post: deprecated: true tags: - Portfolios summary: Create Portfolio description: Creates a Portfolio. requestBody: content: application/json: schema: $ref: '#/components/schemas/portfolioReq' required: true responses: '200': description: Creating a Portfolio was Successful. content: application/json: schema: $ref: '#/components/schemas/portfolioRes' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /managed/portfolios/{portfolioID}: get: deprecated: true tags: - Portfolios summary: Retrieve Portfolio description: Retrieves a Portfolio by portfolioID. parameters: - in: path name: portfolioID schema: type: string required: true example: portfolio_4a22340a-31f8-4f0e-b5ee-24ddfbc66727 description: A unique identifier associated with a specific Portfolio. responses: '200': description: Retrieving a Portfolio by portfolioID was Successful. content: application/json: schema: $ref: '#/components/schemas/portfolioRes' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] patch: deprecated: true tags: - Portfolios summary: Update Portfolio description: Updates a Profolio by portfolioID. parameters: - in: path name: portfolioID schema: type: string required: true example: portfolio_4a22340a-31f8-4f0e-b5ee-24ddfbc66727 description: A unique identifier associated with a specific Portfolio. requestBody: content: application/json: schema: type: object properties: name: type: string example: Recession Proof description: A name given to the Portfolio by the RIA. clientPortfolioID: $ref: '#/components/schemas/clientPortfolioID' description: type: string example: A portifolio description. description: A short description for the portfolio. holdings: type: array description: An array of objects that hold the type of Funds in the Portfolio. items: $ref: '#/components/schemas/portfolioReqHoldings' triggers: $ref: '#/components/schemas/portfolioTriggers' responses: '200': description: Updating a Portfolio by portfolioID was Successful. content: application/json: schema: $ref: '#/components/schemas/portfolioRes' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /managed/autopilot/{partnerID}: post: deprecated: true tags: - AutoPilot parameters: - in: path name: partnerID schema: type: string required: true example: 66304da9-3h6f-2234-935f-ac6b7933d706 description: This is the parentIBID or userID of the registered investment advisor. summary: Create Autopilot Run description: Create an Autopilot Run. requestBody: content: application/json: schema: $ref: '#/components/schemas/autopilotReq' required: true responses: '200': description: Creating an Autopilot Run was Successful. content: application/json: schema: $ref: '#/components/schemas/autopilotRes' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /managed/autopilot/{rebalanceRunID}: get: deprecated: true tags: - AutoPilot parameters: - in: path name: rebalanceRunID schema: type: string required: true example: ria_rebalance_ebf7e878-e2d6-4b3d-a333-b8ff05b92b83 description: The unique re-balance run identifier `rebalanceRunID` associated with a specific re-balance. summary: Retrieve Autopilot Run description: Retrieves an Autopilot Run by rebalanceRunID. responses: '200': description: Retrieving an Autopilot Run by rebalanceRunID was Successful. content: application/json: schema: $ref: '#/components/schemas/runStatusRes' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /accounts: post: tags: - Accounts summary: Create Account description: Creates a trading 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: Creating an Account was Successful. content: application/json: schema: $ref: '#/components/schemas/AccountRes' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /accounts/{accountID}: get: tags: - Accounts parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true summary: Retrieve Account description: Retrieves an Account details by accountID. responses: '200': description: Retrieving Account details was Successful. content: application/json: schema: $ref: '#/components/schemas/AccountDetailRes' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] patch: tags: - Accounts parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true summary: Update Account description: Updates an Account details by accountID. 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 Enable Equity Dividend Reinvestment: value: accountFeatures: equities: dividendReinvestment: true capitalGainsReinvestment: true Update Account Status: value: status: FROZEN statusChangeReason: PARTNER_RESTRICTED statusComment: Account is restricted by partner due to suspicious activity. required: true responses: '200': description: Updating an Account details by accountID was Successful. content: application/json: schema: $ref: '#/components/schemas/AccountDetailRes' examples: Account Summary: value: account: id: cc07f91b-7ee1-4868-b8fc-823c70a1b932.1407775317759 accountNo: DWBG000052 accountType: name: LIVE description: Live Account accountMgmtType: name: SELF description: Self Directed Account status: name: OPEN description: Open tradingType: name: CASH description: Cash Account 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 lastActivityDate: '2024-07-23' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /accounts/{accountID}/commissions: get: tags: - Commission Schedules parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true summary: List Commission Schedules description: Retrieves a list of Commissions Schedules by accountID. responses: '200': description: Retrieving a list of Commissions Schedules was Successful. content: application/json: schema: $ref: '#/components/schemas/CommissionsRes' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /accounts/{accountID}/beneficiaries: post: tags: - Beneficiaries parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true summary: Create Account Beneficiaries description: Creates an Account Beneficiary by accountID. requestBody: content: application/json: schema: $ref: '#/components/schemas/BeneficiaryReq' required: true responses: '200': description: Creating an Account Beneficiary was Successful. content: application/json: schema: $ref: '#/components/schemas/BeneficiaryRes' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] get: tags: - Beneficiaries parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true summary: Retrieve Account Beneficiaries description: Retrieves a list of Account Beneficiaries by accountID. responses: '200': description: Retrieving a list of Account Beneficiaries was Successful. content: application/json: schema: $ref: '#/components/schemas/BeneficiaryRes' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] delete: tags: - Beneficiaries parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true summary: Delete Account Beneficiaries description: Removes all Accounts Beneficiaries by accountID. responses: '202': description: Removing all Account Beneficiaries was Accepted. security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /accounts/{accountID}/funding/deposit-instructions: get: tags: - Virtual Bank Accounts parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true summary: Retrieve Account Virtual Bank Account description: Retrieves an Account Virtual Bank Account details by accountID. responses: '200': description: Retrieving Virtual Bank Account details by accountID was Successful. content: application/json: schema: $ref: '#/components/schemas/VirtualAccountRes' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /accounts/{accountID}/funding/deposits: get: tags: - Deposits parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true summary: List Account Deposits description: Retrieves a list of Account Deposits by accountID. responses: '200': description: Retrieving a list of Account Deposits was Successful. content: application/json: schema: $ref: '#/components/schemas/depositsByUserIDObject' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /accounts/{accountID}/funding/redemptions: get: tags: - Withdrawals parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true summary: List Account Withdrawals description: Retrieves a list of Account Withdrawals by accountID responses: '200': description: Retrieving a list of Account Withdrawals was Successful. content: application/json: schema: $ref: '#/components/schemas/Redemptions' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /accounts/{accountID}/summary/orders: get: tags: - Orders summary: List Account resting Orders description: Retrives a list of Account Orders by accountID. The orders returned will all be currently pending Orders that are awaiting a fill or cancellation. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true responses: '200': description: Retrieving a list of Account Orders was Successful. content: application/json: schema: $ref: '#/components/schemas/PendingOrders' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /accounts/{accountID}/reports/order-history: get: tags: - Orders summary: List Account historical Orders description: Retrieves a list of Account Orders by accountID. The orders returned are ones that have been previously closed, either by being filled or by being canceled. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true - in: query name: from schema: type: string required: true example: '2022-06-16' description: Date start 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: Date end time of data. Follow [ISO 8601 standard](https://en.wikipedia.org/wiki/ISO_8601) - in: query name: limit schema: type: number required: false example: 25 description: The number of orders to be returned per page. - in: query name: offset schema: type: string required: false example: '2022-07-16' description: Follow [ISO 8601 standard](https://en.wikipedia.org/wiki/ISO_8601) - in: query name: direction schema: type: string enum: - prev - next required: false example: prev description: The direction of pagination. responses: '200': description: Retrieving a list of Account Orders was Successful content: application/json: schema: $ref: '#/components/schemas/OrderHistoryRes' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /accounts/{accountID}/portfolio: get: deprecated: true tags: - AutoPilot parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true summary: Retrieve Portfolio by Account description: Retrieve Portfolio details by accountID. responses: '200': description: Fetching Portfolio details was Successful. content: application/json: schema: $ref: '#/components/schemas/PortfolioStatusRes' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /accounts/{accountID}/summary/money: get: tags: - Accounts parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true summary: Retrieve Account Cash description: Retrieves an Account Cash details by accountID. responses: '200': description: Retrieving Money details was Successful. content: application/json: schema: $ref: '#/components/schemas/MoneyDetailsRes' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /accounts/{accountID}/statements: get: tags: - Statements parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true summary: List Account Statements description: Retrives a list of Account Statements by accountID. responses: '200': description: Retrieving a list of Account Statements by accountID was Successful. content: application/json: schema: $ref: '#/components/schemas/StatementListRes' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /accounts/{accountID}/taxforms: get: tags: - Statements parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true - $ref: '#/components/parameters/fromParams' - $ref: '#/components/parameters/toParams' summary: List Account Tax Statements description: Retrieves a list of Account Tax Statements by accountID. responses: '200': description: Retrieving a list of Account Tax Statements by accountID was Successful. content: application/json: schema: $ref: '#/components/schemas/ListTaxDocsRes' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /accounts/{accountID}/confirms: get: tags: - Statements parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true - in: query name: from schema: type: string required: false example: '2018-09-18' description: Filter, the date from which to start the search. - in: query name: to schema: type: string required: false example: '2019-09-18' description: Filter, the date to which to end the search. summary: List Account Trade Confirmations description: Retrieves a list of Account Trade Confirmations by accountID. responses: '200': description: Retrieving a list of Account Trade Confirmations by accountID was Successful. content: application/json: schema: $ref: '#/components/schemas/ListTradeConfirmsRes' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /accounts/{accountID}/summary: get: tags: - Accounts parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true summary: Retrieve Account Summary description: |- Retrieves an Account Summary details by accountID. The full Account Summary API is now deprecated. Instead, use the individual APIs for retrieving the Account's Positions, Transactions, or Orders separately. deprecated: true responses: '200': description: Retrieving Account Summary details by accountID was Successful. content: application/json: schema: $ref: '#/components/schemas/SummaryRes' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /accounts/{accountID}/performance: get: deprecated: true tags: - Accounts parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true - in: query name: period schema: type: string enum: - 1d - '*d' - 1w - '*w' - 1m - '*m' - 1y - '*y' required: false example: 3d 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: from schema: type: string required: false example: '2018-09-18' description: Start date and time of requested time frame of the accounts performance. - in: query name: to schema: type: string required: false example: '2019-09-18' description: End date and time of requested time frame of the accounts performance. summary: Retrieve Account Performance description: Retrieves realtime Account Performance details by accountID. responses: '200': description: Retrieving realtime Account Performance details by accountID was Successful. content: application/json: schema: $ref: '#/components/schemas/PerformanceRes' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /accounts/{accountID}/summary/positions: get: tags: - Positions parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true summary: List Account Positions description: Retrives a list of Account Positions by accountID responses: '200': description: Retrieving an Account's Positions by accountID was Successful. content: application/json: schema: $ref: '#/components/schemas/PositionsRes' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /accounts/{accountID}/summary/violations: get: tags: - Violations parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true summary: Retrieve Account Violations Summary description: Retrives Account Violations Summary details by accountID. responses: '200': description: Retrieving an Account Violations Summary details by accountID was Successful. content: application/json: schema: $ref: '#/components/schemas/ViolationListRes' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /accounts/{accountID}/violations: get: tags: - Violations parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true summary: List Account Violations description: Retrives a list of Account Violations by accountID. responses: '200': description: Retrieving a list of Account Violations by accountID was Successful. content: application/json: schema: $ref: '#/components/schemas/ViolationDetailsRes' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /accounts/{accountID}/summary/margin: get: tags: - Accounts parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true summary: Retrieve Account Margin description: Retrieves Account Margin details by accountID. responses: '200': description: Retrieving an Account Margin details by accountID was Successful. content: application/json: schema: $ref: '#/components/schemas/MarginRes' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /accounts/{accountID}/summary/transactions: get: deprecated: true tags: - Transactions parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true summary: Retrieve Account Transaction Summary description: |- Retrives an Account Transaction Summary details by accountID. This API has been deprecated. Instead, use List Account Transactions to retrieve historical Transactions. To retrieve orders, use List Account historical Orders. responses: '200': description: Retrieving Account Transaction Summary details was Successful. content: application/json: schema: $ref: '#/components/schemas/TransactionSummaryRes' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /accounts/{accountID}/transactions: get: tags: - Transactions parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true - in: query name: from schema: type: string required: true example: '2022-06-16' description: Date start 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: Date end time of data. Follow [ISO 8601 standard](https://en.wikipedia.org/wiki/ISO_8601) - in: query name: limit schema: type: number required: false example: 25 description: The number of transactions to be returned per page. - in: query name: offset schema: type: string required: false example: '2022-07-16' description: Follow [ISO 8601 standard](https://en.wikipedia.org/wiki/ISO_8601) - in: query name: direction schema: type: string enum: - prev - next required: false example: prev description: The direction of pagination summary: List Account Transactions description: Retrieves a list of Account Transactions by accountID. responses: '200': description: Retrieving a list of Account Transactions was Successful. content: application/json: schema: $ref: '#/components/schemas/TransactionRes' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /accounts/{accountID}/position-details: get: tags: - Accounts summary: Retrieve Account Lots description: Retrieves an Account Lots details by accountID. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true responses: '200': description: Retrieving Account Lots details 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 side: B 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: 3db27e74626adac3be7b549f2bbc0ab2480852a7 created: '2023-09-25T15:28:12.120Z' initialQuantity: 0.00407932 openQuantity: 0.00407932 effectiveCostPerShare: 245.14 side: B comment: TSLA FRACK part TSLA KI... security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /accounts/{accountID}/options/positions: get: tags: - Positions parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true - in: query name: filterBy schema: type: string example: expirationDate description: The expiration date of options; to filter by. - in: query name: from schema: type: string example: '2023-02-16' description: The start date of the range of option's expiration. - in: query name: to schema: type: string required: false example: '2023-02-16' description: The end date of the range of option's expiration. - in: query name: limit schema: type: number default: 50 required: false example: 10 description: The number of results to be returned. - 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 description: The identifier of the page. summary: Retrieve Account Option Positions description: Retrieves Account Option Positions responses: '200': description: Retrieving Account Option Positions was Successful. content: application/json: schema: $ref: '#/components/schemas/OptPositionRes' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /asset-transfers/acats: post: tags: - Asset Transfer summary: Create ACATS Transfer responses: '200': description: Initiating a transfer was successful content: application/json: schema: $ref: '#/components/schemas/ACATSTransferCreatedResponseModel' examples: ACATS Transfer (Full): value: id: acats_41eb5bdd-8ce2-4471-8fc6-9892da089cd1 source: BROKER0001 sourceAccountID: d6a776bc-be5c-47df-94eb-baf914f1847c.1738660911962 destination: DWXR001004 destinationAccountID: c815c129-27cd-46f2-b316-ab6bde9aff62.1737384219426 clearingNo: '0001' status: name: PENDING description: Asset transfer request is pending type: name: ACAT description: ACAT transfer acatType: name: FULL description: Full Acats Transfer sourceAccountType: name: INDIVIDUAL description: Individual Account positions: [] metadata: {} auditDetails: - timestamp: '2023-07-28T23:56:10.507Z' status: name: STARTED description: Asset transfer request has been initiated. comment: Transfer request has been submitted in queue - timestamp: '2023-07-28T23:56:10.645Z' status: name: PENDING description: Asset transfer request is pending comment: created: '2023-07-28T23:56:10.491Z' updated: '2023-07-28T23:56:10.667Z' ACATS Transfer (Partial): value: id: acats_45dc50ac-3daa-484d-98cb-5264abb51d86 source: FOLIO123 sourceAccountID: d6a776bc-be5c-47df-94eb-baf914f1847c.1738660911962 destination: DWKN000094 destinationAccountID: c815c129-27cd-46f2-b316-ab6bde9aff62.1737384219426 clearingNo: '0001' status: name: STARTED description: Asset transfer request has been initiated. acatType: name: PARTIAL description: Partial Acats Transfer sourceAccountType: name: INDIVIDUAL description: Individual Account cash: 10 positions: - symbol: META instrumentID: 4312a85c-93ba-4adb-b50d-cc7973243a53 quantity: 1 '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' 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 Invalid clearing broker: value: errorCode: E032 message: Invalid or missing parameters in the request body. Refer to the API documentation for details. errorDetails: detail: 'Refer supported DTCC Broker list on API documentation. ' field: brokerCode type: STRING Cash Should be Greater Than 0 400 Bad: value: errorCode: E032 message: Invalid or missing parameters in the request body. Refer to the API documentation for details. errorDetails: detail: cash should greater than 0 field: cash type: DECIMAL Invalid Symbol in Partial Acats Transfer 400 Bad: value: errorCode: I019 message: Invalid symbol(s) in the request body. errorDetails: detail: Invalid value for AMZ field: positions.symbol type: STRING Positions Required on Partial Acat Transfer 400 Bad: value: errorCode: E032 message: Invalid or missing parameters in the request body. Refer to the API documentation for details. errorDetails: field: positions type: OBJECT Acat Type is Missing 400 Bad: value: errorCode: E032 message: Invalid or missing parameters in the request body. Refer to the API documentation for details. errorDetails: detail: PARTIAL, FULL field: type type: ENUM requestBody: content: application/json: schema: $ref: '#/components/schemas/AcatsCreateRequestModel' 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. security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /asset-transfers/minor-graduation: post: tags: - Asset Transfer summary: Create Minor Graduation Transfer responses: '200': description: Initiating a transfer was successful content: application/json: schema: $ref: '#/components/schemas/GenericTransferResponseModel' examples: Minor Graduation Created: value: id: grad_28d08c72-3d0f-4c6e-8961-2dc6491c28a8 source: LKGE000001 destination: LKKZ000004 status: name: STARTED description: Asset transfer request has been initiated. type: name: TEEN description: Teen Account Transfer created: '2023-07-26T14:05:18.518Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' examples: Validate Source accountNo 400 Bad: value: errorCode: E033 message: Invalid parameter in message body. Refer to the API documentation for details. errorDetails: field: source type: STRING Validate Destination accountNo 400 Bad: value: errorCode: E033 message: Invalid parameter in message body. Refer to the API documentation for details. errorDetails: field: destination type: STRING Source and Destination account can't be same in transfer 400 Bad: value: errorCode: E032 message: 'Invalid or missing parameters in the request body. Refer to the API documentation for details. Details: Source and Destination accounts can''t be same.' Destination account should be OPEN 400 Bad: value: errorCode: U072 message: 'User is not allowed to access this resource. Forbidden: LKAF000023 should be OPEN in order to initiate the transfer.' Source account should be OPEN 400 Bad: value: errorCode: T004 message: 'Assets Transfer cannot initiate. Details: LKKZ000021 has PENDING account status, user can''t initiate the transfer. Please contact support.' Source account has no cash and positions both 400 Bad: value: errorCode: T004 message: 'Assets Transfer cannot initiate. Details: LKMA000035 has no cash or positions, user can''t initiate the transfer. Please contact support.' Missing Authorized User on Teen Account 400 Bad: value: errorCode: A022 message: Authorized user on account is missing. Refer to the API documentation for the details. Duplicate Minor Asset Transfer Request 400 Bad: value: errorCode: E020 message: 'Value is already exists. Details: Assets transfer request is already exist for LKNS000023' requestBody: content: application/json: schema: $ref: '#/components/schemas/MinorCreateRequestModel' examples: Minor Graduation: value: source: LKGE000001 destination: LKKZ000004 comment: Migrating Teen account to Individual account. metadata: {} 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. security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /asset-transfers/{assetTransferID}: parameters: - schema: type: string name: assetTransferID in: path required: true get: tags: - Asset Transfer summary: Retrieve Transfer responses: '200': description: OK content: application/json: schema: anyOf: - $ref: '#/components/schemas/AcatsTransferGetResponseModel' - $ref: '#/components/schemas/GenericTransferResponseModel' examples: ACATS Transfer (Full): value: id: acats_385621f4-ef89-4a4e-8cc1-ef1295549ca4 source: FA-IJKE001 destination: DWWFP000907 destinationAccountID: deb66500-168a-4432-9b1c-05a58e1d563f.1742485154193 clearingNo: '0123' status: name: PENDING description: Asset transfer request is pending type: name: ACAT description: ACAT transfer acatType: name: FULL description: Full Acats Transfer acatTransit: name: ACAT_IN description: Incoming ACAT Transfer sourceAccountType: name: INDIVIDUAL description: Individual Account partner: id: ac5de50f-2297-e2e7-7b31-2c54872ae231 name: Test incomingCash: 10000 positions: [] incomingPositions: - symbol: AMD cusip: '007903107' instrumentID: 0bfd8059-8456-4b1b-1491-b394992409df quantity: 8 - symbol: SBSI cusip: 84470P109 instrumentID: 1c6c1625-a84b-4dd3-8146-c6a97cd74bcf quantity: 7 - symbol: TSLA cusip: 88160R101 instrumentID: 5b85fabb-a7f6-44e6-d57c-a3efc760226c quantity: 9 outgoingPositions: [] settlementInfo: controlNo: '20250320013533' status724: '310' status: ACAT_SETTLED positions: accepted: - '007903107' - 84470P109 - 88160R101 cash: 10000 auditDetails: - timestamp: '2025-03-20T15:39:19.319Z' status: name: STARTED description: Asset transfer request has been initiated. comment: Transfer request has been submitted in queue - timestamp: '2025-03-20T15:43:09.252Z' status: name: PENDING description: Asset transfer request is pending comment: TIF has been created updatedBy: ACAT_TRANSFER_SYSTEM - timestamp: '2025-03-20T15:44:26.852Z' status: name: PENDING description: Asset transfer request is pending comment: Transfer is under review updatedBy: ACAT_STATUS_UPDATE_SYSTEM - timestamp: '2025-03-20T15:45:03.041Z' status: name: PENDING description: Asset transfer request is pending status724: '230' comment: ACAT auto-review completed. Ready for sending to DTCC. updatedBy: ACAT_REVIEW_SYSTEM - timestamp: '2023-10-20T18:00:04.185Z' status: name: PENDING description: Asset transfer request is pending status724: '500' comment: Partial transfer in progress updatedBy: ACAT_STATUS_UPDATE_SYSTEM - timestamp: '2023-10-21T00:01:19.340Z' status: name: SUCCESSFUL description: Asset transfer request has been successfully completed status724: '310' comment: Transfer Settled updatedBy: ACAT_STATUS_UPDATE_SYSTEM created: '2025-03-20T15:39:19.226Z' updated: '2025-03-20T15:44:27.029Z' ACATS Transfer (Partial): value: id: acats_0a18eea2-c63d-447a-a0f1-1c7d9a08c9da source: TR6666 destination: FWCT000005 destinationAccountID: c815c129-27cd-46f2-b316-ab6bde9aff62.1737384219426 clearingNo: '0158' status: name: SUCCESSFUL description: Asset transfer request has been successfully completed type: name: ACAT description: ACAT transfer acatType: name: PARTIAL description: Partial Acats Transfer acatTransit: name: ACAT_IN description: Incoming Acats Transfer sourceAccountType: name: INDIVIDUAL description: Individual Account partner: id: 25f77a3e-2a4b-48bf-bea2-1b8bcd541621 name: Stark House incomingCash: 0 incomingPositions: - symbol: AMD cusip: '007903107' instrumentID: 0bfd8059-8456-4b1b-1491-b394992409df quantity: 3 - symbol: SBSI cusip: 84470P109 instrumentID: 1c6c1625-8146-4dd3-a84b-c6a97cd74bcf quantity: 56 outgoingPositions: [] settlementInfo: controlNo: '20250320013533' status724: '310' status: ACAT_SETTLED positions: accepted: - '007903107' positions: - symbol: AMD instrumentID: 0bfd8059-8456-4b1b-1491-b394992409df quantity: 3 - symbol: SBSI instrumentID: 1c6c1625-8146-4dd3-a84b-c6a97cd74bcf quantity: 56 metadata: {} auditDetails: - timestamp: '2023-10-20T13:02:50.970Z' status: name: STARTED description: Asset transfer request has been initiated. comment: Transfer request has been submitted in queue - timestamp: '2023-10-20T15:00:04.185Z' status: name: PENDING description: Asset transfer request is pending comment: TIF has been created updatedBy: ACAT_TRANSFER_SYSTEM - timestamp: '2023-10-20T17:00:04.185Z' status: name: PENDING description: Asset transfer request is pending status724: '230' comment: ACAT auto-review completed. Ready for sending to DTCC. updatedBy: ACAT_REVIEW_SYSTEM - timestamp: '2023-10-20T18:00:04.185Z' status: name: PENDING description: Asset transfer request is pending status724: '500' comment: Partial transfer in progress updatedBy: ACAT_STATUS_UPDATE_SYSTEM - timestamp: '2023-10-21T00:01:19.340Z' status: name: SUCCESSFUL description: Asset transfer request has been successfully completed status724: '310' comment: Transfer Settled updatedBy: ACAT_STATUS_UPDATE_SYSTEM created: '2023-10-20T13:02:50.960Z' updated: '2023-10-21T00:01:19.340Z' ACATS Transfer accepted: value: id: acats_385621f4-ef89-4a4e-8cc1-ef1295549ca4 source: TR6666 destination: DWWFP000907 destinationAccountID: deb66500-168a-4432-9b1c-05a58e1d563f.1742485154193 clearingNo: '0123' status: name: PENDING description: Asset transfer request is pending type: name: ACAT description: ACAT transfer acatType: name: FULL description: Full Acats Transfer acatTransit: name: ACAT_IN description: Incoming ACAT Transfer sourceAccountType: name: INDIVIDUAL description: Individual Account partner: id: ac5de50f-2297-e2e7-7b31-2c54872ae231 name: Test incomingCash: 0 positions: [] incomingPositions: - symbol: AMD cusip: '007903107' instrumentID: 0bfd8059-8456-4b1b-1491-b394992409df quantity: 3 outgoingPositions: [] settlementInfo: controlNo: '20250320013533' status724: '230' status: ACAT_REVIEW_ACCEPTED positions: accepted: - '007903107' auditDetails: - timestamp: '2025-03-20T15:39:19.319Z' status: name: STARTED description: Asset transfer request has been initiated. comment: Transfer request has been submitted in queue - timestamp: '2025-03-20T15:43:09.252Z' status: name: PENDING description: Asset transfer request is pending comment: TIF has been created updatedBy: ACAT_TRANSFER_SYSTEM - timestamp: '2025-03-20T15:44:26.852Z' status: name: PENDING description: Asset transfer request is pending comment: Transfer is under review updatedBy: ACAT_STATUS_UPDATE_SYSTEM - timestamp: '2025-03-20T15:45:03.041Z' status: name: PENDING description: Asset transfer request is pending status724: '230' comment: ACAT auto-review completed. Ready for sending to DTCC. updatedBy: ACAT_REVIEW_SYSTEM created: '2025-03-20T15:39:19.226Z' updated: '2025-03-20T15:44:27.029Z' ACATS Transfer rejected, symbol unsupported: value: id: acats_afa75685-370b-4b28-a3d1-3e791797f4e6 source: FAKE001 destination: DWWHA000914 destinationAccountID: deb66500-168a-4432-9b1c-05a58e1d563f.1742496584428 clearingNo: '0123' status: name: PENDING description: Asset transfer request is pending type: name: ACAT description: ACAT transfer acatType: name: PARTIAL description: Partial Acats Transfer acatTransit: name: ACAT_IN description: Incoming ACAT Transfer sourceAccountType: name: INDIVIDUAL description: Individual Account partner: id: ac5de50f-2297-e2e7-7b31-2c54872ae231 name: Test incomingCash: 100 positions: - symbol: AMD instrumentID: 0bfd8059-8456-4b1b-1491-b394992409df quantity: 15 incomingPositions: - symbol: AMD cusip: '007903107' instrumentID: 0bfd8059-8456-4b1b-1491-b394992409df quantity: 3 outgoingPositions: [] settlementInfo: controlNo: '20250320013538' status724: '220' status: ACAT_REVIEW_ERROR cash: 100 rejectionInfo: rejected: '007903107': AMD is not supported. EQUITY is not supported. rejectionCode: SYMBOL_NOT_SUPPORTED rejectionReason: Instrument not supported positions: '007903107': AMD is not supported. EQUITY is not supported. auditDetails: - timestamp: '2025-03-20T18:54:32.953Z' status: name: STARTED description: Asset transfer request has been initiated. comment: Transfer request has been submitted in queue - timestamp: '2025-03-20T18:54:41.967Z' status: name: PENDING description: Asset transfer request is pending comment: TIF has been created - timestamp: '2025-03-20T18:56:19.001Z' status: name: PENDING description: Asset transfer request is pending comment: Transfer is under review - timestamp: '2025-03-20T18:56:27.547Z' status: name: PENDING description: Asset transfer request is pending status724: '220' comment: ACAT auto-review completed. Ready for sending to DTCC. created: '2025-03-20T18:54:32.914Z' updated: '2025-03-20T18:56:19.148Z' ACATS Transfer rejected, debit balance: value: id: acats_8a83f127-642f-467f-9b3c-499995d20c23 source: FAKE001 destination: DWWNE000902 destinationAccountID: deb66500-168a-4432-9b1c-05a58e1d563f.1742500153887 clearingNo: '0123' status: name: PENDING description: Asset transfer request is pending type: name: ACAT description: ACAT transfer acatType: name: PARTIAL description: Partial Acats Transfer acatTransit: name: ACAT_IN description: Incoming ACAT Transfer sourceAccountType: name: INDIVIDUAL description: Individual Account partner: id: ac5de50f-2297-e2e7-7b31-2c54872ae231 name: Test cash: 500 incomingCash: -700 positions: - symbol: AMD instrumentID: 0bfd8059-8456-4b1b-1491-b394992409df quantity: 15 incomingPositions: - symbol: AMD cusip: '007903107' instrumentID: 0bfd8059-8456-4b1b-1491-b394992409df quantity: 15 outgoingPositions: [] settlementInfo: controlNo: '20250320013541' status724: '220' status: ACAT_REVIEW_ERROR positions: accepted: - '007903107' rejectionInfo: rejectionCode: MISSING_FUND rejectionReason: Partial transfer cannot have debit balance. cash: 700 auditDetails: - timestamp: '2025-03-20T19:49:18.653Z' status: name: STARTED description: Asset transfer request has been initiated. comment: Transfer request has been submitted in queue - timestamp: '2025-03-20T19:50:08.062Z' status: name: PENDING description: Asset transfer request is pending status724: '200' comment: Transfer is under review updatedBy: ACAT_STATUS_UPDATE_SYSTEM - timestamp: '2025-03-20T19:50:32.102Z' status: name: PENDING description: Asset transfer request is pending status724: '220' comment: ACAT auto-review completed. Ready for sending to DTCC. updatedBy: ACAT_REVIEW_SYSTEM created: '2025-03-20T19:49:18.627Z' updated: '2025-03-20T19:50:08.308Z' ACATS Transfer with excluded securities: value: id: acats_91bd66d1-85bd-49c7-ae1a-aefb9e77a79e source: FF-12-001 destination: DWWNE000901 destinationAccountID: deb66500-168a-4432-9b1c-05a58e1d563f.1742499753944 clearingNo: '0123' status: name: PENDING description: Asset transfer request is pending type: name: ACAT description: ACAT transfer acatType: name: PARTIAL description: Partial Acats Transfer acatTransit: name: ACAT_IN description: Incoming ACAT Transfer sourceAccountType: name: INDIVIDUAL description: Individual Account partner: id: ac5de50f-2297-e2e7-7b31-2c54872ae231 name: Test incomingCash: 100 positions: - symbol: AMD instrumentID: 0bfd8059-8456-4b1b-1491-b394992409df quantity: 15 incomingPositions: - symbol: AMD cusip: '007903107' instrumentID: 0bfd8059-8456-4b1b-1491-b394992409df quantity: 15 - symbol: '' cusip: L7066G104 quantity: 21 - symbol: '' cusip: L8066G104 quantity: 21 - symbol: '' cusip: L9066G104 quantity: 21 outgoingPositions: [] settlementInfo: controlNo: '20250320013540' status724: '230' status: ACAT_REVIEW_ACCEPTED positions: accepted: - '007903107' excluded: L7066G104: Offshore MF found and excluded. L8066G104: Offshore MF found and excluded. L9066G104: Offshore MF found and excluded. cash: 100 auditDetails: - timestamp: '2025-03-20T19:42:38.877Z' status: name: STARTED description: Asset transfer request has been initiated. comment: Transfer request has been submitted in queue - timestamp: '2025-03-20T19:43:32.377Z' status: name: PENDING description: Asset transfer request is pending status724: '200' comment: Transfer is under review updatedBy: ACAT_STATUS_UPDATE_SYSTEM - timestamp: '2025-03-20T19:43:56.113Z' status: name: PENDING description: Asset transfer request is pending status724: '230' comment: ACAT auto-review completed. Ready for sending to DTCC. updatedBy: ACAT_REVIEW_SYSTEM created: '2025-03-20T19:42:38.799Z' updated: '2025-03-20T19:43:32.611Z' Minor Graduation: value: id: grad_28d08c72-3d0f-4c6e-8961-2dc6491c28a8 source: LKGE000001 destination: LKKZ000004 status: name: STARTED description: Asset transfer request has been initiated. acatType: name: FULL description: Full ACATs Transfer type: name: TEEN description: Teen Account Transfer partner: id: 25f77a3e-2a4b-48bf-bea2-1b8bcd541621 name: Stark House auditDetails: - timestamp: '2023-07-26T14:05:18.518Z' status: name: STARTED description: Asset transfer request has been initiated. comment: Transfer request has been submitted in queue created: '2023-07-26T14:05:18.518Z' description: Get a Transfer's current details. security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /asset-transfers: get: summary: List Transfers tags: - Asset Transfer description: Lists all of your Transfers across all Accounts. This can be filtered by type of Transfer. parameters: - schema: $ref: '#/components/schemas/AssetTransferStatus' in: query name: status description: A status to filter by - schema: $ref: '#/components/schemas/AssetTransferType' in: query name: type description: A Transfer type to filter by required: true - in: query name: limit description: Maximum number of records to be returned schema: type: string - in: query name: offset description: Specify an identifier from last API response to go to the next page or prev page schema: type: string - in: query name: direction description: Go to the next page or prev page schema: type: string enum: - prev - next responses: '200': description: Listing Transfers was successful content: application/json: schema: type: object properties: data: type: array items: anyOf: - $ref: '#/components/schemas/AcatsTransferListResponseModel' - $ref: '#/components/schemas/GenericTransferResponseModel' nextPageOffset: type: string description: The next page offset. prevPageOffset: type: string description: The previous page offset. examples: List Assets Transfers [TEEN]: value: data: - id: grad_ba9522d8-0f3a-43bd-bb16-9efc0ad1a913 source: DWCW001118 destination: DWYE001127 status: name: SUCCESSFUL description: Asset transfer request has been successfully completed type: name: TEEN description: Teen Account Transfer partner: id: 25f77a3e-2a4b-48bf-bea2-1b8bcd541621 name: Stark House auditDetails: - timestamp: '2023-10-25T16:00:42.126Z' status: name: STARTED description: Asset transfer request has been initiated. comment: Transfer request has been submitted in queue - timestamp: '2023-10-25T16:00:42.257Z' status: name: PENDING description: Asset transfer request is pending comment: Transfer process started - timestamp: '2023-10-27T21:00:07.959Z' status: name: ON_HOLD description: Asset transfer request is on hold. comment: Transfer is on hold for DWCW001118. Settlement is not finished yet. - timestamp: '2023-10-28T14:00:02.453Z' status: name: SUCCESSFUL description: Asset transfer request has been successfully completed 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: name: ON_HOLD description: Asset transfer request is on hold. type: name: TEEN description: Teen Account Transfer partner: id: 25f77a3e-2a4b-48bf-bea2-1b8bcd541621 name: Stark House auditDetails: - timestamp: '2023-10-29T04:00:56.167Z' status: name: STARTED description: Asset transfer request has been initiated. comment: Transfer request has been submitted in queue - timestamp: '2023-10-29T04:00:56.309Z' status: name: PENDING description: Asset transfer request is pending comment: Transfer process started - timestamp: '2023-11-01T21:00:02.207Z' status: name: ON_HOLD description: Asset transfer request is 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 sourceAccountID: d6a776bc-be5c-47df-94eb-baf914f1847c.1738660911962 destination: FWCT000005 destinationAccountID: c815c129-27cd-46f2-b316-ab6bde9aff62.1737384219426 clearingNo: '1111' status: name: PENDING description: Asset transfer request is pending type: name: ACAT description: ACAT transfer acatType: name: PARTIAL description: Partial Acats Transfer acatTransit: name: ACAT_IN description: Incomming Acats Transfer sourceAccountType: name: INDIVIDUAL description: Individual Account partner: id: 25f77a3e-2a4b-48bf-bea2-1b8bcd541621 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: name: STARTED description: Asset transfer request has been initiated. comment: Transfer request has been submitted in queue - timestamp: '2023-10-20T15:00:04.207Z' status: name: PENDING description: Asset transfer request is 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-1c7d9a08c9da source: TR6666 sourceAccountID: d6a776bc-be5c-47df-94eb-baf914f1847c.1738660911962 destination: FWCT000005 destinationAccountID: c815c129-27cd-46f2-b316-ab6bde9aff62.1737384219426 clearingNo: '1111' status: name: SUCCESSFUL description: Asset transfer request has been successfully completed type: name: ACAT description: ACAT transfer acatType: name: PARTIAL description: Partial Acats Transfer sourceAccountType: name: INDIVIDUAL description: Individual Account 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: name: STARTED description: Asset transfer request has been initiated. comment: Transfer request has been submitted in queue - timestamp: '2023-10-20T15:00:04.185Z' status: name: PENDING description: Asset transfer request is pending comment: TIF has been created - timestamp: '2023-11-02T00:01:19.340Z' status: name: SUCCESSFUL description: Asset transfer request has been successfully completed comment: Transfer Settled created: '2023-10-20T13:02:50.960Z' updated: '2023-11-02T00:01:19.340Z' - id: acats_d9faa000-9d97-4ab8-85f8-cbd856d31b79 source: TR6666 sourceAccountID: d6a776bc-be5c-47df-94eb-baf914f1847c.1738660911962 destination: FWRT000005 destinationAccountID: c815c129-27cd-46f2-b316-ab6bde9aff62.1737384219426 clearingNo: '1111' status: name: FAILED description: Asset transfer is failed. type: name: ACAT description: ACAT transfer acatType: name: FULL description: Full Acats Transfer sourceAccountType: name: INDIVIDUAL description: Individual Account partner: id: 25f77a3e-2a4b-48bf-bea2-1b8bcd541621 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: name: STARTED description: Asset transfer request has been initiated. comment: Transfer request has been submitted in queue - timestamp: '2023-09-12T15:55:03.294Z' status: name: PENDING description: Asset transfer request is pending comment: Request has been submitted for ACAT transfer - timestamp: '2023-11-02T00:01:34.330Z' status: name: FAILED description: Asset transfer is 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: '' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /auth: post: tags: - Auth summary: Create Authentication Token description: Creates an authentication token for an implementer to utilize for subsequent API requests. deprecated: true 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' security: [] /auth/tokens: post: tags: - Auth summary: Create Session Token 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' security: [] /correspondantReport: get: tags: - Correspondent Reports parameters: - in: query name: date schema: type: string required: true example: '2023-03-21' description: The date for which the Correspondent Report is being requested summary: Retrieve Correspondent Reports description: Fetch daily reports generated to provide positions, account activity, balances, and more in file format responses: '200': description: Fetching Correspondent reports was successful. content: application/json: schema: type: object properties: url: $ref: '#/components/schemas/fileURL' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' examples: Invalid request missing date: value: errorCode: E031 message: 'Invalid or missing parameters in the request URL or body. Refer to the API documentation for details. Details: Required : [date]' Invalid request: value: errorCode: E033 message: Invalid parameter in message body. Refer to the API documentation for details. '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /countries: get: tags: - Supported Countries summary: List Supported Countries description: Retrieves a list of allowed countries for which users can be onboard from. parameters: - in: query name: status schema: type: string enum: - ACTIVE - INACTIVE required: true example: ACTIVE description: Filters on the returned countries list has inactive or active countries inside it. responses: '200': description: Retrieving a list of Supported Countries was Successful. content: application/json: schema: $ref: '#/components/schemas/ListOfAllowedCountries' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /funding/deposits: post: tags: - Deposits summary: Create Deposit description: Creates a Deposit. parameters: - in: header name: Idempotency-Key schema: type: string example: a1b2c3d4-5e6f-7g8h-9i0j-1k2l3m4n5o6 required: false description: A unique key (UUID) that is used to prevent duplicate requests. Should a network interruption occur, or you otherwise lost a response from the API, you can safely perform the request provided that you send the same value as the Idempotency-Key. DriveWealth Idempotency Keys are saved for 4 days. Within this time period, sending any request with a duplicate key will return the exact same response as the original request, including the same status code and payload. 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' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /funding/deposits/{depositID}: get: tags: - Deposits summary: Retrieve Deposit description: Retrieves Deposit details by depositID. parameters: - in: path name: depositID schema: $ref: '#/components/schemas/depositID' required: true description: A unique identifier for the user's account deposit. responses: '200': description: Retrieving a Deposit by depositID was Successful. content: application/json: schema: $ref: '#/components/schemas/DepositByDepositID' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /exchanges: post: tags: - Exchanges summary: Create Instrument Exchange description: Creates an Instrument Exchange. The ability to sale of a held instrument and purchase of another. responses: '200': description: Creating an Exchange was Successful. content: application/json: schema: type: object properties: id: type: string description: 'The specific id of the exchange. ' exchangeNo: type: string description: The specific exchange number required: - id - exchangeNo examples: Example 1: value: id: IC.0e352bb7-9869-4233-9861-1173544efedd exchangeNo: ICDU023727 requestBody: content: application/json: schema: type: object properties: accountNo: $ref: '#/components/schemas/accountNo' sellSymbol: type: string description: This will be the ticker of the mutual fund you will be liquidating. example: VTSMX buySymbol: type: string description: This will be the ticker of the mutual fund you will be purchasing with the proceeds of the liquidation. example: VTSAX amountCash: type: number description: This is the total notional amount you exchange from the sellSymbol to the buySymbol. This field is populated if quantity is null example: '100.00' quantity: type: number 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. example: 100.503 required: - accountNo - sellSymbol - buySymbol - amountCash - quantity examples: Example 1: value: accountNo: DWPH000003 sellSymbol: VTSMX buySymbol: VTSAX amountCash: 100 quantity: 10 description: '' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] patch: tags: - Exchanges summary: Update Instrument Exchange responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string description: The ID of the Exchange exchangeNo: type: string description: A human-readable number that represents the Exchange required: - id - exchangeNo examples: Example 1: value: id: IC.0e352bb7-9869-4233-9861-1173544efedd exchangeNo: ICDU023727 description: Updates an Instrument Exchange. requestBody: content: application/json: schema: type: object properties: method: type: string example: CANCEL required: - method security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /exchanges/{exchangeIdentifier}: parameters: - schema: type: string name: exchangeIdentifier in: path required: true description: The Exchange ID (id) or Exchange Number (exchangeNo) get: tags: - Exchanges summary: Retrieve Exchange responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string description: The specific id of the exchange exchangeNo: type: string description: The specific exchange number status: type: string description: The state of the exchange. enum: - NEW - FILLED - REJECTED - PENDING_CANCEL - CANCELED - FILLED sellSymbol: type: string description: This will be the ticker of the mutual fund you will be liquidating sellOrderId: type: string description: The order ID corresponding to the sell transaction sellOrderNo: type: string description: The order number corresponding to the sell transaction buySymbol: type: string description: This will be the ticker of the mutual fund you will be purchasing with the proceeds of the liquidation buyOrderId: type: string description: The order ID corresponding to the buy transaction buyOrderNo: type: string description: The order number corresponding to the buy transaction sellAveragePrice: type: number description: The price the sell order was filled at sellCumulativeQuantity: type: number description: The total quantity the sell was for buyAveragePrice: type: number description: The price the buy order was filled at buyCumulativeQuantity: type: number description: The total quantity the buy was for amountCash: type: number description: This is the total notional amount you exchange from the sellSymbol to the buySymbol. This field is populated if quantity is null. fees: type: number description: The total fees for both the buy and sell order of the exchange orderExpires: type: string description: The date the exchange expires createdBy: type: string description: The user that created the exchange userID: type: string description: The id of the user by whom the exchange was placed accountID: type: string description: The account id of the user where the exchange was placed accountNo: type: string description: The account number of the user where the exchange was placed created: type: string description: The time the exchange was created cancelledWhen: type: string description: The date and time the exchange was cancelled cancelledBy: type: string description: The user that cancelled the exchange. rejectedWhen: type: string description: The timestamp when the exchange was rejected. rejectedReason: type: string description: Reason exchange was rejected required: - id - exchangeNo - status - sellSymbol - sellOrderId - sellOrderNo - buySymbol - buyOrderId - buyOrderNo - sellAveragePrice - sellCumulativeQuantity - buyAveragePrice - buyCumulativeQuantity - amountCash - fees - orderExpires - createdBy - userID - accountID - accountNo - created 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' 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. ' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /accounts/{accountID}/summary/exchanges: parameters: - schema: type: string name: accountID in: path required: true description: The account id of the user where the order was placed get: tags: - Exchanges summary: List Account Instrument Exchanges. responses: '200': description: Retrieving a list of Account Instrument Exchanges by accountID was Successful. content: application/json: schema: type: object properties: accountID: type: string description: The account id of the user where the order was placed accountNo: type: string description: |+ The account number of the user where the order was placed tradingType: type: string example: CASH updated: type: string exchanges: type: array items: type: object properties: id: type: string description: 'The specific id of the exchange. ' exchangeNo: type: string description: The specific exchange number status: type: string description: The state of the exchange. enum: - NEW - FILLED - REJECTED - PENDING_CANCEL - CANCELED - FILLED sellSymbol: type: string description: This will be the ticker of the mutual fund you will be liquidating. sellOrderId: type: string description: The order ID corresponding to the sell transaction. sellOrderNo: type: string description: The order number corresponding to the sell transaction. buySymbol: type: string description: This will be the ticker of the mutual fund you will be purchasing with the proceeds of the liquidation. buyOrderId: type: string description: The order ID corresponding to the buy transaction. buyOrderNo: type: string description: The order number corresponding to the buy transaction. sellAveragePrice: type: number description: The price the sell order was filled at. sellCumulativeQuantity: type: number description: The total quantity the sell was for. buyCumulativeQuantity: type: number description: The total quantity the buy was for. buyAveragePrice: type: number description: The price the buy order was filled at. amountCash: type: number description: This is the total notional amount you exchange from the sellSymbol to the buySymbol. fees: type: number description: The total fees for both the buy and sell order of the exchange. orderExpires: type: string description: The timestamp the exchange expires. createdBy: type: string description: Who the orders were created by userID: $ref: '#/components/schemas/userID' accountID: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' created: type: string description: The time the order was created 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 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' description: Retrives a list of Account Instrument Exchanges by accountID. security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /accounts/{accountID}/reports/exchange-history: parameters: - schema: type: string name: accountID in: path required: true description: The account id of the user where the order was placed get: tags: - Exchanges summary: Retrieve Account Instrument Exchange History description: Retrieves a list of Account Instrument Exchange History by accountID. responses: '200': description: Retrieving Account Instrument Exchange History was Successful. content: application/json: schema: type: object properties: accountID: type: string description: The account id of the user where the order was placed accountNo: type: string description: The account number of the user where the order was placed tradingType: type: string updated: type: string exchanges: type: array items: oneOf: - $ref: '#/components/schemas/Exchange' required: - accountID - accountNo - tradingType - updated - exchanges 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-6b03e02dc11f 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' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /bars: get: deprecated: true tags: - Charts parameters: - in: query name: instrumentID schema: type: string required: true example: 3fb1e8a9-f7d5-4d90-95e2-43e7326b5636 description: A unique ID created by DriveWealth to identify a specific instrument. - in: query name: compression schema: type: string enum: - '0' - '1' - '4' - '8' - '9' - '10' required: true example: '9' description: The compression number represents the time increments of the chart data. Refer to the Compression table above. - in: query name: dateStart schema: type: string required: true example: '2022-11-10T00:00:00Z' description: The start 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: The end date of the chart data. Follow ISO-8601 format. - in: query name: tradingDays schema: type: string required: false example: '20' 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. summary: Retrieve Chart description: Fetch historical bars for a given instrument over a given time period. 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/ErrorResponseModel' 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. Invalid request: value: errorCode: E033 message: Invalid parameter in message body. Refer to the API documentation for details. '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' 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. security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /instruments: get: tags: - Instruments parameters: - in: query name: status schema: type: string required: false example: ACTIVE description: The instrument status; to filter by. - in: query name: isOptionsEnabled schema: type: boolean required: false example: true description: The ability to trade options for this instrument; to filter by. summary: List Instruments description: Retrives a list of Instruments. responses: '200': description: Retrieving a list of Instruments was Successful. content: application/json: schema: $ref: '#/components/schemas/Instruments' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /instruments/{symbolOrInstrumentID}: get: tags: - Instruments parameters: - in: path name: symbolOrInstrumentID schema: type: string required: true example: 3fb1e8a9-f7d5-4d90-95e2-43e7326b5636 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: query name: options schema: type: string required: false example: Fundamentals 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. summary: Retrieve Instrument description: Retrieves an Instrument details by symbol or instrumentID. responses: '200': description: Fetching Instrument details was successful. content: application/json: schema: oneOf: - $ref: '#/components/schemas/EquityInstrumentDetails' - $ref: '#/components/schemas/OptionInstrumentDetails' - $ref: '#/components/schemas/MutualFundInstrumentDetails' - $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' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /instruments/{symbolOrInstrumentID}/options: get: tags: - Instruments parameters: - in: path name: symbolOrInstrumentID schema: type: string required: true example: AAPL description: Symbol or instrumentID of the underlying equity security - in: query name: expirationDate schema: type: string required: true example: '2022-05-15' description: The expiration date of the option security; to filter by. - in: query name: page schema: type: integer required: false example: 1 - in: query name: pageSize schema: type: integer required: false example: 20 description: The number of option instruments to be returned per page. - in: query name: sortOrder schema: type: string enum: - asc - desc default: asc required: false example: asc description: The sorting order of option instruments. - in: query name: noOfStrikes schema: type: integer required: false example: 5 description: The number of option instruments to be returned above and below market price. - in: query name: minStrikePrice schema: type: integer required: false example: 20 description: The option instruments to be returned above the strike price. - in: query name: maxStrikePrice schema: type: integer required: false example: 100 description: The option instruments to be returned below the strike price. - in: query name: optionType schema: type: string enum: - CALL - PUT required: false example: CALL description: The type of option instruments to be returned. - in: query name: id schema: type: string required: false example: 3fb1e8a9-f7d5-4d90-95e2-43e7326b5636 description: The instrument ID of the option security. - in: query name: filterBy schema: type: string required: false example: expirationDate description: The expiration dates for the given underlying security; to filter by. summary: Retrieve Instrument Options Chain description: Retrieves an Instrument Options Chain by symbol or instrumentID. responses: '200': description: Retrieving an Instrument Options Chain by symbol or instrumentID 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 security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /instruments/{symbolOrInstrumentID}/options/expiration-dates: get: tags: - Instruments parameters: - in: path name: symbolOrInstrumentID schema: type: string required: true example: AAPL description: Symbol or instrumentID of the underlying equity security. summary: Retrieve Instrument Option Expiration description: Retrieve an Instrument Option Expiration details by symbol or instrumentID. responses: '200': description: Retrieving an Instrument Option Expiration details by symbol or instrumentID was Successful content: application/json: schema: $ref: '#/components/schemas/ExpirationDateList' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /instruments/filter: post: tags: - Instruments summary: Search Instruments description: Searches Instruments based on the filter criteria provided. operationId: filterInstruments 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: Searching Instruments by filter criteria was Successful. 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 security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /orders: post: tags: - Orders summary: Create Order description: Create an Order. 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 symbol: US459058GX53 quantity: 3 commission: 3.567 price: 4.5 currency: USD timeInForce: DAY limitType: YIELD Order With Commission: value: accountNo: DWFS001102 orderType: LIMIT side: SELL symbol: AAPL quantity: 3 commission: 3.5 price: 4.5 Order With CommissionRate: value: accountNo: DWFS001102 orderType: LIMIT side: SELL symbol: AAPL quantity: 3 commissionRate: 0.3 price: 4.5 Market Order With Travel Rule Enforced: value: accountNo: DWFS001102 orderType: MARKET symbol: SBUX side: BUY quantity: 2 travelRuleBankAccountID: bank_485ba18c-009d-4c4a-a6e9-99b104c800b2 Market Order With deptType: value: accountNo: DWFS001102 orderType: MARKET symbol: SBUX side: BUY quantity: 2 deptType: ATS required: true responses: '200': description: Creating an Order was Successful. content: application/json: schema: $ref: '#/components/schemas/CreateOrderResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' examples: Both Commission and CommissionRate are present in the request: value: errorCode: E032 message: Invalid or missing parameters in the request body. Refer to the API documentation for details. errorDetails: detail: Cannot specify both 'commission' and 'commissionRate'. Provide either 'commission' or 'commissionRate' field: commission/commissionRate type: DECIMAL CommissionRate decimal places more than 4: value: errorCode: E032 message: Invalid or missing parameters in the request body. Refer to the API documentation for details. errorDetails: detail: Commission rate should not exceed 4 decimal places field: commissionRate type: DECIMAL Invalid commissionRate range: value: errorCode: E032 message: Invalid or missing parameters in the request body. Refer to the API documentation for details. errorDetails: detail: Commission rate should be between 0.0001 and 1.0 field: commissionRate type: DECIMAL '403': description: Account restricted to make day trades content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' examples: Account is restricted from making day trades: value: errorCode: A051 message: 'Account has been restricted. Check account status and notes for details. Forbidden: Account is restricted from making day trades. accountID=' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /orders/{orderID}: get: tags: - Orders parameters: - in: path name: orderID schema: $ref: '#/components/schemas/orderID' required: true summary: Retrieve Order description: Retrieves an Order details by orderID. responses: '200': description: Fetching Order status was successful. content: application/json: schema: $ref: '#/components/schemas/OrderStatusResponse' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] patch: tags: - Orders parameters: - in: path name: orderID schema: $ref: '#/components/schemas/orderID' required: true summary: Update Order description: Updates an Order by orderID. 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' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /orders/byOrderNo/{orderNo}: get: tags: - Orders summary: Retrieve Order by Order Number 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' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /orders/{orderID}/audit: get: tags: - Orders summary: Retrieve Order Audit Details description: Retrieves an Order Audit Details by Order parameters: - in: path name: orderID schema: $ref: '#/components/schemas/orderID' required: true responses: '200': description: Retrieving an Order Audit by OrderID was Successful. content: application/json: schema: $ref: '#/components/schemas/OrderAuditResponse' examples: Order Audit Example: value: orderID: LL.203309cd-91c7-4f9a-9f33-632d0109cc77 orderNo: LLFE048977 accountID: a8888112-92d3-65d9-h20a-f333aeb4ae76.1646639525528 accountNo: XXXR000004 quantities: requestedQuantity: 10 totalFilledQuantity: 10 ordStatus: FILLED side: SELL symbol: HOOD ordType: LIMIT amountCash: 0 violationExempt: false preventQueuing: false extendedHours: false pricing: avgPxRaw: 44.22 avgPx: 44.22 stopPx: 0 mitTriggerPrice: 0 instrumentID: 4ab39131-2ca0-466c-b96c-332357bc0826 orderExpires: '2025-03-07T21:00:00.000Z' commissionOverride: commissionOverrideType: RAW_COMMISSION commissionID: null commissionOverrideDesc: Standard Commission commissionAmount: 1.28 secOverride: 0.01 tafOverride: 0.01 commissionAndFees: total: 1.3 tefra: 0 ptp: 0 auditOrders: - status: NEW quantities: cumulativeQuantity: 0 filledQuantity: 0 remainingQuantity: 0 pricing: averagePrice: 0 averagePriceRaw: 0 lastPrice: 0 rateAsk: 0 rateBid: 0 commissionAndFees: commission: 1.28 feeSec: 0 feeTaf: 0 feeBase: 0 feeXtraShares: 0 feeExchange: 0 pnl: 0 transactTime: '2024-12-10T01:57:53.109Z' comment: NOS started createdWhen: '2024-12-10T01:57:53.109Z' - status: CANCELED quantities: cumulativeQuantity: 0 filledQuantity: 0 remainingQuantity: 0 pricing: averagePrice: 0 averagePriceRaw: 0 lastPrice: 0 rateAsk: 37.44 rateBid: 37.4 commissionAndFees: commission: 0 feeSec: 0 feeTaf: 0 feeBase: 0 feeXtraShares: 0 feeExchange: 0 pnl: 0 transactTime: '2024-12-10T21:25:00.358Z' comment: oNo LLFE048977 aNo RAXR000004 eventID: event_cc97eaa0-a245-469b-83f4-1f5b8374f77e createdWhen: '2024-12-10T21:25:00.375Z' - status: NEW quantities: cumulativeQuantity: 0 filledQuantity: 0 remainingQuantity: 10 pricing: averagePrice: 0 averagePriceRaw: 0 lastPrice: 0 rateAsk: 38.74 rateBid: 38.7 commissionAndFees: commission: 0 feeSec: 0 feeTaf: 0 feeBase: 0 feeXtraShares: 0 feeExchange: 0 pnl: 0 transactTime: '2024-12-11T14:05:32.600Z' comment: NOS Sending to sor when open createdWhen: '2024-12-11T14:05:32.600Z' - status: FILLED quantities: cumulativeQuantity: 0 filledQuantity: 0 remainingQuantity: 0 pricing: averagePrice: 44.22 averagePriceRaw: 44.22 lastPrice: 0 rateAsk: 38 rateBid: 37.84 commissionAndFees: commission: 0 feeSec: 0 feeTaf: 0 feeBase: 0 feeXtraShares: 0 feeExchange: 0 pnl: 0 transactTime: '2024-12-11T21:00:05.494Z' comment: oNo LLFE048977 aNo RAXR000004 eventID: event_539cae86-9c77-48a1-b2d7-5efe111a638c createdWhen: '2024-12-11T21:00:05.523Z' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /documents: post: tags: - Physical Documents summary: Upload Physical Document description: Uploads a Physical Document. requestBody: content: application/json: schema: $ref: '#/components/schemas/UploadUserPhysicalDocumentReq' responses: '200': description: Uploading a Physical Document was Successful. content: application/json: schema: $ref: '#/components/schemas/UploadUserPhysicalDocument' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /documents/{documentID}/url: get: tags: - Physical Documents summary: Retrieve Physical Document URL description: Retrieves a Physical Document by documentID. parameters: - in: path name: documentID schema: $ref: '#/components/schemas/physicalDocumentID' required: true description: The unique identifier of the document. responses: '201': description: Retrieving a Physical Document URL by documentID was Successful. content: application/json: schema: $ref: '#/components/schemas/GetUserPhysicalDocumentByID' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /quotes: get: tags: - Quotes parameters: - in: header name: dw-customer-user-id schema: type: string example: 66304da9-3h6f-2234-935f-ac6b7933d706 description: The unique identifier of the user, who is requesting the quote. - in: query name: symbols schema: type: string required: true example: MS description: The ticker symbol of the associated instrument. Multiple ticker symbols separated by a comma may also be used. - in: query name: exchangeOverride schema: type: string required: false example: 15MinDelayed description: The quote details will be 15 minutes delayed. - in: query name: instrumentIDs schema: type: string required: true example: 1179e8dd-2781-4ce9-842c-f05ded6a40d7 description: The id of an instrument. Multiple instrumentIDs separated by a comma may also be used. - in: query name: isins schema: type: string required: true example: US912810RC45 description: The unique identifier of the instrument. Multiple instrumentIDs separated by a comma may also be used. summary: Retrieve Quote (referential feed) description: Fetch the realtime or 15 minute delayed Referential quote details for a specific security. 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: NYSE 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 Fixed Income Quote: value: - instrumentID: 1179e8dd-2781-4ce9-842c-f05ded6a40d7 isin: US912810RC45 bidYield: 4.220776 askYield: 4.207803 bid: 92.276 ask: 92.436 priorClose: 92.3085938 askSize: 0 bidSize: 0 lastTradeSize: 0 tradeCount: 0 marketCondition: NORMAL dataProvider: ICE BondPoint timeOffset: 0 security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /quotes/vdr: get: tags: - Quotes parameters: - in: header name: dw-customer-user-id schema: type: string example: 66304da9-3h6f-2234-935f-ac6b7933d706 description: The unique identifier of the user, who is requesting the quote. - in: query name: symbols schema: type: string required: true example: MS description: The ticker symbol of the associated instrument. summary: Retrieve Quote (consolidated feed) description: Fetch the NBBO quote details for a specific security. responses: '200': description: Fetch NBBO quote details was Successful. content: application/json: schema: $ref: '#/components/schemas/NBBO' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /quotes/depth: post: tags: - Depth of Book description: |- Get the Depth of Book for an Instrument. For now, this API only works with debt instruments, but will expand in the future. summary: Retrieve Depth of Book operationId: getQuoteDepth requestBody: content: application/json: schema: $ref: '#/components/schemas/MarketQuoteRequest' examples: MarketQuoteRequestSample: value: instrumentID: f6d3e213-4e6f-4ee3-8a9a-793027c62c57 quantity: 3.14 required: true responses: '200': description: Fetching Market data was successful content: application/json: schema: $ref: '#/components/schemas/MarketQuoteResponse' 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 date: '2017-07-21T17:32:28Z' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /funding/reconciliations: get: tags: - Settlements summary: List Cashless Reconciliations description: Fetches a list of daily reconciliations for a firm using cashless settlement. parameters: - in: query name: to schema: type: string required: true example: '2022-12-25T18:36:40.609Z' description: The date and time in which to end at. - in: query name: from schema: type: string required: true example: '2022-12-08T18:36:40.609Z' description: The date and time in which to start from. - in: query name: type schema: type: string required: false example: CRYPTO description: Filters the reconciliations reports by the type of reconciliation. - in: query name: status schema: $ref: '#/components/schemas/reconciliationStatus' required: false description: Filters the reconciliations reports by the status of reconciliation. responses: '200': description: Fetching a list of daily reconciliations for a firm was successful. content: application/json: schema: $ref: '#/components/schemas/ListOfDailyReconciliations' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /funding/reconciliations/{reconciliationID}: get: tags: - Settlements summary: Retrieve Cashless Reconciliation description: Fetches reconciliations details for a firm using cashless settlement. parameters: - in: path name: reconciliationID schema: $ref: '#/components/schemas/reconciliationID' required: true description: The unique identifier of the reconciliation report. responses: '200': description: Fetching a firm's reconciliation details was successful. content: application/json: schema: oneOf: - $ref: '#/components/schemas/ReconciliationDetails' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] patch: tags: - Settlements summary: Update Cashless Reconciliation 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: oneOf: - $ref: '#/components/schemas/ReconciliationDetails' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /funding/recurring-deposits/{recurringID}: get: tags: - Deposits summary: Retrieve Recurring Deposits description: Retrieves Recurring Deposits details by recurringID. parameters: - in: path name: recurringID schema: type: string required: true example: recurring_98be6652-6361-4d4c-905b-06e9ec38d060 description: A unique identifier for the user's recurring bank deposit. responses: '200': description: Fetching recurring deposit schedule was successful. content: application/json: schema: $ref: '#/components/schemas/RecurringDeposit' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] patch: tags: - Deposits summary: Update Recurring Deposit description: Updates Recurring Deposit details by recurringID. parameters: - in: path name: recurringID schema: type: string required: true example: recurring_98be6652-6361-4d4c-905b-06e9ec38d060 description: A unique identifier for the user's recurring bank deposit. 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' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] delete: tags: - Deposits summary: Delete Recurring Deposit description: Deactivates Recurring Deposit details by recurringID. parameters: - in: path name: recurringID schema: type: string required: true example: recurring_98be6652-6361-4d4c-905b-06e9ec38d060 description: A unique identifier for the user's recurring bank deposit. responses: '200': description: Deactivating Recurring Deposit was Successful. content: application/json: schema: $ref: '#/components/schemas/RecurringDepositDeleteResponse' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /funding/redemptions: post: tags: - Withdrawals summary: Create Withdrawal description: Creates a Withdrawal. parameters: - in: header name: Idempotency-Key schema: type: string example: a1b2c3d4-5e6f-7g8h-9i0j-1k2l3m4n5o6 required: false description: A unique key (UUID) that is used to prevent duplicate requests. Should a network interruption occur, or you otherwise lost a response from the API, you can safely perform the request provided that you send the same value as the Idempotency-Key. DriveWealth Idempotency Keys are saved for 4 days. Within this time period, sending any request with a duplicate key will return the exact same response as the original request, including the same status code and payload. 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' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] get: tags: - Withdrawals summary: List Withdrawals description: Retrieves a list of Withdrawals. parameters: - in: query name: status schema: $ref: '#/components/schemas/withdrawalStatus' required: true description: The current status of the withdrawal; to filter by. - in: query name: type schema: $ref: '#/components/schemas/withdrawalTypes' required: true description: The type of withdrawal; to filter by. responses: '200': description: Retrieving a list of Withdrawals was Successful. content: application/json: schema: $ref: '#/components/schemas/ListAllWithdrawalsForTheFirm' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /funding/redemptions/{redemptionID}: get: tags: - Withdrawals summary: Retrieve Withdrawal description: Retrieves a Withdrawal by redemptionID. parameters: - in: path name: redemptionID schema: $ref: '#/components/schemas/redemptionID' required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 description: A unique identifier for the user's account redemption/withdrawal. responses: '200': description: Retrieving a Withdrawal by redemptionID was Successful. content: application/json: schema: $ref: '#/components/schemas/WithdrawalByRedemptionID' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /accounts/{accountID}/reports/daily-trade-summary: post: tags: - Settlements summary: Create DVP RVP Report 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' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] get: tags: - Settlements summary: List DVP RVP Reports description: Lists DVP RVP reports. parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true - in: query name: status schema: $ref: '#/components/schemas/DVPRVPStatus' description: A filter, to filter on the status of the DVP/RVP. - 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' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /accounts/{accountID}/reports/daily-trade-summary/{reportID}: get: summary: Retrieve DVP RVP description: Retrieves a DVP RVP by reportID. tags: - Settlements parameters: - in: path name: accountID schema: $ref: '#/components/schemas/accountID' required: true - in: path name: reportID schema: type: string example: bsr_040fb9cc-84e8-4f20-bf09-d398dacd458d.1622745430469_20210604 description: The DVP/RVP report identifier. required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/DVPRVPDetails' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /settlements: get: tags: - Settlements summary: Retrieve Settlements description: Retrieves a list of Settlements. parameters: - in: query name: from schema: type: string required: true example: '2022-12-08' description: The date to start from. - in: query name: to schema: type: string required: true example: '2022-12-25' description: The date to end at. - in: query name: status schema: $ref: '#/components/schemas/singleSettlementStatus' required: false description: Filters, the settlements by the status. - in: query name: settlementProfileID schema: $ref: '#/components/schemas/settlementProfileID' required: false description: Filters, the settlements by the settlement profile. - in: query name: limit schema: type: integer default: 50 maximum: 200 required: false description: The number of items to return. - in: query name: offset schema: type: string default: null required: false description: Used for pagination. Set this to the first/last id value of your payload to get the prev/next page of results respectively. - in: query name: direction schema: type: string enum: - prev - next required: false description: The direction of the pagination. responses: '200': description: Retrieving a list of Settlements was Successful. content: application/json: schema: $ref: '#/components/schemas/SingleSettlementReports' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /settlements/{settlementID}: get: tags: - Settlements summary: Retrieve Settlement description: Retrieves Settlement by settlementID. parameters: - in: path name: settlementID schema: $ref: '#/components/schemas/singleSettlementID' required: true responses: '200': description: Retrieving Settlement by settlementID was Successful. content: application/json: schema: $ref: '#/components/schemas/SingleSettlementByID' '404': description: The settlement for given settlementID doesn't exist. security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /statements/{accountID}/{fileKey}: get: tags: - Statements summary: Retrieve Statement description: Retrieves an Account Statement (Monthly, Trade Confirms, Tax Forms, etc.) by accountID and fileKey. 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: Retrieving an Account Statement was Successful. content: application/json: schema: $ref: '#/components/schemas/UserGeneratedAccountDocument' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /subscriptions: post: deprecated: true tags: - Subscriptions summary: Create Subscription description: |- Creates a Subscription charge for a User's Linked Bank Account. This API is now deprecated as the Subscriptions product is no longer supported. 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' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /subscriptions/{subscriptionID}: delete: deprecated: true tags: - Subscriptions summary: Delete Subscription description: |- Removes a User's Subscription by Subscription. This API is now deprecated as the Subscriptions product is no longer supported. parameters: - in: path name: subscriptionID schema: $ref: '#/components/schemas/subscriptionID' required: true description: The unique identifier that identifies the user's subscription. responses: '201': description: User's Subscription removal was Received. security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /users: post: tags: - Users summary: Create User description: Creates a User. requestBody: content: application/json: schema: $ref: '#/components/schemas/UsersReq' responses: '200': description: Creating a User was Successful. content: application/json: schema: $ref: '#/components/schemas/UserResponse' examples: {} security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /users/{userID}: get: tags: - Users summary: Retrieve User description: Retrieves a User details by userID. parameters: - in: path name: userID schema: type: string required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 description: Unique ID of the User to fetch. responses: '200': description: Retrieving a User was Successful. content: application/json: schema: $ref: '#/components/schemas/FetchUserResponse' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] patch: tags: - Users summary: Update User description: Updates a User details by userID. parameters: - in: path name: userID schema: type: string required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 description: Unique ID of the User to update. 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-42fb3262c4b9 name: Tendies Trading Company phone: '18004612680' referralCode: 71J000 stateProvince: NJ wlpID: TTC zipPostalCode: '94105' idNo: '****-4444' status: name: PENDING description: User is pending approval. userType: name: INDIVIDUAL_TRADER description: Individual Trader usCitizen: true updatedWhen: '2022-12-11T22:28:21.810Z' brandAmbassador: false employerBusiness: FINANCE employementStatus: name: EMPLOYED description: Employed citizenship: US createdWhen: '2022-12-11T22:28:21.810Z' marginDefault: 0 maritalStatus: name: SINGLE description: Single ackCustomerAgreement: true ackFindersFee: false ackFixedIncomeAgreement: true ackForeignFindersFee: false ackJointCustomerAgreement: true ackJointFindersFee: false ackJointForeignFindersFee: false ackJointMarketData: false ackMarketData: false ackExtendedHoursAgreement: false ackOptionsAgreement: true dependents: 0 termsOfUse: true director: false employerCompany: DriveWealth LLC employerCompanyID: cc07f91b-7ee1-4868-b8fc-823c70a1b932 employerCompanyStartDate: '2014-09-29' employerCompanyEndDate: '2022-12-25' employerIsBroker: true employmentPosition: ENGINEER employmentYears: 0 jointEmployerIsBroker: false investmentObjectives: name: FREQUENT description: Frequent trader, depending on the market investmentExperience: name: YRS_10_ description: 10+ yrs 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 security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /users/{userID}/kyc-status: get: tags: - Users summary: Retrieve KYC description: Retrives a User KYC by userID. parameters: - in: path name: userID schema: type: string required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 description: Unique ID of the User to fetch their profile & kyc status. responses: '200': description: Fetching User's Profile Details & KYC is Successful. content: application/json: schema: $ref: '#/components/schemas/FetchUserKYCResponse' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /users/{userID}/accounts: get: tags: - Accounts summary: List User Accounts description: Retrieves a list of User Accounts by userID. parameters: - in: path name: userID schema: type: string required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 description: Unique ID of the User to fetch their accounts at DriveWealth. responses: '200': description: Retrieving a list of User Accounts by userID was Successful. content: application/json: schema: $ref: '#/components/schemas/AccountDetails' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /users/{userID}/bank-accounts: get: tags: - Linked Bank Accounts summary: List User Linked Bank Accounts description: Retrieves a list of User Linked Bank Accounts by userID. parameters: - in: path name: userID schema: type: string required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 description: Unique ID of the User to fetch their stored bank accounts. responses: '200': description: Retrieving a list of User Linked Bank Accounts was Successful. content: application/json: schema: $ref: '#/components/schemas/BankAccountsArray' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /users/{userID}/documents: get: tags: - Physical Documents summary: List User Physical Documents description: Retrieves a list of Users Physical Documents by userID. parameters: - in: path name: userID schema: type: string required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 description: The User's unique identifier. responses: '200': description: Retrieving a list of Users Physical Documents by userID was Successful. content: application/json: schema: $ref: '#/components/schemas/DocumentsArray' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /users/{userID}/subscriptions: get: deprecated: true tags: - Subscriptions summary: List Subscriptions by User description: |- Retrieves all User's Subscriptions by User This API is now deprecated as the Subscriptions product is no longer supported. parameters: - in: path name: userID schema: type: string required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 description: The User's unique identifier. responses: '200': description: Retrieving all User's Subscription was Successful. content: application/json: schema: $ref: '#/components/schemas/UserSubscriptions' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /users/{userID}/recurring-deposits: get: tags: - Deposits summary: List User Recurring Deposits description: Retrieves a list of User Recurring Deposits by userID. parameters: - in: path name: userID schema: type: string required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 description: The User's unique identifier. responses: '200': description: Fetching All User's Recurring Deposits was Successful. content: application/json: schema: $ref: '#/components/schemas/RecurringDepositsByUserID' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /users/{userID}/funding/deposits: get: tags: - Deposits summary: List User Deposits description: Retrieves a list of User Deposits by userID. parameters: - in: path name: userID schema: type: string required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 description: The User's unique identifier. responses: '200': description: Retrieving a list User Deposits by userID was Successful. content: application/json: schema: $ref: '#/components/schemas/DepositsArray' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /users/{userID}/funding/redemptions: get: tags: - Withdrawals summary: List User Withdrawals description: Retrieves a list of User Withdrawals by userID. parameters: - in: path name: userID schema: $ref: '#/components/schemas/userID' required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 description: The User's unique identifier. responses: '200': description: Retrieving a list of User Withdrawals by userID was Successful. content: application/json: schema: $ref: '#/components/schemas/Redemptions' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /users/{userID}/managed/allocations: get: tags: - Trade Allocations summary: List Trade Allocations by Advisor description: Fetches a list of an User's allocations. parameters: - in: path name: userID schema: $ref: '#/components/schemas/userID' required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 description: The User's unique identifier. responses: '200': description: Fetching A List Of A User's Allocation was Successful. content: application/json: schema: $ref: '#/components/schemas/Allocations' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /users/{userID}/managed/orders/summary: get: tags: - Advisor Reports summary: List Orders by Advisor description: Fetches a User's sub account orders allocations summary by date. parameters: - in: path name: userID schema: $ref: '#/components/schemas/userID' required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 description: The User's unique identifier. - in: query name: date schema: type: string required: false example: '2022-12-25' description: The specific request date in format YYYY-MM-DD. responses: '200': description: Fetching A User's Sub Account Orders Allocations Summary By Date was Successful. content: application/json: schema: $ref: '#/components/schemas/OrdersAllocationSummary' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /users/{userID}/managed/orders: get: tags: - Advisor Reports summary: List Allocations by Advisor description: Fetches a user's sub account orders allocations by userID parameters: - in: path name: userID schema: $ref: '#/components/schemas/userID' required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 description: The User's unique identifier. - in: query name: from schema: type: string required: true example: '2022-12-08T18:36:40.609Z' description: The date and time in which to start from. - in: query name: to schema: type: string required: true example: '2022-12-25T18:36:40.609Z' description: The date and time in which to end at. responses: '200': description: Fetching A user's Sub Account Orders Allocations By userID was Successful. content: application/json: schema: $ref: '#/components/schemas/ListOrdersAllocationsByUserID' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /users/{userID}/managed/bod: get: tags: - Advisor Reports summary: Retrieve Beginning Of Day (BOD) by Advisor description: Fetches a list of sub accounts beginning of day holdings by userID parameters: - in: path name: userID schema: $ref: '#/components/schemas/userID' required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 description: The User's unique identifier. 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' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /users/{userID}/managed/funds: get: deprecated: true tags: - Funds summary: List Funds by Advisor description: Fetches a list of funds by userID parameters: - in: path name: userID schema: $ref: '#/components/schemas/userID' required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 description: The User's unique identifier. responses: '200': description: Fetching A List of Funds By userID was Successful. content: application/json: schema: $ref: '#/components/schemas/FundsByUserID' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /users/{userID}/managed/portfolio: get: deprecated: true tags: - Portfolios summary: List Portfolios by Advisor description: Fetches a list of portfolios by userID parameters: - in: path name: userID schema: $ref: '#/components/schemas/userID' required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 description: The User's unique identifier. responses: '200': description: Fetching A List of Portfolios By userID was Successful. content: application/json: schema: $ref: '#/components/schemas/PortfoliosByUserID' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] /users/{userID}/managed/autopilot: get: deprecated: true tags: - AutoPilot summary: List AutoPilot Runs by Advisor description: Fetches a list of autopilot runs by userID. parameters: - in: path name: userID schema: $ref: '#/components/schemas/userID' required: true example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 description: The User's unique identifier. - in: query name: from schema: type: string required: false example: '2022-12-08T18:36:40.609Z' description: The date and time in which to start from. - in: query name: to schema: type: string required: false example: '2022-12-25T18:36:40.609Z' description: The date and time in which to end at. - 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' security: - bearerAuth: [] dwAppKey: [] - sessionToken: [] dwAppKey: [] components: schemas: AllocationRequest: type: object required: - userID - orders properties: userID: type: string example: 66304da9-3h6f-2234-935f-ac6b7933d706 description: The unique identifier of the registered investment advisors account. clientListID: $ref: '#/components/schemas/clientListID' note: $ref: '#/components/schemas/allocationNote' orders: type: array description: An array of objects that hold the specific order and allocation details. required: - orderID - allocations items: oneOf: - $ref: '#/components/schemas/order' AllocationResponse: type: object properties: id: type: string example: JL.allocation.SomeRIACompany.9d6def3b-14d7-4934-8a64-57d443e67ce6 description: The unique allocation identifier associated to a specific allocation. order: type: object properties: orderID: type: string example: JL.562f3719-7c8f-50ee-b234-db7775715a99 description: The orderID of a filled order being used in an allocation. allocations: type: array description: An array that holds relevant information about how and where to distribute securities from a recent order. required: - accountID - accountNo - qty - useClientFunds items: oneOf: - $ref: '#/components/schemas/allocation' allocation: type: object properties: accountID: type: string example: cc07f91b-7ee1-4868-b8fc-823c70a1b932.1407775317759 description: The unique account identifier of the end user receiving an allocation. accountNo: type: string example: ZYXC000008 description: The account number of the end user receiving an allocation. qty: type: string example: '27' description: The number of shares allocated to a users account. useClientFunds: type: boolean example: true description: True, if allocations should use client funds. comment: type: string example: Suds boapi test to 1st description: A note created by the RIA upon creating an allocation. allocationDetailObject: type: object description: Contains details for a user associated with an allocation. properties: accountID: type: string example: 743a1018-e292-449c-a43f-58d657990db0.1671689261882 description: The account identifier for an end user associated with an allocation. accountNo: type: string example: ZYXC000008 description: The account number of an end user associated with an allocation. status: type: string example: FILLED description: The status of the allocation. enum: - NEW - FILLED - REJECTED instrumentID: $ref: '#/components/schemas/instrumentID' symbol: $ref: '#/components/schemas/instrumentSymbol' side: $ref: '#/components/schemas/sideAbbreviated' clientComment: type: string example: Foo test allocation description: A note for the type of allocation happening. qtyRequested: type: number example: 10 description: Quantity of shares requested to allocate to a users account. qtyAllocated: type: number example: 10 description: Quantity of shares allocated to a users account. avgPx: type: number example: 126.52 description: The average price of the security being allocated. fees: $ref: '#/components/schemas/fees' fees: type: object description: The fees associated with an allocation. properties: total: type: number example: '0' description: The sum of all fees. sec: type: number example: '0' description: The Securities and Exchange Commission Fee. taf: type: number example: '0' description: The Trading Activity Fees. commission: type: number example: '0' description: The commissions for the allocation other: type: number example: '0' description: Any miscellaneous fees associated with the allocation. AllocationDetails: type: object properties: id: type: string example: JL.allocation.SomeRIACompany.9d6def3b-14d7-4934-8a64-57d443e67ce6 description: The unique allocationID associated with a specific allocation. status: type: string example: COMPLETE description: Overall status of an allocation. enum: - NEW - ACCEPTED - PART_COMPLETE - COMPLETE - REJECTED clientListID: $ref: '#/components/schemas/clientListID' accountID: type: string example: 66304da9-3d6f-4253-935f-ac6b7933d701.1619201263789 description: The account identifier for the RIA master trading account. accountNo: type: string example: ZYXB000008 description: The account number for the RIA master trading account. createdWhen: type: string example: '2022-12-22T16:04:46.724Z' description: Date and time of allocation creation. allocations: type: array description: An array of allocation objects that hold details of the allocation. items: oneOf: - $ref: '#/components/schemas/allocationDetailObject' comment: 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 description: A note created by the RIA upon creating an allocation. fundsRequest: type: object required: - userID - name - clientFundID - description - holdings - triggers properties: userID: type: string example: 66304da9-3h6f-2234-935f-ac6b7933d706 description: The unique identifier of the registered investment advisors account. name: type: string example: TECH description: A name given to the Fund by the RIA. clientFundID: $ref: '#/components/schemas/clientListID' description: type: string example: Top 10 US Tech description: A short description for the Fund. holdings: type: array description: An array of objects that hold the type of securities in a Fund. items: $ref: '#/components/schemas/holdingsObject' triggers: type: array description: An array of objects that hold information on when to trigger a rebalance in a Fund. items: $ref: '#/components/schemas/triggersObject' triggersObject: type: object description: An object that holds the details of when to trigger a rebalance of the Fund. required: - type - child - maxAllowed - lowerBound - upperBound properties: type: type: string example: TOTAL_DRIFT description: The type of trigger specified to enable a rebalance. enum: - TOTAL_DRIFT - RELATIVE_DRIFT - ABSOLUTE_DRIFT maxAllowed: type: number example: 0.05 description: The maximum allowed drift for the Fund. child: type: string example: null lowerBound: type: number example: 0.01 description: The lowest bound range of the drift parameters. upperBound: type: number example: 0.02 description: The highest bound range of the drift parameter. fundsResponse: type: object properties: id: type: string example: fund_3d7d00d1-f09e-4f86-9cbf-893c75cf77fe description: The unique identifier associated with the Fund. userID: $ref: '#/components/schemas/managedAccountsUserID' name: type: string example: TECH description: A name given to the Fund by the RIA. type: type: string example: FUND clientFundID: $ref: '#/components/schemas/clientFundID' description: type: string example: Top 10 US Tech description: A short description for the Fund. holdings: type: array description: An array of objects that hold the type of securities in a Fund. items: $ref: '#/components/schemas/holdingsObject' triggers: type: array description: An array of objects that hold information on when to trigger a rebalance. 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: userID: $ref: '#/components/schemas/managedAccountsUserID' name: type: string example: Recession Proof description: A name given to the Portfolio by the RIA. clientPortfolioID: $ref: '#/components/schemas/clientPortfolioID' description: type: string example: Mix of sectors description: A short description for the portfolio. holdings: type: array description: An array of objects that hold a list of Funds in a portfolio. items: $ref: '#/components/schemas/portfolioReqHoldings' triggers: type: array description: An array of objects that hold a list if triggers associated with a portfolio. items: $ref: '#/components/schemas/portfolioTriggers' portfolioRes: type: object properties: id: type: string example: portfolio_4a22340a-31f8-4f0e-b5ee-24ddfbc66727 description: The unique identifier associated with a portfolio. name: type: string example: Recession Proof description: A name given to the Portfolio by the RIA. clientPortfolioID: $ref: '#/components/schemas/clientPortfolioID' description: type: string example: A portifolio description description: A short description for the Portfolio. holdings: type: array description: An array of objects that hold the type of Funds in the Portfolio. items: $ref: '#/components/schemas/portfolioResHoldingsObject' userID: $ref: '#/components/schemas/managedAccountsUserID' triggers: type: array description: An array of objects that hold information on when to trigger a rebalance in the Portfolio. items: $ref: '#/components/schemas/portfolioTriggers' isFundTargetsChanged: type: boolean example: false fundsTargetsChanged: type: boolean example: false portfolioReqHoldings: type: object required: - type - target properties: type: type: string example: FUND description: The type of asset in a Portfolio. enum: - FUND - CASH_RESERVE id: type: string example: fund_3d9d00d1-f06e-4f86-9cbf-893c75cf77fe description: The unique fundID. target: type: number example: 0.95 description: The percentage of a Fund within a Portfolio. portfolioTriggers: type: object description: An object that holds the details of when to trigger a rebalance of a Portfolio. required: - type - child - maxAllowed - lowerBound - upperBound properties: type: type: string example: TOTAL_DRIFT description: The type of trigger specified to enable a rebalance. enum: - TOTAL_DRIFT - RELATIVE_DRIFT - ABSOLUTE_DRIFT maxAllowed: type: number example: 0.05 description: The maximum allowed drift for the Portfolio. child: type: string example: null lowerBound: type: number example: 0.01 description: The lowest bound range of the drift parameters. upperBound: type: number example: 0.02 description: The highest bound range of the drift parameter. portfolioResHoldingsObject: type: object description: An array of objects that hold details of a Fund in a Portfolio. properties: id: type: string example: fund_3d9d00d1-f06e-4f86-9cbf-893c75cf77fe description: The unique FundID. name: type: string example: TECH description: A name given to the Fund by the RIA. type: type: string example: FUND description: The type of asset in the Portfolio. enum: - FUND - CASH_RESERVE clientFundID: $ref: '#/components/schemas/clientFundID' description: type: string example: Top 10 US Tech description: A short description for the Fund. target: type: number example: 0.95 description: The percentage of a Fund within a Portfolio. holdings: type: array description: A list of the securities held in a Fund. items: $ref: '#/components/schemas/holdingsObject' triggers: type: array description: The triggers associated with a Portfolio. items: $ref: '#/components/schemas/triggersObject' autopilotReq: type: object required: - reviewOnly - forceRebalance properties: reviewOnly: type: boolean example: true description: True, if a review should occur without a forced rebalance. forceRebalance: type: boolean example: true description: True, if a forces rebalance should occur. subAccounts: type: array description: A list of user's accountIDs to be rebalanced. items: oneOf: - $ref: '#/components/schemas/accountID' autopilotRes: type: object properties: id: type: string example: ria_rebalance_ebf7e764-e2d6-4b3d-a333-b8ff05b92b89 description: The unique re-balance run identifier `rebalanceRunID` associated with a specific re-balance. created: type: string example: '2022-12-27T06:06:28.955Z' description: A timestamp of when the re-balance run was created. status: type: string example: REBALANCE_NOT_STARTED description: Status of the re-balance run. See [Autopilot Run Status](https://developer.drivewealth.com/reference/get-autopilot-run-status) for status values. riaID: $ref: '#/components/schemas/riaID' runStatusRes: type: object properties: id: type: string example: ria_rebalance_ebf7e764-e2d6-4b3d-a333-b8ff05b92b89 description: The unique re-balance run identifier `rebalanceRunID` associated with a specific re-balance. riaID: type: string example: 66304da9-3h6f-2234-935f-ac6b7933d706 description: This is the parentIBID or userID of the registered investment advisor creating the re-balance run. status: type: string example: REBALANCE_NOT_STARTED description: Status of the re-balance run. See [Autopilot Run Status](https://developer.drivewealth.com/reference/get-autopilot-run-status) for status values. updated: type: string example: '2022-12-27T06:07:28.955Z' description: A timestamp of when the re-balance run was updated. created: type: string example: '2022-12-27T06:06:28.955Z' description: A timestamp of when the re-balance run was created. moneyMovement: type: boolean example: true description: Was this run part of the regular AutoPilot money movement process? regularRebalance: type: boolean example: true description: Was this run part of the regular AutoPilot rebalancing process? reviewOnly: type: boolean example: true orders: type: object description: An object containing the details of submitted orders for the re-balance. properties: total: type: number example: 0 description: Total number of orders submitted. submitted: type: string example: https://uat.drivewealth.autopilot.s3.amazonaws.com/44304da9.... description: Amazon S3 download containing the details of each submitted order. outcome: type: string example: https://uat.drivewealth.autopilot.s3.... description: Amazon S3 download containing the status and final outcome of the orders that were submitted. amountBuys: type: number example: -1059.35 description: An aggregate value of all buy orders. Expect a negative number. amountSells: type: number example: 862.69 description: An aggregate value of all sell orders. cleanedUp: type: string example: null allocations: type: object description: An object containing the details of the allocations in a re-balance. properties: submitted: type: string example: https://uat.drivewealth.autopilot.s3.... description: Amazon S3 download containing the details of each submitted allocation. outcome: type: string example: https://uat.drivewealth.autopilot.s3.... description: Amazon S3 download containing the status and final outcome of each allocation that was submitted. subAccounts: type: object description: An object containing details on user accounts and their holdings. properties: total: type: number example: 4 description: The total number of user accounts under the advisor. rebalanced: type: number example: 3 description: The total number of user accounts that were rebalanced. error: type: number example: 0 description: The total number of allocation errors at the users account level during the rebalance. outcome: type: string example: https://uat.drivewealth.autopilot.s3.... description: Amazon S3 download containing the final outcome of the rebalance, includes users account details and their holdings. clientListID: type: string example: SUMS_CUSTOM_ALLOCATION_TEST description: An advisor created identifier for a specific allocation. allocationNote: type: string example: Allocating via api allocation test description: A note for the type of allocation happening. instrumentID: type: string format: uuid example: 3fb1e8a9-f7d5-4d90-95e2-43e7326b5636 description: 'A unique ID created by DriveWealth to identify a specific instrument. ' instrumentSymbol: type: string nullable: true example: MS 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`. sideAbbreviated: type: string example: B description: The side of the order. enum: - B - S - BUY_OPEN - BUY_CLOSE - SELL_OPEN - SELL_CLOSE holdingsObject: type: object description: An object in the holdings array that holds the instrumentID and target. properties: instrumentID: type: string example: 5b85fabb-d57c-44e6-a7f6-a3efc760226c description: A unique ID created by DriveWealth to identify a specific instrument. target: type: number example: 0.5 description: The target percentage for the specific instrumentID within a fund. managedAccountsUserID: type: string example: 66304da9-3h6f-2234-935f-ac6b7933d706 description: The unique identifier of the registered investment advisors account. clientFundID: type: string example: AAABBB-1222-3344.123456789 description: A user defined identifier attached to the fund. clientPortfolioID: type: string example: AAABBB-1222-3344.123456789 description: A user defined identifier attached to the portfolio. accountID: type: string example: cc07f91b-7ee1-4868-b8fc-823c70a1b932.1407775317759 description: The user's unique account identifier. riaID: type: string example: 66304da9-3h6f-2234-935f-ac6b7933d706 description: This is the parentIBID or userID of the registered investment advisor creating the re-balance run. AccountReq: type: object required: - userID - accountType - accountManagementType - tradingType properties: userID: $ref: '#/components/schemas/userID' accountType: $ref: '#/components/schemas/accountType' accountManagementType: $ref: '#/components/schemas/accountManagementType' accountHolderType: $ref: '#/components/schemas/accountHolderType' tradingType: $ref: '#/components/schemas/tradingType' finra3210ComplianceEntity: $ref: '#/components/schemas/finra3210ComplianceEntity' riaUserID: $ref: '#/components/schemas/riaID' riaProductID: type: string example: '' description: RIA product identifier (legacy) riaPortfolioID: $ref: '#/components/schemas/portfolioID' description: A unique ID associated with an RIA managed portfolio. If set, a portfolio will be assigned to this account for automatic rebalancing. authorizedUsers: type: array items: oneOf: - $ref: '#/components/schemas/authorizedUser' ignoreBuyingPower: type: boolean example: false description: If true, the accounts cash balance can go negative. violationsExempt: type: boolean example: false description: Instruct the GFV/PDT system to not process for this account. Available only in sandbox. ignoreMarketHoursForTest: type: boolean example: true 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`. extendedHoursEnrolled: type: boolean example: false description: '''true or ''false'' if the account is enrolled in and able to access Extended Hours Trading' metadata: type: object example: myCustomKey: myCustomValue description: The metadata object allows for creating a maximum of 5 keys (max 36 characters) and each value cannot exceed more than 128 bytes. leverage: $ref: '#/components/schemas/leverage' accountFeatures: $ref: '#/components/schemas/accountFeatures' interestedParties: type: array items: $ref: '#/components/schemas/interestedParty' AccountRes: type: object properties: id: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' accountType: type: object properties: name: type: string example: LIVE description: The type of account. description: type: string example: Live Account description: A description of the type of account. accountMgmtType: $ref: '#/components/schemas/accountManagementTypeObject' accountHolderType: $ref: '#/components/schemas/accountHolderTypeObject' status: type: object properties: name: $ref: '#/components/schemas/accountStatus' description: type: string example: Open description: A description of the account status. tradingType: type: object properties: name: type: string example: CASH description: The type of trading ocurring in the account. enum: - CASH - MARGIN - CRYPTO description: type: string example: Cash Account description: A custom description about the type of account. 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: $ref: '#/components/schemas/userID' description: The userID associated with the account. This will be the userID of your customer. 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' interestedParties: type: array items: $ref: '#/components/schemas/interestedParty' AccountDetailRes: type: object properties: account: type: object properties: id: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' accountType: type: object properties: name: type: string example: LIVE description: The type of account. description: type: string example: Live Account description: A description of the type of account. accountMgmtType: $ref: '#/components/schemas/accountManagementTypeObject' accountHolderType: $ref: '#/components/schemas/accountHolderTypeObject' finra3210ComplianceEntity: $ref: '#/components/schemas/finra3210ComplianceEntity' status: type: object properties: name: $ref: '#/components/schemas/accountStatus' description: type: string example: Open description: A description of the account status. tradingType: type: object properties: name: type: string example: CASH description: The type of trading ocurring in the account. enum: - CASH - MARGIN - CRYPTO description: type: string example: Cash Account description: A custom description about the type of account. 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: $ref: '#/components/schemas/userID' description: The userID associated with the account. This will be the userID of your customer. restricted: $ref: '#/components/schemas/restricted' description: True, when the account cannot trade on unsettled funds. 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' statusChangeReason: $ref: '#/components/schemas/statusChangeReasonInternal' statusUpdatedBy: $ref: '#/components/schemas/statusUpdatedBy' statusChangeHistory: $ref: '#/components/schemas/statusChangeHistory' createdWhen: type: string example: '2022-12-22T06:07:41.773Z' description: A timestamp of when the account was created. openedWhen: $ref: '#/components/schemas/openedWhen' updatedWhen: type: string example: '2022-12-22T16:04:47.140Z' description: A timestamp of when the account was last updated. ignoreMarketHoursForTest: $ref: '#/components/schemas/ignoreMarketHoursForTest' flaggedForACATS: $ref: '#/components/schemas/flaggedForACATS' extendedHoursEnrolled: type: boolean example: false description: Is the account enrolled in extended hours trading? lastActivityDate: $ref: '#/components/schemas/lastActivityDate' interestedParties: type: array items: $ref: '#/components/schemas/interestedParty' UpdateAcctReq: type: object properties: leverage: $ref: '#/components/schemas/leverage' nickname: $ref: '#/components/schemas/accountNickname' status: $ref: '#/components/schemas/accountStatus' items: anyOf: - required: - statusChangeReason accountHolderType: $ref: '#/components/schemas/accountHolderType' statusComment: type: string example: Closing the Account. description: A reason for updating the account status, not required when editing other attributes. statusChangeReason: $ref: '#/components/schemas/statusChangeReason' 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' lastActivityDate: $ref: '#/components/schemas/lastActivityDate' interestedParties: type: array items: $ref: '#/components/schemas/interestedParty' CommissionsRes: type: array items: $ref: '#/components/schemas/CommissionObject' CommissionObject: type: object properties: active: type: boolean example: true description: Commission group status. commissionID: $ref: '#/components/schemas/commissionID' description: type: string example: Free description: A short description about the commission. assignmentCriteria: $ref: '#/components/schemas/assignmentCriteria' rates: type: object description: This object contains the details of the commission rates. properties: fractional: type: object description: Object provides commission rates on order quantities between 0.0001 and 0.9999 (aka fractional shares). properties: schema: $ref: '#/components/schemas/ratesObject' default: type: object description: Object provided commission rates on full share order quantities. properties: schema: $ref: '#/components/schemas/ratesObject' BeneficiaryReq: type: object properties: primary: type: array description: An array of objects containing the primary beneficiary details items: oneOf: - $ref: '#/components/schemas/beneficiariesObject' contingent: type: array description: An array of objects containing the contingent beneficiary details. items: oneOf: - $ref: '#/components/schemas/beneficiariesObject' BeneficiaryRes: type: object properties: primary: type: array description: An array of objects containing the primary beneficiary details items: oneOf: - $ref: '#/components/schemas/beneficiariesObject' contingent: type: array description: An array of objects containing the contingent beneficiary details. 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: type: number example: 11003.76 description: The account value of the customers account. totalDrift: type: number example: 0.012 description: Total drift away from target. rebalanceRequired: type: boolean example: true description: A flag that determines if a re-balance is required based on total drift. nextPortfolioRebalance: type: string example: '2018-12-11T15:00:00.846Z' description: The date of the next portfolio re-balance. lastPortfolioRebalance: type: string example: '2017-12-11T15:00:00.846Z' description: The date of the last portfolio rebalance. 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: type: string example: '2021-04-23T18:41:32.440Z' description: Timestamp of the last time the deposit was updated. cash: type: object properties: cashAvailableForTrade: type: number example: 0 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. cashAvailableForWithdrawal: type: number example: 0 description: An accounts withdrawal balance, this property only contains settled funds, and money that has already seasoned. cashBalance: type: number example: -12043.23 description: An accounts total cash balance, including both settled and un-settled money. noBuyingPowerReason: type: array description: Reasons for no buying power. items: {} cashSettlement: type: array description: An array of objects containing the time of when money settles as a result of a sale. items: oneOf: - $ref: '#/components/schemas/cashSettlementTime' cashPendingSettlement: type: number description: The amount of unsettled cash not included in cash available to trade. example: 500 pendingPaymentsAmount: type: number example: 0 description: The total amount of money that is pending due to a recent deposit(s) payments: type: object properties: buyingPower: type: object properties: pendingDepositsAmountAvailable: type: number example: 20802.71 description: The current buying power of an account based on recent deposit requests. pendingDepositsAmountNotAvailable: type: number example: 0 description: Recent deposits that are not included in buying power. redemptions: type: object properties: amountWithheldFromRedemptions: type: number example: 60 description: Total dollar amount not included in `cashAvailableForWithdrawal` due to seasoning period on deposit StatementListRes: type: array description: An array that holds the reference details to an accounts statements. items: oneOf: - $ref: '#/components/schemas/statementObj' ListTaxDocsRes: type: array description: An array that holds the reference details to an accounts tax documents. items: oneOf: - $ref: '#/components/schemas/taxStatementObj' ListTradeConfirmsRes: type: array description: An array that holds the reference details to an accounts trade confirmations. 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: type: string example: '2017-06-16T15:35:30.617Z' description: Time of last update. 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: type: array description: An array of pending orders. items: oneOf: - $ref: '#/components/schemas/ordersObj' transactions: type: array description: An array of account transactions items: oneOf: - $ref: '#/components/schemas/transactionSumObj' PerformanceRes: type: object properties: accountID: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' startDate: type: string example: '2017-09-18' description: Start date and time of requested time frame of the accounts performance. endDate: type: string example: '2018-09-18' description: End date and time of requested time frame of the accounts performance. lastUpdated: type: string example: '2017-06-16T15:35:30.617Z' description: Date and time of last performance update. performance: type: array description: Array of performance objects. 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: type: string example: '2017-06-16T15:35:30.617Z' description: Time of last update. equityValue: $ref: '#/components/schemas/equityValue' optionsValue: $ref: '#/components/schemas/optionsValue' debtValue: $ref: '#/components/schemas/debtValue' positionsValue: $ref: '#/components/schemas/positionsValue' equityPositions: type: array description: An array of the positions in the account. items: $ref: '#/components/schemas/equityPositionsObj' optionsPositions: type: array description: An array of the options positions in the account. items: $ref: '#/components/schemas/optionsPositionsObj' mutualFundsPositions: type: array description: An array of the mutual funds positions in the account. items: $ref: '#/components/schemas/mutualFundsPositionsObj' debtPositions: type: array description: An array of the debt positions in the account. 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: type: string example: '2017-06-16T15:35:30.617Z' description: Time of last update. violations: $ref: '#/components/schemas/violationsObj' ViolationDetailsRes: type: object properties: goodFaithViolations: $ref: '#/components/schemas/properties-goodFaithViolations' patternDayTrades: type: array description: An array of pattern day trade violations. 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: type: string example: '2017-06-16T15:35:30.617Z' description: Time of last update. 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: type: string example: '2017-06-16T15:35:30.617Z' description: Time of last update. orders: type: array description: An array that holds a list of completed orders. 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: type: string example: null description: The time when the limit order expires. limitPrice: type: number example: null description: The price set for the limit order. side: $ref: '#/components/schemas/sideAbbreviated' mitTriggerPrice: type: number example: 0 description: Market If Touched trigger price. For MIT orders. triggered: type: number example: 0 description: The trigger price for limit orders. averagePriceRaw: type: number example: 147.45 description: The average price of purchase for the order. orderCashAmt: type: number example: null description: The amount of cash requested for an order (notional orders only). stopPrice: type: number example: 200 description: The stop price of a limit order. ISIN: $ref: '#/components/schemas/instrumentISIN' finra3210ComplianceEntity: type: string example: COMPLYSCI description: The regulatory system that the account will be reported to. enum: - '' - COMPLYSCI - MCO TransactionSummaryRes: type: object properties: accountID: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' tradingType: $ref: '#/components/schemas/tradingType' updated: type: string example: '2017-06-16T15:35:30.617Z' description: Time of last update. transactions: type: array description: An Array of transactions. 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: type: number example: 19 description: The cost basis of the position. quantity: type: number example: 0.16707001 description: The total amount of securities held in this position. currentMarketPrice: type: number example: 90.16 description: The current market price of the instrument. currentMarketValue: type: number example: 15.06 description: The average price of the the total position. unrealizedPnL: type: number example: -3.94 description: The unrealized profit/loss of the position. effectiveCostPerShare: type: number example: 1.09 description: The effective cost per share of the position. side: type: string example: B description: The parent side of the position, which can be 'B' for Long or 'S' for Short. taxLots: type: array items: oneOf: - $ref: '#/components/schemas/PositionLegs' PositionLegs: type: object properties: id: $ref: '#/components/schemas/taxLotID' created: type: string example: '2017-06-16T15:35:30.617Z' description: The timestamp when the position was created. initialQuantity: type: number example: 0.17583963 description: The initial quantity of shares for position leg. openQuantity: type: number example: 10.1 description: The total amount of shares that are currently held in this position leg. effectiveCostPerShare: type: number example: 113.74 description: The effective cost per share of the position leg. side: $ref: '#/components/schemas/sideAbbreviated' comment: $ref: '#/components/schemas/note' Position: type: object properties: accountID: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' costBasis: type: number example: 975.98 description: The cost basis of the position. effectivePx: type: number example: 975.98 description: The effective price of the position. execID: type: string example: '170638430890297892000' description: The execution ID of the position. initPx: type: number example: 975.98 description: The initial price of the position. initQty: type: number example: 0.01 description: The initial quantity of the position. instrumentID: $ref: '#/components/schemas/instrumentID' side: $ref: '#/components/schemas/sideAbbreviated' openQty: type: number example: 10 description: The quantity of shares owned by the account. comment: type: string example: TOP description: A comment describing the position Instrument: type: object properties: rootSymbol: type: string example: AAPL description: The ticker symbol of the underlying Instrument from which this Option is derived. rootId: $ref: '#/components/schemas/rootId' symbol: $ref: '#/components/schemas/instrumentSymbol' optionType: $ref: '#/components/schemas/optionType' marketPrice: type: number example: 16.5 description: The market price of the option. strikePrice: type: number example: 16.5 description: The strike price of the option. OptPosition: type: object properties: expirationDate: type: string example: '2018-09-18' description: The date the Option contract will expire. format: date position: $ref: '#/components/schemas/Position' instrument: $ref: '#/components/schemas/Instrument' OptPositionRes: type: object properties: data: type: array description: An array of the options positions in the account. items: oneOf: - $ref: '#/components/schemas/OptPosition' nextPageOffset: type: string example: 86572e14-84ae-4f0c-9533-3c9432637f8e.1627500314555#65d1aee9-9a6c-4720-9879-71c4fcf43060.2023-12-07T21:17:45.743Z description: The next page offset. prevPageOffset: type: string example: 86572e14-84ae-4f0c-9533-3c9432637f8e.1627500314555#65d1aee9-9a6c-4720-9879-71c4fcf43060.2023-12-07T21:17:45.743Z description: The previous page offset. accountFeatures: type: object properties: options: $ref: '#/components/schemas/AccountFeatureOptions' mutualFunds: $ref: '#/components/schemas/AccountFeatureMutualFunds' fixedIncome: $ref: '#/components/schemas/AccountFeatureFixedIncome' equities: $ref: '#/components/schemas/AccountFeatureEquities' AccountFeatureFixedIncome: type: object description: Account features related to Fixed Income properties: enrolled: description: Indicates if this account is enrolled for trading fixed income assets type: boolean default: false example: true AccountFeatureEquities: type: object description: Account features related to equities properties: dividendReinvestment: type: boolean example: true description: True, if equity dividends are reinvested. dividendReinvestmentOptInWhen: type: string example: '2022-12-11T22:28:21.810Z' description: The timestamp when the account has opted for equity dividend reinvestment. readOnly: true dividendReinvestmentOptOutWhen: type: string example: '2022-12-11T22:28:21.810Z' description: The timestamp when the account has opted out of equity dividend reinvestment. readOnly: true capitalGainsReinvestment: type: boolean example: true description: True, if equity capital gains are reinvested. capitalGainsReinvestmentOptInWhen: type: string example: '2022-12-11T22:28:21.810Z' description: The timestamp when the account has opted for equity capital gains reinvestment. readOnly: true capitalGainsReinvestmentOptOutWhen: type: string example: '2022-12-11T22:28:21.810Z' description: The timestamp when the account has opted out of equity capital gains reinvestment readOnly: true AccountFeatureOptions: type: object properties: enrolled: type: boolean description: User requested option trading be allowed for their account example: 'true' optionsLevel: type: string description: The level of options trading the customer requested example: LEVEL_1 enum: - LEVEL_1 - LEVEL_2 - LEVEL_3 - LEVEL_4 AccountFeatureMutualFunds: type: object properties: dividendReinvestment: type: boolean example: true description: True, if dividends are reinvested. dividendReinvestmentOptInWhen: type: string example: '2022-12-11T22:28:21.810Z' description: The timestamp when the account has opted for dividend reinvestment. readOnly: true dividendReinvestmentOptOutWhen: type: string example: '2022-12-11T22:28:21.810Z' description: The timestamp when the account has opted out of dividend reinvestment. readOnly: true capitalGainsReinvestment: type: boolean example: true description: True, if capital gains are reinvested. capitalGainsReinvestmentOptInWhen: type: string example: '2022-12-11T22:28:21.810Z' description: The timestamp when the account has opted for capital gains reinvestment. readOnly: true capitalGainsReinvestmentOptOutWhen: type: string example: '2022-12-11T22:28:21.810Z' description: The timestamp when the account has opted out of capital gains reinvestment readOnly: true userID: type: string example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 description: A unique identifier created for each User on DriveWealth's platform. accountType: type: string example: LIVE description: The type of account that has been created. enum: - LIVE accountManagementType: type: string example: SELF description: The type of account who has trading authority. enum: - SELF - ADVISORY - MANAGED - RIA_MANAGED - CUSTODIAL - CUSTODIAL_MANAGED - RESERVED - HSA_SELF - HSA_ADVISORY - HSA_RIA_MANAGED accountHolderType: type: string example: I description: A classification for the type of the account holder. US broker-dealers must utilize this field for CAIS compliance. If unset, a default value of `I` will be assumed for CAIS reporting. Please refer to CAIS documentation and instructions for more information on the allowed values. enum: - E - I - A - F - O - V - P - X tradingType: type: string example: CASH description: The type of trading the account will participate in. enum: - CASH - MARGIN portfolioID: type: string example: portfolio_87fec25f-c350-4a53-83a0-fc6be0c2989e description: The unique identifier of a portfolio. permissions: type: string example: MINOR_GRADUATION_TRANSFER enum: - ORDERS_CREATE - MINOR_GRADUATION_TRANSFER authorizedUser: type: object properties: userID: $ref: '#/components/schemas/userID' permissions: type: array description: Permission assigned to the authorized user. example: - ORDERS_CREATE - MINOR_GRADUATION_TRANSFER items: oneOf: - $ref: '#/components/schemas/permissions' leverage: type: number example: 1 description: The amount of leverage an account is allowed to trade with. interestedPartyAuthorizedUser: type: object properties: id: $ref: '#/components/schemas/userID' reportingRole: type: string description: The role of the interested party of the ID. enum: - AUTH3RD - AUTHREP - NTHOLDER - TRDHOLDER tradeDiscretion: type: boolean description: The trade discretion of the interested party of the ID. from: type: string format: date-time pattern: yyyy-MM-ddTHH:mm:ss.SSSZ example: '2022-12-25T22:28:21.810Z' description: Time when the interested party role started to: type: string format: date-time pattern: yyyy-MM-ddTHH:mm:ss.SSSZ example: '2022-12-26T22:28:21.810Z' description: Time when the interested party role ended endReason: type: string description: The reason the interested party role ended. enum: - CORRECTION - ENDED - INACTIVE - REPLACED - OTHER - TRANSFER interestedParty: type: object properties: type: type: string description: The type of interested party. enum: - AUTHORIZED_USERS data: type: array description: 'The data of the interested party. Different types can be used in this field. Current supported type: InterestedPartyAuthorizedUser' items: oneOf: - $ref: '#/components/schemas/interestedPartyAuthorizedUser' accountNo: type: string example: DWBG000052 description: The user's unique account number, that is human readable. accountManagementTypeObject: type: object properties: name: type: string example: SELF description: The type of account who has trading authority. 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 - HSA_SELF - HSA_ADVISORY - HSA_RIA_MANAGED description: type: string example: Self Directed Account description: A custom description of the account management type. accountHolderTypeObject: type: object properties: name: $ref: '#/components/schemas/accountHolderType' description: type: string example: An account that does not meet FINRA Rule 4215(c) or a proprietary trading account description: A custom description of the account holder type. accountStatus: type: string example: OPEN description: The current status of the user's account. enum: - PENDING - OPEN - OPEN_NO_NEW_TRADES - FROZEN - CLOSED accountNickname: type: string example: Steve's Robo Advisor Managed Account description: 'A description or nickname for an account. ' parentIBIDObject: type: object properties: id: type: string example: 80f9b672-120d-4b73-9cc9-42fb3262c4b9 description: The unique identifier of an associated organization. name: type: string example: Tendies Trading Company description: The organization name. taxProfileObject: type: object properties: taxStatusCode: type: string example: W-9 description: The tax code of the accounts associated user. taxRecipientCode: type: string example: INDIVIDUAL description: The type of tax filing of the accounts associated user. commissionID: type: string example: b3e985dd-9679-63dc-5dd5-9bd7982efecd description: The unique identifier associated with a specific commission related to the account. beneficiariesOption: type: boolean example: false description: True if the account has associated beneficiaries. restricted: type: boolean example: false description: If true, the account cannot trade on unsettled funds. goodFaithViolations: type: number example: 0 description: The total number of good faith violations. patternDayTrades: type: number example: 0 description: The total number of pattern day trades. freeTradeBalance: type: number example: 0 description: The total number of free trades left for the account. gfvPdtExempt: type: boolean example: false description: True if the account exempt from trading violations. buyingPowerOverride: type: boolean example: false description: True if the account is required to have sufficient buying power to enter a trade. bod: type: object description: Beginning of day balances in the account. properties: moneyMarket: type: number example: 0 description: Beginning of day money market value. equityValue: type: number example: 0 description: Beginning of day equity value. cashAvailableForWithdrawal: type: number example: 0 description: Total amount of settled funds that can be withdrawn. cashAvailableForTrading: type: number example: 0 description: Total amount of settled funds that can be traded. cashBalance: type: number example: 0 description: The current account cash balance. productID: type: string example: product_b94c0b6a-5ac8-43e4-95d1-777051c0503b description: The unique identifier associated with an RIA managed product. riaObject: type: object properties: advisorID: $ref: '#/components/schemas/riaID' productID: $ref: '#/components/schemas/productID' sweepInd: type: boolean example: true description: Are the funds swept into a money market account? interestFree: type: boolean example: false description: Is the interest generated from money market deposited back into account? openedWhen: type: string example: '2022-12-22T06:07:41Z' description: A timestamp of when the account was opened. ignoreMarketHoursForTest: type: boolean example: false description: Can the account ignore market hours in the UAT environment? flaggedForACATS: type: boolean example: false description: True if the account is flagged for an Automated Customer Account Transfer (ACATS). gfvRestricted: type: boolean example: false description: True, when the account cannot trade on unsettled funds. pdtRestricted: type: boolean example: false description: True, when the account is PDT restricted, and can only sell. patternDayTrader: type: boolean example: false description: True, when the account is designated as a Pattern Day Trader. statusChangeReasonInternal: type: string example: LEGAL_AML description: Reason for the account status change enum: - ACAT - ACCOUNT_TRANSFERRED - COMPLIANCE_RESTRICTED - DUPLICATE_ACCOUNT - DECEASED - FINRA_RESTRICTIONS - LEGAL_AML - MARGIN_CALLS - PAYMENT_FAILURE - PARTNER_RESTRICTED - PDT_RESTRICTIONS statusUpdatedBy: type: string example: ACAT_SYSTEM description: A free string, which can be UUID of Backoffice user or any other system which updated the status. statusChangeHistory: type: object properties: status: $ref: '#/components/schemas/accountStatus' statusChangeReason: $ref: '#/components/schemas/statusChangeReasonInternal' statusUpdatedBy: $ref: '#/components/schemas/statusUpdatedBy' lastActivityDate: type: string example: '2024-07-23' description: The date indicating the last recorded activity of the account, across the partner's ecosystem. It's important to update this field regularly, as activity recency may impact functions like escheatment, and there may be activity occuring outside of the DriveWealth APIs. statusChangeReason: type: string example: DECEASED description: Change account status with reason enum: - DUPLICATE_ACCOUNT - DECEASED - PARTNER_RESTRICTED wlpID: type: string example: TTC description: The wlpID is a deep backoffice ID that identifies each partner from each other. assignmentCriteria: type: object properties: wplID: $ref: '#/components/schemas/wlpID' countries: type: string example: USA description: Clients from this country will be assigned this commission. defaultStatus: type: boolean example: true description: The default commission to be applied if no other criteria matches. accountMgmtType: type: string example: null description: NEEDS DESCRIPTION ratesObject: type: object properties: rate: type: number example: 1.49 description: Commission rate in USD. passThroughFees: type: boolean example: true description: If true, SEC and TAF fees are passed through to the client. shareAmountRounding: type: string example: CEIL description: Share amount rounding method. Options:`FLOOR` - Share quantity rounded down `CEIL` - Share quantity rounded up `NEAREST` - Share quantity rounded to nearest integer. enum: - FLOOR - CEIL - NEAREST minimumRate: type: number example: 1.49 description: Minimum commission rate. name: type: string example: Tom Ace description: Full name or entity name of type. beneficiariesObject: type: object description: An object containing the information of a beneficiary. properties: type: type: string example: ENTITY description: Type of beneficiary. enum: - PERSON - ENTITY name: $ref: '#/components/schemas/name' percentage: type: number example: '0.25' description: Percentage ownership beneficiary has in the account. Must total 1 (aka 100%) across all beneficiaries. email: type: string example: tom@ac.com description: The email of the entity. formationDate: type: string example: '2010-10-25' description: 'Entity formation date. Must follow the YYYY-MM-DD format. Only required if type: `ENTITY`.' primaryContact: type: string example: '5512478089' description: 'Primary phone contact of entity. Only required if type: `ENTITY`' phone: type: string example: '4153647890' description: Phone number of beneficiary. created: type: string example: '2022-12-29T18:32:15.533Z' description: The when the beneficiary was added to the account. bankAccountID: type: string example: bank_a4656e60-321e-425b-aa0d-a2e75c38885f description: The unique DriveWealth identifier that identifies each linked bank account. bankAccountNumber: type: string example: '7442393174' description: The account number of the user's external bank account. bankName: type: string example: JP Morgan Chase description: The name of the user's bank. beneficiaryBankAddress: type: string example: 222 BROADWAY description: The user's external bank street address. beneficiaryBankCity: type: string example: New York City description: The user's external bank city. beneficiaryBankProvince: type: string example: New York description: The user's external bank state or province. beneficiaryBankZip: type: string example: '10038' description: The user's external bank postal code. beneficiaryBankCountry: type: string example: USA description: The user's external bank country. wireDetails: type: object properties: bankAccountNumber: $ref: '#/components/schemas/bankAccountNumber' bankName: $ref: '#/components/schemas/bankName' bankSwiftCode: type: string example: CHASUS33 description: Bank accounts swift code. 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: type: string example: bfa2e... description: A unique DriveWealth virtual account identifier. paymentType: type: string example: WIRE description: The type of payment. enum: - WIRE - ACH bankRoutingNumber: type: string example: '110000000' description: The routing number of the user's external bank. 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: type: string example: aba description: The type of routing being used. enum: - ABA - ACH beneficiaryName: $ref: '#/components/schemas/name' beneficiaryAddress: $ref: '#/components/schemas/bankAddress' virtualAccountID: type: string example: bfa2e... description: A unique DriveWealth virtual account identifier. paymentType: type: string example: ACH description: The type of payment. 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: type: string example: aba description: The type of routing being used. enum: - ABA - ACH beneficiaryName: $ref: '#/components/schemas/name' beneficiaryAddress: $ref: '#/components/schemas/bankAddress' virtualAccountID: type: string example: bfa2e... description: A unique DriveWealth virtual account identifier. paymentType: type: string example: WIRE description: The type of payment. enum: - WIRE - ACH depositID: type: string example: CKDQ000001-1671085040913-DMIQY description: A unique identifier for the Deposit. currency: type: string example: USD description: The name of the currency in abbreviation form. enum: - USD currencySymbol: type: string example: $ description: The currency symbol. enum: - $ currencyObject: type: object properties: name: $ref: '#/components/schemas/currency' description: type: string example: US Dollar description: A custom description about the currency. symbol: $ref: '#/components/schemas/currencySymbol' depositStatusNumber: type: number example: 1 description: The current status of the user's deposit in integer form. enum: - 0 - 1 - 2 - 3 - 4 - 14 - 15 - 16 - 5 - -1 depositStatus: type: string example: PENDING description: The current status of the user's deposit. enum: - STARTED - PENDING - SUCCESSFUL - FAILED - OTHER - APPROVED - REJECTED - ON_HOLD - RETURNED - '-' updated: type: string example: '2022-12-11T22:28:21.810Z' description: '' depositStatusObject: type: object properties: id: $ref: '#/components/schemas/depositStatusNumber' message: $ref: '#/components/schemas/depositStatus' updated: $ref: '#/components/schemas/updated' description: The last updated timestamp of the status of the user's deposit. accountTypeObject: type: object properties: name: type: string example: LIVE description: The type of account that has been created. description: type: string example: Live Account description: A custom description of the account type. wlpFinTranTypeID: type: string example: c43bab85-2916-4831-a0db-66215150a6e4 description: A unique identifier to id different type of transactions. note: type: string example: Hey! Welcome to DriveWealth Developer Docs! description: A way to store a message/comment on the this object. depositsByUserIDObject: type: object properties: id: $ref: '#/components/schemas/depositID' paymentID: $ref: '#/components/schemas/depositID' amount: type: number example: 125.22 description: The amount of the deposit 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: type: string example: DWUV000006-1593451797743-R8CC7 description: A unique identifier for the user's account redemption/withdrawal. redemptionStatusObject: type: object properties: id: type: number example: 1 description: The current status of the user's brokerage account withdraw in integer form. message: type: string example: PENDING description: The current status of the user's brokerage account redemption/withdrawal. enum: - STARTED - PENDING - SUCCESSFUL - FAILED - OTHER - RIA_PENDING - RIA_APPROVED - RIA_APPROVED - APPROVED - REJECTED - '-' updated: type: string example: '2022-12-11T22:28:21.810Z' description: The last updated timestamp of the status of the user's brokerage account redemption/withdrawal. transactionCode: type: string example: JOURNAL enum: - JOURNAL - FEE_ACH - DISBURSEMENT_ACH_SVB finTranReference: type: string example: HG.cd22a78a-8a48-441c-89d2-ea400964a34b description: The unique identifier that references back to the specific transaction. feeObject: type: object required: - type - amount properties: type: type: string example: FEE_ACH description: The type of fee that is being applied. enum: - FEE_ACH - FEE_FEDERAL_TAX - FEE_STATE_TAX description: type: string example: Fee - ACH description: A custom description that describes the fee type. amount: type: number example: -5.99 description: The amount of the fee that is being applied. wlpFinTranTypeID: $ref: '#/components/schemas/wlpFinTranTypeID' transactionCode: $ref: '#/components/schemas/transactionCode' finTranReference: $ref: '#/components/schemas/finTranReference' created: type: string example: '2022-12-11T22:28:21.810Z' description: The timestamp of when the fee was charged. 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: type: number example: 250.25 description: The amount that will be withdraw from the user's brokerage account. 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: type: string example: '2022-12-11T22:28:21.810Z' description: The date and time of when the redemption was created. Redemptions: type: array items: oneOf: - $ref: '#/components/schemas/Redemption' orderID: type: string example: IC.0e352bb7-9869-4233-9861-9673544efedd description: A unique DriveWealth order identifier created when an order is placed. orderNo: type: string example: ICDU023727 description: A unique, human-readable DriveWealth order number. created: type: string example: '2022-12-11T22:28:21.810Z' description: '' orderCumulativeQuantity: type: number example: 0.7219 description: The amount of shares currently being transacted; larger orders may execute in chunks. orderQuantity: type: number example: 0.7219 description: The amount of the instrument in shares. 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: type: object 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. properties: currency: $ref: '#/components/schemas/currency' amount: type: integer example: 14 description: The sales credit amount in cents. instrumentType: type: string example: EQUITY description: The classification of the instrument. enum: - EQUITY - ALTERNATIVE_ASSET - MUTUAL_FUND - DEBT - OPTION - CRYPTO PendingOrders: type: object description: A list of pending orders. properties: accountID: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' tradingType: $ref: '#/components/schemas/tradingType' updated: type: string example: '2021-04-23T18:41:32.440Z' description: The time of the last update to the Pending Orders Object. orders: type: array description: An array that holds a list of currently pending orders. 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: type: string example: '2' description: The current status of the order. enum: - '0' - '1' - '2' - '3' - '4' - '6' - '7' - '8' - '9' - A - B - C orderType: type: string example: '1' description: The type of order that is placed. enum: - '0' - '1' - '2' - '3' - '4' - '6' - '7' - m orderQty: $ref: '#/components/schemas/orderQuantity' isoTimeRestingOrderExpires: type: string example: null description: The time when the limit order expires. limitPrice: type: number example: null description: The price set for the limit order. side: $ref: '#/components/schemas/sideAbbreviated' orderCashAmt: type: number example: null description: The amount of cash requested for an order (fractional shares only). stopPrice: type: number example: 200 description: The stop price of a limit order. ISIN: $ref: '#/components/schemas/instrumentISIN' salesCredit: $ref: '#/components/schemas/SalesCredit' instrumentType: $ref: '#/components/schemas/instrumentType' orderStatusNumber: type: number example: 2 description: The current status of the order, represented as a number. enum: - 0 - 1 - 2 - 4 - 6 - 7 - 8 orderTypes: type: string example: MARKET description: The type of the Order. enum: - MARKET - LIMIT - STOP - STOP_LIMIT - MARKET_IF_TOUCHED fundID: type: string example: fund_4c16152c-f8e7-4a5a-af6b-c36f4e5cc6e7 description: The unique identifier of a fund. fundType: type: string example: FUND description: The type of fund. enum: - FUND - CASH_RESERVE fundName: type: string example: Large Capitalization Fund description: A user defined name that describes the underlying fund. fundTarget: type: number example: 0.75 description: The individual targeted weight of the instrument. holdings: type: array description: A list of the securities held in a Fund. 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: type: number example: 0.3054 description: The percentage weight of a Fund in a Portfolio. value: type: number example: 33604.12 description: The current value of the Fund in a Portfolio in USD. rebalanceRequired: type: boolean example: true description: A flag that determines if a re-balance is required based on total drift. holdings: $ref: '#/components/schemas/holdings' cashSettlementTime: type: object properties: utcTime: type: string example: '2021-04-26T13:30:00.001Z' description: Timestamp of when the pending cash amount is released due to settlement. cash: type: number example: 439.7 description: The total amount of money that is settling on the provided utcTime. statementObj: type: object properties: displayName: type: string example: Apr 28, 2017 Statement description: Description of account statement file. fileKey: type: string example: '2017042802' 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. taxStatementObj: type: object properties: displayName: type: string example: 2015 Tax Year 1099-B description: Description of account tax statement file. fileKey: type: string example: '2015123103' 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. tradeConfirmObj: type: object properties: displayName: type: string example: Jun 02, 2017 Trade Confirm description: Description of trade confirmation file. fileKey: type: string example: '2017060201' 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. marginObj: type: object properties: marginRequirement: type: number example: 1 description: Leverage amounts. 0.5 = 2:1 Leverage. 1 = 1:1 Leverage enum: - 0.5 - 1 longMarketValue: type: number example: 0 description: A real-time dollar value of current holdings. debitBalance: type: number example: 0 description: Real-time dollar value of debt; positive dollar amount is a debit balance, negative dollar amount is a credit balance. equity: type: number example: 0 description: Real-time dollar value of equity; calculated as longMarketValue – debitBalance. equityFraction: type: number example: 0 description: Equity as a fraction of long market value; calculated as equity ÷ longMarketValue. equityRequired: type: number example: 1 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. accruedInterest: type: number example: 0 description: NEEDS DESCRIPTION bodDTBP: type: number example: 10000 description: The Day Trading Buying Power (DTBP) in dollars at the beginning of day. nullable: true patternDayTrader: type: boolean example: false description: NEEDS DESCRIPTION restricted: type: boolean example: false 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). daySMA: type: number example: 0 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. rtExcessEquity: type: number example: 0 description: Equity in excess of equityRequired calculated in real time (more is good). effectiveSMA: type: number example: 0 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. noBuyingPowerReason: type: string example: null 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.' marginCall: type: object 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` properties: {} restingOrders: type: number example: 0 description: Total dollar value committed in resting orders that reduces the effectiveSMA equityValue: type: number format: double example: 34275565.44 description: The current total market value of the account's open equity positions. 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: type: number example: 31.65120151 description: Quantity of shares owned by the account. costBasis: type: number example: 975.98 description: Cost basis of the position. marketValue: type: number example: 4540.36 description: Current market value of the position. side: type: string example: B description: 'In this case, Side distinguishes the type of position. This will always return ''long''(B). ' enum: - B priorClose: type: number example: 144.29 description: The prior closing price of the security. availableForTradingQty: type: number example: 31.65120151 description: The quantity of the security available for sale. avgPrice: type: number example: 30.84 description: The average price of the position. mktPrice: type: number example: 143.45 description: The current market price of the position. unrealizedPL: type: number example: 3564.38 description: Unrealized profit and loss for position. unrealizedDayPLPercent: type: number example: -0.58 description: Unrealized day profit and loss for position in percent. unrealizedDayPL: type: number example: -26.59 description: Unrealized day profit and loss for position. orderStatus: type: string example: FILLED description: The current status of the order. enum: - NEW - FILLED - PARTIAL_FILL - PENDING_CANCEL - CANCELED - REJECTED limitPrice: type: number example: null description: The price set for the limit order. stopPrice: type: number example: 200 description: The stop price of a limit order. 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: type: string example: null description: The time when the limit order expires. limitPrice: $ref: '#/components/schemas/limitPrice' side: $ref: '#/components/schemas/sideAbbreviated' orderCashAmt: type: number example: null description: The amount of cash requested for an order (fractional shares only). 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: type: string example: null description: The time when the limit order expires. limitPrice: type: number example: null description: The price set for the limit order. side: $ref: '#/components/schemas/sideAbbreviated' orderCashAmt: type: number example: null description: The amount of cash requested for an order (fractional shares only). stopPrice: type: number example: 200 description: The stop price of a limit order. realizedPL: type: number example: 3564.38 description: Realized profit and loss for position. executedWhen: type: string example: 017-06-16T15:35:27.856Z description: The time when the transaction was executed. updatedWhen: type: string example: '2017-06-16T15:35:30.617Z' description: NEEDS DESCRIPTION updatedReason: type: string example: market_order-buy-new description: A reason for the update. commissions: type: number example: 0 description: Commission for the transaction if applicable. commissionDesc: type: string example: Free description: A short description about the commission. performanceObj: type: object properties: realizedDayPL: type: number example: 100.5 description: The actual profit or loss on the day in USD. unrealizedDayPL: type: number example: 3564.38 description: Current unrealized profit and loss for open positions in account. cumRealizedPL: type: number example: 10 description: The cumulative realized profit/loss from inception of account, each day adds to previous days. date: type: string example: '2018-09-18' description: the date of the performance arrays values. equity: type: number example: 9941.59 description: Invested equity (excluding cash) for this day (see performance.date). For Total `Equity` add performance.equity and performance.cash cash: type: number example: 439.7 description: The total cash balance (settled and unsettled) for this day (see performance.date). deposits: type: number example: 0 description: The total amount of deposits calculated from 4pm of previous day until current time. withdrawals: type: number example: 0 description: The total amount of withdrawals calculated from 4pm of previous day until current time. fees: type: number example: 0 description: The total amount of fees calculated from 4pm of previous day until current time. optionsValue: type: number format: double example: 12345.67 description: The current total market value of the account's open option positions. debtValue: type: number format: double example: 12345.67 description: The current total market value of the account's open debt positions. positionsValue: type: number format: double example: 34287911.11 description: The current total market value of the account's open positions. 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: type: number example: 31.65120151 description: Quantity of shares owned by the account. costBasis: type: number example: 975.98 description: Cost basis of the position. marketValue: type: number example: 4540.36 description: Current market value of the position. side: type: string example: B description: 'In this case, Side distinguishes the type of position. This will always return ''long''(B). ' enum: - B priorClose: type: number example: 144.29 description: The prior closing price of the security. availableForTradingQty: type: number example: 31.65120151 description: The quantity of the security available for sale. avgPrice: type: number example: 30.84 description: The average price of the position. mktPrice: type: number example: 440.75 description: The current market price of the position. unrealizedPL: type: number example: 14.24 description: The unrealized profit and loss for the position. unrealizedDayPLPercent: type: number example: 1.65 description: The unrealized day profit and loss for position in percent. unrealizedDayPL: type: number example: 0.54 description: The unrealized day profit and loss for the position. 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: type: number example: 31.65120151 description: Quantity of shares owned by the account. costBasis: type: number example: 975.98 description: Cost basis of the position. marketValue: type: number example: 4540.36 description: Current market value of the position. side: type: string example: B description: 'In this case, Side distinguishes the type of position. This will always return ''long''(B). ' enum: - B priorClose: type: number example: 144.29 description: The prior closing price of the security. availableForTradingQty: type: number example: 31.65120151 description: The quantity of the security available for sale. avgPrice: type: number example: 30.84 description: The average price of the position. 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: type: number example: 31.65120151 description: Quantity of shares owned by the account. costBasis: type: number example: 975.98 description: Cost basis of the position. marketValue: type: number example: 4540.36 description: Current market value of the position. side: type: string example: B description: 'In this case, Side distinguishes the type of position. This will always return ''long''(B). ' enum: - B priorClose: type: number example: 144.29 description: The prior closing price of the security. availableForTradingQty: type: number example: 31.65120151 description: The quantity of the security available for sale. avgPrice: type: number example: 30.84 description: The average price of the position. violationsObj: type: object properties: goodFaithViolations: type: object properties: count: $ref: '#/components/schemas/goodFaithViolations' patternDayTrades: type: object properties: count: $ref: '#/components/schemas/patternDayTrades' details: type: string example: /back-office/accounts/b5421694-65c6-4e48-9f8f-d90596e2f471.1616427127842/violations description: A string containing the direct path to the [violations API](https://developer.drivewealth.com/reference/list-all-account-violations) for further detail properties-goodFaithViolations: type: object properties: count: $ref: '#/components/schemas/goodFaithViolations' violationSells: type: object properties: qty: $ref: '#/components/schemas/orderQuantity' amount: type: number example: 20 description: The amount of shares being transacted. 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: type: number example: 100 description: The amount of shares being transacted. side: $ref: '#/components/schemas/sideAbbreviated' createdWhen: $ref: '#/components/schemas/created' orderID: $ref: '#/components/schemas/orderID' orderNo: $ref: '#/components/schemas/orderNo' violationSells: type: array description: An array which orders are in violation. items: oneOf: - $ref: '#/components/schemas/violationSells' legacyGoodFaithViolations: type: number example: 0 description: NEEDS DESCRIPTION message: 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. description: A description of the violation. accountEquityBreakdownObj: type: object properties: longMarketValue: type: number example: 30000 description: The current long market value. debitBalance: type: number example: 2000 description: The current debit balance. accountEquity: type: number example: 28000 description: The current total account equity (longMarketValue - debitBalance). 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: type: string example: '1' description: The type of order that is placed. 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: type: number example: 122.47 description: The price at which the order was executed. side: $ref: '#/components/schemas/sideAbbreviated' createdWhen: $ref: '#/components/schemas/created' updatedWhen: type: string example: '2017-06-16T15:35:30.617Z' description: NEEDS DESCRIPTION updatedReason: type: string example: market_order-buy-new description: A reason for the update. commission: type: number example: 0 description: Commission for the transaction if applicable. commissionDesc: type: string example: Free description: A short description about the commission. isoTimeRestingOrderExpires: type: string example: null description: The time when the limit order expires. executedWhen: type: string example: 017-06-16T15:35:27.856Z description: The time when the transaction was executed. realizedPL: type: number example: 3564.38 description: Realized profit and loss for position. orderCashAmt: type: number example: null description: The amount of cash requested for an order (fractional shares only). salesCredit: $ref: '#/components/schemas/SalesCredit' currency: $ref: '#/components/schemas/currency' dividend: type: object properties: type: type: string example: CASH description: The dividend type, whether a cash or stock dividend. enum: - CASH - STOCK - RETURN_OF_CAPITAL - DISTRIBUTION_LONG - DISTRIBUTION_SHORT - OTHER amountPerShare: type: number example: 0.65 description: The amount of the dividend issued, per share. taxCode: type: string example: FULLY_TAXABLE description: Whether the dividend is taxable or not. enum: - FULLY_TAXABLE - NON_TAXABLE - TAX_EXEMPT - 'null' finTranID: type: string example: EF.a935f686-5567-4e10-9e71-261314207c0b description: The internal and unique transaction identification number. finTranTypeID: type: string example: JNLC description: The abbreviated transaction type identifier. 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: type: number example: -890.12 description: The amount of the transaction. accountBalance: type: number example: 49984.44 description: The equity value of the account at the time of the transaction. accountType: $ref: '#/components/schemas/accountType' dividend: $ref: '#/components/schemas/dividend' dividendTax: type: object description: An object containing details of a dividend withholding. properties: rate: type: number description: The Witholding rate associated with the dividend payment. example: 0.15 type: type: string description: The type of tax associated with the withholding example: FOREIGN_TAX enum: - FOREIGN_TAX - NON_RESIDENTIAL_ALIEN - OTHER dnb: type: boolean example: false description: If false, the transaction was sent to inteliclear. Default is false. comment: type: string example: Buy 0.0259 shares of AMZN at 1003.13 FULL fill description: A comment describing the transaction finTranID: $ref: '#/components/schemas/finTranID' finTranTypeID: $ref: '#/components/schemas/finTranTypeID' feeSec: type: number description: The sec fee charged to an applicable sell order. Reference your fee schedule for SEC fee amounts per share. example: 0.01 feeTaf: type: number description: Trading activity fee (TAF) for an applicable sell order. Reference your fee schedule for TAF fee amounts per share. example: 0.01 feeBase: type: number description: The net fee amount of TAF and SEC Fees for a given sell order. example: 0.02 feeXtraShares: type: number description: Commission charged when the share quantity is greater than the base share amount. Reference your commission schedule for more info. example: 0.05 feeExchange: type: number description: An Exchange Fee applied to an order. example: 0.02 fillQty: type: number description: The quantity of shares filled for a transaction. example: 1.02387115 fillPx: type: number description: The fill price of the order for the given transaction. example: 17.44 orderID: $ref: '#/components/schemas/orderID' mergerAcquisition: type: object description: An object containing details of a corporate event, such as a merger or an acquisition. properties: type: type: string description: The transaction result of the corporate event 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: type: object description: Object containing details of the acquiring company properties: id: $ref: '#/components/schemas/instrumentID' symbol: type: string description: The instrument ticker symbol. example: AAPL name: type: string description: The name of the acquiring company example: Apple acquiree: type: object description: Object containing details of the company being acquired properties: id: $ref: '#/components/schemas/instrumentID' symbol: type: string description: The instrument ticker symbol. example: TSLA name: type: string description: The name of the company being acquired example: TSLA positionDelta: type: number description: The delta in the number of shares due to the corporate action. example: 0.18 TransactionRes: type: array description: A list of transactions. items: oneOf: - $ref: '#/components/schemas/Transaction' taxLotID: type: string example: 3db27e74626adac3be7b549f2bbc0ab2480852a7 description: A unique tax lot identifier. rootId: type: string example: 3fb1e8a9-f7d5-4d90-95e2-43e7326b5636 description: A unique ID created by DriveWealth to identify a specific Instrument that this Option is derived from. optionType: type: string example: PUT description: The type of Option. enum: - CALL - PUT parentIBID: type: string example: 80f9b672-120d-4b73-9cc9-42fb3262c4b9 description: The unique identifier of the firm. AssetTransferType: type: string enum: - ACAT - TEEN - CASH - PROMOTIONAL - REWARD - STOCK AssetTransferStatus: type: string enum: - STARTED - PENDING - FAILED - SUCCESSFUL - ON_HOLD AcatRejectionCode: type: string description: The ACAT rejection reason. 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: type: object description: The status of the Transfer properties: name: $ref: '#/components/schemas/AssetTransferStatus' description: type: string GenericTransferRequest: type: object properties: source: $ref: '#/components/schemas/accountNo' destination: type: string description: The DriveWealth destination account number where all assets will be transferred to. example: LKKZ000004 comment: $ref: '#/components/schemas/note' metadata: $ref: '#/components/schemas/metadata' GenericTransferResponseModel: type: object properties: id: $ref: '#/components/schemas/assetTransferID' status: $ref: '#/components/schemas/GenericTransferStatus' type: type: object description: The type of the Transfer properties: name: $ref: '#/components/schemas/AssetTransferType' description: type: string partner: $ref: '#/components/schemas/parentIBIDObject' created: type: string format: date-time example: '2022-12-22T06:07:41Z' updated: type: string format: date-time example: '2022-12-22T06:07:41Z' auditDetails: type: array description: Audit of Transfer status changes items: type: object minProperties: 1 properties: timestamp: type: string format: date-time description: Status update timestamp example: '2022-12-22T06:07:41Z' status: $ref: '#/components/schemas/GenericTransferStatus' comment: type: string description: Status comment added by the system AcatsCreateRequestModelWithoutEnums: type: object properties: clearingNo: type: string example: '0001' description: The DTCC clearing number of the broker. minLength: 1 maxLength: 4 cash: type: number description: The amount of cash to be moved from the source account. default: 0 positions: type: array minItems: 0 description: The positions to be moved from the source account to the destination account. items: $ref: '#/components/schemas/AcatPositionModel' AcatsTransferEnumValues_SourceAccountType: type: string description: The type of account the sources account is. enum: - INDIVIDUAL - CORPORATE - JOINT - CUSTODIAL - IRA - RIA_MANAGED AcatsType: type: string description: The type of ACAT transfer to be performed. enum: - FULL - PARTIAL AcatsTransitType: type: string description: The transit type of ACAT transfer to be performed. enum: - ACAT_IN - ACAT_OUT Status724: type: string description: The status of the transfer in the clearing custody. example: '230' SettlementInfo: title: AcatSettlementInfo type: object description: Settlement Info will appear when transfer gets sent to clearing custody. It consists of the controlno assigned from clearing custody and the status. properties: controlNo: type: string description: The control number assigned by the clearing custody. example: '20250320013533' status: type: string enum: - ACAT_RECEIVED - ACAT_READY - ACAT_READY_AFTER_CUTOFF - ACAT_SENT - ACAT_ACK - ACAT_ADJUST - ACAT_IN_PROGRESS - ACAT_UNDER_REVIEW - ACAT_REVIEW_ACK - ACAT_REVIEW_SENT - ACAT_REVIEW_ADJUST - ACAT_PTR_IN_PROGRESS - ACAT_REVIEW_ACCEPTED - ACAT_SETTLEMENT_IN_PROGRESS - ACAT_REVIEW_ERROR - ACAT_SETTLED - ACAT_REJECTED - ACAT_PURGE - ACAT_PTR_REJECTED - UNRECOGNISED description: Enum for the status assigned by clearing custody example: ACAT_REVIEW_ACCEPTED status724: $ref: '#/components/schemas/Status724' positions: type: object description: The positions and cash which accepted by broker after review. properties: cash: type: number description: The amount of cash to be moved to account. default: 0 accepted: type: array description: The positions which are accepted and to be moved from the account. Array is consist of cusip values. excluded: type: array description: The positions which are excluded in transfer. Array is consist of cusip values. We will exclude the assets which are not supported by ACAT transfer. RejectionInfo: type: object properties: rejectionCode: $ref: '#/components/schemas/AcatRejectionCode' rejectionReason: type: string positions: type: object description: The positions which are rejected by broker after review. additionalProperties: type: string example: Instrument not found. cash: type: number description: The debit amount of cash which is rejected by broker after review. example: -700 AcatsCreateRequestModel: type: object title: AcatsRequestModel description: ACAT Request model 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 - type AcatsTransferListResponseModel: type: object properties: sourceAccountID: $ref: '#/components/schemas/sourceAccountID' destinationAccountID: $ref: '#/components/schemas/destinationAccountID' sourceAccountType: type: object properties: name: $ref: '#/components/schemas/AcatsTransferEnumValues_SourceAccountType' description: type: string acatType: type: object properties: name: $ref: '#/components/schemas/AcatsType' description: type: string acatTransit: type: object properties: name: $ref: '#/components/schemas/AcatsTransitType' description: type: string settlementInfo: $ref: '#/components/schemas/SettlementInfo' rejectionInfo: $ref: '#/components/schemas/RejectionInfo' metadata: $ref: '#/components/schemas/metadata' auditDetails: type: array description: Audit of Transfer status changes anyOf: - $ref: '#/components/schemas/AcatsAuditDetails' AcatsTransferGetResponseModel: type: object properties: sourceAccountID: $ref: '#/components/schemas/sourceAccountID' destinationAccountID: $ref: '#/components/schemas/destinationAccountID' sourceAccountType: type: object properties: name: $ref: '#/components/schemas/AcatsTransferEnumValues_SourceAccountType' description: type: string acatType: type: object properties: name: $ref: '#/components/schemas/AcatsType' description: type: string acatTransit: type: object properties: name: $ref: '#/components/schemas/AcatsTransitType' description: type: string settlementInfo: $ref: '#/components/schemas/SettlementInfo' rejectionInfo: type: object properties: rejectionCode: $ref: '#/components/schemas/AcatRejectionCode' rejectionReason: type: string positions: type: object description: The positions which are rejected by broker after review. additionalProperties: type: string example: Instrument not found. cash: type: number description: The debit amount of cash which is rejected by broker after review. example: -700 metadata: $ref: '#/components/schemas/metadata' auditDetails: type: array description: Audit of Transfer status changes anyOf: - $ref: '#/components/schemas/AcatsAuditDetails' ACATSTransferCreatedResponseModel: type: object properties: sourceAccountID: $ref: '#/components/schemas/sourceAccountID' destinationAccountID: $ref: '#/components/schemas/destinationAccountID' sourceAccountType: type: object properties: name: $ref: '#/components/schemas/AcatsTransferEnumValues_SourceAccountType' description: type: string acatType: type: object properties: name: $ref: '#/components/schemas/AcatsType' description: type: string acatTransit: type: object properties: name: $ref: '#/components/schemas/AcatsTransitType' description: type: string metadata: $ref: '#/components/schemas/metadata' auditDetails: type: array description: Audit of Transfer status changes anyOf: - $ref: '#/components/schemas/AcatsAuditDetails' MinorCreateRequestModel: type: object allOf: - $ref: '#/components/schemas/GenericTransferRequest' properties: {} AcatPositionModel: title: AcatPosition type: object description: Position Model. Symbol or InstrumentID is required. properties: symbol: $ref: '#/components/schemas/instrumentSymbol' instrumentID: $ref: '#/components/schemas/instrumentID' quantity: type: number 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. minimum: 1 required: - quantity CancelRebillIdentifer: type: string description: A unique identifier generated for the Cancel Rebill. format: string CancelRebillReason: type: object properties: name: example: PRICE_ADJUSTMENT_PARTNER enum: - FRAUD - PRICE_ADJUSTMENT_PARTNER - PRICE_ADJUSTMENT_VENUE - DRIVEWEALTH_TECHNICAL_ERROR - PARTNER_TECHNICAL_ERROR - VENDOR_ERROR description: The Cancel Rebill reason. description: type: string description: The description of the reason for the Cancel Rebill. CancelRebillType: type: object properties: name: example: CANCEL enum: - CANCEL - PRICE_ADJUSTMENT - COMMISSION_ADJUSTMENT description: The type of Cancel Rebill. description: type: string description: The description of the cancel rebill type. CancelRebillStatus: type: object properties: name: enum: - STARTED - APPROVED - ON_HOLD - REJECTED - PENDING - SUCCESSFUL description: The status of the Cancel Rebill. description: type: string description: The description of the Cancel Rebill status. code: type: integer AuditDetails: type: object properties: status: $ref: '#/components/schemas/AssetTransferStatus' comment: $ref: '#/components/schemas/note' updatedBy: type: string description: The user who updated the status. timestamp: type: string format: date-time description: Status update timestamp example: '2022-12-22T06:07:41Z' AcatsAuditDetails: type: object properties: status: $ref: '#/components/schemas/AssetTransferStatus' status724: $ref: '#/components/schemas/Status724' comment: $ref: '#/components/schemas/note' updatedBy: type: string description: The user who updated the status. updated: type: string description: The date when the status was last updated. metadata: type: object example: myCustomKey: myCustomValue description: The metadata object allows for creating a maximum of 5 keys (max 36 characters) and each value cannot exceed more than 128 bytes. sourceAccountID: type: string example: d6a776bc-be5c-47df-94eb-baf914f1847c.1738660911962 description: It's a unique source account id, that is human readable. destinationAccountID: type: string example: c815c129-27cd-46f2-b316-ab6bde9aff62.1737384219426 description: It's a unique destination account id, that is human readable. ErrorCode: type: string description: The error code that is returned when an error occurs. example: E032 ErrorCodeMessage: type: string description: The error message that is returned when an error occurs. ErrorDetails: type: object properties: field: type: string description: JSON field name from the request body that caused an error type: type: string enum: - STRING - ARRAY - INT - DECIMAL - BOOL - TEXT - UUID - DATE - MAP - OBJECT description: Expected data type of the field allowedValues: type: string description: Example values which are allowed in the field ErrorResponseModel: type: object description: The error response model that is returned when an error occurs. required: - errorCode - message properties: errorCode: $ref: '#/components/schemas/ErrorCode' message: $ref: '#/components/schemas/ErrorCodeMessage' errorDetails: $ref: '#/components/schemas/ErrorDetails' assetTransferID: type: string example: c85b231a-2bc9-11ee-be56-0242ac120002 description: The unique identifier of the asset transfer. partnerID: type: string example: 80f9b672-120d-4b73-9ccv9-42fb3262c4b9 description: The partner's unique identifier. CreateAuthToken: type: object properties: username: type: string example: bo.sample.api description: The B2B (business to business) back office username. authToken: type: string example: acb33c99-3a6f-4494-85bf-8dae70977552.2018-07-26T14:45:47.391Z description: The B2B (business to business) back office session token. expiresAt: type: string example: '2022-12-28T01:09:33.714Z' description: The date and time the session token expires. security: type: object properties: description: type: string example: Partner Principal description: A custom description that describes the permission set. permissionSet: type: array description: A list of the permissions the back office permissions assigned. example: - ACCOUNTS_CREATE_LIVE - ACCOUNTS_CREATE_MANAGED - ACCOUNTS_CREATE_MARGIN - ACCOUNTS_CREATE_PRACTICE - ACCOUNTS_CREATE_RIA_MANAGED - ACCOUNTS_EDIT permissionID: type: string example: 4380ee75-5acd-f5af-4347-04146bb3f61a description: A unique identifier for the permission set. userID: $ref: '#/components/schemas/userID' firstName: type: string example: Tendies Trading Company description: The Firm Name. lastName: type: string example: LLC description: The Firm Type. parentIBID: $ref: '#/components/schemas/userID' CreateAuthTokenReq: type: object required: - username - password - appTypeID properties: username: type: string example: bo.sample.api description: The B2B (business to business) back office username. password: type: string example: 188ff5b0-8f13-4676-8bb2-305b9e08a3ba description: The B2B (business to business) back office password. appTypeID: type: number example: 4 description: The version type identifier. CreateSessToken: type: object properties: token_type: type: string example: Bearer description: The type of token that was generated. enum: - Bearer expires_in: type: string example: '3600' description: The length of time in seconds for which the session token is valid. access_token: type: string example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c description: The session token. scope: type: string example: all_trading description: The scope of permission set for the JSON Web Token (JWT). CreateSessTokenReq: type: object required: - clientID - clientSecret properties: clientID: type: string example: 0oafccTendies67BTx113 description: The identifier of the client accessing the DriveWealth system. clientSecret: type: string example: 8WfNzC4oTendiesTradingCompanyPuQNwg7BPByWqQOj description: The secret of the client accessing the DriveWealth system. fileURL: 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 description: A short-lived URL that can be accessed to download the file. ListOfAllowedCountry: type: object properties: id: type: string example: ALA description: The abbreviated identifier of a country. name: type: string example: Aland Islands description: The full name of the country code2: type: string example: AX description: An alternative abbreviated identifier of a country. code3: type: string example: ALA description: An alternative abbreviated identifier of a country. active: type: boolean example: true description: True, if a user can be onboarded from this country. expatsAllowed: type: boolean example: false description: True, if a user who resides outside of their country can be onboarded from the listed country. foreignTINNotRequired: type: boolean example: false description: True, if a user's tax identifier is NOT required during onboarding. fpslProhibited: type: boolean example: false supportDomicile: type: boolean example: false taxTreatyCountry: type: boolean example: false description: True, if the country has a tax treaty with the United States. ListOfAllowedCountries: type: array description: A list of allowed countries. items: oneOf: - $ref: '#/components/schemas/ListOfAllowedCountry' DepositRequestReq: type: object required: - accountNo - amount - currency - type properties: accountNo: $ref: '#/components/schemas/accountNo' amount: type: number example: 250.25 description: The amount that will be deposited into the user's account. 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: type: string example: '2017-09-18' description: The start date of the recurring deposit. The date should be in the future and within 90 days. 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: type: object example: myCustomKey: myCustomValue description: The metadata object allows for creating a maximum of 5 keys (max 36 characters) and each value cannot exceed more than 128 bytes. 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: type: number example: 250.25 description: The amount of cash that is being deposited into the user's account. status: $ref: '#/components/schemas/depositStatus' source: type: object properties: id: $ref: '#/components/schemas/depositTypes' brand: type: string example: ACH description: A custom description about the type of deposit. meta_info: type: string example: Hey! Welcome to DriveWealth Developer Docs! description: A way to store a message/note on the deposit object. created: $ref: '#/components/schemas/created' description: The date and time the deposit was created for the user's account. 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: type: string example: '2019-01-15' description: The date of when the next recurring deposit will be triggered. active: type: boolean example: false description: True, if the recurring deposit is active. 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: type: string example: Valid request. Auto-move to Pending description: A custom comment generated by the system. DepositByDepositID: type: object properties: id: $ref: '#/components/schemas/userID' category: type: string example: DEPOSIT amount: type: number example: 250.25 description: The amount of cash that is being deposited into the user's account. currency: $ref: '#/components/schemas/currencyObject' status: $ref: '#/components/schemas/depositStatus' created: $ref: '#/components/schemas/created' description: The date and time the deposit was created for the user's account. 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: type: array description: A list of the different historical status of the deposit items: oneOf: - $ref: '#/components/schemas/DepositStatusHistory' depositTypes: type: string example: ACH description: The method/form in which the funds will be arriving to the user's account. enum: - ACH - BULK_FUNDING - CASH_PROMOTION - CASH_TRANSFER iraContribution: type: string example: CURRENT_YEAR description: The type of contribution deposit for retirement accounts. enum: - CURRENT_YEAR - PRIOR_YEAR - ROLLOVER recurringFrequency: type: string example: MONTHLY_FIRST description: The recurring deposit frequency. enum: - BIWEEKLY - DAILY - MONTHLY - MONTHLY_FIRST - MONTHLY_MIDDLE - QUARTERLY settlementProfileID: type: string example: settlement-profile-bank-account-1 description: A settlement profile identifier that links to a specific bank account for fund settlement. externalBankName: type: string example: Bank of America description: The bank name of the linked account. externalBankAddress: type: string example: 222 Broadway, New York City, NY, 10038 description: The full address of the bank where the account is linked. externalBankCountry: type: string example: USA description: The country of the bank where the account is linked. accountHolderName: type: string example: Justin Smith description: The full name of the user on the external bank account. externalAccountHolderAddress: type: string example: 15 Exchange Place, Jersey City, NJ, 07302 description: The home address of the linked account holder. externalAccountHolderCountry: type: string example: USA description: The country of the linked account holder. recurringID: type: string example: recurring_98be6652-6361-4d4c-905b-06e9ec38d060 description: A unique identifier of the recurring deposit. username: type: string example: ttc.user.justin description: The username of the user. firstName: type: string example: Justin description: The first name of the user. lastName: type: string example: Smith description: The last (family) name of the user. email: type: string example: jj@drivewealth.dev description: The user's email address. firmName: type: string example: Tendies Trading Company description: The firm name. 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: type: string example: 8b8ba3fd-74dc-45dc-b2dc-7de683bd713c.1556222995391 description: The user's unqiue account identifier. accountNo: type: string example: DWBG000052 description: The user's unqiue account number, that is human readable. nickname: type: string example: Justin's Self Directed Account status: type: object properties: name: type: string example: PENDING description: The status of the user's account. description: type: string example: Pending description: A custom description about status of the user's account. accountType: type: string example: LIVE description: The type of account that has been created. accountManagementType: type: string example: SELF description: The type of account who has trading authority. enum: - SELF - ADVISORY - RIA_MANAGED - CUSTODIAL - CUSTODIAL_MANAGED - RESERVED - HSA_SELF - HSA_ADVISORY - HSA_RIA_MANAGED tradingType: type: object properties: name: type: string example: CASH description: The type of trading ocurring in the account. enum: - CASH - MARGIN - CRYPTO description: type: string example: Cash Account description: A custom description about the type of account. leverage: type: number example: 1 description: The leverage that is applied to the user's account. commissionID: type: string example: 449d41b9-3940-41ff-b0e6-334adfb443f8 description: The unique identifier for the assiocated commission schedule. userID: type: string example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 description: The user's unique identifier. restricted: type: boolean example: false description: True, if the user is restricted from trading. goodFaithViolations: type: number example: 0 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. patternDayTrades: type: number example: 0 description: The amount of times that a user buy and sells the same security in the same day over a seven day period. freeTradeBalance: type: number example: 0 gfvPdtExempt: type: boolean example: false buyingPowerOverride: type: boolean example: false description: True, if buying power check turned off. bod: type: object description: Beginning of Day Information, *⚠️ Only updated at the beginning of day, this information will not change interaday.* properties: moneyMarket: type: number example: 3028.98 description: The amount of money the user's has in money market for this account. equityValue: type: number example: 12071.5 description: The value of the sum of all equities in the account. cashAvailableForWithdrawal: type: number example: 3028.98 description: The amount of money available for withdrawal. cashAvailableForTrading: type: number example: 3028.98 description: The amount of money available for trading. updatedWhen: type: string example: '2022-12-12T21:13:12.391Z' description: The date and time the dob job was run. cashBalance: type: number example: 3028.98 description: The amount of settled cash in the account. sweepInd: type: boolean example: true description: True, if the user's account cash is set to move into a bank sweep or money market account. interestFree: type: boolean example: false description: True, if the user will not be paid interest on the money in a bank sweep or money market account. createdWhen: type: string example: '2022-12-11T22:28:21.810Z' description: The createdWhen is the date and time the user's account was created. updatedWhen: type: string example: '2022-12-11T22:28:21.810Z' description: The updatedWhen is the last date and time the user's account was updated. lastActivityDate: $ref: '#/components/schemas/lastActivityDate' interestedParties: type: array items: $ref: '#/components/schemas/interestedParty' AccountDetails: type: array description: A list of all the user's accounts at DriveWealth. items: oneOf: - $ref: '#/components/schemas/Account' batch: type: boolean example: true transactionCodeType: type: string example: CSR enum: - CSR - CSD transactionCodeObject: type: object properties: code: $ref: '#/components/schemas/transactionCode' type: $ref: '#/components/schemas/transactionCodeType' description: type: string example: Cash Receipt - ACH description: A custom description about the transaction code. bankAccountCountry: type: string example: USA description: The country where the user's external bank is located. bankAccountNumberLastFour: type: string example: '****3174' description: The last four digits of the user's external bank account number. bankRoutingNumberLastFour: type: string example: '****0000' description: The last four digits of the user's external bank routing number. updatedBy: type: string example: SYSTEM enum: - SYSTEM REPORT SERVICE - INSTANT FUNDING BREAKDOWN JOB disclosureID: type: string format: uuid example: 31b087cc-4a74-41ad-b0f2-57acca333de6 description: The id of a disclosure disclosureName: type: string pattern: ^[a-zA-Z0-9_]+$ example: OPTIONS_AGREEMENT_V1 description: The name of the disclosure documentID: type: string format: uuid example: 31b087cc-4a74-41ad-b0f2-57acca333de6 description: The id of a document url: type: string format: url example: https://dandbndiekfkx.cloudfront.net/xxxxcxxx-yyyy-zzzz-b0f2-57acca333de6.jpeg?Policy=eyJTdGF0ZW1lbnQiOiBbeyJSZXNvdXJjZSI6Imh0dHBzOi8vZG56cXZuMjgxazc0bS5jbG91ZGZyb250Lm5ldC8zMWIwOD description: The url of the disclosure document version: type: string format: ^[0-9]{1,3}([.])[0-9]{1,3}([.])[0-9]{1,3}$ example: 1.1.0 description: Version of the disclosure obligation: type: string example: DELIVERY description: Indicates the legal obligation of the disclosure enum: - ACKNOWLEDGE - DELIVERY effectiveDate: type: string format: date pattern: yyyy-MM-dd example: '2023-06-14' description: Indicates the effective date of the disclosure product: type: string example: EQUITY description: The applicable product if the disclosure is product specific enum: - ALL - EQUITY - CRYPTO - MUTUAL_FUNDS - DRIVEHUB subProduct: type: string example: OPTIONS description: The applicable sub product within the product if the disclosure is sub product specific enum: - ALL - OPTIONS - REINVESTMENT - OMNI_OPTIONS - TERMS status: type: string example: ACTIVE description: A disclosure can be active or no longer supported enum: - ACTIVE - INACTIVE acknowledged: type: boolean example: true description: Indicates whether the end user acknowledged or declined the disclosure agreement signedAt: type: string format: timestamp example: '2023-06-14T15:07:24Z' description: Timestamp of when the customer acknowledged or declined the disclosure agreement Disclosure: type: object properties: disclosureID: $ref: '#/components/schemas/disclosureID' name: $ref: '#/components/schemas/disclosureName' documentID: $ref: '#/components/schemas/documentID' url: $ref: '#/components/schemas/url' version: $ref: '#/components/schemas/version' 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' CreateDisclosureOutput: $ref: '#/components/schemas/Disclosure' UpdateDisclosureOutput: $ref: '#/components/schemas/Disclosure' CreateAcknowledgmentInput: required: - disclosureID - signedAt - acknowledged $ref: '#/components/schemas/Acknowledgment' CreateAcknowledgmentOutput: $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: type: string description: The specific id of the exchange exchangeNo: type: string description: The specific exchange number status: type: string description: The state of the exchange. enum: - NEW - FILLED - REJECTED - PENDING_CANCEL - CANCELED - FILLED sellSymbol: type: string description: This will be the ticker of the mutual fund you will be liquidating sellOrderId: type: string description: The order ID corresponding to the sell transaction sellOrderNo: type: string description: The order number corresponding to the sell transaction buySymbol: type: string description: This will be the ticker of the mutual fund you will be purchasing with the proceeds of the liquidation buyOrderId: type: string description: The order ID corresponding to the buy transaction buyOrderNo: type: string description: The order number corresponding to the buy transaction sellAveragePrice: type: number description: The price the sell order was filled at. sellCumulativeQuantity: type: number description: The total quantity the sell was for. buyAveragePrice: type: number description: The price the buy order was filled at. buyCumulativeQuantity: type: number description: The total quantity the buy was for. amountCash: type: integer description: This is the total notional amount you exchange from the sellSymbol to the buySymbol. fees: type: integer description: The total fees for both the buy and sell order of the exchange. createdBy: type: string description: The user, who created the order. userID: $ref: '#/components/schemas/userID' accountID: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' created: type: string example: '2019-03-29T20:00:00.000Z' description: The timestamp the order was created. orderExpires: type: string example: '2019-03-29T20:00:00.000Z' description: The timestamp the exchange expires. Bars: type: object properties: instrumentID: $ref: '#/components/schemas/instrumentID' compression: type: number example: 9 description: The compression value represents the time increments of the chart data. Refer to the compression table for the value descriptions. enum: - 0 - 1 - 4 - 8 - 9 - 10 dateStart: type: string example: '2022-11-10T00:00:00Z' description: The start date of the chart data. dateEnd: type: string example: '2022-11-18T23:59:00Z' description: The end date of the chart data. data: 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 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.' 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: type: string example: MS description: The ticker symbol of the associated Instrument. name: type: string example: Morgan Stanley description: The official name of the company associated to the Instrument. enableExtendedHoursNotionalStatus: type: string example: INACTIVE description: The Instrument's eligibility for extended hours notional trading. This will default to INACTIVE instrumentType: $ref: '#/components/schemas/instrumentType' type: deprecated: true type: string example: EQUITY description: The classification of the Instrument. enum: - EQUITY - ETF - ETN - ADR - ALTERNATIVE_ASSET - MUTUAL_FUND - INTEREST_RATE status: type: string example: ACTIVE description: The current status of the instrument. enum: - ACTIVE - INACTIVE - CLOSE_ONLY - HALTED ISIN: $ref: '#/components/schemas/instrumentISIN' isOptionsEnabled: type: boolean example: true default: false description: The ability to trade options for this equity instrument. 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: type: string example: Morgan Stanley description: A friendly name of the Instrument, like the Company name for an equity orderSizeMax: type: number example: 20000 description: The maximum share amount for any order of this Instrument. orderSizeMin: type: number example: 0.1 description: The minimum share amount for any order of this Instrument. orderSizeStep: type: number example: 0.01 description: Increment amount on order of this Instrument. id: $ref: '#/components/schemas/instrumentID' instrumentType: $ref: '#/components/schemas/instrumentType' exchange: type: string example: NYQ description: The stock exchange the instrument is listed on. status: $ref: '#/components/schemas/instrumentStatus' ISIN: $ref: '#/components/schemas/instrumentISIN' CUSIP: $ref: '#/components/schemas/instrumentCUSIP' settlementDays: type: integer description: Number of days for the instrument to settle example: 1 OptionInstrumentBase: type: object properties: id: $ref: '#/components/schemas/instrumentID' symbol: type: string example: AAPL220517P00016000 description: The Option OSI symbol type: $ref: '#/components/schemas/instrumentType' name: type: string example: Morgan Stanley description: A friendly name of the Instrument, like the Company name for an equity exchange: type: string example: NYQ description: The stock exchange the instrument is listed on. orderSizeMax: type: number example: 20000 description: The maximum share amount for any order of this Instrument. orderSizeMin: type: number example: 0.1 description: The minimum share amount for any order of this Instrument. orderSizeStep: type: number example: 0.01 description: Increment amount on order of this Instrument. InstrumentsProperties: type: object properties: reutersPrimaryRic: type: string example: MS description: Reuters instrument code, or RIC, is a ticker-like code similar to the ticker symbol of a security. description: 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.' description: A comprehensive description of the Instrument in English. marketTier: type: string example: Q enum: - Q - G sector: type: string example: Financial Services description: The categorization of the sector pertaining to the Instrument. enum: - Services - Industrials - Energy - Technology - Healthcare - Financial - Consumer Cyclical - Real Estate - Capital Goods - Utilities - Consumer Defensive - Basic Materials - Financial Services - Transportation - Communication Services industry: type: string example: Retail (Apparel) description: The categorization of the industry pertaining to the Instrument. 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: type: string example: USA description: The country code of the incorporated company's Instrument. 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: type: boolean example: true description: The ability to trade options for this equity instrument. Default is false, meaning it is not possible to trade options for this instrument. longOnly: type: boolean example: true description: The ability to short an Instrument. Default is true, meaning it is not possible to short the instrument. exchangeNickelSpread: type: boolean example: false description: If true, a limit order for this Instrument must be in increments of $0.05 close: type: number example: 87.79 description: The most recent closing price of the Instrument. enableExtendedHoursNotionalStatus: type: string example: INACTIVE description: The instruments eligibility for extended hours notional trading. This will default to INACTIVE. fundamentalDataModel: $ref: '#/components/schemas/fundamentalDataModel' type: deprecated: true type: string example: EQUITY description: The classification of the Instrument. enum: - EQUITY - ETF - ETN - ADR - ALTERNATIVE_ASSET - MUTUAL_FUND url: type: string example: http://investor.apple.com description: URL for the investor site of the instrument. closePrior: type: number example: 90.5 description: The instruments closing price of the prior trading day. image: type: string example: http://syscdn.drivewealth.net/images/symbols/ms.png description: A publicly hosted image of the instruments logo. isPTP: type: boolean example: false description: True, if the Instrument is a publicly traded partnership (PTP). 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: type: number example: 72.05 description: The lowest price of the instrument in the past 52 weeks. fiftyTwoWeekHighPrice: type: number example: 109.73 description: The highest price of the instrument in the past 52 weeks. cumulativeVolume: type: number example: 3970567 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. marketCap: type: number example: 148374700000 description: The total market cap of the instrument measured in USD. peRatio: type: number example: 12.7434 description: The Price-earnings ratio for the instrument. dividendYield: type: number example: 3.5312 description: The percentage of a company's share price that is payed out in dividends each year. earningsPerShare: type: number example: 6.889 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. dividend: type: number example: 3.1 description: The annual dividend amount paid out per share measured in USD. sharesOutstanding: type: number example: 1307993346 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. timeLastUpdate: type: string example: '18:28:00' description: The last time the instruments data was updated. bookValuePerShare: type: string example: '59.49634' 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. cashFlowPerShare: type: string example: '10.40132' 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. operatingIncome: type: string example: '19668000000' 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. pbRatio: type: string example: '1.61196' 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. volumeMovingAverage10Day: type: number example: 7791905 description: The volume moving average of the last 10 days for the instrument measured in quantity of shares. volumeMovingAverage25Day: type: number example: 6768708 description: The volume moving average of the last 25 days for the instrument measured in quantity of shares. volumeMovingAverage50Day: type: number example: 7307176 description: The volume moving average of the last 50 days for the instrument measured in quantity of shares. priceMovingAverage50Day: type: number example: 85.3034 description: The price moving average of the last 50 days for the instrument measured in (USD) per share. priceMovingAverage150Day: type: number example: 83.6295 description: The price moving average of the last 150 days for the instrument measured in (USD) per share. priceMovingAverage200Day: type: number example: 84.3036 description: The price moving average of the last 200 days for the instrument measured in (USD) per share. roe: type: string example: '0.15315' 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. percentchangeWTD: type: number example: 2.31 description: The percentage change between the most recent market closing price and the closing price at the week start. percentchangeMTD: type: number example: 2.3 description: The price percentage change for the instrument Month to Date. percentchangeYTD: type: number example: 10.11 description: The price percentage change for the instrument Year to Date. percentchange4week: type: number example: 21.22 description: The price percentage change for the instrument in last 4 Weeks. percentchange13week: type: number example: 6.67 description: The price percentage change for the instrument in last 13 Weeks. percentchange26week: type: number example: 8.26 description: The price percentage change for the instrument in last 26 Weeks. percentchange52week: type: number example: 12.1 description: The price percentage change for the instrument in last 52 Weeks. percentchange5day: type: number example: 10.11 description: The 5 Day Price Percent Change is the percentage change in the company's stock price over the last 5 tradable (business) days. percentchangeYTDrelsnp: type: number example: 9.11 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. percentchange5weekrelsnp: type: number example: 16.62 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 percentchange13weekrelsnp: type: number example: 5.67 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 percentchange26weekrelsnp: type: number example: 2.66 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. percentchange52weekrelsnp: type: number example: 11.12 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. OptionInstrumentDetails: type: object allOf: - $ref: '#/components/schemas/OptionInstrumentBase' properties: optionsData: type: object properties: rootSymbol: type: string example: AAPL description: Ticker symbol of the underlying instrument from which this Option is derived. rootId: type: string example: 3fb1e8a9-f7d5-4d90-95e2-43e7326b5636 description: A unique ID created by DriveWealth to identify a specific Instrument that this Option is derived from. expirationDate: type: string example: '2018-09-18' description: The date the Option Contract will expire format: date optionType: type: string example: PUT description: Call or Put enum: - CALL - PUT strikePrice: type: number example: 16.5 description: The strike price of the option. deliverable: type: number example: 100 default: 100 description: The deliverable unit, available for stock and index options, is the number of shares of the underlying stock with respect to one option contract. multiplier: type: number example: 100 default: 100 description: The premium/strike Multiplier, available for stock and index options, provides the premium/strike multiplier for an option contract. MutualFundInstrumentDetails: type: object allOf: - $ref: '#/components/schemas/InstrumentBase' properties: url: type: string example: http://investor.apple.com description: The URL to the investor information page or the prospectus. image: type: string example: http://syscdn.drivewealth.net/images/symbols/ms.png description: A publicly hosted image of the instruments logo. mutualFundData: type: object properties: fundFamily: type: string description: The name of the fund family. For example, "ABC Funds". example: Vanguard shareClass: type: string description: Identifies the share class of the fund. For example Class A, Class B, or Institutional. enum: - A - B - INST example: INST loadType: type: string description: Identifies how commissions are paid for the fund, if any. enum: - NO_LOAD - FRONT_END - BACK_END - LEVEL - HYBRID - OTHER example: NO_LOAD dccsEligible: type: boolean description: Indicates if the fund allows orders to be submitted through the NSCC DCC&S Defined Contribution Clearance and Settlement. example: true blueSkyStates: type: array description: State postal abbreviation for each state the fund has been registered in. example: - CA - NY - AZ items: type: string purchaseCutOff: type: string description: The cutoff time to accept a buy order and execute the same day. example: '16:00' redemptionCutOff: type: string description: The cutoff time to accept a sell order and execute the same day. example: '16:00' maximumPurchaseAmount: type: integer description: The maximum purchase amount in dollars the fund will allow. example: 10000000 purchaseMinimums: type: object properties: minimumInitialTaxable: type: integer description: The minimum initial purchase amount, in dollars, the fund will allow for taxable accounts. example: 500 minimumInitialIRA: type: integer description: The minimum initial purchase amount, in dollars, the fund will allow for IRA accounts. example: 500 minimumInitialQualifiedPlans: type: integer description: The minimum initial purchase amount, in dollars, the fund will allow for qualified plans. This would include 401K, HSAs, etc. example: 500 minimumSubsequentTaxable: type: integer description: The minimum subsequent purchase amount, in dollars, the fund will allow for taxable accounts. example: 100 minimumSubsequentIRA: type: integer description: The minimum subsequent purchase amount, in dollars, the fund will allow for IRA accounts. example: 100 minimumSubsequentQualifiedPlans: type: integer description: 'The minimum subsequent purchase amount, in dollars, the fund will allow for qualified plans. This would include 401K, HSAs, etc. ' example: 100 minimumSystematicPurchase: type: integer description: The minimum amount, in dollars, which will be allowed for systematic purchases. example: 10 minimumInitialExchange: type: integer description: The minimum initial purchase amount, in dollars, which will be allowed for exchange purchases. example: 10 minimumSubsequentExchange: type: integer description: The minimum subsequent purchase amount, in dollars, which will be allowed for exchange purchases. example: 10 fundType: type: string description: The type of mutual fund. enum: - MUTUAL_FUND - MONEY_MARKET - UIT - CLOSE_END - GIC - STABLE_VALUE - SEPARATE_ACCOUNT - BANK_COLLECTIVE_TRUST - OFFSHORE_NRA - BIC - 529_PLAN - OFFSHORE_US_DOLLAR - OFFSHORE_NON_US_DOLLAR - ANNUITY - UNKNOWN example: MUTUAL_FUND fundStatus: type: string description: Indicates if the fund is open or closed. Eligible values are Open, Closed - Liquidated, Closed - Merged. enum: - OPEN - LIQUIDATED - MERGED - UNKNOWN example: OPEN largeTradeNotificationRequired: type: boolean description: Does the fund required prior notification when large trades are being placed. largeTradeDollarThreshold: type: number description: At what dollar amount is prior trade notification. example: 1000000000 redemptionFeePercentage: type: integer description: The percent charged for the non-short-term redemption. example: 0 redemptionFeeAmount: type: integer description: The amount, in dollars, charged for the non-short-term redemption fee. example: 0 restrictedRedemption: type: boolean description: Is the redemption of shares for this fund limited to specific dates and/or intervals. purchaseEligibility: type: string description: 'Can the fund be purchased by new and/or existing shareholders. Eligible values: All, Existing Only, Closed, Restrictions Apply (see Prospectus).' enum: - ALL - EXISTING_ONLY - CLOSED - RESTRICTIONS_APPLY - UNKNOWN example: ALL exchangeBuyEligibility: type: string description: Can shares of another fund be exchanged into new and/or existing accounts or is the fund closed for exchange purchases. enum: - ALL - EXISTING_ONLY - CLOSED - RESTRICTIONS_APPLY - UNKNOWN example: ALL exchangeFee: type: string description: Are exchange fees charged on this fund and, if so, are they done on a percentage or fixed dollar basis. enum: - NO_EXCHANGE_FEE - PERCENTAGE - FIXED_DOLLAR - UNKNOWN example: PERCENTAGE exchangeFeePercentage: type: number description: The exchange fee percent charged. example: 10.5 exchangeFeeAmount: type: integer description: The amount, in dollars, of the exchange fee charged. example: 0 dividendFrequency: type: string description: The frequency dividends are paid out by the fund. enum: - MONTHLY - QUARTERLY - SEMI_ANNUALLY - ANNUALLY example: MONTHLY operatingExpenses: type: number description: Expenses paid by the shareholders each year as a percentage of the fund's value. example: 0.25 portfolioTurnover: type: number description: Investment portfolio turnover rate. example: 10.7 shortTermRedemptionRules: type: boolean description: Do Short-Term Redemption Fee fields apply for this fund. example: true shortTermRedemptionMinimumAmount: type: integer description: The minimum amount that the fund will charge as a short-term redemption fee. example: 0 mergedSecurity: type: string description: The fund status code equal to closed - merged, the Security ID of the fund to which it was merged. example: '922908306' prospectusUrl: type: string description: The link to the fund prospectus. example: https://app.allfunds.com/docs/legal/fund/.... managementFee: type: number description: The fund management fee. example: 0.15 domicile: type: string description: The fund ISO 2 domicile code. example: GB summaryRiskIndicator: type: integer description: The fund risk reward indicator. minimum: 1 maximum: 7 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 example: 3 UCITS: type: boolean description: True, if the investment funds regulated at European Union level. example: true DebtInstrumentDetails: type: object allOf: - $ref: '#/components/schemas/InstrumentBase' properties: debtData: $ref: '#/components/schemas/DebtReferenceData' ExpirationDateList: type: object properties: symbol: type: string example: AAPL description: The Symbol of the underlying equity security. expiration: type: array example: - '2022-05-10' - '2022-05-11' description: The date the Option Contract will expire. items: type: string OptionsList: type: object properties: symbol: type: string example: AAPL220517P00016000 description: Option OSI symbol options: type: array items: $ref: '#/components/schemas/OptionInstrumentDetails' 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 SpRatingDate: description: The date on which the S&P Rating was last updated. type: string format: date example: '2018-05-10' 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' spRatingDate: $ref: '#/components/schemas/SpRatingDate' 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 issuePricePercent: 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 debtType: description: The code for the type fixed income instrument. type: integer readOnly: true bondType: $ref: '#/components/schemas/BondType' debtTypeDescription: type: string description: The description for the type fixed income instrument. 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 sector: type: string example: FINANCE_AND_INSURANCE description: The categorization of the sector pertaining to the Instrument. enum: - AGRICULTURE_FORESTRY_FISHING_AND_HUNTING - MINING_QUARRYING_AND_OIL_AND_GAS_EXTRACTION - UTILITIES - CONSTRUCTION - MANUFACTURING - WHOLESALE_TRADE - RETAIL_TRADE - TRANSPORTATION_AND_WAREHOUSING - INFORMATION - FINANCE_AND_INSURANCE - REAL_ESTATE_AND_RENTAL_AND_LEASING - PROFESSIONAL_SCIENTIFIC_AND_TECHNICAL_SERVICES - MANAGEMENT_OF_COMPANIES_AND_ENTERPRISES - ADMINISTRATIVE_AND_SUPPORT_AND_WASTE_MANAGEMENT_AND_REMEDIATION_SERVICES - EDUCATIONAL_SERVICES - HEALTH_CARE_AND_SOCIAL_ASSISTANCE - ARTS_ENTERTAINMENT_AND_RECREATION - ACCOMMODATION_AND_FOOD_SERVICES - OTHER_SERVICES_EXCEPT_PUBLIC_ADMINISTRATION - PUBLIC_ADMINISTRATION duration: description: The duration of the bond. type: number format: double example: '10.5' readOnly: true nullable: true nextCallDate: description: The next call date of the bond. type: string format: date example: '2018-05-10' readOnly: true nullable: true debtRankType: description: The debt rank type of the bond. type: string example: SENIOR readOnly: true enum: - UNKNOWN - SECOND_MORTGAGE - 'FIRST_MORTGAGE ' - JUNIOR - MEZZANINE - SENIOR_SUBORDINATED - SUBORDINATED - THIRD_MORTGAGE - UNSUBORDINATED - JUNIOR_SUBORDINATED - SENIOR - NOT_APPLICABLE - TIER_I - LOWER_TIER_II - UPPER_TIER_II - TIER_III - SENIOR_SECURED - ALTERNATIVE_ADDITIONAL_TIER_I - SENIOR_NON_PREFERRED spRatingType: type: string example: INVESTMENT_GRADE description: The spRating type of the bond. enum: - INVESTMENT_GRADE - HIGH_YIELD coupon: $ref: '#/components/schemas/Coupon' issuer: $ref: '#/components/schemas/Issuer' indicators: $ref: '#/components/schemas/Indicators' denominationAmounts: $ref: '#/components/schemas/DenominationAmounts' 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' Indicators: description: Indicators that provide additional information about the security example: callIndicator: false convertibleIndicator: false defaultIndicator: false dtcIndicator: true oidIndicator: false putIndicator: false sinkIndicator: false tipsIndicator: false floaterIndicator: false traceEligible: true capitalizedIndicator: false childIndicator: false defeasanceIndicator: false equityLinkedNoteIndicator: false pikIndicator: false tenderExchangeOfferIndicator: false warrantsIndicator: false tradingRestrictionsType: None properties: callIndicator: description: Indicates if the security is eligible to be redeemed by the issuer on a call basis readOnly: true type: boolean convertibleIndicator: description: Specifies whether an issue is convertible or exchangeable readOnly: true type: boolean defaultIndicator: description: Specifies whether the security is in default or not readOnly: true type: boolean dtcIndicator: description: Indicates whether the security is acceptable for clearing by the DTCC. readOnly: true type: boolean oidIndicator: description: Specifies whether or not this issue qualifies for Original Issue Discount status readOnly: true type: boolean putIndicator: description: Indicates whether the security carries provisions that allow for redemption at the request of owners of the security readOnly: true type: boolean sinkIndicator: description: Indicates whether the security carries a sinking fund as part of its terms and conditions readOnly: true type: boolean tipsIndicator: description: Indicates whether the security is a Treasury Inflation Protected Security readOnly: true type: boolean traceEligible: description: Indicates whether the security is considered TRACE eligible for price reporting readOnly: true type: boolean capitalizedIndicator: description: Specifies whether a bond issuer has set aside some of the proceeds from a bond sale to cover a certain number of interest payments readOnly: true type: boolean childIndicator: description: Indicates whether the security is created as the result of a corporate action or other event (the child instrument) from a previously issued instrument (the parent) readOnly: true type: boolean defeasanceIndicator: description: Indicates whether the security contains a provision that voids a bond or loan when the borrower sets aside cash or bonds sufficient enough to service the borrower's debt (a process called defeasance) readOnly: true type: boolean equityLinkedNoteIndicator: description: Indicates whether the security is an Equity Linked Note readOnly: true type: boolean pikIndicator: description: Indicates whether the security carries provisions to make Payment In Kind (PIK) to owners of the security readOnly: true type: boolean tenderExchangeOfferIndicator: description: Indicates whether the security has an associated exchange or tender offer readOnly: true type: boolean warrantsIndicator: description: Indicates whether there is a warrant associated with the particular security readOnly: true type: boolean floaterIndicator: description: Indicates whether the security has a floating or adjustable rate issue readOnly: true type: boolean tradingRestrictionsType: description: Indicates whether any trading restrictions are in effect for the security enum: - None - 144A - REG_S - PRIVATE_PLACEMENT - ACCREDITED_INVESTORS - REG_D - SEC_ACT_OF_1933 readOnly: true type: string DenominationAmounts: description: A set of amounts that represent denomination amounts for the security properties: incrementAmount: description: The increment amount for the security. readOnly: true type: number format: double incrementAmountSecondary: description: The secondary increment amount for the security. readOnly: true type: number format: double minimumAmount: description: ' The minimum denomination amount for the security.' readOnly: true type: number format: double FilterCriterion: type: object required: - field - operator - value1 properties: field: description: The name of the field to be filtered on. type: string example: spRating enum: - id - ISIN - CUSIP - CINS - payFrequency - payFrequencyDescription - couponRate - maturityDate - spRating - assetClassCode - assetClassDescription - accrualDate - bidPrice - askPrice - meanPrice - askYieldToMaturity - bidYieldToMaturity - status - statusDescription - issuer.primaryName - issuer.country - issuer.domicileCountry - features.minimumInvestmentAmount - features.incrementalInvestmentAmount - coupon.dayCountDescription - coupon.couponTypeDescription - details.nextCouponDate - statusCode - longOnly - coupon.dayCount - coupon.couponType - coupon.nextCouponDate - sector - price - minimumAmount - orderBook.liquidityRetail - orderBook.liquidityInstitutional - orderBook.liquidityMicro - orderBook.onlyLiveQuotes - orderBook.price - orderBook.yieldToWorst - details.debtTypeDescription - denominationAmounts.incrementAmount - indicators.tradingRestrictionsType 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: type: string description: The index members of the instrument. 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: type: string example: US description: The ISO standard country alpha-2 code. instrumentStatus: type: string example: ACTIVE description: The current status of the instrument. enum: - ACTIVE - INACTIVE - CLOSE_ONLY - HALTED openPrice: type: number example: 86.53 description: Most recent opening price of the instrument. bidPrice: type: number example: 86.12 description: The current price buyers are prepared to pay for a security. askPrice: type: number example: 85.14 description: The current price sellers are prepared to sell a security. lowPrice: type: number example: 85.83 description: The lowest price in the current trading day. highPrice: type: number example: 86.85 description: The highest price in the current trading day. CreateOrderRequest: type: object required: - accountNo - orderType - side properties: accountNo: type: string example: CSSW000001 description: The user's assiocated account number. orderType: $ref: '#/components/schemas/orderTypesRequest' limitType: $ref: '#/components/schemas/limitType' symbol: $ref: '#/components/schemas/instrumentSymbol' side: $ref: '#/components/schemas/schemas-side' instrumentID: $ref: '#/components/schemas/instrumentID' ISIN: $ref: '#/components/schemas/instrumentISIN' quantity: type: number format: double example: 5 description: The unit quantity to purchase or sell. Required if `amountCash` is null. amountCash: $ref: '#/components/schemas/amountCash' price: type: number format: double example: 160.12 description: The price for non-`MARKET` Order types. This would be required if placing a `LIMIT`, `STOP`, or `MARKET_IF_TOUCHED` order. currency: $ref: '#/components/schemas/currency' commission: type: number format: double example: 4 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. commissionRate: $ref: '#/components/schemas/commissionRate' clientNotes: type: string example: Manual limit order. description: Client facing notes that can be added to a request. preventQueuing: $ref: '#/components/schemas/preventQueuing' extendedHours: $ref: '#/components/schemas/extendedHours' metadata: $ref: '#/components/schemas/metadata' timeInForce: $ref: '#/components/schemas/timeInForce' expiration: $ref: '#/components/schemas/expiration' salesCredit: $ref: '#/components/schemas/SalesCredit' dccs: $ref: '#/components/schemas/dccs' taxLotDisposition: $ref: '#/components/schemas/LotDisposition' travelRuleBankAccountID: type: string example: bank_485ba18c-009d-4c4a-a6e9-99b104c800b2 description: The travel rule bank account ID. Supported By MARKET, LIMIT, STOP, MARKET_IF_TOUCHED orders. Only if partner enabled to send travel rule. traderID: type: string example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 description: The trader ID of the individual creating the order. clientOrderTransactionTime: $ref: '#/components/schemas/clientOrderTransactionTime' clientOrderID: $ref: '#/components/schemas/clientOrderID' deptType: $ref: '#/components/schemas/deptType' LotDisposition: type: array items: allOf: - $ref: '#/components/schemas/TaxLot' CreateOrderResponse: type: object properties: orderId: type: string example: EF.418a5506-256c-4c3c-9d4d-f491522cf7f2 description: A unique identifier for the order. orderNo: type: string example: EFXM000103 description: A human readable order identifier. OrderStatusResponse: type: object description: Order details for a fixed income asset trade properties: id: $ref: '#/components/schemas/orderID' orderNo: $ref: '#/components/schemas/orderNo' type: $ref: '#/components/schemas/orderTypes' side: $ref: '#/components/schemas/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: $ref: '#/components/schemas/orderAveragePrice' currency: $ref: '#/components/schemas/currency' totalOrderAmount: type: number format: double example: 800 description: Total amount paid for the order. cumulativeQuantity: $ref: '#/components/schemas/orderCumulativeQuantity' quantity: $ref: '#/components/schemas/orderQuantity' fees: type: number format: double example: 0.01 description: Cost of the order. ptpWithholdingFee: type: number format: double example: 0.01 description: The publicly traded partnership (PTP) withholding fee for the order. createdBy: type: string example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 description: userID of the individual creating the order. userID: type: string example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 description: userID of the account holder the order relates to. accountID: type: string example: cc07f91b-7ee1-4868-b8fc-823c70a1b932.1407776996299 description: accountID for the account the order relates to. accountNo: type: string example: CSSW000001 description: accountNo for the account the order related to. created: type: string example: '2019-02-14T18:56:07.411Z' description: The time at which the order was created. statusMessage: type: object description: If the Order was unsuccessful, this object will be present with additional details regarding why. properties: errorCode: type: object example: null description: A DriveWealth error code. message: type: string example: null description: Description of the error code. reason: type: string example: null description: A longer reason for the error. amountCash: $ref: '#/components/schemas/amountCash' OrderExpires: type: string example: null 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. 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' travelRuleBankAccountID: type: string example: bank_485ba18c-009d-4c4a-a6e9-99b104c800b2 description: Displays travel rule bank account ID which set while creating order clientOrderTransactionTime: $ref: '#/components/schemas/clientOrderTransactionTime' clientOrderID: $ref: '#/components/schemas/clientOrderID' CancelOrder: type: object required: - method properties: method: type: string example: CANCEL enum: - CANCEL description: The method in which is requested. traderID: type: string example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 description: The trader ID of the individual. clientOrderTransactionTime: $ref: '#/components/schemas/clientOrderTransactionTime' clientOrderID: $ref: '#/components/schemas/clientOrderID' cancelDetails: $ref: '#/components/schemas/cancelDetails' CancelOrderResponse: type: object properties: orderId: type: string example: EF.418a5506-256c-4c3c-9d4d-f491522cf7f2 description: A unique identifier for the order. orderNo: type: string example: EFXM000103 description: A human readable order identifier. openQuantity: type: number example: 1 description: The number of units currently represented by the position in the Account. availableForTradingQuantity: type: number example: 1 description: The number of units that can currently be traded by the Account holder. commissionOverrideType: type: string enum: - NO_OVERRIDE - RAW_COMMISSION example: RAW_COMMISSION description: The type of commission override applied to the order commissionOverrideDesc: type: string example: Standard Commission description: The description of commission override applied to the order amountCash: type: number format: double example: null description: The USD-denominated amount to purchase or sell. localOrderStatus: type: string example: FILLED description: The current status of the order. enum: - NEW - FILLED - PARTIAL_FILL - REJECTED - CANCELED - PENDING_CANCEL side: type: string example: BUY description: The side of the order. enum: - BUY - SELL auditLog: type: object properties: status: $ref: '#/components/schemas/localOrderStatus' quantities: type: object properties: cumulativeQuantity: example: 0 filledQuantity: example: 0 remainingQuantity: example: 0 pricing: type: object properties: averagePrice: example: 0 averagePriceRaw: example: 0 lastPrice: example: 0 rateAsk: example: 0 rateBid: example: 0 commissionAndFees: type: object properties: commission: example: 0 feeSec: example: 0 feeTaf: example: 0 feeBase: example: 0 feeXtraShares: example: 0 feeExchange: example: 0 pnl: example: 0 transactTime: $ref: '#/components/schemas/updated' comment: $ref: '#/components/schemas/note' eventID: type: string example: event_15cc717e-856d-4eb4-8348-93cd5b6186aa description: EventID sent to client createdWhen: $ref: '#/components/schemas/created' dccs: type: boolean example: true description: True, when the Mutual Fund HSA is classified as Defined Contribution Clearing and Settlement (DCC&S) order. commissionOverride: oneOf: - type: object properties: commissionOverrideType: $ref: '#/components/schemas/commissionOverrideType' commissionID: $ref: '#/components/schemas/commissionID' commissionOverrideDesc: $ref: '#/components/schemas/commissionOverrideDesc' - type: object properties: commissionOverrideType: $ref: '#/components/schemas/commissionOverrideType' commissionID: $ref: '#/components/schemas/commissionID' commissionOverrideDesc: $ref: '#/components/schemas/commissionOverrideDesc' commissionAmount: example: 3.5 secOverride: example: 0.01 tafOverride: example: 0.01 - type: object properties: commissionOverrideType: example: '#/components/schemas/commissionOverrideType' commissionID: $ref: '#/components/schemas/commissionID' commissionOverrideDesc: example: '#/components/schemas/commissionOverrideDesc' commissionRate: example: 0.5 secOverride: example: 0.01 tafOverride: example: 0.01 OrderAuditResponse: type: object properties: id: $ref: '#/components/schemas/orderID' orderNo: $ref: '#/components/schemas/orderNo' accountID: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' quantities: type: object properties: requestedQuantity: type: number example: 1 description: The amount of shares requested in the order. totalFilledQuantity: type: number example: 1 description: The amount of shares filled in the order. ordStatus: $ref: '#/components/schemas/localOrderStatus' side: $ref: '#/components/schemas/side' symbol: $ref: '#/components/schemas/instrumentSymbol' ordType: $ref: '#/components/schemas/orderTypes' amountCash: $ref: '#/components/schemas/amountCash' violationExempt: type: boolean example: true preventQueuing: $ref: '#/components/schemas/preventQueuing' extendedHours: $ref: '#/components/schemas/extendedHours' orderExpires: type: string format: date example: YYYY-MM-DDTHH:MM:SS.sssZ description: The date of expiration for a good-til-canceled order, in ISO 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. openQuantity: $ref: '#/components/schemas/openQuantity' availableForTradingQuantity: $ref: '#/components/schemas/availableForTradingQuantity' instrumentID: $ref: '#/components/schemas/instrumentID' pricing: type: object properties: avgPxRaw: example: 33.66 avgPx: example: 33.66 stopPx: example: 0 minTriggerPrice: example: 0 commissionOverride: $ref: '#/components/schemas/commissionOverride' commissionAndFees: type: object properties: total: example: 2.99 tefra: example: 0 ptp: example: 0 auditLog: type: array items: oneOf: - $ref: '#/components/schemas/auditLog' clientOrderTransactionTime: $ref: '#/components/schemas/clientOrderTransactionTime' clientOrderID: $ref: '#/components/schemas/clientOrderID' clientOrderTransactionTime: type: string example: '2024-07-30T22:13:18.000Z' description: The date with a valid timestamp of when a partner received the order from the customer. clientOrderID: type: string example: 5a1762d5-4562 description: A unique identifier that represents the order, as defined by the partner. This detail will be reported to the CAT system for US brokers to more easily reconcile reported information. cancelDetails: type: object description: Additional details to clarify when and how the cancel request was received. US broker-dealers must utilize this field for CAT compliance. properties: initiator: type: string nullable: true example: C description: The individual responsible for initiating the cancellation of an order. Please refer to CAT documentation and instructions for more information on the allowed values. enum: - C - F requestedTimestamp: type: string nullable: true example: '2023-07-30T22:13:18.000Z' description: The requested timestamp in ISO format by user to cancel an order manualCancel: type: boolean nullable: true example: true description: Whether an order cancellation request was received from a human, manually. A false value represents that an automated system initiated the cancel. comment: type: string nullable: true example: This order has been cancelled description: A freeform comment to attach to the cancel request orderTypesRequest: type: string example: MARKET description: The type of the Order. enum: - MARKET - LIMIT - STOP - MARKET_IF_TOUCHED limitType: type: string enum: - PRICE - YIELD description: Whether the limit price represents a unit price, or a yield. Only applicable to Orders for debt Instruments. example: PRICE schemas-side: type: string example: BUY 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. enum: - BUY - SELL - BUY_OPEN - BUY_CLOSE - SELL_OPEN - SELL_CLOSE commissionRate: type: number format: BigDecimal description: The commission rate is a percentage charge to the total amount of the order. example: 0.3 minimum: 0.0001 maximum: 1 preventQueuing: type: boolean example: false 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. enum: - true - false extendedHours: type: boolean example: false 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. enum: - true - false timeInForce: type: string example: GTC 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. enum: - GTC - GTX - DAY - FILL_OR_KILL expiration: type: string format: date example: YYYY-MM-DD 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. TaxLot: type: object properties: taxLotID: $ref: '#/components/schemas/taxLotID' deptType: type: string example: ATS description: The name of the department in abbreviation form. enum: - A - ATS - DMA - SA - T - O orderAveragePrice: type: number example: 1038.81 description: The average price of the security being transacted in the order. 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/fileURL' physicalDocumentTypes: type: string example: DRIVER_LICENSE description: The type of physical document. enum: - DRIVER_LICENSE - PASSPORT - NATIONAL_ID_CARD - VOTER_ID - WORK_PERMIT - VISA - RESIDENCE_PERMIT - ACATS_IN - ACATS_OUT - TRANSFER_ON_DEATH - BENEFICIARY_DOCUMENT physicalDocumentBase64: type: string example: data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAASABIAAD/4QCMR description: The Base64 encoded string of the document. maximum: 10 physicalDocumentSides: type: string example: FRONT description: The actual side of the physical document. physicalDocumentID: type: string example: 532e1b7d-09fd-4a1b-956f-d4e91ad71b4f description: The unique identifier of the document. physicalDocumentStatus: type: string example: NOT_SUBMITTED description: The current status of the physical document. enum: - NOT_SUBMITTED - PENDING - APPROVED - REJECTED physicalDocumentStatusObject: type: object properties: name: $ref: '#/components/schemas/physicalDocumentStatus' description: type: string example: Document has not been submitted for approval. description: A custom description that describes the document current status. 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: type: number example: 2779731 description: The total trading volume of the security for the current day in quantity of shares. askSize: type: number example: 3 description: The ask size is the number of shares investors are trying to sell at a given price for a particular security. bidSize: type: number example: 4 description: The bid size is the number of shares investors are trying to buy at a given price for a particular security. change: type: number example: -1.33 description: The percentage change in trade price relative to the previous days close. lastTradeExchange: type: string example: DX description: The last exchange the symbol was traded on. bestBidExchange: type: string example: 'N' description: The exchange that is offering the best bid for the current symbol. bestAskExchange: type: string example: Q description: The exchange that is offering best ask for the symbol. lastTrade: type: number example: 86.47 description: The NBBO quote of the most recent trade. lastTradeSize: type: number example: 2 description: The quantity of shares of the last trade. marketCondition: type: string example: NORMAL description: The trading status of the symbol. enum: - NORMAL - TRADING_HALT - UNKNOWN tradeCount: type: number example: 29565 description: The number of trades placed for the symbol during the current trading day. close: type: number example: 0 description: The close price populated after market close, price updates overnight if a corporate action occurs. priorClose: type: number example: 86.86 description: The closing price of the current symbol for the prior trading day. Referential: type: array items: oneOf: - $ref: '#/components/schemas/EquityQuote' - $ref: '#/components/schemas/FixedIncomeQuote' EquityQuote: type: object properties: symbol: $ref: '#/components/schemas/instrumentSymbol' bid: $ref: '#/components/schemas/bidPrice' ask: $ref: '#/components/schemas/askPrice' lastTrade: type: number example: 86.47 description: The NBBO quote of the most recent trade. change: type: number example: -1.33 description: The percentage change in trade price relative to the previous days close. open: $ref: '#/components/schemas/openPrice' high: $ref: '#/components/schemas/highPrice' low: $ref: '#/components/schemas/lowPrice' close: type: number example: 0 description: The close price populated after market close, price updates overnight if a corporate action occurs. priorClose: type: number example: 86.86 description: The closing price of the current symbol for the prior trading day. volume: type: number example: 2779731 description: The total trading volume of the security for the current day in quantity of shares. marketCondition: type: string example: NORMAL description: The trading status of the symbol. enum: - NORMAL - TRADING_HALT - UNKNOWN dataProvider: type: string example: NYSE description: The exchange venue providing the quote. FixedIncomeQuote: type: array properties: instrumentID: type: string example: 1179e8dd-2781-4ce9-842c-f05ded6a40d7 description: The unique identifier of the instrument. isin: type: string example: US912810RC45 description: The International Securities Identification Number (ISIN) of the instrument. bidYield: type: number example: 4.220776 description: The yield at which the buyer is willing to buy the security. askYield: type: number example: 4.207803 description: The yield at which the seller is willing to sell the security. bid: type: number example: 92.276 description: The price at which the buyer is willing to buy the security. ask: type: number example: 92.436 description: The price at which the seller is willing to sell the security. priorClose: type: number example: 92.3085938 description: The closing price of the current symbol for the prior trading day. askSize: type: number example: 0 description: The ask size is the number of shares investors are trying to sell at a given price for a particular security. bidSize: type: number example: 0 description: The bid size is the number of shares investors are trying to buy at a given price for a particular security. lastTradeSize: type: number example: 0 description: The quantity of shares of the last trade. tradeCount: type: number example: 0 description: The number of trades placed for the symbol during the current trading day. marketCondition: type: string example: NORMAL description: The trading status of the symbol. enum: - NORMAL - TRADING_HALT - UNKNOWN dataProvider: type: string example: ICE BondPoint description: The exchange venue providing the quote. timeOffset: type: number example: 0 BidPrice: type: object description: Bid Price example: bidPrice: 98.992 bidSize: 10000 bidYield: 4.799 minQty: 150 properties: bidPrice: type: number format: double example: 130.529 description: Bid value readOnly: true bidSize: type: number format: double example: 150 description: Bid size readOnly: true bidYield: type: number format: double example: 4.799 description: Bid yield readOnly: true minQty: type: number format: double example: 150 description: Minimum quantity readOnly: true AskPrice: type: object description: Ask Price example: askPrice: 98.992 askSize: 10000 askYield: 4.799 minQty: 150 properties: askPrice: type: number format: double example: 98.884 description: Ask value readOnly: true askSize: type: number format: double example: 150 description: Ask size readOnly: true askYield: type: number format: double example: 4.793 description: Ask yield readOnly: true minQty: type: number format: double example: 150 description: Minimum quantity readOnly: true RecentTrade: type: object description: Recent Trade properties: price: type: number format: double example: 98.884 description: Trade price quantity: type: number format: double example: 150 description: Trade size/quantity yield: type: number format: double example: 4.793 description: Trade yield date: type: string format: date-time description: Asset's trade time. example: '2017-07-21T17:32:28Z' side: type: string example: sell description: The side of order that is being placed. enum: - buy - sell example: price: 98.992 size: 10000 yield: 4.799 side: buy dateTime: '2017-07-21T17:32:28Z' MarketQuoteRequest: type: object description: Trade Quote Request for Fixed Income Securities required: - instrumentID - quantity properties: instrumentID: $ref: '#/components/schemas/instrumentID' quantity: type: number format: double example: 3.14 description: The quantity of bonds user wishes to trade. minimum: 0 salesCredit: $ref: '#/components/schemas/SalesCredit' MarketQuoteResponse: type: object description: Trade Quote Response for Fixed Income Orders 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 date: '2017-07-21T17:32:28Z' properties: id: type: string description: Quote id in the DriveWealth System 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: type: number format: double example: 150 description: Trade size/quantity salesCredit: $ref: '#/components/schemas/SalesCredit' bidPrices: type: array description: bid prices without sales credit items: $ref: '#/components/schemas/BidPrice' askPrices: type: array description: ask prices without sales credit items: $ref: '#/components/schemas/AskPrice' effectiveBidPrices: type: array description: prices include any sales credit provided in the request items: $ref: '#/components/schemas/BidPrice' effectiveAskPrices: type: array description: prices include any sales credit provided in the request items: $ref: '#/components/schemas/AskPrice' recentTrades: type: array description: Recent Trades items: $ref: '#/components/schemas/RecentTrade' DailyReconciliation: type: object properties: id: $ref: '#/components/schemas/reconciliationID' date: type: string example: '2024-04-17' description: The date of when the reconciliation report was generated for. status: $ref: '#/components/schemas/reconciliationStatus' statusComment: type: string example: Finished processing breakdown description: A custom comment about the status. totalAmount: type: number example: 12001.01 description: The total amount due or owed to the firm. created: type: string example: '2024-04-15T22:28:21.810Z' description: The date and time the reconciliation report was created. updated: type: string example: '2024-04-17T22:28:21.810Z' description: The date and time the reconciliation report was last updated. updatedBy: $ref: '#/components/schemas/updatedBy' ListOfDailyReconciliations: type: array description: A list of daily reconciliations for a firm. items: oneOf: - $ref: '#/components/schemas/DailyReconciliation' ReconciliationUpdate: type: object properties: status: type: string example: SUCCESSFUL description: The status to update the reconciliation report to. enum: - SUCCESSFUL statusComment: type: string example: Manually approving reconciliation for testing purposes. description: A custom comment about the status. ReconciliationDetails: type: object properties: id: $ref: '#/components/schemas/reconciliationID' date: type: string example: '2024-04-17' description: The date of when the reconciliation report was generated for. status: $ref: '#/components/schemas/reconciliationStatus' statusComment: type: string example: Finished processing breakdown description: A custom comment about the status. amounts: type: object properties: total: type: number example: -1263.56 description: The total amount due or owed to the firm. purchases: type: number example: -1680.07 description: The total amount in purchases of equity instruments, that are due to DriveWealth. sales: type: number example: 416.51 description: The total amount in sales of equity instruments, that are owed to the firm. dividends: type: number example: 0 description: The total amount of dividends, that are owed to the firm. fees: type: number example: 0 description: The total amount of fees, that are due to DriveWealth. other: type: number example: 0 description: The total amount of other payments, that are owed to the firm. transferAmounts: type: object properties: currency: type: string example: USD description: The currency in abbreviation form. payablesToDW: type: number example: 1263.56 description: The total amount due to DriveWealth. receivablesFromDW: type: number example: 0 description: The total amount owed to the partner firm. reconciliationBreakdown: type: string properties: JSON: type: string example: https://d3k101jzh5wilt.cloudfront.net/reconciliation_2e901d48-dd17-42fe-8225-32d2ca6b633e_20190322.json?Policy=eyJTdGF0ddiOiBbeyJSZXNvdXJjZSI6Imh0dHBzOi8vZDNrMTAxanpoNXdpbHQuY2xvdWRmcm9udC5uZXQvcmVjb25jaWxpYXRpb25fMmU5ffdasdamA17ggVl6C40gHkKsr2HLfmjTd9BevcYRPh-QDKA1J~76INZ3nfada4ROS6OUR66A%22 description: A URL that contains the breakdown of all the transactions that are settling in the reconciliation report. partnerID: $ref: '#/components/schemas/parentIBID' created: type: string example: '2024-04-15T22:28:21.810Z' description: The date and time when the reconciliation report was created. updated: type: string example: '2024-04-17T22:28:21.810Z' description: The date and time when the reconciliation report was last updated. updatedBy: $ref: '#/components/schemas/updatedBy' reconciliationStatus: type: string example: APPROVED description: The current status of the reconciliation report. enum: - PENDING - APPROVED - PROCESSING - SUCCESSFUL - FAILED reconciliationID: type: string example: 80f9b672-120d-4b73-9cc9-42fb3262c4b9_20240417 description: The unique identifier of the reconciliation report. RecurringDeposit: type: object properties: id: $ref: '#/components/schemas/recurringID' currency: $ref: '#/components/schemas/currency' amount: type: number example: 1075.25 description: The amount of the recurring deposit. frequency: $ref: '#/components/schemas/recurringFrequency' bankAccountID: $ref: '#/components/schemas/bankAccountID' active: type: boolean example: true description: True, if the recurring deposit is active. nextDeposit: type: string example: '2019-01-15' description: The date of when the next recurring deposit will be triggered. depositHistory: type: array description: A list of all the past deposit processed. items: oneOf: - $ref: '#/components/schemas/DepositHistory' RecurringDepositUpdate: type: object properties: amount: type: number example: 330.25 description: The amount of the recurring deposit will be updated to. frequency: $ref: '#/components/schemas/recurringFrequency' RecurringDepositDeleteResponse: type: object properties: id: $ref: '#/components/schemas/recurringID' currency: $ref: '#/components/schemas/currency' amount: type: number example: 1075.25 description: The amount of the recurring deposit. frequency: $ref: '#/components/schemas/recurringFrequency' bankAccountID: $ref: '#/components/schemas/bankAccountID' active: type: boolean example: false description: True, if the recurring deposit is active. nextDeposit: type: string example: null description: The date of when the next recurring deposit will be triggered. depositHistory: type: array description: A list of all the past deposit processed. items: $ref: '#/components/schemas/DepositHistory' accountID: $ref: '#/components/schemas/accountID' userID: $ref: '#/components/schemas/userID' created: type: string example: '2022-12-11T22:28:21.810Z' description: The date and time the recurring deposit was created for the user's external bank account. updated: type: string example: '2022-12-11T22:28:21.810Z' description: The date and time the recurring deposit was updated for the user's external bank account. createdBy: type: string example: b25f0d36-b4e4-41f8-b3d9-9249e46402cd description: The user identifier whom created the recurring deposit. DepositHistory: type: object properties: depositID: $ref: '#/components/schemas/depositID' currency: $ref: '#/components/schemas/currency' status: $ref: '#/components/schemas/depositStatus' created: $ref: '#/components/schemas/created' description: The date and time the recurring deposit was created for the user's external bank account. updated: $ref: '#/components/schemas/updated' description: The date and time the recurring deposit was updated for the user's external bank account. createdBy: type: string example: b25f0d36-b4e4-41f8-b3d9-9249e46402cd description: The user identifier whom created the recurring deposit. metaAccountInfo: type: string example: Automated DAILY recurring deposit for b25f0d3... |MyBank Premier Checking|****5204 description: A custom message about the processing of the recurring deposit. WithdrawalFromUserAccount: type: object properties: id: $ref: '#/components/schemas/withdrawalID' accountNo: $ref: '#/components/schemas/accountNo' category: type: string example: REDEMPTION description: The category of the withdrawal. currency: $ref: '#/components/schemas/currency' amount: type: number example: -560.36 description: The amount of the withdrawal. 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: type: string example: '2022-12-08T18:36:40.609Z' description: The date and time the when the withdrawal was 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 description: True, if the withdrawal will be batched. account_number: $ref: '#/components/schemas/accountNo' WithdrawalFromUserAccountReq: type: object required: - accountNo - amount - currency - type - details properties: accountNo: $ref: '#/components/schemas/accountNo' amount: type: number example: 125.92 description: The amount of the withdrawal 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: type: boolean example: false description: True, if the account is a managed account and a full liquidation is requested from the user. fees: type: array description: A list of fees associated to the withdrawal. items: oneOf: - $ref: '#/components/schemas/feeObject' 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: $ref: '#/components/schemas/created' description: The date and time the redemption/withdrawal was created. userDetails: $ref: '#/components/schemas/withdrawalUserDetails' accountDetails: $ref: '#/components/schemas/withdrawalAccountDetails' batch: $ref: '#/components/schemas/batch' transactionCode: $ref: '#/components/schemas/transactionCodeObject' statusHistory: type: array description: A list of the status history of the withdrawal. items: oneOf: - $ref: '#/components/schemas/withdrawalStatusHistoryObject' details: $ref: '#/components/schemas/withdrawalDetailsObject' wlpFinTranTypeID: $ref: '#/components/schemas/wlpFinTranTypeID' fees: type: array description: A list of fees associated to the withdrawal. 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: type: number example: 125.92 description: The amount of the withdrawal currency: $ref: '#/components/schemas/currencyObject' status: $ref: '#/components/schemas/redemptionStatusObject' userDetails: $ref: '#/components/schemas/withdrawalUserDetails' accountDetails: $ref: '#/components/schemas/withdrawalAccountDetails' fees: type: array description: A list of fees associated to the withdrawal. items: oneOf: - $ref: '#/components/schemas/feeObject' wlpFinTranTypeID: $ref: '#/components/schemas/wlpFinTranTypeID' transactionCode: $ref: '#/components/schemas/transactionCodeObject' ListAllWithdrawalsForTheFirm: type: array description: A list of all redemptions for the firm. items: oneOf: - $ref: '#/components/schemas/WithdrawalForTheFirm' withdrawalStatus: type: string example: PENDING description: The current status of the user's redemption/withdrawal. enum: - STARTED - PENDING - SUCCESSFUL - FAILED - OTHER - RIA_PENDING - RIA_APPROVED - RIA_REJECTED - APPROVED - REJECTED - '-' withdrawalTypes: type: string example: ACH description: The method/form in which the redemption/withdrawal will be sent back to the user's external account. enum: - ACH - WIRE - CASH_TRANSFER - BULK_FUNDING withdrawalID: type: string example: ZYNN000001-1672169822525-RIUIN description: The unique identifier of the redemption/withdrawal. 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: type: string example: Justin Smith description: The full name of the user at the external bank. beneficiaryAccountNumber: type: string example: '00257596002028990212396' description: The user's external bank account number. beneficiaryAccountType: type: string example: CHECKING description: The user's external bank account type. enum: - CHECKING - SAVINGS beneficiaryRoutingNumber: type: string example: '021000322' description: The user's external bank account routing number. beneficiarySwiftABA: type: string example: BOFAUS3NXXX description: The user's external bank SWIFT code or ABA number. beneficiaryBankName: type: string example: Bank of America description: The user's external bank name. 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: type: string example: CHASUS3AXXX description: The SWIFT code of the intermediary bank that is facilitating the international wire transfer. intermediaryBankName: type: string example: J.P Morgan Chase & Co. description: The full name of the intermediary bank that is facilitating the international wire transfer. iraDistribution: type: string example: PREMATURE description: The type of redemption/withdrawal from an IRA type of account. enum: - PREMATURE - QUALIFIED - RMD deprecated: true iraTaxWithHoldings: type: object properties: federalTaxPercentage: type: number example: 0.1 description: The percentage amount that should be withheld for federal taxes. withdrawalCategories: type: string example: REDEMPTION description: The category of the withdrawal. withdrawalStatusNumber: type: number example: 1 description: The current status of the user's redemption/withdrawal in integer form. 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: $ref: '#/components/schemas/created' description: The date and time the withdrawal move into this step. updatedBy: $ref: '#/components/schemas/updatedBy' comment: type: string example: New redemption request from the back-office description: A custom description that describes the current status of the redemption/withdrawal. CreateDVPRVP: type: object required: - tradeDate properties: tradeDate: type: string format: date example: '2021-06-04' pattern: yyyy-MM-dd description: The date to generate the DVP/RVP report for. note: $ref: '#/components/schemas/note' CreateDVPRVPRes: type: object properties: id: type: string example: bsr_040fb9cc-84e8-4f20-bf09-d398dacd458d.1622745430469_20210604 description: The DVP/RVP report identifier. accountID: $ref: '#/components/schemas/accountID' accountNo: $ref: '#/components/schemas/accountNo' tradeDate: type: string format: date example: '2021-06-04' pattern: yyyy-MM-dd description: The date for which the DVP/RVP was run for. note: $ref: '#/components/schemas/note' partnerID: $ref: '#/components/schemas/partnerID' DVPRVPStatus: type: string example: Processing enum: - Processing - Successful DVPRVP: type: object properties: id: type: string example: bsr_040fb9cc-84e8-4f20-bf09-d398dacd458d.1622745430469_20210604 description: The DVP/RVP report identifier. tradeDate: type: string format: date example: '2021-06-04' pattern: yyyy-MM-dd description: The date for which the DVP/RVP was run for. status: type: string example: SUCCESSFUL description: The status of the generated report. 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: type: string example: MANUAL enum: - MANUAL - SYSTEM description: The method type in which the report was generated. 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: type: number example: 10.71358941 description: The amount of shares that were purchased. notional: type: number example: 144.26 description: The total amount in USD value of the instruments. orders: type: number example: 30 description: The total amount of orders assiocated to the amount of shares purchased. totalSell: type: object properties: quantity: type: number example: 0 description: The amount of shares that were sold. notional: type: number example: 0 description: The total amount in USD value of the instruments. orders: type: number example: 0 description: The total amount of orders assiocated to the amount of shares sold. breakdownJson: type: string format: url description: A json file of the trade breakdown of all the purchases and sale transactions. example: https://du2c4wzqz90h1.cloudfront.net/buySellTradesReport.... SingleSettlementDetails: type: object properties: id: $ref: '#/components/schemas/singleSettlementID' settlementDate: $ref: '#/components/schemas/date' description: The date for which the settlement was generated. partnerID: $ref: '#/components/schemas/parentIBID' status: $ref: '#/components/schemas/singleSettlementStatus' totalAmount: type: number example: -14250 description: The total aggregated sum of all underlying accounts and transactions. createdAt: $ref: '#/components/schemas/created' description: The date and time the settlement was created. updatedAt: $ref: '#/components/schemas/updated' description: The date and time the settlement was last updated. settlementProfileID: $ref: '#/components/schemas/settlementProfileID' SingleSettlementReports: type: object properties: pageSize: type: integer example: 1 description: The amount of results on the page. limit: type: integer example: 50 description: The maximum number of results per page. settlements: type: array items: oneOf: - $ref: '#/components/schemas/SingleSettlementDetails' SingleSettlementByID: type: object properties: id: $ref: '#/components/schemas/singleSettlementID' settlementDate: $ref: '#/components/schemas/date' description: The date the settlement was generated for. status: $ref: '#/components/schemas/singleSettlementStatus' statusComment: type: string example: Finished processing breakdown description: A custom comment about the current status of the settlement. amount: type: object properties: total: type: number example: 5000.45 description: The aggregated sum of all the transactions settling on the settlement date. credits: type: number example: 6000.45 description: The aggregated sum of all the credit transactions settling on the settlement date. debits: type: number example: -1000 description: The aggregated sum of all the debit transactions settling on the settlement date. breakdownReport: type: string format: url example: https://du2c4wzqz90h1.cloudfront.net/singleSettlementReport.... description: A breakdown of all the deposits or withdrawals across sub accounts over the course of the settlement date. partnerID: $ref: '#/components/schemas/partnerID' settlementProfileID: $ref: '#/components/schemas/settlementProfileID' updatedBy: $ref: '#/components/schemas/updatedBy' createdAt: $ref: '#/components/schemas/created' description: The date and time of when the settlement was created. updatedAt: $ref: '#/components/schemas/updated' description: The date and time of when the settlement was last updated. from: type: string format: date pattern: yyyy-MM-dd example: '2022-12-25' description: A filter, the start date. to: type: string format: date pattern: yyyy-MM-dd example: '2022-12-26' description: A filter, the end date. singleSettlementStatus: type: string example: PENDING description: The current status of the settlement. enum: - PENDING - APPROVED - SUCCESSFUL - REJECTED singleSettlementID: type: string example: sett_63ccb073-a7b6-4b33-af77-5baec5cc4494_settle-profile-usa_20221224 description: A unique identifier that identifies the settlement. date: type: string example: '2022-12-25' description: '' UserGeneratedAccountDocument: type: object properties: accountID: $ref: '#/components/schemas/accountID' url: $ref: '#/components/schemas/fileURL' fileKey: type: string example: '2022122502' description: A unique identifier for the specific account document. SubscriptionRequest: type: object required: - accountID - bankAccountID - planID properties: accountID: $ref: '#/components/schemas/accountID' bankAccountID: $ref: '#/components/schemas/bankAccountID' planID: type: string example: plan_1d3e1630-9107-47c2-a9c4-6cca93821cb7 description: The unique identifier that identifies the plan schedule. Subscription: type: object properties: subscriptionID: $ref: '#/components/schemas/subscriptionID' subscriptionID: type: string example: subscription_4451b62e-0e88-46ce-9eab-f0a54ccdc599 description: The unique identifier that identifies the user's subscription. 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: type: string example: true description: True, if this is the default bank account set by the customer. status: $ref: '#/components/schemas/bankAccountStatus' created: $ref: '#/components/schemas/created' description: The date and time the User's bank account was linked. updated: $ref: '#/components/schemas/updated' description: The date and time the User's bank account was updated. UsersReq: required: - userType - documents type: object properties: userType: $ref: '#/components/schemas/userType' wlpID: type: string example: TTCC 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**. deprecated: true parentIBID: type: string example: 95c98ed5-e29e-4d55-90bf-8898fcf6af85 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**. deprecated: true documents: type: array description: The personal identifiable information & digital signatures. 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/KYC_Verification_Info' - $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/Director_Info' - $ref: '#/components/schemas/Institutional_Info' - $ref: '#/components/schemas/Trust_Info' metadata: type: object example: myCustomKey: myCustomValue description: The metadata object allows for creating a maximum of 5 keys (max 36 characters) and each value cannot exceed more than 128 bytes. KYC_Verification_Info: 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: type: string example: Justin Smith description: The name of the customer that was passed during the KYC verification. verificationTimestamp: type: string example: '2022-12-22T16:04:46.724Z' description: The ISO 8601 timestamp of when the KYC verification was completed by the partner. verificationTransactionID: type: string example: '' description: A unique identifier passed to reference the KYC verification was completed by the partner. customField1: example: customFieldValue1 customField2: example: customFieldValue2 customField3: example: customFieldValue3 customField4: example: customFieldValue4 customField5: example: customFieldValue5 Trust_Info: type: object properties: type: type: string example: TRUST_INFO data: type: object properties: name: type: string example: Justin's Trust description: The name of the trust. dateEstablished: type: string example: '2014-09-29' description: The inception date of the trust. stateEstablished: type: string example: NJ description: The state or province where the trust was established. street1: type: string example: 15 Exchange Place description: The physical street address where the institution is located. street2: type: string example: Unit 1100 city: type: string example: NJ description: The institutuion physical city. province: type: string example: New Jersey description: The institutuion physical state or province. postalCode: type: string example: '07302' description: The institutuion physical postal or zip code. primaryTrusteeAuthority: type: string example: TRUSTEE_ONLY description: The permissions the primary trustee has over the trust. enum: - TRUSTEE_ONLY - TRUSTEE_AND_GRANTOR - MODIFY_TRUSTEES - MODIFY_TRUST tin: type: string example: '123456789' description: The tax identification number of the trust. MarginDisclosure: type: object properties: type: type: string example: MARGIN_DISCLOSURE data: type: object properties: marginAgreement: type: boolean example: true description: A User's acceptance of DriveWealth's Margin Agreement. CustodianInfo: type: object properties: type: type: string example: CUSTODIAN_INFO data: type: object properties: userID: $ref: '#/components/schemas/userID' Director_Info: type: object properties: type: type: string example: DIRECTOR_INFO data: type: object properties: directorList: type: array oneOf: - $ref: '#/components/schemas/directors' directors: type: object properties: title: type: string example: Chief Innovation Officer description: The title of the director. controlContact: type: boolean example: true description: True, if the director has control over the account. institutionalID: type: string example: fa1336af-02a3-2a82-d1a8-ccf11ecea398 description: The unique identifier of the institution director should assioacted with.. Institutional_Info: type: object properties: type: type: string example: INSTITUTIONAL_INFO data: type: object properties: physicalAddressLine1: type: string example: 15 Exchange Place description: The physical street address where the institution is located. physicalAddressLine2: type: string example: Unit 1100 physicalCity: type: string example: Jersey City description: The institutuion physical city. physicalStateProvince: type: string example: New Jersey description: The institutuion physical state or province. physicalZipPostalCode: type: string example: '07302' description: The institutuion physical postal or zip code. physicalCountryID: type: string example: USA description: The institutuion physical country of origin. companyOrganizedAs: type: string example: LLC description: The institutuion orginizational structure. enum: - NON_CORP - INC - CLUB - LLC - LLLP - LLP - LP - PARTNERSHIP - SOLE_PROPRIETOR usaBranch: type: boolean example: true description: True, if the institutuion is registered in side of the United States. foreignBank: type: boolean example: false description: True, if the institution is a foreign bank. foreignFinancialInstitution: type: boolean example: false description: True, if the institution is maintained for a foreign finanical institution. directorCount: type: number example: '15' description: The number of directors to be added to institutional account. Basic_Info: type: object required: - type - data properties: type: type: string description: The type of data object. 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: type: string example: USA description: The country where the User is residing. phone: $ref: '#/components/schemas/phoneNumber' emailAddress: $ref: '#/components/schemas/email' language: $ref: '#/components/schemas/language' Identification_Info: type: object required: - type - data properties: type: type: string description: The type of data object. 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: $ref: '#/components/schemas/userCountry' description: The country where the User has citizenship. usTaxPayer: type: boolean example: true description: True, the User is a United States tax payer. Tax_Info: type: object required: - type - data properties: type: type: string description: The type of data object. 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: type: boolean example: true description: True, if the User's country has a tax treaty with the United States. Personal_Info: type: object required: - type - data properties: type: type: string description: The type of data object. 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: type: number example: 3 description: The User's born day. birthMonth: type: number example: 12 description: The User's born month. birthYear: type: number example: 2000 description: The User's born year. politicallyExposedNames: type: string example: Nancy Pelosi description: The names of the people whom are political exposes, separated by a comma. irsBackupWithholdings: type: boolean example: false description: True, if the type of account will be a retirement account. gender: type: string example: Male description: The gender of the User. enum: - Male - Female martial: $ref: '#/components/schemas/userMartialStatus' Address_Info: type: object required: - type - data properties: type: type: string description: The type of data object. 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: type: string example: EMPLOYED description: The User current employment status. enum: - EMPLOYED - RETIRED - STUDENT - UNEMPLOYED - SELF_EMPLOYED company: type: string example: DriveWealth LLC description: |- The User's current employer name. *⚠️ Only required when status equal to EMPLOYED or SELF_EMPLOYED* companyID: type: string example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 description: |- A unique identifier created for each Institution or entity on DriveWealth's platform. *⚠️ Required when 'company' is not provided* from: type: string example: '2014-09-29' description: The User's start date at the employment. to: type: string example: '2022-12-25' description: The User's end date at the employment. type: type: string example: FINANCE description: |- The User's current employer type. *⚠️ Only required when status equal to EMPLOYED or SELF_EMPLOYED* enum: - AGRICULTURE - MINING - UTILITIES - CONSTRUCTION - MANUFACTURING - WHOLESALE - RETAIL - TRANSPORT - INFORMATION - FINANCE - REAL_ESTATE - PROFESSIONAL - MANAGEMENT - EDUCATION - HEALTH - ART - FOOD - PUBLIC - WASTE position: type: string example: ENGINEER description: |2- The User's current role at the employment. *⚠️ Only required when status equal to EMPLOYED or SELF_EMPLOYED* 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: type: boolean example: true description: |- True, if the User's current employer is broker. *⚠️ Only required when status equal to EMPLOYED or SELF_EMPLOYED* directorOf: type: string example: AAPL, SQ description: The company name, ticker of the company; if the user is a director or owns more than 10% of a publicly traded company. 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: type: string example: YRS_10_ description: The User's current investment expertise. enum: - NONE - YRS_1_2 - YRS_3_5 - YRS_5_10 - YRS_10_ annualIncome: type: number example: 1000000 description: The User's current annalized income over one year. networthTotal: type: number example: 2500000 description: The user's current networth. This calculation is the User's assets - liabilities. riskTolerance: type: string example: HIGH description: The User's risk ceiling. enum: - LOW - MODERATE - SPECULATION - HIGH investmentObjectives: type: string example: LONG_TERM description: The User's current investment objectives. enum: - LONG_TERM - INFREQUENT - FREQUENT - ACTIVE_DAILY - NEW networthLiquid: type: number example: 300000 description: The user's liquid net worth. The amount of cash or near cash equivalents of the User's net worth. dependents: type: number example: '4' description: Total number of dependents the account holder has. suitabilityEquities: $ref: '#/components/schemas/investmenetsSuitability' description: An object containing required fields for options approval suitabilityOptions: $ref: '#/components/schemas/investmenetsSuitability' description: An object containing required fields for options approval Disclosures: type: object required: - type - data properties: type: type: string example: DISCLOSURES data: type: object required: - termsOfUse - marketDataAgreement - rule14b - privacyPolicy - dataSharing properties: extendedHoursAgreement: type: boolean example: false description: True, if the User accepts DriveWealth's Extended Hours Agreement. termsOfUse: type: boolean example: true description: True, if the User accepts DriveWealth's Terms of Use. customerAgreement: type: boolean example: true description: True, if the User accepts DriveWealth's Customer Agreement. *⚠ Only for opening regular brokerage accounts.* iraAgreement: type: boolean example: false description: True, if the User accepts DriveWealth's Individual Retirement Account (IRA) Agreement. *⚠ Only for opening IRA accounts.* marginAgreement: type: boolean example: false description: True, if the User accepts DriveWealth's Margin Agreement. *⚠ Only for opening Margin (leveraged) accounts.* cryptoAgreements: type: boolean example: false description: True, if the User accepts DriveWealth's Digital Assets Agreement. marketDataAgreement: type: boolean example: true description: True, if the User accepts DriveWealth's Market Data Agreement. optionsAgreement: type: boolean example: true description: True, if the User accepts DriveWealth's Options trading Agreement. rule14b: type: boolean example: true description: True, if the User accepts DriveWealth's Rule 14b1(c). finderFee: type: boolean example: false description: True, if the User accepts DriveWealth Finder's Fee Disclosure. *⚠ Only required for foreign finder relationships.* privacyPolicy: type: boolean example: true description: True, if the User accepts DriveWealth's Privacy Policy. dataSharing: type: boolean example: true description: True, if the User accepts DriveWealth's Data Sharing Policy. signedBy: type: string example: Justin Smith description: The User's digital signature (full name). Basic_Info_Optional: type: object required: - type - data properties: type: type: string example: BASIC_INFO data: type: object properties: firstName: type: string example: Justin description: The first name of the User. lastName: type: string example: Smith description: The last (family) name of the User. country: type: string example: USA description: The country where the User is residing. phone: type: string example: '18004612680' description: The phone number of the User. emailAddress: type: string example: jj@drivewealth.dev description: The email address of the User. language: type: string example: en_US enum: - en_US - zh_CN - es_ES - pt_BR description: The lanaguage the User read/speaks. Identification_Info_Optional: type: object required: - type - data properties: type: type: string example: IDENTIFICATION_INFO data: type: object properties: value: type: string example: '1223334444' description: The User's national identification number or tax identification number. type: type: string example: SSN description: The type of national identification number. enum: - SSN - EIN - FTIN - FTNLO citizenship: type: string example: USA description: The country where the User has citizenship. usTaxPayer: type: boolean example: true description: True, the User is a United States tax payer. Tax_Info_Optional: type: object required: - type - data properties: type: type: string example: TAX_INFO data: type: object properties: taxTreatyWithUS: type: boolean example: true description: True, if the User's country has a tax treaty with the United States. Personal_Info_Optional: type: object required: - type - data properties: type: type: string example: PERSONAL_INFO data: type: object properties: birthDay: type: number example: 3 description: The User's born day. birthMonth: type: number example: 12 description: The User's born month. birthYear: type: number example: 2000 description: The User's born year. politicallyExposedNames: type: string example: Nancy Pelosi description: The names of the people whom are politicaly exposes, separated by a comma. irsBackupWithholdings: type: boolean example: false description: True, if the type of account will be a retirement account. gender: type: string example: Male description: The gender of the User. enum: - Male - Female martial: type: string example: SINGLE description: The marital status of the User. 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: type: string example: 15 Exchange Place description: The User's current street address, where they live. street2: type: string example: Suite 1000 description: The User's additional details of an address i.e. an apartment number. city: type: string example: Jersey City description: The User's current city, where they live. province: type: string example: NJ description: The User's current state/province/territory, where they live. postalCode: type: string example: 7302 description: The User's current postal code (zip code). country: type: string example: USA description: The User's current country, where they live. Employment_Info_Optional: type: object required: - type - data properties: type: type: string example: EMPLOYMENT_INFO data: type: object properties: status: type: string example: EMPLOYED description: The User's current employment status. enum: - EMPLOYED - RETIRED - STUDENT - UNEMPLOYED - SELF_EMPLOYED company: type: string example: DriveWealth LLC description: |- The User's current employer name. *⚠️ Only required when status equal to EMPLOYED or SELF_EMPLOYED* companyID: type: string example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 description: |- A unique identifier created for each Institution or entity on DriveWealth's platform. *⚠️ Required when 'company' is not provided* from: type: string example: '2014-09-29' description: The User's start date at the employment. to: type: string example: '2022-12-25' description: The User's end date at the employment. type: type: string example: FINANCE description: |- The User's current employer type. *⚠️ Only required when status equal to EMPLOYED or SELF_EMPLOYED* enum: - AGRICULTURE - MINING - UTILITIES - CONSTRUCTION - MANUFACTURING - WHOLESALE - RETAIL - TRANSPORT - INFORMATION - FINANCE - REAL_ESTATE - PROFESSIONAL - MANAGEMENT - EDUCATION - HEALTH - ART - FOOD - PUBLIC - WASTE position: type: string example: ENGINEER description: ' The User''s current role at the employment. *⚠️ Only required when staus equal to EMPLOYED or SELF_EMPLOYED*' 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: type: boolean example: true description: True, if the User's current employer is broker.*⚠️ Only required when staus equal to EMPLOYED or SELF_EMPLOYED* directorOf: type: string example: Apple Inc, AAPL description: The company name, ticker of the company; if the user is a director or owns more than 10% of a publicly traded company. Investor_Profile_Info_Optional: type: object required: - type - data properties: type: type: string example: INVESTOR_PROFILE_INFO data: type: object properties: investmentExperience: type: string example: YRS_10_ description: The User's current investment expertise. enum: - NONE - YRS_1_2 - YRS_3_5 - YRS_5_10 - YRS_10_ annualIncome: type: number example: 1000000 description: The User's current annalized income over one year. networthTotal: type: number example: 2500000 description: The user's current networth. This calculation is the User's assets - liabilities. riskTolerance: type: string example: HIGH description: The User's risk ceiling. enum: - LOW - MODERATE - SPECULATION - HIGH investmentObjectives: type: string example: LONG_TERM description: The User's current investment objectives. enum: - LONG_TERM - INFREQUENT - FREQUENT - ACTIVE_DAILY - NEW networthLiquid: type: number example: 300000 description: The user's liquid net worth. The amount of cash or near cash equivalents of the User's net worth. dependents: type: number example: '4' description: Total number of dependents the account holder has. suitabilityEquities: $ref: '#/components/schemas/investmenetsSuitability' description: An object containing required fields for options approval suitabilityOptions: $ref: '#/components/schemas/investmenetsSuitability' description: An object containing required fields for options approval Disclosures_Optional: type: object required: - type - data properties: type: type: string example: DISCLOSURES data: type: object properties: extendedHoursAgreement: type: boolean example: false description: The User accepts DriveWealth's Extended Hours Agreement. termsOfUse: type: boolean example: true description: The User accepts DriveWealth's Terms of Use. customerAgreement: type: boolean example: true description: |- The User accepts DriveWealth's Customer Agreement. *⚠ Only for opening regular brokerage accounts.* iraAgreement: type: boolean example: false description: |- The User accepts DriveWealth's Individual Retirement Account (IRA) Agreement. *⚠ Only for opening IRA accounts.* marginAgreement: type: boolean example: false description: |- The User accepts DriveWealth's Margin Agreement. *⚠ Only for opening Margin (leveraged) accounts.* cryptoAgreements: type: boolean example: false description: |- The User accepts DriveWealth's Digital Assets Agreement. *⚠ Only for opening Digital Assets accounts.* marketDataAgreement: type: boolean example: true description: The User accepts DriveWealth's Market Data Agreement. optionsAgreement: type: boolean example: true description: True, if the User accepts DriveWealth's Options trading Agreement. rule14b: type: boolean example: true description: The User accepts DriveWealth's Rule 14b1(c). foreignFindersFee: type: boolean example: false finderFee: type: boolean example: false privacyPolicy: type: boolean example: true description: The User accepts DriveWealth's Privacy Policy. dataSharing: type: boolean example: true description: The User accepts DriveWealth's Data Sharing Policy. signedBy: type: string example: Justin Smith description: The User's digital signature (full name). UserResponse: type: object properties: id: $ref: '#/components/schemas/userID' userType: type: object properties: name: $ref: '#/components/schemas/userType' description: type: string example: Individual Trader description: A custom description of the User type. status: type: object properties: name: $ref: '#/components/schemas/userStatus' description: type: string example: User is pending approval. description: A custom description of the User's status. parentIBID: type: object properties: id: $ref: '#/components/schemas/parentIBID' name: $ref: '#/components/schemas/firmName' documents: type: array description: The personal identifiable information & digital signatures. 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: type: string example: 71J000 description: The associated referral program associated to the User. createdWhen: type: string example: '2022-12-11T22:28:21.810Z' description: The createdWhen is the date and time the User was created. updatedWhen: type: string example: '2022-12-11T22:28:21.810Z' description: The updatedWhen is the last date and time the User was updated. UserObject: type: object properties: id: $ref: '#/components/schemas/userID' ackSignedWhen: type: string example: '2022-12-11T22:28:21.666Z' description: The date and time the User signed the digital documents. addressLine1: $ref: '#/components/schemas/userStreet1' addressLine2: $ref: '#/components/schemas/userStreet2' city: $ref: '#/components/schemas/userCity' countryID: $ref: '#/components/schemas/userCountry' displayName: type: string example: JSmith description: The User's display name. *By default this is firstName inital followed by last name.* dob: type: string example: 2000-12-3 description: The User's date of birth in this format YYYY-MM-DD email: $ref: '#/components/schemas/email' firstName: $ref: '#/components/schemas/firstName' gender: type: object properties: name: type: string example: MALE enum: - MALE - FEMALE description: The description of the User's gender. 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: type: string example: 71J000 description: The assiocated referral program assiocated to the User. stateProvince: $ref: '#/components/schemas/userProvince' wlpID: $ref: '#/components/schemas/wlpID' zipPostalCode: type: string example: 7302 description: The User's current postal code (zip code). idNo: $ref: '#/components/schemas/userTaxIDLastFour' status: type: object properties: name: type: string example: PENDING description: The user's current know your User (KYC) status. enum: - PENDING - APPROVED description: type: string example: User is pending approval. description: A custom description of the User's status. userType: type: object properties: name: type: string example: INDIVIDUAL_TRADER description: The name that describes the type of User. enum: - INDIVIDUAL_TRADER - CUSTODIAL description: type: string example: Individual Trader description: A custom description of the User type. usCitizen: type: boolean example: true description: True, if a the User is a United States Citizen updatedWhen: type: string example: '2022-12-11T22:28:21.810Z' description: The updatedWhen is the last date and time the User was updated. brandAmbassador: type: boolean example: false employerBusiness: type: string example: FINANCE description: The User's current employer type. employementStatus: type: object properties: name: type: string example: EMPLOYED description: The User's current employement status. description: type: string example: Employed description: A description of the employement status. citizenship: $ref: '#/components/schemas/userCountry' createdWhen: type: string example: '2022-12-11T22:28:21.810Z' description: The createdWhen is the date and time the User was created. marginDefault: type: number example: 0 maritalStatus: type: object properties: name: $ref: '#/components/schemas/userMartialStatus' description: type: string example: Single description: A description of the martial status of the User. ackCustomerAgreement: type: boolean example: true description: True, if the User accepted DriveWealth's Customer Agreement. ackFixedIncomeAgreement: type: boolean example: false description: True, if the User accepted DriveWealth's Fixed Income Agreement. ackFindersFee: type: boolean example: false description: True, if the User accepted DriveWealth's Finders Fee Agreement. ackForeignFindersFee: type: boolean example: false description: True, if the User accepted DriveWealth's Foreign Finders Fee Agreement. ackJointCustomerAgreement: type: boolean example: true description: True, if the User accepted DriveWealth's Customer Agreement. ackJointFindersFee: type: boolean example: false description: True, if the User has accepted a Joint Finder's Fee Agreement with DriveWealth & the partner. ackJointForeignFindersFee: type: boolean example: false description: True, if the User has accepted a Joint Foreign Finder's Fee Agreement with DriveWealth & the partner. ackJointMarketData: type: boolean example: false description: True, if the User has accepted a Joint Market Data Agreement with DriveWealth & the partner. ackMarketData: type: boolean example: false description: True, if the User has accepted DriveWealth's Market Data Agreement. ackExtendedHoursAgreement: type: boolean example: false description: True, if the User has accepted DriveWealth's Extended Hours Agreement. ackOptionsAgreement: type: boolean example: true description: True, if the User accepts DriveWealth's Options trading Agreement. dependents: type: number example: 0 description: The amount of children or dependents assiocated with the User. termsOfUse: type: boolean example: true description: True, if the User has accepted DriveWealth's Terms of Use Agreement. badPasswordCount: type: boolean example: 0 director: type: boolean example: false description: True, if the User is a director at a public traded company or owns 10% or more of a public company. employerCompany: type: string example: DriveWealth LLC description: The name of the User's employer. employerCompanyID: type: string example: cc07f91b-7ee1-4868-b8fc-823c70a1b932 description: |- A unique identifier created for each Institution or entity on DriveWealth's platform. *⚠️ Required when 'company' is not provided* employerCompanyStartDate: type: string example: '2014-09-29' description: The User's start date at the employment. employerCompanyEndDate: type: string example: '2022-12-25' description: The User's end date at the employment. employerIsBroker: type: boolean example: true description: True, if the User's employer is a brokerage firm. employmentPosition: type: string example: ENGINEER description: The User's current employment job type. employmentYears: type: number example: 0 description: The amount of years the User has been employed with the employer. jointEmployerIsBroker: type: boolean example: false investmentObjectives: type: object properties: name: type: string example: FREQUENT description: The User's current investment objectives. description: type: string example: Frequent trader, depending on the market description: A custom description of the investment objective. investmentExperience: type: object properties: name: type: string example: YRS_10_ description: The User's current investment expertise. description: type: string example: 10+ yrs description: A custom description of investment expertise. politicallyExposed: type: boolean example: false description: True, if the User is politically exposed to another person. riskTolerance: type: string example: HIGH description: The User's risk ceiling. enum: - LOW - MODERATE - SPECULATION - HIGH userNoteQty: type: number example: 0 description: Total number of notes on the user. validTaxForm: type: boolean example: true description: True, if the user has verified/updated tax information. taxTreatyWithUS: type: boolean example: true description: True, if the User's country has a tax treaty with the United States. avatarURL: type: string example: https://secure.gravatar.com/avatar/2076105f6efe7c11e285add95f514b9a.jpg description: The User's avatar. annualIncomeRange: type: string example: $0 - $24,999 description: The User's annual income range, in dollar form. enum: - Unknown - $0 - $24,999 - $25,000 - $49,999 - $50,000 - $99,999 - $100,000 - $199,999 - $200,000 - $499,999 - $500,000 - $999,999 - $1,000,000 - $4,999,999 - $5,000,000 - $9,999,999 - $10,000,000+ ackDisclosureRule14b: type: boolean example: true description: True, if the User has accepted DriveWealth's Rule 14b Agreement. ackJointDisclosureRule14b: type: boolean example: false description: True, if the User has accepted a Joint Rule 14b Agreement with DriveWealth & the parnter. networthLiquidRange: type: string example: $0 - $24,999 description: 'The user''s liquid net worth range. The amount of cash or near cash equivalents of the User''s net worth. ' enum: - Unknown - $0 - $4,999 - $5,000 - $24,999 - $25,000 - $49,999 - $50,000 - $99,999 - $100,000 - $199,999 - $200,000 - $499,999 - $500,000 - $999,999 - $1,000,000 - $4,999,999 - $5,000,000 - $9,999,999 - $10,000,000+ networthTotalRange: type: string example: $0 - $24,999 description: The User's net total net worth range. enum: - Unknown - $0 - $4,999 - $5,000 - $24,999 - $25,000 - $49,999 - $50,000 - $99,999 - $100,000 - $199,999 - $200,000 - $499,999 - $500,000 - $999,999 - $1,000,000 - $4,999,999 - $5,000,000 - $9,999,999 - $10,000,000+ investmentEquitiesExperience: type: string example: LIMITED description: Trading experience level. enum: - LIMITED - NONE - GOOD - EXCELLENT investmentEquitiesYears: type: string example: YRS_10_PLUS description: Number of years equity trading experience. enum: - YRS_1_2 - YRS_3_5 - YRS_6_9 - YRS_10_PLUS investmentEquitiesTradesPerYear: type: string example: YRS_10_14 description: Total number of trades per year. enum: - YRS_0_9 - YRS_10_14 - YRS_15_24 - YRS_25_74 - YRS_75_PLUS investmentEquitiesAverageTradeSize: type: string example: AVG_0_9999 description: 'Average per trade size ' enum: - AVG_0_9999 - AVG_10000_24999 - AVG_5000_PLUS investmentOptionsExperience: type: string example: LIMITED description: Trading experience level. enum: - LIMITED - NONE - GOOD - EXCELLENT investmentOptionsYears: type: string example: YRS_10_PLUS description: Number of years equity trading experience. enum: - YRS_1_2 - YRS_3_5 - YRS_6_9 - YRS_10_PLUS investmentOptionsTradesPerYear: type: string example: YRS_10_14 description: Total number of trades per year. enum: - YRS_0_9 - YRS_10_14 - YRS_15_24 - YRS_25_74 - YRS_75_PLUS investmentOptionsAverageTradeSize: type: string example: AVG_0_9999 description: A unique identifier for the Deposit. enum: - AVG_0_9999 - AVG_10000_24999 - AVG_5000_PLUS FetchUserResponse: type: object properties: user: $ref: '#/components/schemas/UserObject' Documents: type: object properties: documents: type: array description: The personal identifiable information & digital signatures that will be updated. 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: type: string example: '2000-12-03' description: The User's date of birth in this format YYYY-MM-DD accounts: type: array description: A list of all the User's accounts. items: oneOf: - $ref: '#/components/schemas/AccountsRequest' kyc: type: object properties: status: type: object properties: name: type: string example: KYC_INFO_REQUIRED description: The current kyc status of the User. 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 description: type: string example: User's PII not matched. Please revisit user's PII Info. description: A custom description about the User's KYC status. approved: type: object properties: timestamp: type: string example: '2022-12-12T21:13:12.391Z' description: The date and time the User's KYC was approved. approvedBy: type: string example: 0ef9ef36-3720-4b76-a938-dac4501a7f95 description: The identifier of the backoffice user that approved the User's KYC. accepted: type: object properties: acceptedBy: type: string example: SYSTEM PRINCIPAL APPROVER description: The name of the role who approved the User's kyc. timeStamp: type: string example: '2022-12-12T21:13:12.391Z' description: The date and time the role who approved the User's kyc. status: type: object properties: name: type: string example: APPROVED description: The User's current status. enum: - PENDING - APPROVED description: type: string example: User approved. description: A custom description of the User's status. partnerID: type: object properties: id: $ref: '#/components/schemas/parentIBID' name: $ref: '#/components/schemas/firmName' documents: type: array example: [] items: {} description: Please call the user's endpoint to get the User's documents. AccountsRequest: type: object properties: id: type: string example: 8b8ba3fd-74dc-45dc-b2dc-7de683bd713c.1556222995391 description: The User's unqiue account identifier. accountNo: type: string example: DWBG000052 description: The User's unqiue account number, that is human readable. nickname: type: string example: Justin's Self Directed Account accountStatus: type: object properties: name: type: string example: PENDING description: The status of the User's account. description: type: string example: Pending description: A custom description about status of the User's account. accountType: type: string example: LIVE description: The type of account that has been created. accountManagementType: type: string example: SELF description: The type of account who has trading authority. enum: - SELF - ADVISORY - RIA_MANAGED - CUSTODIAL - CUSTODIAL_MANAGED - RESERVED - HSA_SELF - HSA_ADVISORY - HSA_RIA_MANAGED tradingType: type: string example: CASH description: The type of trading ocurring in the account. enum: - CASH - MARGIN - CRYPTO leverage: type: number example: 1 description: The leverage that is applied to the User's account. 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: type: string example: All allocated and accounted for. 1::1::0 client note[empty], . timeMs=667 ratePerSec=1.50 msPerItem=667.00 description: A custom comment generated by DriveWealth. createdWhen: type: string example: '2022-12-22T16:04:46.724Z' description: The date and time of the allocation creation. Allocations: type: array description: A list of a User's sub account allocations. items: oneOf: - $ref: '#/components/schemas/Allocation' OrdersAllocationSummary: type: object properties: id: $ref: '#/components/schemas/allocationID' accountNo: $ref: '#/components/schemas/accountNo' date: type: string example: '2022-12-25' description: The specific date requested in the inbound API request. orders: type: array description: A list of order and allocations. 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: type: string example: '2022-12-11T22:28:21.810Z' description: The createdWhen is the date and time the order was created. 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: type: array description: A list of a User's sub account allocations. 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: 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' description: $ref: '#/components/schemas/fundDescription' holdings: type: array description: A list of instruments to make up the fund. items: oneOf: - $ref: '#/components/schemas/FundByUserID.Holdings' triggers: type: array description: A list of the individual triggers for each instrument. items: oneOf: - $ref: '#/components/schemas/FundByUserID.Triggers' FundsByUserID: type: array description: A list of individual funds holdings. items: oneOf: - $ref: '#/components/schemas/FundByUserID' PortfolioByUserID.Holdings.CashReserve: type: object properties: type: type: string example: CASH_RESERVE description: The type of collection making up the portfolio enum: - CASH_RESERVE - FUND target: type: string example: 0.25 description: The individual targeted weight of the cash portion of the portfolio. 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: id: $ref: '#/components/schemas/portfolioID' name: $ref: '#/components/schemas/portfolioName' description: $ref: '#/components/schemas/portfolioDescription' clientPortfolioID: $ref: '#/components/schemas/clientPortfolioID' holdings: type: array description: A list of all the individual funds making up the portfolio. items: oneOf: - $ref: '#/components/schemas/PortfolioByUserID.Holdings.CashReserve' - $ref: '#/components/schemas/FundByUserID' userID: $ref: '#/components/schemas/userID' triggers: type: array description: A list of the individual triggers for each fund and or cash. items: $ref: '#/components/schemas/PortfolioByUserID.Triggers' PortfoliosByUserID: type: array description: A list of portfolios by userID. items: oneOf: - $ref: '#/components/schemas/PortfolioByUserID' AutoPilotRunByUserID: type: object properties: id: $ref: '#/components/schemas/autoPilotRebalanceID' created: type: string example: '2022-12-11T22:28:21.810Z' description: The date and time that the autopilot re-balance was created. status: $ref: '#/components/schemas/autoPilotStatus' moneyMovement: type: string example: true description: True, if the re-balance was apart of a funding or withdrawal process. regularRebalance: type: string example: false description: True, if the re-balance was apart of the regularly scheduled re-balancing cycle. AutoPilotRunsByUserID: type: array description: A list of autopilot runs by userID. 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: type: string example: '2022-12-11T22:28:21.810Z' description: The date and time the order was created. 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: type: array description: A list of sub account allocations. items: oneOf: - $ref: '#/components/schemas/OrderAllocations' BankAccountsArray: type: array description: A list of all the User's linked bank accounts. items: oneOf: - $ref: '#/components/schemas/BankAccount' beginningOfDay: type: object properties: url: type: string example: '''https://dtygu59lw0as9.cloudfront.net/_bod...' format: url description: The url to the beginning of day json file. userType: type: string example: INDIVIDUAL_TRADER description: The type of user being onboarded. enum: - INDIVIDUAL_TRADER - CUSTODIAL phoneNumber: type: string example: '18004612680' description: The phone number of the user. language: type: string example: en_US enum: - en_US - zh_CN - es_ES - pt_BR description: The language the user read/speaks. userTaxID: type: string example: '1223334444' description: The user's national identification number or tax identification number. userTaxIDType: type: string example: SSN description: The type of national identification number or tax identification number. enum: - SSN - EIN - FTIN - FTNLO - '*' userCountry: type: string example: USA description: The user's country. userMartialStatus: type: string example: SINGLE description: The marital status of the user. enum: - SINGLE - DIVORCED - MARRIED - WIDOWED - PARTNER userStreet1: type: string example: 15 Exchange Place description: The user's current street address, where they live. userStreet2: type: string example: Suite 1000 description: The user's additional details of an address i.e. an apartment number. userCity: type: string example: Jersey City description: The user's current city, where they live. userProvince: type: string example: NJ description: The user's current state/province/territory, where they live. userPostalCode: type: string example: 7302 description: The user's current postal code (zip code), where they live. investmenetsSuitability: type: object properties: experience: type: string example: LIMITED description: Trading experience level. enum: - LIMITED - NONE - GOOD - EXCELLENT years: type: string example: YRS_10_PLUS description: Number of years equity trading experience. enum: - YRS_1_2 - YRS_3_5 - YRS_6_9 - YRS_10_PLUS tradesPerYear: type: string example: YRS_10_14 description: Total number of trades per year. enum: - YRS_0_9 - YRS_10_14 - YRS_15_24 - YRS_25_74 - YRS_75_PLUS averageTradeSize: type: string example: AVG_0_9999 description: Average per trade size. enum: - AVG_0_9999 - AVG_10000_24999 - AVG_5000_PLUS userStatus: type: string example: PENDING description: The user's current status. enum: - PENDING - APPROVED userTaxIDLastFour: type: string example: '****-4444' description: The user's last 4 digits of their national identification number or tax identification number. bankAccountNickName: type: string example: PREFERRED CHECKING description: The linked bank account nickname defined by the user. bankAccountStatus: type: string example: ACTIVE description: The current status of the user's external linked bank account. enum: - ACTIVE - DELETED - DISABLED schemas-Documents: type: object properties: id: $ref: '#/components/schemas/physicalDocumentID' type: type: object properties: name: $ref: '#/components/schemas/physicalDocumentTypes' description: type: string example: Driver License description: A custom description about the classification of the document. status: type: object properties: name: $ref: '#/components/schemas/physicalDocumentStatus' description: type: string example: The document has not been submitted for approval. description: A custom description to describe the status. DocumentsArray: type: array description: An array of uploaded documents items: oneOf: - $ref: '#/components/schemas/schemas-Documents' subscriptionStatus: type: string example: ACTIVE description: The current status of the user's subscription. 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: type: string example: plan_1d3e1630-9107-47c2-a9c4-6cca93821cb7 description: The unique identifier that identifies the plan schedule. name: type: string example: Monthly Subscription description: The name of the global name of the planned subscription. interval: type: string example: MONTH description: The interval in which the user's linked bank account will be charged. enum: - MONTHLY - QUARTERLY intervalCount: type: number example: 1 description: The interval in which the user's linked bank account will be charged represented as an integer value. enum: - 1 - 3 amount: type: number example: 4.99 description: The amount the user's linked bank account will be charged. currency: $ref: '#/components/schemas/currency' created: $ref: '#/components/schemas/created' description: The date and time that the subscription was created for the user's linked bank account. started: type: string example: '2022-12-11T22:28:21.810Z' description: The date and time that the subscription started. expires: type: string example: '2022-12-11T22:28:21.810Z' description: The date and time that the subscription will expire; and stop charging the user's linked bank account. transactionHistory: type: array example: [] description: A list of all this historical subscriptions transactions charged to the user's linked bank account. items: oneOf: - $ref: '#/components/schemas/TransactionRes' UserSubscriptions: type: array description: A list of the user's current subscriptions. items: oneOf: - $ref: '#/components/schemas/UserSubscription' DepositByUserID: type: object properties: id: $ref: '#/components/schemas/recurringID' currency: $ref: '#/components/schemas/currency' amount: type: number example: 1075.25 description: The amount of the recurring deposit. frequency: $ref: '#/components/schemas/recurringFrequency' bankAccountID: $ref: '#/components/schemas/bankAccountID' active: type: boolean example: true description: True, if the recurring deposit is active. nextDeposit: type: string example: '2019-01-15' description: The date of when the next recurring deposit will be triggered. accountID: $ref: '#/components/schemas/accountID' created: type: string example: '2022-12-11T22:28:21.810Z' description: The date and time the recurring deposit was created for the user's external bank account. updated: type: string example: '2022-12-11T22:28:21.810Z' description: The date and time the recurring deposit was updated for the user's external bank account. createdBy: type: string example: b25f0d36-b4e4-41f8-b3d9-9249e46402cd description: The user identifier whom created the recurring deposit. RecurringDepositsByUserID: type: array description: A list of the all the user's recurring deposits. items: oneOf: - $ref: '#/components/schemas/DepositByUserID' DepositsByUserID: type: object properties: id: $ref: '#/components/schemas/depositID' paymentID: $ref: '#/components/schemas/depositID' amount: type: number example: 125.22 description: The amount of the deposit 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: type: array description: A list of deposits items: oneOf: - $ref: '#/components/schemas/DepositsByUserID' allocationID: type: string example: JF.allocation.TendiesTradingCo.e61f512a-ed9c-4047-9ccf-224a5864158d description: The unique identifier that identifies the lot of the allocation. allocationStatus: type: string example: NEW description: The current status of the lot of allocation. enum: - NEW - ACCEPTED - PART_COMPLETE - COMPLETED - REJECTED allocationsRequested: type: number example: 500 description: The amount of sub account allocations passed to the system. minimum: 1 maximum: 10000 allocationsCompleted: type: number example: 25 description: The amount of completed sub account allocations. minimum: 1 maximum: 10000 unallocatedNotional: type: number example: 5320 description: The notional value of the shares that have not been allocated to sub accounts. unallocatedQuantity: type: number example: 302 description: The remaining amount of shares that have not been allocated to the sub accounts. allocatedQuantity: type: number example: 0.7219 description: The amount of allocated shares. allocationUrl: type: string example: /back-office/managed/allocations/JF.TENDIESTRADINGCO_20221225_120000_MOD_AUTO_LIQUIDATE description: A specific URL that contains the full break down of the allocation. OrderAllocations: type: object properties: id: $ref: '#/components/schemas/allocationID' url: $ref: '#/components/schemas/allocationUrl' created: type: string example: '2022-12-22T16:04:46.724Z' description: The date and time of the allocation creation. 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: type: string example: All allocated and accounted for. 1::1::0 client note[empty], . timeMs=667 ratePerSec=1.50 msPerItem=667.00 description: A custom comment generated by DriveWealth. fundDescription: type: string example: This fund is comprised of large cap stocks weight like the S&P 500. description: A user defined description that describes the underlying fund. fundMaxAllowed: type: number example: 0.05 description: The total drift amount for this instrument. fundLowerBound: type: number example: 0.1 fundUpperLowerBound: type: number example: 0.25 triggerTypes: type: string example: TOTAL_DRIFT description: The type of trigger associated to the fund as a whole or an individual instrument. enum: - TOTAL_DRIFT - RELATIVE_DRIFT - ABSOLUTE_DRIFT portfolioName: type: string example: Go Getter Portfolio description: A user defined name that describes the underlying portfolio. portfolioDescription: type: string example: This portfolio is comprised different funds that make up an aggressive portfolio. description: A user defined description that describes the underlying portfolio. portfolioMaxAllowed: type: number example: 0.05 description: The total drift amount for this fund or cash. portfolioLowerBound: type: number example: 0.1 portfolioUpperLowerBound: type: number example: 0.25 autoPilotRebalanceID: type: string example: ria_rebalance_721ff5c3-f6f2-48d8-aaa3-41a49a044f2c description: The unique identifier of the auto pilot re-balance run. autoPilotStatus: type: string example: REBALANCE_NOT_STARTED description: The current status of the re-balance run. 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 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 parameters: fromParams: in: query name: from schema: type: string required: false example: '2022-06-16' description: The date to start the filter. toParams: in: query name: to schema: type: string required: false example: '2022-07-16' description: The date to end the filter.