v1
latestOpenAPI 3.1.02026-07-24680631.6 KBCreate User
Create a new individual user for the partner
Headers
API Key
Auth key generated using API key & secret
Request body
First name, when displaying in your mobile application please list as Legal Name
Middle Name
Last Name
Password
Unique username
Phone Number
Email Address
Gender. Options: MALE/FEMALE/OTHER. Default value is Other
Country which user resides. Follows the ISO 3166-1 alpha-3 standard.
National Identification Number (e.g.PAN, SSN, National ID etc). If the idType is PAN, PAN Verification will be done. error codes are added below
Type of National Identification Number. Options: “PAN” – Permanent Account Number "SSN" – Social Security Number "TIN" – Tax Identification Number "other"
Country of citizenship. Follows the ISO 3166-1 alpha-3 standard.
Customer Tax Country, if true W9 is created, if false W-8BEN is created
Date of birth (YYYY-MM-DD)
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
Address
Address, continued
City
For U.S., use USPS postal abbreviations, outside of U.S. use the standard province/territory name
Postal code| if not applicable put ‘00000’
Employment status. For all values check <a href="https://developer.stockal.com/reference/create-user-fields-type-and-data">Table.</a>
Position at employment company. Only required when employmentStatus is "EMPLOYED" or "SELF_EMPLOYED". For all values check <a href="https://developer.stockal.com/reference/create-user-fields-type-and-data">Table</a>. Default Null
Employer company name. Only required when employmentStatus is "EMPLOYED" or "SELF_EMPLOYED". Default is null
Type of employment Only required when employmentStatus is "EMPLOYED" or "SELF_EMPLOYED" For all values check <a href="https://developer.stockal.com/reference/create-user-fields-type-and-data">Table</a>. Default is PROFESSIONAL
Follows the ISO 3166-1 alpha-3 standard.
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. Default to Null
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. Default to Null
Investment objectives. For all values check <a href="https://developer.stockal.com/reference/create-user-fields-type-and-data">Table</a>. Default Value: "FREQUENT"
Investment experience. For all values check the <a href="https://developer.stockal.com/reference/create-user-fields-type-and-data">Table</a>. Default Value: "YRS_3_5"
Approximate annual income. Number must be USD. Default value is 24999
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. Default same as annual income
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. Default same as annual income
Risk tolerance. For values check <a href="https://developer.stockal.com/reference/create-user-fields-type-and-data">Table</a>. Default Value: "LOW"
Acceptance of DriveWealth's Terms Of Use
Acceptance of Rule 14b1(c).
USED FOR STANDARD BROKERAGE ACCOUNTS Acceptance of DriveWealth's Customer Agreement.
Acceptance of DriveWealth's Market Data Agreement
Acceptance of DriveWealth's Privacy Policy
Acceptance of DriveWealths Data Sharing Policy, includes New Services, Promotional and Marketing Consent
Required only if using hybrid app approach. i.e. use both API & Stockal WebApp. For only API use not required
Name of user creating account
Optional – Applicable if managing sub partner(RIA’s)
Referral code
Partner Token
Response
200