Offboarding

Start Offboarding

post
/offboardings

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

Authorizations
OAuth2clientCredentialsRequired
Token URL:
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
post
/offboardings
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
/offboardings

Get list of offboardings

Authorizations
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
get
/offboardings
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": "2025-11-18T09:13:16.352Z",
    "modifiedOn": "2025-11-18T09:13:16.352Z"
  }
]

Get Offboarding

get
/offboardings/{offboardingId}

Get offboarding information

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
offboardingIdstring · uuidRequired

Unique offboarding identification number in UUID format

Responses
200

OK

application/json
get
/offboardings/{offboardingId}
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": "2025-11-18T09:13:16.352Z",
  "modifiedOn": "2025-11-18T09:13:16.352Z"
}

Cancel Offboarding

delete
/offboardings/{offboardingId}

Cancel created offboarding if not started.

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
offboardingIdstring · uuidRequired

Unique offboarding identification number in UUID format

Responses
200

OK

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

No content

Last updated