Onboarding
Ready to test
Start onboarding process. Proxy and beneficial owner can be onboarded if the customer is already onboarded.
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, beneficial owner or partner depending on the value of entityType
Responses
200
OK
application/json
400
Bad Request
application/json
404
Not Found
application/json
409
Conflict
application/json
post
POST /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: 75
{
"entityType": "CUSTOMER",
"entityId": "123e4567-e89b-12d3-a456-426614174000"
}
{
"onboardingId": "123e4567-e89b-12d3-a456-426614174000"
}
Ready to test
Get list of onboardings
Authorizations
Query parameters
entityTypestring · enumRequiredPossible values:
entityIdstring · uuidRequired
Unique identification number of onboarded entity type in UUID format.
Responses
200
OK
application/json
404
Not Found
application/json
get
GET /onboardings 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-07-10T02:30:11.402Z",
"modifiedOn": "2025-07-10T02:30:11.402Z"
}
]
Ready to test
Get onboarding information
Authorizations
Path parameters
onboardingIdstring · uuidRequired
Unique onboarding identification number in UUID format
Responses
200
OK
application/json
404
Not Found
application/json
get
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-07-10T02:30:11.402Z",
"modifiedOn": "2025-07-10T02:30:11.402Z"
}
Last updated