Offboarding

Start Offboarding

post

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

Authorizations

Header parameters

Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body

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

400

Bad Request

application/json

404

Not Found

application/json

409

Conflict

application/json

post

HTTPcURLJavaScriptPython

POST /offboardings HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Requestor-ID: 123e4567-e89b-12d3-a456-426614174000
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

Get list of offboardings

Authorizations

Query parameters

entityTypestring · enumRequiredPossible values:

entityIdstring · uuidRequired

Unique identification number of offboarded entity type in UUID format.

Responses

200

OK

application/json

404

Not Found

application/json

get

HTTPcURLJavaScriptPython

GET /offboardings HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Accept: */*

[
  {
    "offboardingId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "RECEIVED",
    "entityType": "CUSTOMER",
    "entityId": "123e4567-e89b-12d3-a456-426614174000",
    "reason": "CUSTOMER_REQUEST_IMMEDIATE",
    "createdOn": "2025-05-23T00:48:50.385Z",
    "modifiedOn": "2025-05-23T00:48:50.385Z"
  }
]

Get Offboarding

get

Get offboarding information

Authorizations

Path parameters

offboardingIdstring · uuidRequired

Unique offboarding identification number in UUID format

Responses

200

OK

application/json

404

Not Found

application/json

get

HTTPcURLJavaScriptPython

GET /offboardings/{offboardingId} HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Accept: */*

{
  "offboardingId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "RECEIVED",
  "entityType": "CUSTOMER",
  "entityId": "123e4567-e89b-12d3-a456-426614174000",
  "reason": "CUSTOMER_REQUEST_IMMEDIATE",
  "createdOn": "2025-05-23T00:48:50.385Z",
  "modifiedOn": "2025-05-23T00:48:50.385Z"
}

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

200

OK

400

Bad Request

application/json

404

Not Found

application/json

delete

HTTPcURLJavaScriptPython

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

No content