{"_id":"56952386fcb1032d0089df94","editedParams2":true,"editedParams":true,"user":"563cc6fa8894d20d00014ea3","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"},"__v":4,"parentDoc":null,"project":"563cc7119799fb0d00047685","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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-12T16:02:14.890Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"code":"POST /v1/signups/practice HTTP/1.1\nHost: api.drivewealth.io\nAccept: application/json\nContent-Type: application/json\n\n{\n    \"wlpID\": \"DW\",\n    \"languageID\": \"en_US\",\n    \"firstName\": \"Bob\",\n    \"lastName\": \"Belcher\",\n    \"emailAddress1\": \"bob:::at:::belchers.com\",\n    \"username\": \"bob227\",\n    \"password\": \"abcd1234\",\n    \"transAmount\": 10000\n}","language":"http"}]},"method":"post","results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n    \"password\": \"abcd1234\",\n    \"userID\": \"02e57c7d-d071-4c63-b491-1194a9939ea5\",\n    \"username\": \"bob227\"\n}"},{"status":400,"language":"json","code":"{\n    \"code\": 400,\n    \"message\": \"Password must contain at least 1 character and 1 digit.\"\n}","name":"Invalid Password"},{"code":"{\n    \"code\": 400,\n    \"message\": \"Duplicate username [username=bob226]\"\n}","language":"json","status":400,"name":"Duplicate Username"},{"code":"{\n    \"code\": 400,\n    \"message\": \"Invalid value: {INPUT_PARAMETER}\"\n}","language":"json","status":400,"name":"Invalid Value"}]},"auth":"required","params":[{"_id":"56954d4c562335190016daf6","ref":"","in":"body","required":true,"desc":"Email address.","default":"bob@belchers.com","type":"string","name":"emailAddress1"},{"_id":"56954d4c562335190016daf5","ref":"","in":"body","required":true,"desc":"First name.","default":"Bob","type":"string","name":"firstName"},{"_id":"56954d4c562335190016daf4","ref":"","in":"body","required":true,"desc":"Last name.","default":"Belcher","type":"string","name":"lastName"},{"_id":"56954d4c562335190016daf3","ref":"","in":"body","required":true,"desc":"Username<br />**Requirements**: Must be unique.","default":"belcherbob","type":"string","name":"username"},{"_id":"56954d4c562335190016daf2","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":"56954d4c562335190016daf1","ref":"","in":"body","required":false,"desc":"User's language preference<br />**Options**: `\"en_US\"` (Default), `\"zh_CN\"`, `\"es_ES\"`, `\"pt_BR\"`, `\"ja_JP\"`.","default":"en_US","type":"string","name":"languageID"},{"_id":"56954d4c562335190016daf0","ref":"","in":"body","required":false,"desc":"Amount to fund practice account.","default":"10000","type":"int","name":"tranAmount"},{"_id":"56954d4c562335190016daef","ref":"","in":"body","required":false,"desc":"Referral code of investor who **referred** this user.","default":"ABC123","type":"string","name":"referralCode"},{"_id":"56954d4c562335190016daee","ref":"","in":"body","required":false,"desc":"The individual campaign name, slogan, promo code, etc.","default":"FacebookNewsFeed","type":"string","name":"utm_campaign"},{"_id":"569588ddfcb1032d0089e031","ref":"","in":"body","required":false,"desc":"Used to differentiate versions of content.","default":"BannerAdv2b","type":"string","name":"utm_content"},{"_id":"569588ddfcb1032d0089e030","ref":"","in":"body","required":false,"desc":"The advertising or marketing medium.","default":"Email","type":"string","name":"utm_medium"},{"_id":"56958ab80c650a2300250622","ref":"","in":"body","required":false,"desc":"Identify the advertiser, site, publication, etc.","default":"Facebook","type":"string","name":"utm_source"},{"_id":"56958ab80c650a2300250621","ref":"","in":"body","required":false,"desc":"Identify paid search keywords.","default":"Investing+Account","type":"string","name":"utm_term"},{"_id":"56958ab80c650a2300250623","ref":"","in":"body","required":false,"desc":"WLP ID.<br />**Note**: Default to `\"DW\"`.","default":"DW","type":"string","name":"wlpID"}],"url":"/signups/practice"},"isReference":true,"order":5,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\nThe response contains the user's `userID`, `username` and `password`. It's typical to log the user in (via [Create Session](doc:create-session)) 1000ms after getting this successful response.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Already Have A Username?\",\n  \"body\": \"If you already have a username and want to add a practice account, POST your `userID` to the same endpoint.\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /v1/signups/practice HTTP/1.1\\nHost: api.drivewealth.io\\nAccept: application/json\\nContent-Type: application/json\\nx-mysolomeo-session-key: 0b84203d-73c6-4cd6-8937-ac751a69990a.2015-12-15T17:52:20.633Z\\n\\n{\\n    \\\"userID\\\":\\\"02e57c7d-d071-4c63-b491-1194a9939ea5\\\"\\n}\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]","excerpt":"Create a new user and a funded practice account (aka \"paper trading\").","slug":"create-practice-account","type":"endpoint","title":"Create Practice Account"}

postCreate Practice Account

Create a new user and a funded practice account (aka "paper trading").

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

emailAddress1:
required
stringbob@belchers.com
Email address.
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.
languageID:
stringen_US
User's language preference<br />**Options**: `"en_US"` (Default), `"zh_CN"`, `"es_ES"`, `"pt_BR"`, `"ja_JP"`.
tranAmount:
integer10000
Amount to fund practice account.
referralCode:
stringABC123
Referral code of investor who **referred** this user.
utm_campaign:
stringFacebookNewsFeed
The individual campaign name, slogan, promo code, etc.
utm_content:
stringBannerAdv2b
Used to differentiate versions of content.
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.
wlpID:
stringDW
WLP ID.<br />**Note**: Default to `"DW"`.

Examples


Result Format


Documentation

[block:api-header] { "type": "basic", "title": "Response" } [/block] The response contains the user's `userID`, `username` and `password`. It's typical to log the user in (via [Create Session](doc:create-session)) 1000ms after getting this successful response. [block:callout] { "type": "info", "title": "Already Have A Username?", "body": "If you already have a username and want to add a practice account, POST your `userID` to the same endpoint." } [/block] [block:code] { "codes": [ { "code": "POST /v1/signups/practice HTTP/1.1\nHost: api.drivewealth.io\nAccept: application/json\nContent-Type: application/json\nx-mysolomeo-session-key: 0b84203d-73c6-4cd6-8937-ac751a69990a.2015-12-15T17:52:20.633Z\n\n{\n \"userID\":\"02e57c7d-d071-4c63-b491-1194a9939ea5\"\n}", "language": "http" } ] } [/block]

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 }}