Create User

All users (traders) must have unique user names. However, multiple users may share the same email.

This will be the first step to giving customers access to your firm. Each user may have an unlimited number of trading accounts associated with them.

Create User

API Reference: Register API

To create your first user, you must acquire the new user's password, email, first name, last name, username and email.

Example Usage

cURL

curl -L 'https://userapi-demo.s2f.projectx.com/register' -H 'Content-Type: application/json' --data-raw '{
  "password": "password",
  "email": "jdoe@email.com",
  "userName": "jdoe",
  "firstName": "J",
  "lastName": "Doe",
  "screenName": "",
  "internalTag": 0    // 0 = Default, 1 = Internal
}'

Response

{
    "userId": 7,
    "loginToken": "LOGIN_TOKEN_FOR_USER",
    "errorMessage": null,
    "result": 0
}

Final Step

Process the JSON response and make sure the result is successful (0). If there was an error creating the user, the errorMessage field will provide details.

Store the provided userId field within your platform. This ID will be used for managing the specific user in all further API requests.

The loginToken field can be ignored - it is only used to log in as the specified user (and still expires after 24 hours)