Onboardings

Start Onboarding

post

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

/entities/onboardings

Start onboarding process

Authorizations

Bearer

OAuth2clientCredentialsRequired

Token URL:

Header parameters

Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body

application/json

entityTypestring · enumRequiredPossible values:

entityIdstring · uuidRequired

Identification number in UUID format of the entity

Responses

200

OK

application/json

400

Bad Request

application/json

404

Not Found

application/json

409

Conflict

application/json

post

/entities/onboardings

HTTPcURLJavaScriptPython

POST /entities/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: 83

{
  "entityType": "BENEFICIAL_OWNER",
  "entityId": "123e4567-e89b-12d3-a456-426614174000"
}

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

Get Onboardings

get

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

/entities/onboardings

Get list of onboardings for an entity

Authorizations

Bearer

OAuth2clientCredentialsRequired

Token URL:

Query parameters

onboardingEntityTypestring · enumRequiredPossible values:

entityIdstring · uuidRequired

Unique identification number of entity in UUID format

Responses

200

OK

application/json

404

Not Found

application/json

get

/entities/onboardings

HTTPcURLJavaScriptPython

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

[
  {
    "onboardingId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "CREATED",
    "entityType": "BENEFICIAL_OWNER",
    "entityId": "123e4567-e89b-12d3-a456-426614174000",
    "createdOn": "2026-01-31T12:00:51.759Z",
    "modifiedOn": "2026-01-31T12:00:51.759Z"
  }
]

Get Onboarding

get

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

/entities/onboardings/{onboardingId}

Get onboarding information

Authorizations

Bearer

OAuth2clientCredentialsRequired

Token URL:

Path parameters

onboardingIdstring · uuidRequired

Unique onboarding identification number in UUID format

Responses

200

OK

application/json

404

Not Found

application/json

get

/entities/onboardings/{onboardingId}

HTTPcURLJavaScriptPython

GET /entities/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",
  "entityType": "BENEFICIAL_OWNER",
  "entityId": "123e4567-e89b-12d3-a456-426614174000",
  "createdOn": "2026-01-31T12:00:51.759Z",
  "modifiedOn": "2026-01-31T12:00:51.759Z"
}