Create Account

post

https://bo-api.drivewealth.io/back-office/accounts

Creates a trading Account

Body Params

userID

string

required

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

accountType

string

enum

required

The type of account that has been created.

Allowed:

accountManagementType

string

enum

required

The type of account who has trading authority.

coOwners

array of objects

length between 1 and 1

The userID(s) of the joint account's co-owner(s), in addition to userID. Required for joint account management types; not accepted otherwise. A joint account has exactly two owners: userID plus one co-owner. Every owner must be an existing user of userType INDIVIDUAL_TRADER. The account remains PENDING until every owner is KYC approved. Owners cannot be changed after the account is created.

coOwners

tenancyType

string

enum

The form of joint ownership of the account. Required for joint account management types; not accepted otherwise.

Allowed:

accountHolderType

string

enum

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

string

enum

required

The type of trading the account will participate in.

Allowed:

finra3210ComplianceEntity

string

enum

The regulatory system that the account will be reported to.

Allowed:

riaUserID

string

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

riaProductID

string

RIA product identifier (legacy)

riaPortfolioID

string

A unique ID associated with an RIA managed portfolio. If set, a portfolio will be assigned to this account for automatic rebalancing.

authorizedUsers

array

authorizedUsers

ignoreBuyingPower

boolean

If true, the accounts cash balance can go negative.

violationsExempt

boolean

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

ignoreMarketHoursForTest

boolean

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

boolean

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

classActionsEnrolled

boolean

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.

metadata

object

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

leverage

number

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

accountFeatures

object

accountFundingType

string

enum

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.

Allowed:

interestedParties

array of objects

interestedParties

trustedContact

object

A trusted contact for the account. This information is typically collected for account holders who are seniors or vulnerable adults.

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

200Creating an Account was Successful.