---
title: "Retrieve User"
method: GET
path: "/users/{userID}"
tags: ["Users"]
---

# Retrieve User

`GET /users/{userID}`

Retrieves a User details by userID.

## Path parameters

- `userID` string, required

## Response `200`

Retrieving a User was Successful.

- UserObject
  - `id` string — A unique identifier created for each User on DriveWealth's platform.
  - `ackSignedWhen` string — The date and time the User signed the digital documents.
  - `addressLine1` string — The user's current street address, where they live.
  - `addressLine2` string — The user's additional details of an address i.e. an apartment number.
  - `city` string — The user's current city, where they live.
  - `countryID` string — The user's country.
  - `displayName` string — The User's display name. *By default this is firstName inital followed by last name.*
  - `dob` string — The User's date of birth in this format YYYY-MM-DD
  - `dateOfDeath` string — The User's date of death in YYYY-MM-DD format.
  - `email` string — The user's email address.
  - `firstName` string — The first name of the user.
  - `lastName` string — The last (family) name of the user.
  - `parentIB` object
    - `id` string — The unique identifier of the firm.
    - `name` string — The firm name.
  - `phone` string — The phone number of the user.
  - `referralCode` string — The assiocated referral program assiocated to the User.
  - `stateProvince` string — The user's current state/province/territory, where they live.
  - `wlpID` string — The wlpID is a deep backoffice ID that identifies each partner from each other.
  - `walletSettlementProfileID` string — The walletSettlementProfileID is a identifier that denotes a user's wallet settlement profile for eligible partners.
  - `zipPostalCode` string — The User's current postal code (zip code).
  - `idNo` string — The user's last 4 digits of their national identification number or tax identification number.
  - `idIssuingCountry` string — The user's country.
  - `idIssuingProvince` string — The user's current state/province/territory, where they live.
  - `idIssueDate` string
  - `idExpiryDate` string
  - `institutionalDirectorInfo` object — A map of institutional director information, where keys are director IDs (strings) and values are director details.
  - `status` object
    - `name` 'PENDING' | 'APPROVED' — The user's current know your User (KYC) status.
    - `description` string — A custom description of the User's status.
  - `userType` object
    - `name` 'INDIVIDUAL_TRADER' | 'CUSTODIAL' — The name that describes the type of User.
    - `description` string — A custom description of the User type.
  - `usCitizen` boolean — True, if a the User is a United States Citizen
  - `updatedWhen` string — The updatedWhen is the last date and time the User was updated.
  - `brandAmbassador` boolean
  - `employerBusiness` string — The User's current employer type.
  - `employmentStatus` object
    - `name` string — The User's current employment status.
    - `description` string — A description of the employment status.
  - `citizenship` string — The user's country.
  - `createdWhen` string — The createdWhen is the date and time the User was created.
  - `marginDefault` number
  - `maritalStatus` object
    - `name` 'SINGLE' | 'DIVORCED' | 'MARRIED' | 'WIDOWED' | 'PARTNER' — The marital status of the user.
    - `description` string — A description of the marital status of the User.
  - `ackCustomerAgreement` boolean — True, if the User accepted DriveWealth's Customer Agreement.
  - `ackFindersFee` boolean — True, if the User accepted DriveWealth's Finders Fee Agreement.
  - `ackForeignFindersFee` boolean — True, if the User accepted DriveWealth's Foreign Finders Fee Agreement.
  - `ackJointCustomerAgreement` boolean — True, if the User accepted DriveWealth's Customer Agreement.
  - `ackJointFindersFee` boolean — True, if the User has accepted a Joint Finder's Fee Agreement with DriveWealth & the partner.
  - `ackJointForeignFindersFee` boolean — True, if the User has accepted a Joint Foreign Finder's Fee Agreement with DriveWealth & the partner.
  - `ackJointMarketData` boolean — True, if the User has accepted a Joint Market Data Agreement with DriveWealth & the partner.
  - `ackMarketData` boolean — True, if the User has accepted DriveWealth's Market Data Agreement.
  - `ackExtendedHoursAgreement` boolean — True, if the User has accepted DriveWealth's Extended Hours Agreement.
  - `ackOptionsAgreement` boolean — True, if the User accepts DriveWealth's Options trading Agreement.
  - `dependents` number — The amount of children or dependents assiocated with the User.
  - `termsOfUse` boolean — True, if the User has accepted DriveWealth's Terms of Use Agreement.
  - `badPasswordCount` boolean
  - `director` boolean — True, if the User is a director at a public traded company or owns 10% or more of a public company.
  - `employerCompany` string — The name of the User's employer.
  - `employerCompanyID` string — A unique identifier created for each Institution or entity on DriveWealth's platform.*
  - `employerCompanyStartDate` string — The User's start date at the employment.
  - `employerCompanyEndDate` string — The User's end date at the employment.
  - `employerIsBroker` boolean — True, if the User's employer is a brokerage firm.
  - `employmentPosition` string — The User's current employment job type.
  - `employmentYears` number — The amount of years the User has been employed with the employer.
  - `jointEmployerIsBroker` boolean
  - `investmentObjectives` object
    - `name` string — The User's current investment objectives.
    - `description` string — A custom description of the investment objective.
  - `investmentExperience` object
    - `name` string — The User's current investment expertise.
    - `description` string — A custom description of investment expertise.
  - `politicallyExposed` boolean — 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.
  - `userNoteQty` number — Total number of notes on the user.
  - `validTaxForm` boolean — True, if the user has verified/updated tax information.
  - `w8received` string — The date W8 is received
  - `w8expires` string — The date W8 expires
  - `validTaxFormWhen` string — The validTaxForm is the date and time the validTaxForm was changed.
  - `taxTreatyWithUS` boolean — True, if the user lives in a treaty country and is claiming tax treaty with the United States.
  - `taxCountry` string — Tax residence country code (ISO 3166-1 alpha-3) on Tax Treaty Benefits with the United States.
  - `taxAttestation` object
    - `signedBy` string — The user ID of the person who signed the attestation.
    - `signedWhen` string — The timestamp when attestation was signed.
  - `avatarURL` string — 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+' — The User's annual income range, in dollar form.
  - `ackDisclosureRule14b` boolean — True, if the User has accepted DriveWealth's Rule 14b Agreement.
  - `ackJointDisclosureRule14b` boolean — 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+' — 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+' — 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.
  - `investmentEquitiesYearsOfExperience` number — Number of years of experience trading equities.
  - `investmentEquitiesTradesPerYearV2` number — Number of equity trades per year.
  - `investmentEquitiesAverageTransactionAmount` number — Average transaction amount of equity trades.
  - `investmentEquitiesTransactionTypes` string[] — Types of equity transactions the user has experience with.
  - `investmentOptionsYearsOfExperience` number — Number of years of experience trading options.
  - `investmentOptionsTradesPerYearV2` number — Number of options trades per year.
  - `investmentOptionsAverageTransactionAmount` number — Average transaction amount of options trades.
  - `investmentOptionsTransactionTypes` string[] — Types of options transactions the user has experience with.
  - `investmentFixedIncomeDeclinedToAnswer` boolean — True, if the user declined to answer questions regarding fixed income trading.
  - `investmentCommodityDeclinedToAnswer` boolean — True, if the user declined to answer questions regarding commodity trading.
  - `investmentOtherFinancialDeclinedToAnswer` boolean — True, if the user declined to answer questions regarding other financial trading.
  - `secondaryInvestmentObjectives` string[] — The User's secondary investment objectives.

---

[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)