Users | Tradevest

Create User

post

/users

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

OAuth2clientCredentialsRequired

Token URL:

Body

genderstring · enumRequired

Gender

Possible values:

firstNamestring · max: 255Required

All first names of the person according to the identification document

Pattern: ^\S+( \S+)*$

lastNamestring · max: 255Required

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

/users

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

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

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

Reset user password

get

/users/{userId}/reset-password

Resend email with initial password if it is expired.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

userIdstring · uuidRequired

User ID

Responses

200

OK

No content

400

Bad Request

application/json

404

Not Found

application/json

get

/users/{userId}/reset-password

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

No content

Get User Onboardings

get

/user-onboardings

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Query parameters

userIdstring · uuidRequired

Unique identification number of onboarded user type in UUID format.

Responses

200

OK

application/json

400

Bad Request

application/json

404

Not Found

application/json

get

/user-onboardings

GET /user-onboardings?userId=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[]

Start User Onboarding

post

/user-onboardings

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Body

userIdstring · uuidRequired

Responses

200

OK

application/json

400

Bad Request

application/json

post

/user-onboardings

POST /user-onboardings HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 49

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

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

Get User Onboarding

get

/user-onboardings/{onboardingId}

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

onboardingIdstring · uuidRequired

Unique onboarding identification number in UUID format

Responses

200

OK

application/json

400

Bad Request

application/json

404

Not Found

application/json

get

/user-onboardings/{onboardingId}

GET /user-onboardings/{onboardingId} HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "onboardingId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "CREATED",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "createdOn": "2025-12-08T08:51:06.589Z",
  "modifiedOn": "2025-12-08T08:51:06.589Z"
}

Get Users

get

/users

Get list of users

Authorizations

OAuth2clientCredentialsRequired

Token URL:

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

/users

GET /users?limit=20 HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Get User

get

/users/{userId}

Get user

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

userIdstring · uuidRequired

User ID

Responses

200

OK

application/json

400

Bad Request

application/json

404

Not Found

application/json

get

/users/{userId}

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

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

Update User

patch

/users/{userId}

Update user

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

userIdstring · uuidRequired

User ID

Body

lastNamestring · max: 255Optional

statusstring · enumOptional

Update to INACTIVE or SUSPENDED is possible only from ACTIVE status. It will disable user access to API. Update to ACTIVE is possible only from SUSPENDED. It will enable user access to API.

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

No content

400

Bad Request

application/json

patch

/users/{userId}

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

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

No content