Get User

Get specific details about a particular user

Results Explained

🚧

Legacy API Formatting

This API has a different response than other User requests for backwards compatibility. To receive a response that matches the Create User output instead, set the "Accept" header to the value "application/vnd.drivewealth-v1+json".

Attribute

Type

Description

id

string

user identifier number

ackSignedWhen

string

time at which customer signed the application

addressLine1

string

user entered address

addressLine2

string

user entered address

city

string

users city

countryID

string

country identifier

displayName

string

user display name

dob

string

date of birth

email

string

email address

firstName

string

first name

gender

array

gender.name

string

gender name

gender.description

string

description of gender

languageID

string

user language identifier en_US = English

lastName

string

last name

parentIB

array

parentIB.id

string

introducing parent account identifier

parentIB.name

string

name of the parent introducing account

phone

string

phone number

referralCode

string

user specific referral code

stateProvince

string

users state

username

string

customers username

wlpID

string

wlpID tagged to the customer account during on-boarding

zipPostalCode

string

postal / zip code

idNo

string

user identification number (SSN/TIN)

status

array

status.name

string

name of current user status

status.description

string

description of the status name

userType

array

userType.name

string

name of the user type

userType.description

string

description of the user type

usCitizen

boolean

identifies whether the customer is a US citizen

updatedWhen

string

time of last user update

lastLoginWhen

string

the last time the user has logged in

brandAmbassador

boolean

identifies if user is a brand ambassador

employerBusiness

string

user employers business type

employmentStatus

array

employmentStatus.name

string

name of employment status

employmentStatus.description

string

description of employment status name

citizenship

string

identifier of users citizenship

createdWhen

string

date and time of user creation

addressProofReviewWhen

string

date and time of address document review

approvedWhen

string

date and time of user approval

approvedBy

string

userID of the approving user

kycWhen

string

date and time of KYC checks

pictureReviewWhen

string

date and time of picture document review

pictureReviewBy

string

userID of the reviewing user

annualIncomeRange

string

annual income

marginDefault

number

ownershipType

string

type of user

maritalStatus

array

maritalStatus.name

string

name of status

maritalStatus.description

string

description of martial status

ackCustomerAgreement

boolean

ackFindersFee

boolean

ackForeignFindersFee

boolean

ackJointCustomerAgreement

boolean

ackJointFindersFee

boolean

ackJointForeignFindersFee

boolean

ackJointMarketData

boolean

ackMarketData

boolean

termsOfUse

boolean

ackSignedBy

string

users first name and last name

addressProofReviewBy

string

userID of the document reviewer

badPasswordCount

number

total number of failed password attempts

director

boolean

identities if a user is a director of a public company

employerCompany

string

name of users employer

employerCountryID

string

country identifier for user employer

employerIsBroker

boolean

identifies is the users employer is a broker dealer

employmentYears

number

how many years a user has been employed

investmentObjectives

array

investmentObjectives.name

string

name of the investment objective

investmentObjectives.description

string

description of the investment objective name

investmentExperience

array

investmentExperience.name

string

name of the investment experience

investmentExperience.description

string

description of the investment experience name

networthLiquidRange

string

user liquid net worth

networthTotalRange

string

user total net worth

politicallyExposed

boolean

identifies if the user is politically exposed

riskTolerance

string

users risk tolerance

userNoteQty

number

number of notes added to users

ackDisclosureRule14b

boolean

ackJointDisclosureRule14b

boolean

Language
Authentication