DRdrivewealth
Accounts

List User Accounts

Retrieves a list of User Accounts by userID, including joint accounts the user co-owns.

get/users/{userID}/accounts

Request

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

Path parameters

userIDstring required

sensitive Unique ID of the User to fetch their accounts at DriveWealth.

Response

Retrieving a list of User Accounts by userID was Successful.

idstring

The user's unqiue account identifier.

accountNostring

sensitive The user's unqiue account number, that is human readable.

nicknamestring
accountTypestring

The type of account that has been created.

accountManagementType'SELF' | 'ADVISORY' | 'RIA_MANAGED' | 'CUSTODIAL' | 'CUSTODIAL_MANAGED' | 'RESERVE' | 'HSA_SELF' | 'HSA_ADVISORY' | 'HSA_RIA_MANAGED' | 'BUSINESS_SELF' | 'BUSINESS_ADVISORY' | 'BUSINESS_RIA_MANAGED'

The type of account who has trading authority.

leveragenumber

The leverage that is applied to the user's account.

commissionIDstring

The unique identifier for the assiocated commission schedule.

userIDstring

sensitive The user's unique identifier.

restrictedboolean

True, if the user is restricted from trading.

goodFaithViolationsnumber

The amount of times that a user buy a security and sell it before paying for the inital purchase in full with settled funds.

patternDayTradesnumber

The number of times a user buys and sells the same security in the same day over a seven-day period.

freeTradeBalancenumber
gfvPdtExemptboolean
buyingPowerOverrideboolean

True, if buying power check turned off.

cashBalancenumber

The amount of settled cash in the account.

sweepIndboolean

True, if the user's account cash is set to move into a bank sweep or money market account.

interestFreeboolean

True, if the user will not be paid interest on the money in a bank sweep or money market account.

createdWhenstring

The createdWhen is the date and time the user's account was created.

updatedWhenstring

The updatedWhen is the last date and time the user's account was updated.

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.

Example response

[
  {
    "id": "123e4567-e89b-12d3-a456-00000000005c.1234567890143",
    "accountNo": "FFFF000005",
    "nickname": "John's Self Directed Account",
    "status": {
      "name": "PENDING",
      "description": "Pending"
    },
    "accountType": "LIVE",
    "accountManagementType": "SELF",
    "tradingType": {
      "name": "CASH",
      "description": "Cash Account"
    },
    "leverage": 1,
    "commissionID": "123e4567-e89b-12d3-a456-00000000005d",
    "userID": "123e4567-e89b-12d3-a456-000000000004",
    "bod": {
      "moneyMarket": 3028.98,
      "equityValue": 12071.5,
      "cashAvailableForWithdrawal": 3028.98,
      "cashAvailableForTrading": 3028.98,
      "updatedWhen": "2022-12-12T21:13:12.391Z"
    },
    "cashBalance": 3028.98,
    "sweepInd": true,
    "createdWhen": "2022-12-11T22:28:21.810Z",
    "updatedWhen": "2022-12-11T22:28:21.810Z",
    "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"
          }
        ]
      }
    ]
  }
]

Changes

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