Offboarding

Start Offboarding

post

https://tvda-api.platform-test.tradevest.aihttps://tvda-api.platform-pretest.tradevest.ai

/offboardings

Start offboarding process. Customers, proxies, and beneficial owners can be offboarded if necessary due to cancellation or changes in the company structure.

Authorizations

Bearer

OAuth2clientCredentialsRequired

Token URL:

Body

application/json

entityTypestring · enumRequiredPossible values:

entityIdstring · uuidRequired

Identification number in UUID format of customer, proxy or beneficial owner depending on the value of entityType

reasonstring · enumRequiredPossible values:

Responses

200

OK

application/json

offboardingIdstring · uuidRead-onlyRequired

400

Bad Request

application/json

404

Not Found

application/json

409

Conflict

application/json

post

/offboardings

HTTPcURLJavaScriptPython

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

{
  "entityType": "CUSTOMER",
  "entityId": "123e4567-e89b-12d3-a456-426614174000",
  "reason": "CUSTOMER_REQUEST_IMMEDIATE"
}

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

Get Offboardings

get

https://tvda-api.platform-test.tradevest.aihttps://tvda-api.platform-pretest.tradevest.ai

/offboardings

Get list of offboardings

Authorizations

Bearer

OAuth2clientCredentialsRequired

Token URL:

Query parameters

entityTypestring · enumRequiredPossible values:

entityIdstring · uuidRequired

Unique identification number of offboarded entity type in UUID format.

Responses

200

OK

application/json

offboardingIdstring · uuidRead-onlyRequired

statusstring · enumRead-onlyRequiredPossible values:

entityTypestring · enumRequiredPossible values:

entityIdstring · uuidRequired

Identification number in UUID format of customer, proxy or beneficial owner depending on the value of entityType

reasonstring · enumRequiredPossible values:

createdOnstring · date-timeRead-onlyRequired

modifiedOnstring · date-timeRead-onlyRequired

404

Not Found

application/json

get

/offboardings

HTTPcURLJavaScriptPython

GET /offboardings?entityType=CUSTOMER&entityId=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "offboardingId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "RECEIVED",
    "entityType": "CUSTOMER",
    "entityId": "123e4567-e89b-12d3-a456-426614174000",
    "reason": "CUSTOMER_REQUEST_IMMEDIATE",
    "createdOn": "2026-05-20T16:12:46.397Z",
    "modifiedOn": "2026-05-20T16:12:46.397Z"
  }
]

Get Offboarding

get

https://tvda-api.platform-test.tradevest.aihttps://tvda-api.platform-pretest.tradevest.ai

/offboardings/{offboardingId}

Get offboarding information

Authorizations

Bearer

OAuth2clientCredentialsRequired

Token URL:

Path parameters

offboardingIdstring · uuidRequired

Unique offboarding identification number in UUID format

Responses

200

OK

application/json

offboardingIdstring · uuidRead-onlyRequired

statusstring · enumRead-onlyRequiredPossible values:

entityTypestring · enumRequiredPossible values:

entityIdstring · uuidRequired

Identification number in UUID format of customer, proxy or beneficial owner depending on the value of entityType

reasonstring · enumRequiredPossible values:

createdOnstring · date-timeRead-onlyRequired

modifiedOnstring · date-timeRead-onlyRequired

404

Not Found

application/json

get

/offboardings/{offboardingId}

HTTPcURLJavaScriptPython

GET /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",
  "entityType": "CUSTOMER",
  "entityId": "123e4567-e89b-12d3-a456-426614174000",
  "reason": "CUSTOMER_REQUEST_IMMEDIATE",
  "createdOn": "2026-05-20T16:12:46.397Z",
  "modifiedOn": "2026-05-20T16:12:46.397Z"
}

Cancel Offboarding

delete

https://tvda-api.platform-test.tradevest.aihttps://tvda-api.platform-pretest.tradevest.ai

/offboardings/{offboardingId}

Cancel created offboarding if not started.

Authorizations

Bearer

OAuth2clientCredentialsRequired

Token URL:

Path parameters

offboardingIdstring · uuidRequired

Unique offboarding identification number in UUID format

Responses

200

OK

No content

400

Bad Request

application/json

404

Not Found

application/json

delete

/offboardings/{offboardingId}

HTTPcURLJavaScriptPython

DELETE /offboardings/{offboardingId} HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content