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
OK
Bad Request
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-09-14",
"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"
}Resend email with initial password if it is expired.
User ID
OK
No content
Bad Request
Not Found
GET /users/{userId}/reset-password HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Unique identification number of onboarded user type in UUID format.
OK
Bad Request
Not Found
GET /user-onboardings HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[]OK
Bad Request
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"
}Unique onboarding identification number in UUID format
OK
Bad Request
Not Found
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-09-14T06:21:45.127Z",
"modifiedOn": "2025-09-14T06:21:45.127Z"
}Get list of users
String value used for pagination
Maximum number of items to return
20User type filter
Current customer status
OK
Bad Request
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-09-14T06:21:45.127Z",
"modifiedOn": "2025-09-14T06:21:45.127Z",
"gender": "MALE",
"firstName": "text",
"lastName": "text",
"birthDay": "2025-09-14",
"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
OK
Bad Request
Not Found
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-09-14T06:21:45.127Z",
"modifiedOn": "2025-09-14T06:21:45.127Z",
"gender": "MALE",
"firstName": "text",
"lastName": "text",
"birthDay": "2025-09-14",
"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
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.
Sending request with SMS will switch MFA to SMS until the next time user login. After that method will be switched to TOTP again.
OK
No content
Bad Request
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