Update Account

patch

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

Updates an Account details by accountID.

Path Params

accountID

string

required

The user's unique account identifier.

Body Params

leverage

number

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

nickname

string

A description or nickname for an account.

status

string

enum

The current status of the user's account.

Show Details

PENDING	The account is in a pending state, most likely due to KYC.
OPEN	The account is open and trades may be placed.
OPEN_NO_NEW_TRADES	The account is open, but no new trades may be placed.
FROZEN	The account is frozen; no new trades may be placed.
CLOSED	The account is closed.

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.

Show Details

E	Employee — an employee or associated person of the partner's firm and/or an employee or associated person of the affiliated group companies.
I	Individual — an account that does not meet FINRA Rule 4215(c), or a proprietary trading account.
A	Institutional — an institutional account as defined in FINRA Rule 4512(c).
F	Foreign — a non-broker-dealer foreign affiliate or non-reporting foreign broker-dealer.
O	Market — see CAT FAQ C5 and CAT FAQ B68.
V	Firm — an agency average price account.
P	Other — proprietary.
X	Error — an error account of the firm.

statusComment

string

A reason for updating the account status, not required when editing other attributes.

statusChangeReason

string

enum

Change account status with reason

Show Details

DUPLICATE_ACCOUNT	The account was a duplicate of another account.
DECEASED	The account holder is deceased.
PARTNER_RESTRICTED	The partner has restricted the account.
ACCOUNT_REOPENING	The account is being reopened.

Allowed:

restricted

boolean

If true, the account cannot trade on unsettled funds.

ignoreMarketHoursForTest

boolean

Can the account ignore market hours in the UAT environment?

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.

Show Details

CASH	The account receives cash deposits and/or maintains a cash balance.
CASHLESS	The account does not maintain a cash balance.

Allowed:

authorizedUsers

array

authorizedUsers

finra3210ComplianceEntity

string

enum

The regulatory system that the account will be reported to.

Show Details

–	Not reported to any compliance monitoring system.
COMPLYSCI	Reported to ComplySci.
MCO	Reported to MyComplianceOffice (MCO).

Allowed:

lastActivityDate

string

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.

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.

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.

regTConversionConsent

boolean

Client's confirmed consent to convert an existing LPMA margin account to a Regulation T margin account. Must be true when this request converts the account's accountFeatures.margin.methodology to REG_T; any other edit ignores this field. A false or omitted value is never persisted as a revoked-consent state.

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

200Updating an Account details by accountID was Successful.