{"_id":"5695238fcaa32519009c4114","project":"563cc7119799fb0d00047685","editedParams":true,"editedParams2":true,"parentDoc":null,"user":"563cc6fa8894d20d00014ea3","version":{"_id":"563cc7119799fb0d00047688","__v":18,"project":"563cc7119799fb0d00047685","createdAt":"2015-11-06T15:28:17.683Z","releaseDate":"2015-11-06T15:28:17.683Z","categories":["563cc7129799fb0d00047689","566f37f37ffa002300c3cd5b","56914e9bd47b020d002225ac","5692b19ffe72e00d00e4f0a8","56940bc2d8c04d1700e5adb6","56940bc83e9d080d00f064f0","56951b2dfcb1032d0089df7a","569522aecaa32519009c410c","569523ce562335190016da97","569523fddcaf0d1700cb86bf","56980e4a8560a60d00e2c3c3","569921a41693520d002e1305","5699323b7465970d00650b82","569e6cc4fbee990d0072d927","56a2768a0aefae0d00b7fe66","5862e862b8b7fa23009665b7","592835c7bc8bca0f000cc9ff","596f693df43cca002e690e1c"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Model T","version_clean":"1.0.0","version":"1"},"__v":8,"category":{"_id":"56914e9bd47b020d002225ac","__v":7,"pages":["5691500e3c4f510d00ec9baa","5691543972f2810d007e4cc1","5692a6d74c4d6d0d00f7cb4b","5694070ebcd0a90d0044d2a6","56952386fcb1032d0089df94","5695238fcaa32519009c4114","569923123da4370d009d20c9"],"project":"563cc7119799fb0d00047685","version":"563cc7119799fb0d00047688","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-01-09T18:16:59.760Z","from_sync":false,"order":1,"slug":"rest-api","title":"Accounts"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-12T16:02:23.309Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n\t\"userID\":\"6fa7c497-d3d6-4964-a974-cb18b27a94ee\",\"username\":\"bobbelcher\"\n}","name":""},{"name":"","status":400,"language":"json","code":"{\n    \"code\": 400,\n    \"message\": \"Password must contain at least 1 character and 1 digit.\"\n}"},{"language":"json","status":400,"code":"{\n    \"code\": 400,\n    \"message\": \"Duplicate username [username=bob226]\"\n}"},{"code":"{\n    \"code\": 400,\n    \"message\": \"Invalid value: {INPUT_PARAMETER}\"\n}","language":"json","status":400}]},"settings":"","examples":{"codes":[{"language":"http","code":"POST /v1/signups/live HTTP/1.1\nHost: api.drivewealth.io\nAccept: application/json\nContent-Type: application/json\n\n{\n    \"wlpID\": \"DW\",\n    \"tradingType\": \"c\",\n    \"userID\": \"02e57c7d-d071-4c63-b491-1194a9939ea5\",\n    \"languageID\": \"en_US\",\n    \"usCitizen\": \"true\",\n    \"firstName\": \"Bob\",\n    \"lastName\": \"Belcher\",\n    \"emailAddress1\": \"bob:::at:::belcher.com\",\n    \"username\": \"bobbelcher\",\n    \"addressLine1\": \"123 Main St\",\n    \"addressLine2\": \"Apt 2\",\n    \"city\": \"Wicker\",\n    \"stateProvince\": \"New Jersey\",\n    \"countryID\": \"USA\",\n    \"zipPostalCode\": \"08312\",\n    \"dob\": \"1976-11-18\",\n    \"gender\": \"male\",\n    \"maritalStatus\": \"married\",\n    \"phoneHome\": \"(212) 555-3212\",\n    \"idNo\": \"113-43-1231\",\n    \"citizenship\": \"USA\",\n    \"ownershipType\": \"Individual\",\n    \"employerIsBroker\": \"false\",\n    \"director\": \"false\",\n    \"employmentStatus\": \"Employed / Self-Employed\",\n    \"politicallyExposed\": \"false\",\n    \"employerCompany\": \"Bob's Burgers\",\n    \"employerBusiness\": \"Food and Beverage\",\n    \"employerCountryID\": \"USA\",\n    \"directorOf\": \"\",\n    \"politicallyExposedNames\": \"\",\n    \"investmentObjectives\": \"Income\",\n    \"investmentExperience\": \"Limited\",\n    \"annualIncome\": \"$25,000 - $99,999\",\n    \"networthLiquid\": \"$5,000 - $99,999\",\n    \"networthTotal\": \"$25,000 - $99,999\",\n    \"riskTolerance\": \"Low\",\n    \"ackSigned\": true,\n    \"disclosureAck\": true,\n    \"disclosureRule14b\": true,\n    \"ackCustomerAgreement\": true,\n    \"ackSweep\": true,\n    \"ackMarketData\": true,\n    \"ackSignedBy\": \"Bob Belcher\",\n    \"ackSignedWhen\": \"2015-11-03T18:25:02.622Z\",\n    \"ackFindersFee\": true\n}"},{"language":"curl","code":"curl -X POST -H \"Accept: application/json\" -H \"Content-Type: application/json\" -H \"Cache-Control: no-cache\" -d '{\n    \"wlpID\": \"DW\",\n    \"tradingType\": \"c\",\n    \"userID\": \"02e57c7d-d071-4c63-b491-1194a9939ea5\",\n    \"languageID\": \"en_US\",\n    \"usCitizen\": \"true\",\n    \"firstName\": \"Bob\",\n    \"lastName\": \"Belcher\",\n    \"emailAddress1\": \"bob@belcher.com\",\n    \"username\": \"bobbelcher\",\n    \"addressLine1\": \"123 Main St\",\n    \"addressLine2\": \"Apt 2\",\n    \"city\": \"Wicker\",\n    \"stateProvince\": \"New Jersey\",\n    \"countryID\": \"USA\",\n    \"zipPostalCode\": \"08312\",\n    \"dob\": \"1976-11-18\",\n    \"gender\": \"male\",\n    \"maritalStatus\": \"married\",\n    \"phoneHome\": \"(212) 555-3212\",\n    \"idNo\": \"113-43-1231\",\n    \"citizenship\": \"USA\",\n    \"ownershipType\": \"Individual\",\n    \"employerIsBroker\": \"false\",\n    \"director\": \"false\",\n    \"employmentStatus\": \"Employed / Self-Employed\",\n    \"politicallyExposed\": \"false\",\n    \"employerCompany\": \"Bob's Burgers\",\n    \"employerBusiness\": \"Food and Beverage\",\n    \"employerCountryID\": \"USA\",\n    \"directorOf\": \"\",\n    \"politicallyExposedNames\": \"\",\n    \"investmentObjectives\": \"Income\",\n    \"investmentExperience\": \"Limited\",\n    \"annualIncome\": \"$0 - $99,999\",\n    \"networthLiquid\": \"$0 - $99,999\",\n    \"networthTotal\": \"$0 - $99,999\",\n    \"riskTolerance\": \"Low\",\n    \"ackSigned\": true,\n    \"disclosureAck\": true,\n    \"disclosureRule14b\": true,\n    \"ackCustomerAgreement\": true,\n    \"ackSweep\": true,\n    \"ackMarketData\": true,\n    \"ackSignedBy\": \"Bob Belcher\",\n    \"ackSignedWhen\": \"2015-11-03T18:25:02.622Z\",\n    \"ackFindersFee\": true\n}' 'http://api.drivewealth.io/v1/signups/live'\n\n\n"}]},"method":"post","auth":"required","params":[{"_id":"56996d4a54d7db17000eea4c","ref":"","in":"body","required":true,"desc":"Type of account.","default":"Individual","type":"string","name":"ownershipType"},{"_id":"56996d4a54d7db17000eea4b","ref":"","in":"body","required":true,"desc":"User ID.","default":"02e57c7d-d071-4c63-b491-1194a9939ea5","type":"string","name":"userID"},{"_id":"56996d4a54d7db17000eea4a","ref":"","in":"body","required":true,"desc":"Email address 1.","default":"bob@belchers.com","type":"string","name":"emailAddress1"},{"_id":"56996d4a54d7db17000eea49","ref":"","in":"body","required":false,"desc":"Email address 2.","default":"bob_belcher@gmail.com","type":"string","name":"emailAddress2"},{"_id":"56996d4a54d7db17000eea48","ref":"","in":"body","required":true,"desc":"First name.","default":"Bob","type":"string","name":"firstName"},{"_id":"56996d4a54d7db17000eea47","ref":"","in":"body","required":true,"desc":"Last name.","default":"Belcher","type":"string","name":"lastName"},{"_id":"56996d4a54d7db17000eea46","ref":"","in":"body","required":true,"desc":"Username.<br />**Requirements**: Must be unique.","default":"belcherbob","type":"string","name":"username"},{"_id":"56996d4a54d7db17000eea45","ref":"","in":"body","required":true,"desc":"Password.<br />**Requirements**: At least 8 characters, less than 90 characters, at least 1 digit, at least 1 character.","default":"abcd1234","type":"string","name":"password"},{"_id":"56996d4a54d7db17000eea44","ref":"","in":"body","required":true,"desc":"Gender.","default":"male","type":"string","name":"gender"},{"_id":"56996d4a54d7db17000eea43","ref":"","in":"body","required":false,"desc":"Language.<br />**Options**: `\"en_US\"` (Default), `\"zh_CN\"`, `\"es_ES\"`, `\"pt_BR\"` or `\"ja_JP\"`.","default":"en_US","type":"string","name":"languageID"},{"_id":"56996d4a54d7db17000eea42","ref":"","in":"body","required":true,"desc":"Home phone.","default":"212-555-3125","type":"string","name":"phoneHome"},{"_id":"56996d4a54d7db17000eea41","ref":"","in":"body","required":false,"desc":"Work phone.","default":"212-333-4123","type":"string","name":"phoneWork"},{"_id":"56996d4a54d7db17000eea40","ref":"","in":"body","required":false,"desc":"Mobile phone.","default":"212-111-3312","type":"string","name":"phoneMobile"},{"_id":"56996d4a54d7db17000eea3f","ref":"","in":"body","required":true,"desc":"Address line 1.","default":"123 Main St.","type":"string","name":"addressLine1"},{"_id":"56996d4a54d7db17000eea3e","ref":"","in":"body","required":false,"desc":"Address line 2.","default":"Apt. #2","type":"string","name":"addressLine2"},{"_id":"56996d4a54d7db17000eea3d","ref":"","in":"body","required":true,"desc":"City.","default":"Wicker","type":"string","name":"city"},{"_id":"56996d4a54d7db17000eea3c","ref":"","in":"body","required":true,"desc":"Reference [List All Countries](doc:list-all-countries) for list of active countries.","default":"USA","type":"string","name":"countryID"},{"_id":"56996d4a54d7db17000eea3b","ref":"","in":"body","required":true,"desc":"State / province.","default":"New Jersey","type":"string","name":"stateProvince"},{"_id":"56996d4a54d7db17000eea3a","ref":"","in":"body","required":true,"desc":"WLP ID.<br />**Note**: Default to `\"DW\"`.","default":"DW","type":"string","name":"wlpID"},{"_id":"56996d4a54d7db17000eea39","ref":"","in":"body","required":false,"desc":"Zip / postal code.","default":"08312","type":"string","name":"zipPostalCode"},{"_id":"56996d4a54d7db17000eea38","ref":"","in":"body","required":true,"desc":"Date of birth.<br />**Requirements**: YYYY-MM-DD format required. Must be older than 18 years old.","default":"1976-11-18","type":"string","name":"dob"},{"_id":"56996d4a54d7db17000eea37","ref":"","in":"body","required":false,"desc":"Marital Status.<br />**Options**: `\"Single\"`, `\"Divorced\"`, `\"Married\"` or `\"Widowed\"`.","default":"Married","type":"string","name":"maritalStatus"},{"_id":"56996d4a54d7db17000eea34","ref":"","in":"body","required":true,"desc":"SSN, TaxID, or National ID Number (non-USA)","default":"111-11-1111","type":"string","name":"idNo"},{"_id":"56996d4a54d7db17000eea33","ref":"","in":"body","required":true,"desc":"US citizen or permanent resident.","default":"true","type":"boolean","name":"usCitizen"},{"_id":"56996d4a54d7db17000eea32","ref":"","in":"body","required":true,"desc":"Referral code of investor who **referred** this new investor.","default":"ABC123","type":"string","name":"referralCode"},{"_id":"56996d4a54d7db17000eea31","ref":"","in":"body","required":true,"desc":"Trading type.<br />**Options**: `C` for cash (default) and `M` for margin.","default":"c","type":"string","name":"tradingType"},{"_id":"56996d4a54d7db17000eea30","ref":"","in":"body","required":true,"desc":"Country Citizenship, uses 3 character country code.<br />Follows the [ISO 3166-1 format](https://en.wikipedia.org/wiki/ISO_3166-1).","default":"USA","type":"string","name":"citizenship"},{"_id":"56996d4a54d7db17000eea2f","ref":"","in":"body","required":false,"desc":"The individual campaign name, slogan, promo code, etc.","default":"FacebookNewsFeed","type":"string","name":"utm_campaign"},{"_id":"56996d4a54d7db17000eea2e","ref":"","in":"body","required":false,"desc":"Used to differentiate similar content, or links within the same ad.","default":"BannerAdv2b","type":"string","name":"utm_content"},{"_id":"56996d4a54d7db17000eea2d","ref":"","in":"body","required":false,"desc":"The advertising or marketing medium.","default":"Email","type":"string","name":"utm_medium"},{"_id":"56996d4a54d7db17000eea2c","ref":"","in":"body","required":false,"desc":"Identify the advertiser, site, publication, etc.","default":"Facebook","type":"string","name":"utm_source"},{"_id":"56996d4a54d7db17000eea2b","ref":"","in":"body","required":false,"desc":"Identify paid search keywords.","default":"Investing+Account","type":"string","name":"utm_term"},{"_id":"56996d4a54d7db17000eea2a","ref":"","in":"body","required":true,"desc":"Employer's type of business.<br />**Options**: `Automobiles - Components`, `Capital Goods`, `Construction`, `Energy`, `Financial Services`, `Food and Beverage`, `Government`, `Hotels Restaurants - Leisure`, `Household - Personal Products`, `Health Care Equipment - Services`, `Materials`, `Media`, `Pharmaceuticals - Biotechnology`, `Professional Services`, `Real Estate`, `Retail Shops and Services`, `Software - Services`, `Technology Hardware - Equipment`, `Telecommunication Services`, `Transportation`, `Utilities`, `Other`.","default":"Food and Beverage","type":"string","name":"employerBusiness"},{"_id":"56996d4a54d7db17000eea29","ref":"","in":"body","required":true,"desc":"Employer's company name.","default":"Bob's Burgers","type":"string","name":"employerCompany"},{"_id":"56996d4a54d7db17000eea28","ref":"","in":"body","required":true,"desc":"Employer's address line 1.","default":"321 Main St.","type":"string","name":"employerAddressLine1"},{"_id":"56996d4a54d7db17000eea27","ref":"","in":"body","required":true,"desc":"Employer's address line 2.","default":"Suite 201","type":"string","name":"employerAddressLine2"},{"_id":"56996d4a54d7db17000eea26","ref":"","in":"body","required":true,"desc":"Employer's city.","default":"Wicker","type":"string","name":"employerCity"},{"_id":"56996d4a54d7db17000eea25","ref":"","in":"body","required":true,"desc":"Employer's state / province.","default":"New Jersey","type":"string","name":"employerStateProvince"},{"_id":"56996d4a54d7db17000eea24","ref":"","in":"body","required":true,"desc":"Employer's zip / postal code.","default":"08312","type":"string","name":"employerZipPostalCode"},{"_id":"56996d4a54d7db17000eea23","ref":"","in":"body","required":true,"desc":"Employer's country, using 3 character country code.<br />Follows the [ISO 3166-1 format](https://en.wikipedia.org/wiki/ISO_3166-1).","default":"USA","type":"string","name":"employerCountryID"},{"_id":"56996d4a54d7db17000eea22","ref":"","in":"body","required":true,"desc":"Is user affiliated with stock exchange, FINRA or broker dealer?<br />**Official question**: Are they affiliated with or employed by a stock exchange, member firm of an exchange or FINRA, or a municipal securities broker-dealer?<br />If answers \"Yes\", display this: \"If answered Yes, you and DriveWealth are obligated to notify your employer in writing of your intention to open an account.\"","default":"true","type":"boolean","name":"employerIsBroker"},{"_id":"56996d4a54d7db17000eea21","ref":"","in":"body","required":true,"desc":"Occupation.","default":"Chef","type":"string","name":"employmentPosition"},{"_id":"56996d4a54d7db17000eea20","ref":"","in":"body","required":true,"desc":"Employment status.<br />**Options**: `\"Employed / Self-Employed\"`, `\"Retired\"`, `\"Student\"` or `\"Not Employed\"`.","default":"Employed / Self Employed","type":"string","name":"employmentStatus"},{"_id":"56996d4a54d7db17000eea1f","ref":"","in":"body","required":true,"desc":"Years of employment.","default":"4","type":"int","name":"employmentYears"},{"_id":"56996d4a54d7db17000eea1e","ref":"","in":"body","required":true,"desc":"Annual income.<br />**Options**: `\"$0 - $24,999\"`,  `\"$25,000 - $99,999\"`,  `\"$100,000 - $199,999\"` or `\"$200,000+\"`","default":"$0 - $24,999","type":"string","name":"annualIncome"},{"_id":"56996d4a54d7db17000eea1d","ref":"","in":"body","required":true,"desc":"Investment objectives.<br />**Options**: `\"Capital Preservation\"`, `\"Growth\"`, `\"Income\"` or `\"Speculation\"`.","default":"Growth","type":"string","name":"investmentObjectives"},{"_id":"56996d4a54d7db17000eea1c","ref":"","in":"body","required":true,"desc":"Investment experience.<br />**Options**: `\"None\"`, `\"Limited\"`, `\"Good\"` or `\"Extensive\"`.","default":"None","type":"string","name":"investmentExperience"},{"_id":"56996d4a54d7db17000eea1b","ref":"","in":"body","required":true,"desc":"Liquid net worth.<br />**Options**: `\"$0 - $4,999\"`, `\"$5,000 - $99,999\"`, `\"$100,000 - $199,999\"` or `\"$200,000+\"`","default":"$0 - $4,999","type":"string","name":"networthLiquid"},{"_id":"56996d4a54d7db17000eea1a","ref":"","in":"body","required":true,"desc":"Total net worth.<br />**Options**: `\"$0 - $24,999\"`,  `\"$25,000 - $99,999\"`,  `\"$100,000 - $199,999\"` or `\"$200,000+\"`","default":"$0 - $24,999","type":"string","name":"networthTotal"},{"_id":"56996d4a54d7db17000eea19","ref":"","in":"body","required":true,"desc":"Director/officer of public company?<br />**Official question**: Is the account holder(s) a control person of a publicly traded company? A Director, Officer or 10% stock owner?","default":"true","type":"boolean","name":"director"},{"_id":"56996d4a54d7db17000eea18","ref":"","in":"body","required":true,"desc":"If answers \"Yes\" (or true) to `director` then ask:<br />**Official question**: If yes, please list the company name and its ticker symbol.","default":"Google, GOOG","type":"string","name":"directorOf"},{"_id":"56996d4a54d7db17000eea17","ref":"","in":"body","required":true,"desc":"Politically exposed person or public official?<br />**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.","default":"true","type":"boolean","name":"politicallyExposed"},{"_id":"56996d4a54d7db17000eea16","ref":"","in":"body","required":true,"desc":"If answers \"Yes\" (or true) to `politicallyExposed` then ask:<br />**Official question**: If yes, please provide the names of that official and official's immediate family members (including former spouses).","default":"Janet Yellen","type":"string","name":"politicallyExposedNames"},{"_id":"56996d4a54d7db17000eea15","ref":"","in":"body","required":true,"desc":"Risk tolerance.<br />**Options**: `\"Conservative\"`, `\"Moderate\"` or `\"Aggressive\"`.","default":"Moderate","type":"string","name":"riskTolerance"},{"_id":"56996d4a54d7db17000eea14","ref":"","in":"body","required":true,"desc":"All disclosures and acknowledgements.","default":"true","type":"boolean","name":"disclosureAck"},{"_id":"56996d4a54d7db17000eea13","ref":"","in":"body","required":true,"desc":"Disclosure Rule 14b-1(c).<br />**Official text**: Rule 14b-1(c) of the Securities Exchange Act, unless you object, requires us to disclose to an issuer, upon its request, the names, addresses, and securities positions of our customers who are beneficial owners of the issuer's securities held by us in nominee name. The issuer would be permitted to use your name and other related information for corporation communication only.","default":"true","type":"boolean","name":"disclosureRule14b"},{"_id":"56996d4a54d7db17000eea12","ref":"","in":"body","required":true,"desc":"Acknowledges DriveWealth's Customer Account Agreement.<br />**Official links**: [English](http://drivewealth.com/customer-account-agreement), [Chinese](https://drivewealth.com/customer-account-agreement/?lang=cn_ZH), [Spanish](https://drivewealth.com/customer-account-agreement/?lang=es_ES) and [Portuguese](https://drivewealth.com/customer-account-agreement/?lang=pt_BR).","default":"true","type":"boolean","name":"ackCustomerAgreement"},{"_id":"56996d4a54d7db17000eea11","ref":"","in":"body","required":true,"desc":"","default":"true","type":"boolean","name":"ackSweep"},{"_id":"56996d4a54d7db17000eea10","ref":"","in":"body","required":false,"desc":"Acknowledgement of finders fee.<br />**Note**: Only required if user is a U.S. Citizen and was referred to DriveWealth.","default":"true","type":"boolean","name":"ackFindersFee"},{"_id":"56996d4a54d7db17000eea0f","ref":"","in":"body","required":false,"desc":"Acknowledgements of foreign finders fee.<br />**Note**: Only required if user is NOT a U.S. Citizen and was referred to DriveWealth.","default":"false","type":"boolean","name":"ackForeignFindersFee"},{"_id":"56996d4a54d7db17000eea0e","ref":"","in":"body","required":true,"desc":"Acknowledgements of market data agreement.<br />**Official text**: By checking the box below I acknowledge that I have read the market data agreements below from the represented exchanges, and I hereby certify that I qualify as a non-professional pursuant to the definitions described herein.<br />**Official link**: [English only](https://drivewealth.com/bats-subscriber-agreement).","default":"true","type":"boolean","name":"ackMarketData"},{"_id":"56996d4a54d7db17000eea0d","ref":"","in":"body","required":true,"desc":"Digital signature.<br />**Note**: User must type in their full name.","default":"Bob Belcher","type":"string","name":"ackSignedBy"},{"_id":"57d714c046dcc30e007dd222","ref":"","in":"body","required":false,"desc":"Timestamp of acceptance of Margin Agreement (only for margin accounts). See https://drivewealth.com/customer-account-agreement-margin<br />**Note**: Use UTC timestamp.","default":"2015-11-03T18:25:02.622Z","type":"string","name":"ackMarginAgreementWhen"},{"_id":"56996d4a54d7db17000eea0c","ref":"","in":"body","required":true,"desc":"Timestamp of application submittal.<br />**Note**: Use UTC timestamp.","default":"2015-11-03T18:25:02.622Z","type":"string","name":"ackSignedWhen"},{"_id":"56e6daf53899d934007b262f","ref":"","in":"body","required":false,"desc":"Sets Account Management Type:<br /> • `0` - Self-Directed (Default)<br /> • `1` - Managed","default":"0","type":"int","name":"accountMgmtType"}],"url":"/signups/live"},"isReference":true,"order":3,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Creating A Username\",\n  \"body\": \"Before sending listed params, the user must have a valid `username` and `userID`. To create a username, see the [Create User](doc:create-user) Method.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Employer Information\",\n  \"body\": \"Employer and employment information fields are only required if `employmentStatus` = `\\\"Employed / Self-Employed\\\"`, otherwise they may be left `blank`.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request - Joint Account\"\n}\n[/block]\nThe parameters below are in conjunction with the parameters above when the user wants to open a joint account.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Argument\",\n    \"h-1\": \"Example\",\n    \"h-2\": \"Description\",\n    \"h-3\": \"Required\",\n    \"0-3\": \"**Yes**\",\n    \"1-3\": \"**Yes**\",\n    \"2-3\": \"**Yes**\",\n    \"4-3\": \"**Yes**\",\n    \"5-3\": \"**Yes**\",\n    \"6-3\": \"**Yes**\",\n    \"7-3\": \"**Yes**\",\n    \"3-3\": \"**No**\",\n    \"8-3\": \"**No**\",\n    \"9-3\": \"**No**\",\n    \"10-3\": \"**No**\",\n    \"12-3\": \"**No**\",\n    \"11-3\": \"**Yes**\",\n    \"13-3\": \"**No**\",\n    \"14-3\": \"**No**\",\n    \"15-3\": \"**Yes**\",\n    \"16-3\": \"**Yes**\",\n    \"17-3\": \"**Yes**\",\n    \"0-0\": \"`jointFirstName`\",\n    \"1-0\": \"`jointLastName`\",\n    \"2-0\": \"`jointAddressLine1`\",\n    \"3-0\": \"`jointAddressLine2`\",\n    \"4-0\": \"`jointCity`\",\n    \"5-0\": \"`jointStateProvince`\",\n    \"6-0\": \"`jointZipPostalCode`\",\n    \"7-0\": \"`jointCountryID`\",\n    \"8-0\": \"`jointEmailAddress1`\",\n    \"9-0\": \"`jointDisclosureAck`\",\n    \"10-0\": \"`jointDisclosureRule14b`\",\n    \"11-0\": \"`ackJointMarketData`\",\n    \"12-0\": \"`ackJointCustomerAgreement`\",\n    \"13-0\": \"`ackJointFindersFee`\",\n    \"14-0\": \"`ackJointForeignFindersFee`\",\n    \"15-0\": \"`ackJointSweep`\",\n    \"16-0\": \"`ackJointSignedBy`\",\n    \"17-0\": \"`ackJointSignedWhen`\",\n    \"17-1\": \"`\\\"2015-11-03T18:25:02.622Z\\\"`\",\n    \"16-1\": \"`\\\"Linda Belcher\\\"`\",\n    \"15-1\": \"`true`\",\n    \"14-1\": \"`true`\",\n    \"13-1\": \"`true`\",\n    \"12-1\": \"`true`\",\n    \"11-1\": \"`true`\",\n    \"10-1\": \"`true`\",\n    \"9-1\": \"`true`\",\n    \"8-1\": \"`\\\"linda@belcher.com\\\"`\",\n    \"7-1\": \"`\\\"USA\\\"`\",\n    \"6-1\": \"`\\\"08312\\\"`\",\n    \"5-1\": \"`\\\"New Jersey\\\"`\",\n    \"4-1\": \"`\\\"Wicker\\\"`\",\n    \"3-1\": \"`\\\"Apt. #2\\\"`\",\n    \"2-1\": \"`\\\"123 Main St.\\\"`\",\n    \"1-1\": \"`\\\"Belcher\\\"`\",\n    \"0-1\": \"`\\\"Linda\\\"`\",\n    \"0-2\": \"First name.\",\n    \"1-2\": \"Last name.\",\n    \"2-2\": \"Address line 1.\",\n    \"3-2\": \"Address line 2.\",\n    \"4-2\": \"City.\",\n    \"5-2\": \"State / province.\",\n    \"6-2\": \"Zip / postal code.\",\n    \"7-2\": \"3 Character Country Code.<br />Follows the [ISO 3166-1 format](https://en.wikipedia.org/wiki/ISO_3166-1).\",\n    \"8-2\": \"Email address.\",\n    \"9-2\": \"All disclosures and acknowledgements.\",\n    \"10-2\": \"Disclosure Rule 14b-1(c).<br />**Note**: See official text above.\",\n    \"11-2\": \"Acknowledgements of market data agreement.<br />**Note**: See official text above.\",\n    \"12-2\": \"Acknowledgements Customer Account Agreements.<br />**Note**: See official text and link above.\",\n    \"13-2\": \"Acknowledgement of finders fee.<br />**Note**: Only required if user is a U.S. Citizen and was referred to DriveWealth.\",\n    \"14-2\": \"Acknowledgements of foreign finders fee.<br />**Note**: Only required if user is NOT a U.S. Citizen and was referred to DriveWealth.\",\n    \"15-2\": \"\",\n    \"16-2\": \"Digital signature.<br />**Note**: User must type in their full name.\",\n    \"17-2\": \"Timestamp of application submittal.<br />**Note**: Use UTC timestamp.\"\n  },\n  \"cols\": 4,\n  \"rows\": 18\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\nThe response contains the user's `userID` and `username`. To verify that the user now has a live account, call the [Get Account](doc:accounts_get) Method. Once you verify that the account is present, the user must verify their identity via [Add Document](doc:add-document).","excerpt":"Create a new user and a funded live account (aka \"real trading\"). Before sending listed params, the user must have a valid `username` and `userID`.","slug":"create-live-account","type":"endpoint","title":"Create Live Account"}

postCreate Live Account

Create a new user and a funded live account (aka "real trading"). Before sending listed params, the user must have a valid `username` and `userID`.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

ownershipType:
required
stringIndividual
Type of account.
userID:
required
string02e57c7d-d071-4c63-b491-1194a9939ea5
User ID.
emailAddress1:
required
stringbob@belchers.com
Email address 1.
emailAddress2:
stringbob_belcher@gmail.com
Email address 2.
firstName:
required
stringBob
First name.
lastName:
required
stringBelcher
Last name.
username:
required
stringbelcherbob
Username.<br />**Requirements**: Must be unique.
password:
required
stringabcd1234
Password.<br />**Requirements**: At least 8 characters, less than 90 characters, at least 1 digit, at least 1 character.
gender:
required
stringmale
Gender.
languageID:
stringen_US
Language.<br />**Options**: `"en_US"` (Default), `"zh_CN"`, `"es_ES"`, `"pt_BR"` or `"ja_JP"`.
phoneHome:
required
string212-555-3125
Home phone.
phoneWork:
string212-333-4123
Work phone.
phoneMobile:
string212-111-3312
Mobile phone.
addressLine1:
required
string123 Main St.
Address line 1.
addressLine2:
stringApt. #2
Address line 2.
city:
required
stringWicker
City.
countryID:
required
stringUSA
Reference [List All Countries](doc:list-all-countries) for list of active countries.
stateProvince:
required
stringNew Jersey
State / province.
wlpID:
required
stringDW
WLP ID.<br />**Note**: Default to `"DW"`.
zipPostalCode:
string08312
Zip / postal code.
dob:
required
string1976-11-18
Date of birth.<br />**Requirements**: YYYY-MM-DD format required. Must be older than 18 years old.
maritalStatus:
stringMarried
Marital Status.<br />**Options**: `"Single"`, `"Divorced"`, `"Married"` or `"Widowed"`.
idNo:
required
string111-11-1111
SSN, TaxID, or National ID Number (non-USA)
usCitizen:
required
booleantrue
US citizen or permanent resident.
referralCode:
required
stringABC123
Referral code of investor who **referred** this new investor.
tradingType:
required
stringc
Trading type.<br />**Options**: `C` for cash (default) and `M` for margin.
citizenship:
required
stringUSA
Country Citizenship, uses 3 character country code.<br />Follows the [ISO 3166-1 format](https://en.wikipedia.org/wiki/ISO_3166-1).
utm_campaign:
stringFacebookNewsFeed
The individual campaign name, slogan, promo code, etc.
utm_content:
stringBannerAdv2b
Used to differentiate similar content, or links within the same ad.
utm_medium:
stringEmail
The advertising or marketing medium.
utm_source:
stringFacebook
Identify the advertiser, site, publication, etc.
utm_term:
stringInvesting+Account
Identify paid search keywords.
employerBusiness:
required
stringFood and Beverage
Employer's type of business.<br />**Options**: `Automobiles - Components`, `Capital Goods`, `Construction`, `Energy`, `Financial Services`, `Food and Beverage`, `Government`, `Hotels Restaurants - Leisure`, `Household - Personal Products`, `Health Care Equipment - Services`, `Materials`, `Media`, `Pharmaceuticals - Biotechnology`, `Professional Services`, `Real Estate`, `Retail Shops and Services`, `Software - Services`, `Technology Hardware - Equipment`, `Telecommunication Services`, `Transportation`, `Utilities`, `Other`.
employerCompany:
required
stringBob's Burgers
Employer's company name.
employerAddressLine1:
required
string321 Main St.
Employer's address line 1.
employerAddressLine2:
required
stringSuite 201
Employer's address line 2.
employerCity:
required
stringWicker
Employer's city.
employerStateProvince:
required
stringNew Jersey
Employer's state / province.
employerZipPostalCode:
required
string08312
Employer's zip / postal code.
employerCountryID:
required
stringUSA
Employer's country, using 3 character country code.<br />Follows the [ISO 3166-1 format](https://en.wikipedia.org/wiki/ISO_3166-1).
employerIsBroker:
required
booleantrue
Is user affiliated with stock exchange, FINRA or broker dealer?<br />**Official question**: Are they affiliated with or employed by a stock exchange, member firm of an exchange or FINRA, or a municipal securities broker-dealer?<br />If answers "Yes", display this: "If answered Yes, you and DriveWealth are obligated to notify your employer in writing of your intention to open an account."
employmentPosition:
required
stringChef
Occupation.
employmentStatus:
required
stringEmployed / Self Employed
Employment status.<br />**Options**: `"Employed / Self-Employed"`, `"Retired"`, `"Student"` or `"Not Employed"`.
employmentYears:
required
integer4
Years of employment.
annualIncome:
required
string$0 - $24,999
Annual income.<br />**Options**: `"$0 - $24,999"`, `"$25,000 - $99,999"`, `"$100,000 - $199,999"` or `"$200,000+"`
investmentObjectives:
required
stringGrowth
Investment objectives.<br />**Options**: `"Capital Preservation"`, `"Growth"`, `"Income"` or `"Speculation"`.
investmentExperience:
required
stringNone
Investment experience.<br />**Options**: `"None"`, `"Limited"`, `"Good"` or `"Extensive"`.
networthLiquid:
required
string$0 - $4,999
Liquid net worth.<br />**Options**: `"$0 - $4,999"`, `"$5,000 - $99,999"`, `"$100,000 - $199,999"` or `"$200,000+"`
networthTotal:
required
string$0 - $24,999
Total net worth.<br />**Options**: `"$0 - $24,999"`, `"$25,000 - $99,999"`, `"$100,000 - $199,999"` or `"$200,000+"`
director:
required
booleantrue
Director/officer of public company?<br />**Official question**: Is the account holder(s) a control person of a publicly traded company? A Director, Officer or 10% stock owner?
directorOf:
required
stringGoogle, GOOG
If answers "Yes" (or true) to `director` then ask:<br />**Official question**: If yes, please list the company name and its ticker symbol.
politicallyExposed:
required
booleantrue
Politically exposed person or public official?<br />**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.
politicallyExposedNames:
required
stringJanet Yellen
If answers "Yes" (or true) to `politicallyExposed` then ask:<br />**Official question**: If yes, please provide the names of that official and official's immediate family members (including former spouses).
riskTolerance:
required
stringModerate
Risk tolerance.<br />**Options**: `"Conservative"`, `"Moderate"` or `"Aggressive"`.
disclosureAck:
required
booleantrue
All disclosures and acknowledgements.
disclosureRule14b:
required
booleantrue
Disclosure Rule 14b-1(c).<br />**Official text**: Rule 14b-1(c) of the Securities Exchange Act, unless you object, requires us to disclose to an issuer, upon its request, the names, addresses, and securities positions of our customers who are beneficial owners of the issuer's securities held by us in nominee name. The issuer would be permitted to use your name and other related information for corporation communication only.
ackCustomerAgreement:
required
booleantrue
Acknowledges DriveWealth's Customer Account Agreement.<br />**Official links**: [English](http://drivewealth.com/customer-account-agreement), [Chinese](https://drivewealth.com/customer-account-agreement/?lang=cn_ZH), [Spanish](https://drivewealth.com/customer-account-agreement/?lang=es_ES) and [Portuguese](https://drivewealth.com/customer-account-agreement/?lang=pt_BR).
ackSweep:
required
booleantrue
ackFindersFee:
booleantrue
Acknowledgement of finders fee.<br />**Note**: Only required if user is a U.S. Citizen and was referred to DriveWealth.
ackForeignFindersFee:
booleanfalse
Acknowledgements of foreign finders fee.<br />**Note**: Only required if user is NOT a U.S. Citizen and was referred to DriveWealth.
ackMarketData:
required
booleantrue
Acknowledgements of market data agreement.<br />**Official text**: By checking the box below I acknowledge that I have read the market data agreements below from the represented exchanges, and I hereby certify that I qualify as a non-professional pursuant to the definitions described herein.<br />**Official link**: [English only](https://drivewealth.com/bats-subscriber-agreement).
ackSignedBy:
required
stringBob Belcher
Digital signature.<br />**Note**: User must type in their full name.
ackMarginAgreementWhen:
string2015-11-03T18:25:02.622Z
Timestamp of acceptance of Margin Agreement (only for margin accounts). See https://drivewealth.com/customer-account-agreement-margin<br />**Note**: Use UTC timestamp.
ackSignedWhen:
required
string2015-11-03T18:25:02.622Z
Timestamp of application submittal.<br />**Note**: Use UTC timestamp.
accountMgmtType:
integer0
Sets Account Management Type:<br /> • `0` - Self-Directed (Default)<br /> • `1` - Managed

Examples


Result Format


Documentation

[block:callout] { "type": "info", "title": "Creating A Username", "body": "Before sending listed params, the user must have a valid `username` and `userID`. To create a username, see the [Create User](doc:create-user) Method." } [/block] [block:callout] { "type": "info", "title": "Employer Information", "body": "Employer and employment information fields are only required if `employmentStatus` = `\"Employed / Self-Employed\"`, otherwise they may be left `blank`." } [/block] [block:api-header] { "type": "basic", "title": "Request - Joint Account" } [/block] The parameters below are in conjunction with the parameters above when the user wants to open a joint account. [block:parameters] { "data": { "h-0": "Argument", "h-1": "Example", "h-2": "Description", "h-3": "Required", "0-3": "**Yes**", "1-3": "**Yes**", "2-3": "**Yes**", "4-3": "**Yes**", "5-3": "**Yes**", "6-3": "**Yes**", "7-3": "**Yes**", "3-3": "**No**", "8-3": "**No**", "9-3": "**No**", "10-3": "**No**", "12-3": "**No**", "11-3": "**Yes**", "13-3": "**No**", "14-3": "**No**", "15-3": "**Yes**", "16-3": "**Yes**", "17-3": "**Yes**", "0-0": "`jointFirstName`", "1-0": "`jointLastName`", "2-0": "`jointAddressLine1`", "3-0": "`jointAddressLine2`", "4-0": "`jointCity`", "5-0": "`jointStateProvince`", "6-0": "`jointZipPostalCode`", "7-0": "`jointCountryID`", "8-0": "`jointEmailAddress1`", "9-0": "`jointDisclosureAck`", "10-0": "`jointDisclosureRule14b`", "11-0": "`ackJointMarketData`", "12-0": "`ackJointCustomerAgreement`", "13-0": "`ackJointFindersFee`", "14-0": "`ackJointForeignFindersFee`", "15-0": "`ackJointSweep`", "16-0": "`ackJointSignedBy`", "17-0": "`ackJointSignedWhen`", "17-1": "`\"2015-11-03T18:25:02.622Z\"`", "16-1": "`\"Linda Belcher\"`", "15-1": "`true`", "14-1": "`true`", "13-1": "`true`", "12-1": "`true`", "11-1": "`true`", "10-1": "`true`", "9-1": "`true`", "8-1": "`\"linda@belcher.com\"`", "7-1": "`\"USA\"`", "6-1": "`\"08312\"`", "5-1": "`\"New Jersey\"`", "4-1": "`\"Wicker\"`", "3-1": "`\"Apt. #2\"`", "2-1": "`\"123 Main St.\"`", "1-1": "`\"Belcher\"`", "0-1": "`\"Linda\"`", "0-2": "First name.", "1-2": "Last name.", "2-2": "Address line 1.", "3-2": "Address line 2.", "4-2": "City.", "5-2": "State / province.", "6-2": "Zip / postal code.", "7-2": "3 Character Country Code.<br />Follows the [ISO 3166-1 format](https://en.wikipedia.org/wiki/ISO_3166-1).", "8-2": "Email address.", "9-2": "All disclosures and acknowledgements.", "10-2": "Disclosure Rule 14b-1(c).<br />**Note**: See official text above.", "11-2": "Acknowledgements of market data agreement.<br />**Note**: See official text above.", "12-2": "Acknowledgements Customer Account Agreements.<br />**Note**: See official text and link above.", "13-2": "Acknowledgement of finders fee.<br />**Note**: Only required if user is a U.S. Citizen and was referred to DriveWealth.", "14-2": "Acknowledgements of foreign finders fee.<br />**Note**: Only required if user is NOT a U.S. Citizen and was referred to DriveWealth.", "15-2": "", "16-2": "Digital signature.<br />**Note**: User must type in their full name.", "17-2": "Timestamp of application submittal.<br />**Note**: Use UTC timestamp." }, "cols": 4, "rows": 18 } [/block] [block:api-header] { "type": "basic", "title": "Response" } [/block] The response contains the user's `userID` and `username`. To verify that the user now has a live account, call the [Get Account](doc:accounts_get) Method. Once you verify that the account is present, the user must verify their identity via [Add Document](doc:add-document).

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}