Web APIFIX API
API Reference
API StatusLogin

Create Account

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

Creates a trading Account

Body Params
string
required

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

string
enum
required

The type of account that has been created.

Show Details
LIVEA live, production trading account.
Allowed:
string
enum
required

The type of account who has trading authority.

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.

Show Details
EEmployee — an employee or associated person of the partner's firm and/or an employee or associated person of the affiliated group companies.
IIndividual — an account that does not meet FINRA Rule 4215(c), or a proprietary trading account.
AInstitutional — an institutional account as defined in FINRA Rule 4512(c).
FForeign — a non-broker-dealer foreign affiliate or non-reporting foreign broker-dealer.
OMarket — see CAT FAQ C5 and CAT FAQ B68.
VFirm — an agency average price account.
POther — proprietary.
XError — an error account of the firm.
string
enum

The type of trading the account will participate in.

Show Details
CASHA cash account; trades settle using available cash only.
MARGINA margin account; trades may be placed using borrowed funds.
Allowed:
string
enum

The regulatory system that the account will be reported to.

Show Details
–Not reported to any compliance monitoring system.
COMPLYSCIReported to ComplySci.
MCOReported to MyComplianceOffice (MCO).
Allowed:
string

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

string

RIA product identifier (legacy)

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
boolean

If true, the accounts cash balance can go negative.

boolean

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

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.

boolean

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

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 10 keys (max 36 characters) and each value cannot exceed 512 bytes.

number

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

accountFeatures
object
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.

Show Details
CASHThe account receives cash deposits and/or maintains a cash balance.
CASHLESSThe account does not maintain a 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.

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 4 months ago

Did this page help you?