---
title: "Create User"
method: POST
path: "/sso/user"
---

# Create User

`POST /sso/user`

Create a new individual user for the partner

## Headers

- `api-key` string, required
- `auth-key` string, required

## Request body

- object
  - `firstName` string, required — First name, when displaying in your mobile application please list as Legal Name
  - `middleName` string — Middle Name
  - `lastName` string, required — Last Name
  - `password` string, required — Password
  - `username` string, required — Unique username
  - `phone` string, required — Phone Number
  - `email` string, required — Email Address
  - `gender` string — Gender. Options: MALE/FEMALE/OTHER. Default value is Other
  - `country` string, required — Country which user resides. Follows the ISO 3166-1 alpha-3 standard.
  - `idNo` string, 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
  - `idType` string, required — Type of National Identification Number. Options: “PAN” – Permanent Account Number "SSN" – Social Security Number "TIN" – Tax Identification Number "other"
  - `citizenship` string, required — Country of citizenship. Follows the ISO 3166-1 alpha-3 standard.
  - `usTaxPayer` boolean, required — Customer Tax Country, if true W9 is created, if false W-8BEN is created
  - `dob` string, date, required — Date of birth (YYYY-MM-DD)
  - `politicallyExposedNames` string, 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
  - `address1` string, required — Address
  - `address2` string — Address, continued
  - `city` string, required — City
  - `state` string, required — For U.S., use USPS postal abbreviations, outside of U.S. use the standard province/territory name
  - `postalCode` string, required — Postal code| if not applicable put ‘00000’
  - `employmentStatus` string, required — Employment status. For all values check <a href="https://developer.stockal.com/reference/create-user-fields-type-and-data">Table.</a>
  - `employmentPosition` string — 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
  - `employmentCompany` string — Employer company name. Only required when employmentStatus is "EMPLOYED" or "SELF_EMPLOYED". Default is null
  - `employmentType` string, 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
  - `employmentCountry` string — Follows the ISO 3166-1 alpha-3 standard.
  - `isBroker` boolean, 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
  - `directorOf` string, 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
  - `investmentObjectives` string — Investment objectives. For all values check <a href="https://developer.stockal.com/reference/create-user-fields-type-and-data">Table</a>. Default Value: "FREQUENT"
  - `investmentExperience` string, 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"
  - `annualIncome` integer, required — Approximate annual income. Number must be USD. Default value is 24999
  - `networthLiquid` integer, 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
  - `networthTotal` integer, 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
  - `riskTolerance` string, required — Risk tolerance. For values check <a href="https://developer.stockal.com/reference/create-user-fields-type-and-data">Table</a>. Default Value: "LOW"
  - `termsOfUse` boolean, required — Acceptance of DriveWealth's Terms Of Use
  - `rule14b` boolean, required — Acceptance of Rule 14b1(c).
  - `customerAgreement` boolean, required — USED FOR STANDARD BROKERAGE ACCOUNTS Acceptance of DriveWealth's Customer Agreement.
  - `marketDataAgreement` boolean, required — Acceptance of DriveWealth's Market Data Agreement
  - `privacyPolicy` boolean, required — Acceptance of DriveWealth's Privacy Policy
  - `dataSharing` boolean, required — Acceptance of DriveWealths Data Sharing Policy, includes New Services, Promotional and Marketing Consent
  - `stockalTermsOfUse` boolean, required — Required only if using hybrid app approach. i.e. use both API & Stockal WebApp. For only API use not required
  - `signedBy` string, required — Name of user creating account
  - `partnerCode` string — Optional – Applicable if managing sub partner(RIA’s)
  - `documents` unknown[], required — For Details check the <a href="https://developer.stockal.com/reference/create-user-fields-type-and-data">Page</a>
    - unknown
  - `userReferralCode` string — Referral code
  - `partnerToken` string — Partner Token

## Response `200`

200

## Other responses

- `400` — 400
- `401` — 401

---

[API](https://skmtc.net/stockal/apis/uat-client-api-v2.md) · [All operations](https://skmtc.net/stockal/apis/uat-client-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/stockal/uat-client-api-v2/versions/08e36bbbd3be/schema)