General

Get Partner details

get

Get partner details

Authorizations
Responses
200

OK

application/json
get
GET /v2/partner-details HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "businessName": "text",
  "globalId": "text",
  "address": {
    "street": "text",
    "streetNumber": "text",
    "city": "text",
    "zip": "text",
    "country": "AF",
    "additionalInfo": "text"
  },
  "contact": {
    "phone": "text",
    "email": "text",
    "fax": "text",
    "website": "text"
  },
  "createdOn": "2025-08-30T17:54:55.428Z",
  "modifiedOn": "2025-08-30T17:54:55.428Z",
  "activatedOn": "2025-08-30T17:54:55.428Z"
}

Get Entities

get

Get list of entities

Authorizations
Query parameters
cursorstringOptional

String value used for pagination

limitinteger · min: 1Required

Maximum number of items to return

Default: 20
entityTypestring · enumOptional

Type of the entity.

Possible values:
entityStatusstring · enumOptional

Status of the entity. Available values depend on entity type.

Possible values:
searchTextstringOptional

Entity search text, the search will be performed on the following fields: Name of the entity:

  • For Natural Person, Beneficial Owner, Legal Representative: firstName, lastName
  • For Joint Person: firstName, lastName of 1st natural person and firstName, lastName of 2nd natural person
  • For Legal Entity: legalName Also entityId and globalId
globalIdstring · min: 12 · max: 12Optional

Global ID filter

entityIdstring · uuidOptional

Entity ID filter

rolestring · enumOptional

Role of the entity:

  • CUSTOMER - Entity is a customer
  • PROXY - Entity is a proxy
Possible values:
Responses
200

OK

application/json
get
GET /entities HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

OK

{
  "data": [
    {
      "globalId": "text",
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "entityName": "text",
      "entityType": "NATURAL_PERSON",
      "entityStatus": "ACTIVE",
      "contactPhone": "text",
      "createdOn": "2025-08-30T17:54:55.428Z",
      "roles": [
        {
          "roleType": "CUSTOMER",
          "roleId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ]
    }
  ],
  "pagination": {
    "cursor": "text",
    "limit": 1
  }
}

Last updated