Users

Update User

Updates a User details by userID.

patch/users/{userID}

Request

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

Path parameters

userIDstring required

sensitive Unique ID of the User to update.

Request body

walletSettlementProfileIDstring

The ID of the wallet settlement profile

metadataMetadata

sensitive The metadata object allows for creating a maximum of 10 keys (max 36 characters) and each value cannot exceed 512 bytes. Do not put personal or account data in this field.

Example request

{
  "documents": [
    {
      "type": "BASIC_INFO",
      "data": {
        "firstName": "John",
        "lastName": "Smith",
        "country": "USA",
        "phone": "18005550100",
        "emailAddress": "john.doe@example.com"
      }
    }
  ],
  "metadata": {
    "myCustomKey": "myCustomValue"
  }
}

Response

Fetching a User is Successful.

idstring

sensitive A unique identifier created for each User on DriveWealth's platform.

ackSignedWhenstring

The date and time the User signed the digital documents.

addressLine1string

sensitive The user's current street address, where they live.

addressLine2string

sensitive The user's additional details of an address i.e. an apartment number.

citystring

sensitive The user's current city, where they live.

countryIDstring

sensitive The user's country.

displayNamestring

The User's display name. By default this is firstName inital followed by last name.

dobstring

sensitive The User's date of birth in this format YYYY-MM-DD

dateOfDeathstring

sensitive The User's date of death in YYYY-MM-DD format.

emailstring

sensitive The user's email address.

firstNamestring

sensitive The first name of the user.

lastNamestring

sensitive The last (family) name of the user.

phonestring

sensitive The phone number of the user.

referralCodestring

The assiocated referral program assiocated to the User.

stateProvincestring

sensitive The user's current state/province/territory, where they live.

wlpIDstring

The wlpID is a deep backoffice ID that identifies each partner from each other.

walletSettlementProfileIDstring

The walletSettlementProfileID is a identifier that denotes a user's wallet settlement profile for eligible partners.

zipPostalCodestring

sensitive The User's current postal code (zip code).

idNostring

sensitive The user's last 4 digits of their national identification number or tax identification number.

idIssuingCountrystring

sensitive The user's country.

idIssuingProvincestring

sensitive The user's current state/province/territory, where they live.

idIssueDatestring

sensitive The date the identification document was issued.

idExpiryDatestring

sensitive The date the identification document expires.

institutionalDirectorInfoobject

A map of institutional director information, where keys are director IDs (strings) and values are director details.

usCitizenboolean

True, if a the User is a United States Citizen

updatedWhenstring

The updatedWhen is the last date and time the User was updated.

brandAmbassadorboolean

employerBusinessstring

The User's current employer type.

citizenshipstring

sensitive The user's country.

createdWhenstring

The createdWhen is the date and time the User was created.

marginDefaultnumber

ackCustomerAgreementboolean

True, if the User accepted DriveWealth's Customer Agreement.

ackFindersFeeboolean

True, if the User accepted DriveWealth's Finders Fee Agreement.

ackForeignFindersFeeboolean

True, if the User accepted DriveWealth's Foreign Finders Fee Agreement.

ackJointCustomerAgreementboolean

True, if the User accepted DriveWealth's Customer Agreement.

ackJointFindersFeeboolean

True, if the User has accepted a Joint Finder's Fee Agreement with DriveWealth & the partner.

ackJointForeignFindersFeeboolean

True, if the User has accepted a Joint Foreign Finder's Fee Agreement with DriveWealth & the partner.

ackJointMarketDataboolean

True, if the User has accepted a Joint Market Data Agreement with DriveWealth & the partner.

ackMarketDataboolean

True, if the User has accepted DriveWealth's Market Data Agreement.

ackExtendedHoursAgreementboolean

True, if the User has accepted DriveWealth's Extended Hours Agreement.

ackOptionsAgreementboolean

True, if the User accepts DriveWealth's Options trading Agreement.

dependentsnumber

sensitive The amount of children or dependents assiocated with the User.

termsOfUseboolean

True, if the User has accepted DriveWealth's Terms of Use Agreement.

badPasswordCountboolean

directorboolean

sensitive True, if the User is a director at a public traded company or owns 10% or more of a public company.

employerCompanystring

sensitive The name of the User's employer.

employerCompanyIDstring

A unique identifier created for each Institution or entity on DriveWealth's platform.*

employerCompanyStartDatestring

The User's start date at the employment.

employerCompanyEndDatestring

The User's end date at the employment.

employerIsBrokerboolean

True, if the User's employer is a brokerage firm.

employmentPositionstring

sensitive The User's current employment job type.

employmentYearsnumber

The amount of years the User has been employed with the employer.

jointEmployerIsBrokerboolean

politicallyExposedboolean

True, if the User is politically exposed to another person.

*⚠️ Can be set to 'NULL' if not politically exposed

riskTolerance'LOW' | 'MODERATE' | 'SPECULATION' | 'HIGH'

The User's risk ceiling.

userNoteQtynumber

Total number of notes on the user.

validTaxFormboolean

True, if the user has verified/updated tax information.

w8receivedstring

The date W8 is received

w8expiresstring

The date W8 expires

validTaxFormWhenstring

The validTaxForm is the date and time the validTaxForm was changed.

taxTreatyWithUSboolean

True, if the user lives in a treaty country and is claiming tax treaty with the United States.

taxCountrystring

Tax residence country code (ISO 3166-1 alpha-3) on Tax Treaty Benefits with the United States.

avatarURLstring

The User's avatar.

annualIncomeRange'Unknown' | '$0 - $24,999' | '$25,000 - $49,999' | '$50,000 - $99,999' | '$100,000 - $199,999' | '$200,000 - $499,999' | '$500,000 - $999,999' | '$1,000,000 - $4,999,999' | '$5,000,000 - $9,999,999' | '$10,000,000+'

sensitive The User's annual income range, in dollar form.

ackDisclosureRule14bboolean

True, if the User has accepted DriveWealth's Rule 14b Agreement.

ackJointDisclosureRule14bboolean

True, if the User has accepted a Joint Rule 14b Agreement with DriveWealth & the parnter.

networthLiquidRange'Unknown' | '$0 - $4,999' | '$5,000 - $24,999' | '$25,000 - $49,999' | '$50,000 - $99,999' | '$100,000 - $199,999' | '$200,000 - $499,999' | '$500,000 - $999,999' | '$1,000,000 - $4,999,999' | '$5,000,000 - $9,999,999' | '$10,000,000+'

sensitive The user's liquid net worth range. The amount of cash or near cash equivalents of the User's net worth.

networthTotalRange'Unknown' | '$0 - $4,999' | '$5,000 - $24,999' | '$25,000 - $49,999' | '$50,000 - $99,999' | '$100,000 - $199,999' | '$200,000 - $499,999' | '$500,000 - $999,999' | '$1,000,000 - $4,999,999' | '$5,000,000 - $9,999,999' | '$10,000,000+'

sensitive The User's net total net worth range.

investmentEquitiesExperience'LIMITED' | 'NONE' | 'GOOD' | 'EXCELLENT'

Trading experience level.

investmentEquitiesYears'YRS_1_LESS' | 'YRS_1_2' | 'YRS_3_5' | 'YRS_6_9' | 'YRS_10_PLUS'

Number of years equity trading experience.

investmentEquitiesTradesPerYear'YRS_0_9' | 'YRS_10_14' | 'YRS_15_24' | 'YRS_25_74' | 'YRS_75_PLUS'

Total number of trades per year.

investmentEquitiesAverageTradeSize'AVG_0_9999' | 'AVG_10000_24999' | 'AVG_25000_PLUS'

Average per trade size

investmentOptionsExperience'LIMITED' | 'NONE' | 'GOOD' | 'EXCELLENT'

Trading experience level.

investmentOptionsYears'YRS_1_LESS' | 'YRS_1_2' | 'YRS_3_5' | 'YRS_6_9' | 'YRS_10_PLUS'

Number of years equity trading experience.

investmentOptionsTradesPerYear'YRS_0_9' | 'YRS_10_14' | 'YRS_15_24' | 'YRS_25_74' | 'YRS_75_PLUS'

Total number of trades per year.

investmentOptionsAverageTradeSize'AVG_0_9999' | 'AVG_10000_24999' | 'AVG_25000_PLUS'

A unique identifier for the Deposit.

investmentEquitiesKnowledge'LIMITED' | 'NONE' | 'GOOD' | 'EXCELLENT'

Self assessed knowledge level of equity trading.

investmentOptionsKnowledge'LIMITED' | 'NONE' | 'GOOD' | 'EXCELLENT'

Self assessed knowledge level of options trading.

investmentEquitiesYearsOfExperiencenumber

Number of years of experience trading equities.

investmentEquitiesTradesPerYearV2number

Number of equity trades per year.

investmentEquitiesAverageTransactionAmountnumber

Average transaction amount of equity trades.

investmentEquitiesTransactionTypesstring[]

Types of equity transactions the user has experience with.

investmentOptionsYearsOfExperiencenumber

Number of years of experience trading options.

investmentOptionsTradesPerYearV2number

Number of options trades per year.

investmentOptionsAverageTransactionAmountnumber

Average transaction amount of options trades.

investmentOptionsTransactionTypesstring[]

Types of options transactions the user has experience with.

investmentFixedIncomeDeclinedToAnswerboolean

True, if the user declined to answer questions regarding fixed income trading.

investmentCommodityDeclinedToAnswerboolean

True, if the user declined to answer questions regarding commodity trading.

investmentOtherFinancialDeclinedToAnswerboolean

True, if the user declined to answer questions regarding other financial trading.

secondaryInvestmentObjectivesstring[]

The User's secondary investment objectives. Deprecated values: LONG_TERM, INFREQUENT, FREQUENT, ACTIVE_DAILY.

Example response

{
  "id": "123e4567-e89b-12d3-a456-000000000004",
  "ackSignedWhen": "2022-12-11T22:28:21.666Z",
  "addressLine1": "123 Main Street",
  "addressLine2": "Suite 1000",
  "city": "New York",
  "countryID": "USA",
  "displayName": "JDoe",
  "dob": "2000-12-3",
  "dateOfDeath": "2025-12-04",
  "email": "john.doe@example.com",
  "firstName": "John",
  "lastName": "Smith",
  "parentIB": {
    "id": "123e4567-e89b-12d3-a456-000000000005",
    "name": "Tendies Trading Company"
  },
  "phone": "18005550100",
  "referralCode": "71J000",
  "stateProvince": "NY",
  "wlpID": "TTC",
  "walletSettlementProfileID": "bank-profile-1",
  "idNo": "****-4444",
  "idIssuingCountry": "USA",
  "idIssuingProvince": "NY",
  "idIssueDate": "2022-12-25",
  "idExpiryDate": "2022-12-25",
  "institutionalDirectorInfo": {
    "123e4567-e89b-12d3-a456-00000000015f": {
      "title": "Chief Innovation Officer",
      "controlContact": false,
      "institutionalID": "123e4567-e89b-12d3-a456-00000000015f",
      "percentage": 0.5,
      "roles": [
        "TRUSTEE",
        "GRANTOR",
        "BENEFICIARY"
      ]
    }
  },
  "status": {
    "name": "PENDING",
    "description": "User is pending approval."
  },
  "userType": {
    "name": "INDIVIDUAL_TRADER",
    "description": "Individual Trader"
  },
  "usCitizen": true,
  "updatedWhen": "2022-12-11T22:28:21.810Z",
  "employerBusiness": "FINANCE",
  "employmentStatus": {
    "name": "EMPLOYED",
    "description": "Employed"
  },
  "citizenship": "USA",
  "createdWhen": "2022-12-11T22:28:21.810Z",
  "maritalStatus": {
    "name": "SINGLE",
    "description": "Single"
  },
  "ackCustomerAgreement": true,
  "ackJointCustomerAgreement": true,
  "ackOptionsAgreement": true,
  "termsOfUse": true,
  "employerCompany": "DriveWealth LLC",
  "employerCompanyID": "123e4567-e89b-12d3-a456-000000000004",
  "employerCompanyStartDate": "2014-09-29",
  "employerCompanyEndDate": "2022-12-25",
  "employerIsBroker": true,
  "employmentPosition": "ENGINEER",
  "investmentObjectives": {
    "name": "CAPITAL_PRESERVATION",
    "description": "Capital Preservation"
  },
  "investmentExperience": {
    "name": "YRS_10_",
    "description": "10+ yrs"
  },
  "riskTolerance": "HIGH",
  "validTaxForm": true,
  "w8received": "2026-02-06",
  "w8expires": "2029-12-31",
  "validTaxFormWhen": "2022-12-11T22:28:21.810Z",
  "taxTreatyWithUS": true,
  "taxCountry": "AUS",
  "taxAttestation": {
    "signedBy": "123e4567-e89b-12d3-a456-00000000015e",
    "signedWhen": "2022-12-11T22:28:21.810Z"
  },
  "avatarURL": "https://secure.gravatar.com/avatar/00000000000000000000000000000000.jpg",
  "annualIncomeRange": "$0 - $24,999",
  "ackDisclosureRule14b": true,
  "networthLiquidRange": "$0 - $24,999",
  "networthTotalRange": "$0 - $24,999",
  "investmentEquitiesExperience": "LIMITED",
  "investmentEquitiesYears": "YRS_10_PLUS",
  "investmentEquitiesTradesPerYear": "YRS_10_14",
  "investmentEquitiesAverageTradeSize": "AVG_0_9999",
  "investmentOptionsExperience": "LIMITED",
  "investmentOptionsYears": "YRS_10_PLUS",
  "investmentOptionsTradesPerYear": "YRS_10_14",
  "investmentOptionsAverageTradeSize": "AVG_0_9999",
  "investmentEquitiesKnowledge": "LIMITED",
  "investmentOptionsKnowledge": "LIMITED",
  "investmentEquitiesYearsOfExperience": 3,
  "investmentEquitiesTradesPerYearV2": 15,
  "investmentEquitiesAverageTransactionAmount": 5000,
  "investmentEquitiesTransactionTypes": [
    "LONG"
  ],
  "investmentOptionsYearsOfExperience": 2,
  "investmentOptionsTradesPerYearV2": 10,
  "investmentOptionsAverageTransactionAmount": 3000,
  "investmentOptionsTransactionTypes": [
    "LONG"
  ],
  "secondaryInvestmentObjectives": [
    "INCOME"
  ]
}

Changes

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

Update User

Request

Path parameters

Request body

Example request

Response 200OK

Example response

Changes

Response