Onboardings

Start Onboarding

post

Start onboarding process for a role

Authorizations
Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body
roleTypestring · enumRequiredPossible values:
roleIdstring · uuidRequired

Identification number in UUID format of the role (customer or proxy)

Responses
200

OK

application/json
post
POST /roles/onboardings HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Requestor-ID: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "roleType": "CUSTOMER",
  "roleId": "123e4567-e89b-12d3-a456-426614174000"
}
{
  "onboardingId": "123e4567-e89b-12d3-a456-426614174000"
}

Get Onboardings

get

Get list of onboardings for a role

Authorizations
Query parameters
onboardingRoleTypestring · enumRequired

Type of role for onboarding

Possible values:
roleIdstring · uuidRequired

Unique identification number of role (customer or proxy) in UUID format.

Responses
200

OK

application/json
get
GET /roles/onboardings HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "onboardingId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "CREATED",
    "roleType": "CUSTOMER",
    "roleId": "123e4567-e89b-12d3-a456-426614174000",
    "createdOn": "2025-08-30T17:51:10.229Z",
    "modifiedOn": "2025-08-30T17:51:10.229Z"
  }
]

Get Onboarding

get

Get onboarding information

Authorizations
Path parameters
onboardingIdstring · uuidRequired

Unique onboarding identification number in UUID format

Responses
200

OK

application/json
get
GET /roles/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",
  "roleType": "CUSTOMER",
  "roleId": "123e4567-e89b-12d3-a456-426614174000",
  "createdOn": "2025-08-30T17:51:10.229Z",
  "modifiedOn": "2025-08-30T17:51:10.229Z"
}

Last updated