Offboarding

Start Offboarding

post

Start offboarding process 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)

reasonstring · enumRequiredPossible values:
Responses
200

OK

application/json
post
POST /roles/offboardings 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: 109

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

Get Offboardings

get

Get list of offboardings for a role

Authorizations
Query parameters
offboardingRoleTypestring · enumRequired

Type of role for offboarding

Possible values:
roleIdstring · uuidRequired

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

Responses
200

OK

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

[
  {
    "offboardingId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "RECEIVED",
    "roleType": "CUSTOMER",
    "roleId": "123e4567-e89b-12d3-a456-426614174000",
    "reason": "CUSTOMER_REQUEST_IMMEDIATE",
    "createdOn": "2025-08-29T19:57:41.827Z",
    "modifiedOn": "2025-08-29T19:57:41.827Z"
  }
]

Get Offboarding

get

Get offboarding information

Authorizations
Path parameters
offboardingIdstring · uuidRequired

Unique offboarding identification number in UUID format

Responses
200

OK

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

{
  "offboardingId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "RECEIVED",
  "roleType": "CUSTOMER",
  "roleId": "123e4567-e89b-12d3-a456-426614174000",
  "reason": "CUSTOMER_REQUEST_IMMEDIATE",
  "createdOn": "2025-08-29T19:57:41.827Z",
  "modifiedOn": "2025-08-29T19:57:41.827Z"
}

Cancel Offboarding

delete

Cancel created offboarding if not started.

Authorizations
Path parameters
offboardingIdstring · uuidRequired

Unique offboarding identification number in UUID format

Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Responses
202

Accepted

No content
delete
DELETE /roles/offboardings/{offboardingId} HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Requestor-ID: 123e4567-e89b-12d3-a456-426614174000
Accept: */*

No content

Last updated