Onboarding

Start Onboarding

post
/onboardings

Ready to test

Start onboarding process. Proxy and beneficial owner can be onboarded if the customer is already onboarded.

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Body
entityTypestring · enumRequiredPossible values:
entityIdstring · uuidRequired

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

Responses
200

OK

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

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

Get Onboardings

get
/onboardings

Ready to test

Get list of onboardings

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Query parameters
entityTypestring · enumRequiredPossible values:
entityIdstring · uuidRequired

Unique identification number of onboarded entity type in UUID format.

Responses
200

OK

application/json
get
/onboardings
GET /onboardings?entityType=CUSTOMER&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": "CUSTOMER",
    "entityId": "123e4567-e89b-12d3-a456-426614174000",
    "createdOn": "2025-11-18T12:41:11.454Z",
    "modifiedOn": "2025-11-18T12:41:11.454Z"
  }
]

Get Onboarding

get
/onboardings/{onboardingId}

Ready to test

Get onboarding information

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
onboardingIdstring · uuidRequired

Unique onboarding identification number in UUID format

Responses
200

OK

application/json
get
/onboardings/{onboardingId}
GET /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": "CUSTOMER",
  "entityId": "123e4567-e89b-12d3-a456-426614174000",
  "createdOn": "2025-11-18T12:41:11.454Z",
  "modifiedOn": "2025-11-18T12:41:11.454Z"
}

Last updated