--- title: "Update Account" method: PATCH path: "/accounts/{accountID}" tags: ["Accounts"] --- # Update Account `PATCH /accounts/{accountID}` Updates an Account details by accountID. ## Path parameters - `accountID` string, required — The user's unique account identifier. ## Request body - UpdateAcctReq - `leverage` number — The amount of leverage an account is allowed to trade with. - `nickname` string — 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. - `statusComment` string — A reason for updating the account status, not required when editing other attributes. - `statusChangeReason` 'DUPLICATE_ACCOUNT' | 'DECEASED' | 'PARTNER_RESTRICTED' — Change account status with reason - `restricted` boolean — If true, the account cannot trade on unsettled funds. - `ignoreMarketHoursForTest` boolean — Can the account ignore market hours in the UAT environment? - `accountFeatures` AccountFeatures - `options` AccountFeatureOptions - `enrolled` boolean — User requested option trading be allowed for their account - `optionsLevel` 'LEVEL_2' — The level of options trading the customer requested - `rop` object — Registered Options Principal (ROP) information for the representative who approved the account for options enrollment. Required for US brokers; optional for foreign brokers. - `name` string — The name of the ROP representative - `licenseType` string — The type of license the ROP representative holds - `licenseNo` string — The license number of the ROP representative - `approvedWhen` string, date-time — The UTC timestamp when the account was approved by the ROP for options trading - `mutualFunds` AccountFeatureMutualFunds - `dividendReinvestment` boolean — True, if dividends are reinvested. - `dividendReinvestmentOptInWhen` string — The timestamp when the account has opted for dividend reinvestment. - `dividendReinvestmentOptOutWhen` string — The timestamp when the account has opted out of dividend reinvestment. - `capitalGainsReinvestment` boolean — True, if capital gains are reinvested. - `capitalGainsReinvestmentOptInWhen` string — The timestamp when the account has opted for capital gains reinvestment. - `capitalGainsReinvestmentOptOutWhen` string — The timestamp when the account has opted out of capital gains reinvestment - `fixedIncome` AccountFeatureFixedIncome — Account features related to Fixed Income - `enrolled` boolean — Indicates if this account is enrolled for trading fixed income assets - `equities` AccountFeatureEquities — Account features related to equities - `dividendReinvestment` boolean — True, if equity dividends are reinvested. - `dividendReinvestmentOptInWhen` string — The timestamp when the account has opted for equity dividend reinvestment. - `dividendReinvestmentOptOutWhen` string — The timestamp when the account has opted out of equity dividend reinvestment. - `capitalGainsReinvestment` boolean — True, if equity capital gains are reinvested. - `capitalGainsReinvestmentOptInWhen` string — The timestamp when the account has opted for equity capital gains reinvestment. - `capitalGainsReinvestmentOptOutWhen` string — The timestamp when the account has opted out of equity capital gains reinvestment - `overnightHoursEnrolled` boolean — True, if the account is enrolled for trading during overnight hours. - `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. - `authorizedUsers` AuthorizedUser[] - `userID` string — A unique identifier created for each User on DriveWealth's platform. - `permissions` Permissions[] — Permission assigned to the authorized user. - `finra3210ComplianceEntity` '' | 'COMPLYSCI' | 'MCO' — The regulatory system that the account will be reported to. - `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` InterestedParty[] - `type` 'AUTHORIZED_USER' | 'CUSTODIAN' — The type of interested party. - `data` union[] — The list of interested parties. The shape of each item is determined by the sibling `type` field: when `type` is `AUTHORIZED_USER`, each item follows `interestedPartyAuthorizedUser`; when `type` is `CUSTODIAN`, each item follows `interestedPartyCustodian`. The item itself does not repeat the `type` field. - union - InterestedPartyAuthorizedUser - `id` string, required — A unique identifier created for each User on DriveWealth's platform. - `reportingRole` 'AUTH3RD' | 'AUTHREP' | 'NTHOLDER' | 'TRDHOLDER', required — The role of the interested party of the ID. - `tradeDiscretion` boolean, required — The trade discretion of the interested party of the ID. - `from` string, date-time, required — Time when the interested party role started - `to` string, date-time — Time when the interested party role ended - `endReason` 'CORRECTION' | 'ENDED' | 'INACTIVE' | 'REPLACED' | 'OTHER' | 'TRANSFER' — The reason the interested party role ended. - InterestedPartyCustodian - `id` string, required — A unique identifier created for each User on DriveWealth's platform. - `trustedContact` TrustedContact — A trusted contact for the account. This information is typically collected for account holders who are seniors or vulnerable adults. - `firstName` string — The first name of the trusted contact. - `lastName` string — The last name of the trusted contact. - `email` string — The email address of the trusted contact. - `address` string — The address of the trusted contact. - `phoneNumber` string — The phone number of the trusted contact. - `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. ## Response `200` Updating an Account details by accountID was Successful. - AccountDetailRes - `account` object - `id` string — The user's unique account identifier. - `accountNo` string — The user's unique account number, that is human readable. - `booksAndRecordsAccountID` string — The unique identifier for the account as maintained in the books and records system. - `accountType` object - `name` string — The type of account. - `description` string — A description of the type of account. - `accountMgmtType` AccountManagementTypeObject - `name` 'SELF' | 'ADVISORY' | 'RIA_MANAGED' | 'CUSTODIAL' | 'CUSTODIAL_MANAGED' | 'RESERVED' | 'RETIREMENT_TRADITIONAL_SELF' | 'RETIREMENT_TRADITIONAL_ADVISORY' | 'RETIREMENT_TRADITIONAL_RIA_MANAGED' | 'RETIREMENT_ROTH_SELF' | 'RETIREMENT_ROTH_ADVISORY' | 'RETIREMENT_ROTH_RIA_MANAGED' | 'TRUST_SELF' | 'TRUST_ADVISORY' | 'TRUST_RIA_MANAGED' | 'HSA_SELF' | 'HSA_ADVISORY' | 'HSA_RIA_MANAGED' | 'BUSINESS_SELF' | 'BUSINESS_ADVISORY' | 'BUSINESS_RIA_MANAGED' | 'JOINT_SELF' | 'JOINT_ADVISORY' | 'JOINT_RIA_MANAGED' | 'TRUMP_SELF' — The type of account who has trading authority. - `description` string — A custom description of the account management type. - `accountHolderType` AccountHolderTypeObject - `name` '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. - `description` string — A custom description of the account holder type. - `finra3210ComplianceEntity` '' | 'COMPLYSCI' | 'MCO' — The regulatory system that the account will be reported to. - `status` object - `name` 'PENDING' | 'OPEN' | 'OPEN_NO_NEW_TRADES' | 'FROZEN' | 'CLOSED' — The current status of the user's account. - `description` string — A description of the account status. - `tradingType` object - `name` 'CASH' | 'MARGIN' | 'CRYPTO' — The type of trading ocurring in the account. - `description` string — A custom description about the type of account. - `leverage` number — The amount of leverage an account is allowed to trade with. - `nickname` string — A description or nickname for an account. - `parentIB` ParentIBIDObject - `id` string — The unique identifier of an associated organization. - `name` string — The organization name. - `taxProfile` TaxProfileObject - `taxStatusCode` string — The tax code of the accounts associated user. - `taxRecipientCode` string — The type of tax filing of the accounts associated user. - `commissionID` string — The unique identifier associated with a specific commission related to the account. - `beneficiaries` boolean — True if the account has associated beneficiaries. - `userID` string — A unique identifier created for each User on DriveWealth's platform. - `restricted` boolean — If true, the account cannot trade on unsettled funds. - `gfvRestricted` boolean — True, when the account cannot trade on unsettled funds. - `goodFaithViolations` number — The total number of good faith violations. - `pdtRestricted` boolean — True, when the account is PDT restricted, and can only sell. - `patternDayTrader` boolean — True, when the account is designated as a Pattern Day Trader. - `patternDayTrades` number — The total number of pattern day trades. - `freeTradeBalance` number — The total number of free trades left for the account. - `gfvPdtExempt` boolean — True if the account exempt from trading violations. - `buyingPowerOverride` boolean — True if the account is required to have sufficient buying power to enter a trade. - `bod` Bod — Beginning of day balances in the account. - `moneyMarket` number — Beginning of day money market value. - `equityValue` number — Beginning of day equity value. - `cashAvailableForWithdrawal` number — Total amount of settled funds that can be withdrawn. - `cashAvailableForTrading` number — Total amount of settled funds that can be traded. - `cashBalance` number — The current account cash balance. - `ria` RiaObject - `advisorID` string — This is the parentIBID or userID of the registered investment advisor creating the re-balance run. - `productID` string — The unique identifier associated with an RIA managed product. - `sweepInd` boolean — Are the funds swept into a money market account? - `interestFree` boolean — Is the interest generated from money market deposited back into account? - `accountFeatures` AccountFeaturesResp - `options` AccountFeatureOptionsResp - `enrolled` boolean — Whether the account is enrolled for options trading. This may be different from the value sent in the request if the account is pending approval for options trading or if the account was previously enrolled but has since been unenrolled. - `optionsLevel` 'LEVEL_2' — The level of options trading the customer is approved for. This may be different from the value sent in the request if the account is pending approval for options trading or if the account was previously approved for a different level of options trading. - `requestedLevel` 'LEVEL_2' — The level of options trading the customer requested. This value is only returned if the account is pending approval for options trading and may be used to differentiate between accounts that are pending approval for new options trading and accounts that are pending approval for changes to existing options trading. - `evaluatedAt` string — The timestamp when the account's options trading features were last evaluated for approval. - `rop` object — Registered Options Principal (ROP) information for the representative who approved the account for options enrollment. Required for US brokers; optional for foreign brokers. - `name` string — The name of the ROP representative - `licenseType` string — The type of license the ROP representative holds - `licenseNo` string — The license number of the ROP representative - `approvedWhen` string, date-time — The UTC timestamp when the account was approved by the ROP for options trading - `mutualFunds` AccountFeatureMutualFunds - `dividendReinvestment` boolean — True, if dividends are reinvested. - `dividendReinvestmentOptInWhen` string — The timestamp when the account has opted for dividend reinvestment. - `dividendReinvestmentOptOutWhen` string — The timestamp when the account has opted out of dividend reinvestment. - `capitalGainsReinvestment` boolean — True, if capital gains are reinvested. - `capitalGainsReinvestmentOptInWhen` string — The timestamp when the account has opted for capital gains reinvestment. - `capitalGainsReinvestmentOptOutWhen` string — The timestamp when the account has opted out of capital gains reinvestment - `fixedIncome` AccountFeatureFixedIncome — Account features related to Fixed Income - `enrolled` boolean — Indicates if this account is enrolled for trading fixed income assets - `equities` AccountFeatureEquities — Account features related to equities - `dividendReinvestment` boolean — True, if equity dividends are reinvested. - `dividendReinvestmentOptInWhen` string — The timestamp when the account has opted for equity dividend reinvestment. - `dividendReinvestmentOptOutWhen` string — The timestamp when the account has opted out of equity dividend reinvestment. - `capitalGainsReinvestment` boolean — True, if equity capital gains are reinvested. - `capitalGainsReinvestmentOptInWhen` string — The timestamp when the account has opted for equity capital gains reinvestment. - `capitalGainsReinvestmentOptOutWhen` string — The timestamp when the account has opted out of equity capital gains reinvestment - `overnightHoursEnrolled` boolean — True, if the account is enrolled for trading during overnight hours. - `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. - `statusChangeReason` StatusChangeReasonObject - `name` 'ACAT' | 'ACCOUNT_TRANSFERRED' | 'COMPLIANCE_RESTRICTED' | 'DUPLICATE_ACCOUNT' | 'DECEASED' | 'FINRA_RESTRICTIONS' | 'LEGAL_AML' | 'MARGIN_CALLS' | 'PAYMENT_FAILURE' | 'PARTNER_RESTRICTED' | 'PDT_RESTRICTIONS' — Reason for the account status change - `description` string — A custom description of the status change reason. - `statusUpdatedBy` string — A free string, which can be UUID of Backoffice user or any other system which updated the status. - `statusChangeHistory` StatusChangeHistory - `status` 'PENDING' | 'OPEN' | 'OPEN_NO_NEW_TRADES' | 'FROZEN' | 'CLOSED' — The current status of the user's account. - `statusChangeReason` 'ACAT' | 'ACCOUNT_TRANSFERRED' | 'COMPLIANCE_RESTRICTED' | 'DUPLICATE_ACCOUNT' | 'DECEASED' | 'FINRA_RESTRICTIONS' | 'LEGAL_AML' | 'MARGIN_CALLS' | 'PAYMENT_FAILURE' | 'PARTNER_RESTRICTED' | 'PDT_RESTRICTIONS' — Reason for the account status change - `statusUpdatedBy` string — A free string, which can be UUID of Backoffice user or any other system which updated the status. - `createdWhen` string — A timestamp of when the account was created. - `openedWhen` string — A timestamp of when the account was opened. - `updatedWhen` string — A timestamp of when the account was last updated. - `ignoreMarketHoursForTest` boolean — Can the account ignore market hours in the UAT environment? - `flaggedForACATS` boolean — True if the account is flagged for an Automated Customer Account Transfer (ACATS). - `extendedHoursEnrolled` boolean — Is the account enrolled in extended hours trading? - `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. - `fpslEnrolled` boolean — Indicates whether the account is enrolled in Fully Paid Securities Lending (FPSL) program. - `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` InterestedParty[] - `type` 'AUTHORIZED_USER' | 'CUSTODIAN' — The type of interested party. - `data` union[] — The list of interested parties. The shape of each item is determined by the sibling `type` field: when `type` is `AUTHORIZED_USER`, each item follows `interestedPartyAuthorizedUser`; when `type` is `CUSTODIAN`, each item follows `interestedPartyCustodian`. The item itself does not repeat the `type` field. - union - InterestedPartyAuthorizedUser - `id` string, required — A unique identifier created for each User on DriveWealth's platform. - `reportingRole` 'AUTH3RD' | 'AUTHREP' | 'NTHOLDER' | 'TRDHOLDER', required — The role of the interested party of the ID. - `tradeDiscretion` boolean, required — The trade discretion of the interested party of the ID. - `from` string, date-time, required — Time when the interested party role started - `to` string, date-time — Time when the interested party role ended - `endReason` 'CORRECTION' | 'ENDED' | 'INACTIVE' | 'REPLACED' | 'OTHER' | 'TRANSFER' — The reason the interested party role ended. - InterestedPartyCustodian - `id` string, required — A unique identifier created for each User on DriveWealth's platform. - `trustedContact` TrustedContact — A trusted contact for the account. This information is typically collected for account holders who are seniors or vulnerable adults. - `firstName` string — The first name of the trusted contact. - `lastName` string — The last name of the trusted contact. - `email` string — The email address of the trusted contact. - `address` string — The address of the trusted contact. - `phoneNumber` string — The phone number of the trusted contact. --- [API](https://skmtc.net/drivewealth/apis/authentication-apis.md) · [All operations](https://skmtc.net/drivewealth/apis/authentication-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/drivewealth/authentication-apis/versions/9fced6d0ac41/schema)