Sign in

v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB
Accounts

Create Account

Creates a trading Account

post/accounts

Request body

userIDstring required

A unique identifier created for each User on DriveWealth's platform.

accountType'LIVE' required

The type of account that has been created.

accountManagementType'SELF' | 'ADVISORY' | 'MANAGED' | 'RIA_MANAGED' | 'CUSTODIAL' | 'CUSTODIAL_MANAGED' | 'RESERVED' | 'HSA_SELF' | 'HSA_ADVISORY' | 'HSA_RIA_MANAGED' | 'BUSINESS_SELF' | 'BUSINESS_ADVISORY' | 'BUSINESS_RIA_MANAGED' | 'TRUST_SELF' | 'TRUST_ADVISORY' | 'TRUST_RIA_MANAGED' | 'JOINT_SELF' | 'JOINT_ADVISORY' | 'JOINT_RIA_MANAGED' | 'TRUMP_SELF' required

The type of account who has trading authority.

accountHolderType'E' | 'I' | 'A' | 'F' | 'O' | 'V' | 'P' | 'X'

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.

tradingType'CASH' | 'MARGIN' required

The type of trading the account will participate in.

finra3210ComplianceEntity'' | 'COMPLYSCI' | 'MCO'

The regulatory system that the account will be reported to.

riaUserIDstring

This is the parentIBID or userID of the registered investment advisor creating the re-balance run.

riaProductIDstring

RIA product identifier (legacy)

riaPortfolioIDstring

The unique identifier of a portfolio.

ignoreBuyingPowerboolean

If true, the accounts cash balance can go negative.

violationsExemptboolean

Instruct the GFV/PDT system to not process for this account. Available only in sandbox.

ignoreMarketHoursForTestboolean

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.

extendedHoursEnrolledboolean

true or false if the account is enrolled in and able to access Extended Hours Trading

classActionsEnrolledboolean

Indicates whether the account is enrolled in class actions settlement claim filing service. Set to false if the client explicitly opts out. If omitted or null, the account is treated as enrolled.

metadataobject

The metadata object allows for creating a maximum of 5 keys (max 36 characters) and each value cannot exceed more than 128 bytes.

leveragenumber

The amount of leverage an account is allowed to trade with.

accountFundingType'CASH' | 'CASHLESS'

The method used to provide liquidity to the account. 'CASH' indicates accounts receive cash deposits and/or maintains a cash balance. 'CASHLESS' indicates accounts do not maintain cash balance.

Example request

{
  "userID": "cc07f91b-7ee1-4868-b8fc-823c70a1b932",
  "accountType": "LIVE",
  "accountManagementType": "SELF",
  "accountHolderType": "I",
  "tradingType": "CASH",
  "finra3210ComplianceEntity": "COMPLYSCI",
  "riaUserID": "66304da9-3h6f-2234-935f-ac6b7933d706",
  "riaPortfolioID": "portfolio_87fec25f-c350-4a53-83a0-fc6be0c2989e",
  "authorizedUsers": [
    {
      "userID": "cc07f91b-7ee1-4868-b8fc-823c70a1b932",
      "permissions": [
        "ORDERS_CREATE",
        "MINOR_GRADUATION_TRANSFER"
      ]
    }
  ],
  "ignoreMarketHoursForTest": true,
  "metadata": {
    "myCustomKey": "myCustomValue"
  },
  "leverage": 1,
  "accountFeatures": {
    "options": {
      "enrolled": true,
      "optionsLevel": "LEVEL_2",
      "rop": {
        "name": "Joe Smith",
        "licenseType": "Series 3",
        "licenseNo": "1234567",
        "approvedWhen": "2022-12-11T22:28:21.810Z"
      }
    },
    "mutualFunds": {
      "dividendReinvestment": true,
      "dividendReinvestmentOptInWhen": "2022-12-11T22:28:21.810Z",
      "dividendReinvestmentOptOutWhen": "2022-12-11T22:28:21.810Z",
      "capitalGainsReinvestment": true,
      "capitalGainsReinvestmentOptInWhen": "2022-12-11T22:28:21.810Z",
      "capitalGainsReinvestmentOptOutWhen": "2022-12-11T22:28:21.810Z"
    },
    "fixedIncome": {
      "enrolled": true
    },
    "equities": {
      "dividendReinvestment": true,
      "dividendReinvestmentOptInWhen": "2022-12-11T22:28:21.810Z",
      "dividendReinvestmentOptOutWhen": "2022-12-11T22:28:21.810Z",
      "capitalGainsReinvestment": true,
      "capitalGainsReinvestmentOptInWhen": "2022-12-11T22:28:21.810Z",
      "capitalGainsReinvestmentOptOutWhen": "2022-12-11T22:28:21.810Z",
      "overnightHoursEnrolled": true
    }
  },
  "accountFundingType": "CASH",
  "interestedParties": [
    {
      "data": [
        {
          "id": "cc07f91b-7ee1-4868-b8fc-823c70a1b932",
          "from": "2022-12-25T22:28:21.810Z",
          "to": "2022-12-26T22:28:21.810Z"
        }
      ]
    }
  ],
  "trustedContact": {
    "firstName": "John",
    "lastName": "Smith",
    "email": "hello@example.com",
    "address": "123 Main Street",
    "phoneNumber": "+15106001234"
  }
}

Response

Creating an Account was Successful.

idstring

The user's unique account identifier.

accountNostring

The user's unique account number, that is human readable.

leveragenumber

The amount of leverage an account is allowed to trade with.

nicknamestring

A description or nickname for an account.

commissionIDstring

The unique identifier associated with a specific commission related to the account.

beneficiariesboolean

True if the account has associated beneficiaries.

userIDstring

A unique identifier created for each User on DriveWealth's platform.

restrictedboolean

If true, the account cannot trade on unsettled funds.

goodFaithViolationsnumber

The total number of good faith violations.

patternDayTradesnumber

The total number of pattern day trades.

freeTradeBalancenumber

The total number of free trades left for the account.

gfvPdtExemptboolean

True if the account exempt from trading violations.

buyingPowerOverrideboolean

True if the account is required to have sufficient buying power to enter a trade.

sweepIndboolean

Are the funds swept into a money market account?

interestFreeboolean

Is the interest generated from money market deposited back into account?

openedWhenstring

A timestamp of when the account was opened.

ignoreMarketHoursForTestboolean

Can the account ignore market hours in the UAT environment?

flaggedForACATSboolean

True if the account is flagged for an Automated Customer Account Transfer (ACATS).

fpslEnrolledboolean

Indicates whether the account is enrolled in Fully Paid Securities Lending (FPSL) program.

accountFundingType'CASH' | 'CASHLESS'

The method used to provide liquidity to the account. 'CASH' indicates accounts receive cash deposits and/or maintains a cash balance. 'CASHLESS' indicates accounts do not maintain cash balance.

Example response

{
  "id": "cc07f91b-7ee1-4868-b8fc-823c70a1b932.1407775317759",
  "accountNo": "DWBG000052",
  "accountType": {
    "name": "LIVE",
    "description": "Live Account"
  },
  "accountMgmtType": {
    "name": "SELF",
    "description": "Self Directed Account"
  },
  "accountHolderType": {
    "name": "I",
    "description": "An account that does not meet FINRA Rule 4215(c) or a proprietary trading 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",
  "userID": "cc07f91b-7ee1-4868-b8fc-823c70a1b932",
  "ria": {
    "advisorID": "66304da9-3h6f-2234-935f-ac6b7933d706",
    "productID": "product_b94c0b6a-5ac8-43e4-95d1-777051c0503b"
  },
  "sweepInd": true,
  "openedWhen": "2022-12-22T06:07:41Z",
  "fpslEnrolled": true,
  "accountFeatures": {
    "options": {
      "enrolled": true,
      "optionsLevel": "LEVEL_2",
      "requestedLevel": "LEVEL_2",
      "evaluatedAt": "2022-12-11T22:28:21.810Z",
      "rop": {
        "name": "Joe Smith",
        "licenseType": "Series 3",
        "licenseNo": "1234567",
        "approvedWhen": "2022-12-11T22:28:21.810Z"
      }
    },
    "mutualFunds": {
      "dividendReinvestment": true,
      "dividendReinvestmentOptInWhen": "2022-12-11T22:28:21.810Z",
      "dividendReinvestmentOptOutWhen": "2022-12-11T22:28:21.810Z",
      "capitalGainsReinvestment": true,
      "capitalGainsReinvestmentOptInWhen": "2022-12-11T22:28:21.810Z",
      "capitalGainsReinvestmentOptOutWhen": "2022-12-11T22:28:21.810Z"
    },
    "fixedIncome": {
      "enrolled": true
    },
    "equities": {
      "dividendReinvestment": true,
      "dividendReinvestmentOptInWhen": "2022-12-11T22:28:21.810Z",
      "dividendReinvestmentOptOutWhen": "2022-12-11T22:28:21.810Z",
      "capitalGainsReinvestment": true,
      "capitalGainsReinvestmentOptInWhen": "2022-12-11T22:28:21.810Z",
      "capitalGainsReinvestmentOptOutWhen": "2022-12-11T22:28:21.810Z",
      "overnightHoursEnrolled": true
    }
  },
  "accountFundingType": "CASH",
  "interestedParties": [
    {
      "data": [
        {
          "id": "cc07f91b-7ee1-4868-b8fc-823c70a1b932",
          "from": "2022-12-25T22:28:21.810Z",
          "to": "2022-12-26T22:28:21.810Z"
        }
      ]
    }
  ],
  "trustedContact": {
    "firstName": "John",
    "lastName": "Smith",
    "email": "hello@example.com",
    "address": "123 Main Street",
    "phoneNumber": "+15106001234"
  }
}