Create a user

POST

https://api.t-dx.com/api/rest/v1/users

POST

/api/rest/v1/users

curl -X POST https://api.t-dx.com/api/rest/v1/users \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "username": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "phoneNumber": "string",
  "permissions": {},
  "challenge": "string",
  "code": "string"
}'

{
  "result": {
    "id": "string",
    "clientAccountId": "string",
    "status": "STATUS_ACTIVE",
    "type": "TYPE_FRONT_OFFICE",
    "username": "string",
    "firstname": "string",
    "lastname": "string",
    "birthDate": "2024-01-15T09:30:00Z",
    "phoneNumber": "string",
    "participantType": "PARTICIPANT_TYPE_TRADING_MEMBER",
    "roles": [
      "ROLE_NONE"
    ],
    "attributes": [
      {
        "id": "string",
        "userId": "string",
        "clientAccountId": "string",
        "owner": "string",
        "type": "string",
        "subType": "string",
        "key": "string",
        "value": "string",
        "contentType": "string",
        "isFile": true,
        "createdAt": "2024-01-15T09:30:00Z",
        "updatedAt": "2024-01-15T09:30:00Z"
      }
    ],
    "language": "string",
    "MFAEnabled": true,
    "email": "string",
    "communicationSecret": "string",
    "secretQuestion": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "permissions": {
      "canRead": true,
      "canWrite": true,
      "canDeposit": true,
      "canWithdraw": true,
      "canTrade": true,
      "canManage": true
    },
    "subAccounts": [
      {
        "id": "string",
        "permissions": {
          "canRead": true,
          "canWrite": true,
          "canDeposit": true,
          "canWithdraw": true,
          "canTrade": true,
          "canManage": true
        }
      }
    ]
  }
}

This endpoint returns a newly created user. The user will receive an email to set a password.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

usernamestringRequired

firstNamestringRequired

lastNamestringRequired

emailstringRequired

phoneNumberstringRequired

permissionsobjectRequired

challengestringRequired

2FA code must always be provided.

codestringRequiredformat: "uint64"

The code received via email by the user as a result of the call to SendUserCreationCode

subAccountslist of objectsOptional

Response

A successful response.

resultobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error