v1

latestOpenAPI 3.1.02026-07-24680631.6 KB

Update User

Update user profile

post/customers/{customerId}

Path parameters

customerIdstring required

Customer Id

Headers

api-keystring

API key

auth-keystring

Auth key generated using API key & secret

Request body

firstNamestring

First name, when displaying in your mobile application please list as Legal Name

middleNamestring

Middle Name

lastNamestring

Last Name

phonestring

Phone Number

emailstring

Email Address

genderstring

Gender. Options: MALE/FEMALE/OTHER.

countrystring

Country which user resides. Follows the ISO 3166-1 alpha-3 standard.

usTaxPayerboolean

Customer Tax Country, if true W9 is created, if false W-8BEN is created

dobstring date

Date of birth (YYYY-MM-DD)

politicallyExposedNamesstring

Politically exposed person or public official? Official Question: >“Is the account maintained for a current or former Politically Exposed Person or Public Official (includes U.S. and Foreign)? A politically exposed person is someone who has been entrusted with a prominent public function, or who is closely related to such a person.” If "Yes", display the following text input prompt and send the response: >"Please provide the names of that official and official's immediate family members (including former spouses)." If "No", send null

address1string

Address

address2string

Address, continued

citystring

City

statestring

For U.S., use USPS postal abbreviations, outside of U.S. use the standard province/territory name

postalCodestring

Postal code| if not applicable put ‘00000’

employmentStatusstring

Employment status. For option check the table

employmentPositionstring

Position at employment company. Only required when employmentStatus is "EMPLOYED" or "SELF_EMPLOYED" For option check the list.

employmentCompanystring

Employer company name Only required when employmentStatus is "EMPLOYED" or "SELF_EMPLOYED" For option check the list.

employmentTypestring

Type of employment Only required when employmentStatus is "EMPLOYED" or "SELF_EMPLOYED" For option check the list.

employmentCountrystring

Country of source of funds

isBrokerboolean

Affiliated with a broker dealer (et al)? Official question: >“Are they affiliated with or employed by a stock exchange, member firm of an exchange or FINRA, or a municipal securities brokerdealer?” If true, display: >“If answered Yes, you and DriveWealth are obligated to notify your employer in writing of your intention to open an account.

directorOfstring

Director/officer of public company? Official question: >"Is the account holder(s) a control person of a publicly traded company? A Director, Officer or 10% stock owner? if "Yes", send string and display: >"If yes, please list the company name and its ticker symbol." If "No", send null

investmentObjectivesstring

Investment objectives

investmentExperiencestring

Investment experience

annualIncomeinteger

Approximate annual income. Number must be USD

networthLiquidinteger

Liquid net worth. The amount of cash or near cash equivalents of your net worth that can be easily converted into cash and can easily be reinvested. Examples include money market holdings, exchange listed stocks, exchange-traded funds, mutual funds, etc. Number must be USD

networthTotalinteger

Total net worth. Your assets minus your liabilities. Assets include figures from checking, savings and liquid securities, plus illiquid assets like your home and pension assets. Your liabilities include money owed like mortgage payments, car loans, student loans, taxes, etc. Number must be USD

riskTolerancestring

Risk tolerance

partnerTokenstring

Partner Token

Response

200