Users

Create User

post

Ready to test

Create a user. Provided email needs to be unique.

Data provided will be used to create credentials to access Partner Panel. Specifically, provided email will be used to identify created account. This means that email needs to be unique.

Authorizations

Body

genderstring · enumRequired

Gender

Possible values:

firstNamestring · max: 255Required

lastNamestring · max: 255Required

middleNamestring · max: 255Optional

birthDaystring · dateRequired

birthPlacestring · max: 255Required

birthCountrystring · enumRequired

Country code in ISO 3166-1 alpha-2 standard

Possible values:

typestring · enumRequiredPossible values:

Responses

200

OK

application/json

400

Bad Request

application/json

post

HTTPcURLJavaScriptPython

POST /users HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Content-Type: application/json
Accept: */*
Content-Length: 368

{
  "gender": "MALE",
  "firstName": "text",
  "lastName": "text",
  "middleName": "text",
  "birthDay": "2025-05-23",
  "birthPlace": "text",
  "birthCountry": "AF",
  "nationalities": [
    "AF"
  ],
  "mainAddress": {
    "street": "text",
    "streetNumber": "text",
    "city": "text",
    "zip": "text",
    "country": "AF",
    "additionalInfo": "text"
  },
  "contact": {
    "phone": "text",
    "email": "text",
    "fax": "text",
    "website": "text"
  },
  "type": "ADMIN"
}

{
  "userId": "123e4567-e89b-12d3-a456-426614174000"
}

Get Users

get

Get list of users

Authorizations

Query parameters

cursorstringOptional

String value used for pagination

limitinteger · min: 1Required

Maximum number of items to return

Default: 20

userTypestring · enumOptional

User type filter

Possible values:

userStatusstring · enumRead-onlyOptional

Current customer status

Possible values:

Responses

200

OK

application/json

400

Bad Request

application/json

get

HTTPcURLJavaScriptPython

GET /users HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Accept: */*

{
  "data": [
    {
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "globalId": "text",
      "status": "RECEIVED",
      "createdOn": "2025-05-23T02:21:21.241Z",
      "modifiedOn": "2025-05-23T02:21:21.241Z",
      "gender": "MALE",
      "firstName": "text",
      "lastName": "text",
      "middleName": "text",
      "birthDay": "2025-05-23",
      "birthPlace": "text",
      "birthCountry": "AF",
      "nationalities": [
        "AF"
      ],
      "mainAddress": {
        "street": "text",
        "streetNumber": "text",
        "city": "text",
        "zip": "text",
        "country": "AF",
        "additionalInfo": "text"
      },
      "contact": {
        "phone": "text",
        "email": "text",
        "fax": "text",
        "website": "text"
      },
      "type": "ADMIN"
    }
  ],
  "pagination": {
    "cursor": "text",
    "limit": 1
  }
}

Get User

get

Get user

Authorizations

Path parameters

userIdstring · uuidRequired

User ID

Responses

200

OK

application/json

400

Bad Request

application/json

404

Not Found

application/json

get

HTTPcURLJavaScriptPython

GET /users/{userId} HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Accept: */*

{
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "globalId": "text",
  "status": "RECEIVED",
  "createdOn": "2025-05-23T02:21:21.241Z",
  "modifiedOn": "2025-05-23T02:21:21.241Z",
  "gender": "MALE",
  "firstName": "text",
  "lastName": "text",
  "middleName": "text",
  "birthDay": "2025-05-23",
  "birthPlace": "text",
  "birthCountry": "AF",
  "nationalities": [
    "AF"
  ],
  "mainAddress": {
    "street": "text",
    "streetNumber": "text",
    "city": "text",
    "zip": "text",
    "country": "AF",
    "additionalInfo": "text"
  },
  "contact": {
    "phone": "text",
    "email": "text",
    "fax": "text",
    "website": "text"
  },
  "type": "ADMIN"
}

Update User

patch

Ready to test

Update user

Authorizations

Path parameters

userIdstring · uuidRequired

User ID

Body

lastNamestring · max: 255Optional

statusstring · enumOptional

Status can be changed to INACTIVE only for users that already have status ACTIVE

Possible values:

mfaTypestring · enumOptional

Sending request with SMS will switch MFA to SMS until the next time user login. After that method will be switched to TOTP again.

Possible values:

Responses

200

OK

400

Bad Request

application/json

patch

HTTPcURLJavaScriptPython

PATCH /users/{userId} HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Content-Type: application/json
Accept: */*
Content-Length: 255

{
  "lastName": "text",
  "nationalities": [
    "AF"
  ],
  "mainAddress": {
    "street": "text",
    "streetNumber": "text",
    "city": "text",
    "zip": "text",
    "country": "AF",
    "additionalInfo": "text"
  },
  "contact": {
    "phone": "text",
    "fax": "text",
    "website": "text"
  },
  "status": "INACTIVE",
  "mfaType": "SMS"
}

No content