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.

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.

statusComment

string

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

statusChangeReason

string

enum

Change account status with reason

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

authorizedUsers

array

authorizedUsers

finra3210ComplianceEntity

string

enum

The regulatory system that the account will be reported to.

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.

Response

Language

Credentials

Bearer

JWT

URL

Response

Choose an example:

application/json

200Updating an Account details by accountID was Successful.