Users
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.
Gender
All first names of the person according to the identification document
^\S+( \S+)*$
Country code in ISO 3166-1 alpha-2 standard
POST /users HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 348
{
"gender": "MALE",
"firstName": "text",
"lastName": "text",
"birthDay": "2025-07-12",
"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 list of users
String value used for pagination
Maximum number of items to return
20
User type filter
Current customer status
GET /users 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-07-12T02:59:17.427Z",
"modifiedOn": "2025-07-12T02:59:17.427Z",
"gender": "MALE",
"firstName": "text",
"lastName": "text",
"birthDay": "2025-07-12",
"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
User ID
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-07-12T02:59:17.427Z",
"modifiedOn": "2025-07-12T02:59:17.427Z",
"gender": "MALE",
"firstName": "text",
"lastName": "text",
"birthDay": "2025-07-12",
"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"
}
Ready to test
Update user
User ID
Status can be changed to INACTIVE only for users that already have status ACTIVE
Sending request with SMS
will switch MFA to SMS until the next time user login. After that method will be switched to TOTP again.
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: 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
Last updated