API Reference

Create User

post
https://uatclientapi-v2.stockal.com/client/v2/sso/user

Create a new individual user for the partner

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
Defaults to Veronica

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

string
Defaults to H

Middle Name

string
required
Defaults to Mars

Last Name

string
required
Defaults to vero@123

Password

string
required
Defaults to veromars

Unique username

string
required
Defaults to 1234567890

Phone Number

string
required
Defaults to [email protected]

Email Address

string
Defaults to OTHER

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

string
required
Defaults to IND

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

string
required
Defaults to BHD234234NJH

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

string
required
Defaults to PAN

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

string
required
Defaults to IND

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

boolean
required
Defaults to false

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

date
required
Defaults to 2000-03-07

Date of birth (YYYY-MM-DD)

string
required
Defaults to null

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

string
required
Defaults to Apt 201

Address

string
Defaults to 123 Main St

Address, continued

string
required
Defaults to Bengaluru

City

string
required
Defaults to Karnataka

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

string
required
Defaults to 560103

Postal code| if not applicable put ‘00000’

string
required
Defaults to EMPLOYED

Employment status. For all values check Table.

string
Defaults to NULL

Position at employment company. Only required when employmentStatus is "EMPLOYED" or "SELF_EMPLOYED". For all values check Table. Default Null

string
Defaults to NULL

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

string
required
Defaults to PROFESSIONAL

Type of employment Only required when employmentStatus is "EMPLOYED" or "SELF_EMPLOYED" For all values check Table. Default is PROFESSIONAL

string
Defaults to IND

Follows the ISO 3166-1 alpha-3 standard.

boolean
required
Defaults to false

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

string
required
Defaults 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

string
Defaults to FREQUENT

Investment objectives. For all values check Table. Default Value: "FREQUENT"

string
required
Defaults to YRS_3_5

Investment experience. For all values check the Table. Default Value: "YRS_3_5"

int32
required
Defaults to 24999

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

int32
required
Defaults to 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

int32
required
Defaults to 24999

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

string
required
Defaults to Low

Risk tolerance. For values check Table. Default Value: "LOW"

boolean
required
Defaults to true

Acceptance of DriveWealth's Terms Of Use

boolean
required
Defaults to true

Acceptance of Rule 14b1(c).

boolean
required
Defaults to true

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

boolean
required
Defaults to true

Acceptance of DriveWealth's Market Data Agreement

boolean
required
Defaults to true

Acceptance of DriveWealth's Privacy Policy

boolean
required
Defaults to true

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

boolean
required
Defaults to true

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

string
required
Defaults to Veronica Mar

Name of user creating account

string

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

documents
array
required

For Details check the Page

documents*
string

Referral code

string
Defaults to XXXXXXXX

Partner Token

Headers
string
required

API Key

string
required

Auth key generated using API key & secret

Responses

Updated over 3 years ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 3 years ago