Accounts

Update Account

Updates an Account details by accountID.

patch/accounts/{accountID}

Request

Base URL
https://bo-api.drivewealth.io/back-office
URL
https://bo-api.drivewealth.io/back-office/accounts/{accountID}
Auth
HTTP bearer

Path parameters

accountIDstring required

sensitive The user's unique account identifier.

Example:123e4567-e89b-12d3-a456-000000000004.1234567890125

sensitive

Request body

leveragenumber

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

nicknamestring

A description or nickname for an account.

status'PENDING' | 'OPEN' | 'OPEN_NO_NEW_TRADES' | 'FROZEN' | 'CLOSED'

The current status of the user's account.

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.

statusCommentstring

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

statusChangeReason'DUPLICATE_ACCOUNT' | 'DECEASED' | 'PARTNER_RESTRICTED' | 'ACCOUNT_REOPENING'

Change account status with reason

restrictedboolean

If true, the account cannot trade on unsettled funds.

ignoreMarketHoursForTestboolean

Can the account ignore market hours in the UAT environment?

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.

finra3210ComplianceEntity'' | 'COMPLYSCI' | 'MCO'

The regulatory system that the account will be reported to.

lastActivityDatestring

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.

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.

regTConversionConsentboolean

Client's confirmed consent to convert an existing LPMA margin account to a REG_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.

Example request

{
  "leverage": 1,
  "nickname": "Steve's Robo Advisor Managed Account",
  "status": "OPEN",
  "accountHolderType": "I",
  "statusComment": "Closing the Account.",
  "statusChangeReason": "DECEASED",
  "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",
  "authorizedUsers": [
    {
      "userID": "123e4567-e89b-12d3-a456-000000000004",
      "permissions": [
        "ORDERS_CREATE",
        "MINOR_GRADUATION_TRANSFER"
      ]
    }
  ],
  "finra3210ComplianceEntity": "COMPLYSCI",
  "lastActivityDate": "2024-07-23",
  "interestedParties": [
    {
      "data": [
        {
          "id": "123e4567-e89b-12d3-a456-000000000004",
          "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": "+15555550100"
  },
  "regTConversionConsent": true
}

Response

Updating an Account details by accountID was Successful.

Example response

{
  "account": {
    "id": "123e4567-e89b-12d3-a456-000000000004.1234567890125",
    "accountNo": "FFFF000005",
    "booksAndRecordsAccountID": "CCCC000002",
    "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"
    },
    "finra3210ComplianceEntity": "COMPLYSCI",
    "status": {
      "name": "OPEN",
      "description": "Open"
    },
    "tradingType": {
      "name": "CASH",
      "description": "Cash Account"
    },
    "leverage": 1,
    "nickname": "Steve's Robo Advisor Managed Account",
    "parentIB": {
      "id": "123e4567-e89b-12d3-a456-000000000005",
      "name": "Tendies Trading Company"
    },
    "taxProfile": {
      "taxStatusCode": "W-9",
      "taxRecipientCode": "INDIVIDUAL"
    },
    "commissionID": "123e4567-e89b-12d3-a456-000000000017",
    "userID": "123e4567-e89b-12d3-a456-000000000004",
    "ria": {
      "advisorID": "123e4567-e89b-12d3-a456-000000000167",
      "productID": "product_123e4567-e89b-12d3-a456-000000000013"
    },
    "sweepInd": true,
    "accountFeatures": {
      "options": {
        "enrolled": true,
        "optionsLevel": "LEVEL_2",
        "requestedLevel": "LEVEL_2",
        "reason": "Approved",
        "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",
    "statusChangeReason": {
      "name": "PARTNER_RESTRICTED",
      "description": "Partner has restricted the account"
    },
    "statusUpdatedBy": "ACAT_SYSTEM",
    "statusChangeHistory": {
      "status": "OPEN",
      "statusChangeReason": "PARTNER_RESTRICTED",
      "statusUpdatedBy": "ACAT_SYSTEM"
    },
    "createdWhen": "2022-12-22T06:07:41.773Z",
    "openedWhen": "2022-12-22T06:07:41Z",
    "updatedWhen": "2022-12-22T16:04:47.140Z",
    "fpslEnrolled": true,
    "lastActivityDate": "2024-07-23",
    "interestedParties": [
      {
        "data": [
          {
            "id": "123e4567-e89b-12d3-a456-000000000004",
            "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": "+15555550100"
    },
    "regTConversionConsent": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.