v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB
Accounts

Retrieve Account

Retrieves an Account details by accountID.

get/accounts/{accountID}

Path parameters

accountIDstring required

The user's unique account identifier.

Example:cc07f91b-7ee1-4868-b8fc-823c70a1b932.1407775317759

Response

Retrieving Account details was Successful.

Example response

{
  "account": {
    "id": "cc07f91b-7ee1-4868-b8fc-823c70a1b932.1407775317759",
    "accountNo": "DWBG000052",
    "booksAndRecordsAccountID": "BOOK123456",
    "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": "80f9b672-120d-4b73-9cc9-42fb3262c4b9",
      "name": "Tendies Trading Company"
    },
    "taxProfile": {
      "taxStatusCode": "W-9",
      "taxRecipientCode": "INDIVIDUAL"
    },
    "commissionID": "b3e985dd-9679-63dc-5dd5-9bd7982efecd",
    "userID": "cc07f91b-7ee1-4868-b8fc-823c70a1b932",
    "ria": {
      "advisorID": "66304da9-3h6f-2234-935f-ac6b7933d706",
      "productID": "product_b94c0b6a-5ac8-43e4-95d1-777051c0503b"
    },
    "sweepInd": true,
    "accountFeatures": {
      "options": {
        "enrolled": true,
        "optionsLevel": "LEVEL_2",
        "requestedLevel": "LEVEL_2",
        "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": "cc07f91b-7ee1-4868-b8fc-823c70a1b932",
            "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": "+15106001234"
    }
  }
}