v1

latestOpenAPI 3.1.02026-07-24680631.6 KB

Create User

Create a new individual user for the partner

post/sso/user

Headers

api-keystring required

API Key

auth-keystring required

Auth key generated using API key & secret

Request body

firstNamestring required

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

middleNamestring

Middle Name

lastNamestring required

Last Name

passwordstring required

Password

usernamestring required

Unique username

phonestring required

Phone Number

emailstring required

Email Address

genderstring

Gender. Options: MALE/FEMALE/OTHER. Default value is Other

countrystring required

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

idNostring required

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

idTypestring required

Type of National Identification Number. Options: “PAN” – Permanent Account Number "SSN" – Social Security Number "TIN" – Tax Identification Number "other"

citizenshipstring required

Country of citizenship. Follows the ISO 3166-1 alpha-3 standard.

usTaxPayerboolean required

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

dobstring date required

Date of birth (YYYY-MM-DD)

politicallyExposedNamesstring required

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 required

Address

address2string

Address, continued

citystring required

City

statestring required

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

postalCodestring required

Postal code| if not applicable put ‘00000’

employmentStatusstring required

Employment status. For all values check <a href="https://developer.stockal.com/reference/create-user-fields-type-and-data">Table.</a>

employmentPositionstring

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

employmentCompanystring

Employer company name. Only required when employmentStatus is "EMPLOYED" or "SELF_EMPLOYED". Default is null

employmentTypestring required

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

employmentCountrystring

Follows the ISO 3166-1 alpha-3 standard.

isBrokerboolean required

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

directorOfstring required

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

investmentObjectivesstring

Investment objectives. For all values check <a href="https://developer.stockal.com/reference/create-user-fields-type-and-data">Table</a>. Default Value: "FREQUENT"

investmentExperiencestring required

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"

annualIncomeinteger required

Approximate annual income. Number must be USD. Default value is 24999

networthLiquidinteger required

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

networthTotalinteger required

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

riskTolerancestring required

Risk tolerance. For values check <a href="https://developer.stockal.com/reference/create-user-fields-type-and-data">Table</a>. Default Value: "LOW"

termsOfUseboolean required

Acceptance of DriveWealth's Terms Of Use

rule14bboolean required

Acceptance of Rule 14b1(c).

customerAgreementboolean required

USED FOR STANDARD BROKERAGE ACCOUNTS Acceptance of DriveWealth's Customer Agreement.

marketDataAgreementboolean required

Acceptance of DriveWealth's Market Data Agreement

privacyPolicyboolean required

Acceptance of DriveWealth's Privacy Policy

dataSharingboolean required

Acceptance of DriveWealths Data Sharing Policy, includes New Services, Promotional and Marketing Consent

stockalTermsOfUseboolean required

Required only if using hybrid app approach. i.e. use both API & Stockal WebApp. For only API use not required

signedBystring required

Name of user creating account

partnerCodestring

Optional – Applicable if managing sub partner(RIA’s)

userReferralCodestring

Referral code

partnerTokenstring

Partner Token

Response

200