Joint Persons

Create Joint Person

post

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

/entities/joint-persons

Create new joint person

Authorizations

Bearer

OAuth2clientCredentialsRequired

Token URL:

Body

application/json

annualIncomeNetnumberOptional

Annual income net

availableAssetsnumberOptional

Available assets

firstNaturalPersonIdstring · uuidRequired

Identifier for the first Natural Person

secondNaturalPersonIdstring · uuidRequired

Identifier for the second Natural Person

externalIdstring · min: 1Optional

External Id in partner's system. This value has to be unique

Responses

200

OK

application/json

jointPersonIdstring · uuidRead-onlyRequired

Unique joint person identification number in UUID format

400

Bad Request

application/json

409

Conflict

application/json

post

/entities/joint-persons

HTTPcURLJavaScriptPython

POST /entities/joint-persons HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 622

{
  "annualIncomeNet": 1,
  "sourceOfIncome": [
    "INCOME_FROM_EMPLOYMENT"
  ],
  "availableAssets": 1,
  "originOfAssets": [
    "NON_EMPLOYED_LABOR"
  ],
  "firstNaturalPersonId": "123e4567-e89b-12d3-a456-426614174000",
  "secondNaturalPersonId": "123e4567-e89b-12d3-a456-426614174000",
  "contact": {
    "phone": "text",
    "email": "text",
    "fax": "text",
    "website": "text"
  },
  "mainAddress": {
    "street": "text",
    "streetNumber": "text",
    "city": "text",
    "zip": "text",
    "state": "text",
    "country": "AF",
    "additionalInfo": "text"
  },
  "correspondenceAddress": {
    "street": "text",
    "streetNumber": "text",
    "city": "text",
    "zip": "text",
    "state": "text",
    "country": "AF",
    "additionalInfo": "text"
  },
  "externalId": "text"
}

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

Get Joint Persons

get

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

/entities/joint-persons

Get joint persons

Authorizations

Bearer

OAuth2clientCredentialsRequired

Token URL:

Query parameters

cursorstringOptional

String value used for pagination

limitinteger · min: 1Required

Maximum number of items to return

Default: 20

jointPersonStatusstring · enumOptional

Joint person status Filter

Possible values:

Responses

200

OK

application/json

400

Bad Request

application/json

get

/entities/joint-persons

HTTPcURLJavaScriptPython

GET /entities/joint-persons?limit=20 HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "data": [
    {
      "annualIncomeNet": 1,
      "sourceOfIncome": [
        "INCOME_FROM_EMPLOYMENT"
      ],
      "availableAssets": 1,
      "originOfAssets": [
        "NON_EMPLOYED_LABOR"
      ],
      "firstNaturalPersonId": "123e4567-e89b-12d3-a456-426614174000",
      "secondNaturalPersonId": "123e4567-e89b-12d3-a456-426614174000",
      "contact": {
        "phone": "text",
        "email": "text",
        "fax": "text",
        "website": "text"
      },
      "mainAddress": {
        "street": "text",
        "streetNumber": "text",
        "city": "text",
        "zip": "text",
        "state": "text",
        "country": "AF",
        "additionalInfo": "text"
      },
      "correspondenceAddress": {
        "street": "text",
        "streetNumber": "text",
        "city": "text",
        "zip": "text",
        "state": "text",
        "country": "AF",
        "additionalInfo": "text"
      },
      "externalId": "text",
      "jointPersonId": "123e4567-e89b-12d3-a456-426614174000",
      "createdOn": "2026-03-18T07:14:22.600Z",
      "modifiedOn": "2026-03-18T07:14:22.600Z",
      "globalId": "text",
      "jointPersonStatus": "CREATED"
    }
  ],
  "pagination": {
    "cursor": "text",
    "limit": 1
  }
}

Update Joint Person

patch

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

/entities/joint-persons/{jointPersonId}

Update existing joint person

Authorizations

Bearer

OAuth2clientCredentialsRequired

Token URL:

Path parameters

jointPersonIdstring · uuidRequired

Joint Person ID

Header parameters

Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body

application/json

annualIncomeNetnumberOptional

Annual income net

availableAssetsnumberOptional

Available assets

externalIdstring · min: 1Optional

External Id in partner's system. This value has to be unique

Responses

202

Accepted

400

Bad Request

application/json

patch

/entities/joint-persons/{jointPersonId}

HTTPcURLJavaScriptPython

PATCH /entities/joint-persons/{jointPersonId} 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: 497

{
  "annualIncomeNet": 1,
  "sourceOfIncome": [
    "INCOME_FROM_EMPLOYMENT"
  ],
  "availableAssets": 1,
  "originOfAssets": [
    "NON_EMPLOYED_LABOR"
  ],
  "contact": {
    "phone": "text",
    "email": "text",
    "fax": "text",
    "website": "text"
  },
  "mainAddress": {
    "street": "text",
    "streetNumber": "text",
    "city": "text",
    "zip": "text",
    "state": "text",
    "country": "AF",
    "additionalInfo": "text"
  },
  "correspondenceAddress": {
    "street": "text",
    "streetNumber": "text",
    "city": "text",
    "zip": "text",
    "state": "text",
    "country": "AF",
    "additionalInfo": "text"
  },
  "externalId": "text"
}

No content

Get Joint Person

get

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

/entities/joint-persons/{jointPersonId}

Get joint person

Authorizations

Bearer

OAuth2clientCredentialsRequired

Token URL:

Path parameters

jointPersonIdstring · uuidRequired

Joint Person ID

Responses

200

OK

application/json

annualIncomeNetnumberOptional

Annual income net

availableAssetsnumberOptional

Available assets

firstNaturalPersonIdstring · uuidRequired

Identifier for the first Natural Person

secondNaturalPersonIdstring · uuidRequired

Identifier for the second Natural Person

externalIdstring · min: 1Optional

External Id in partner's system. This value has to be unique

jointPersonIdstring · uuidRequired

Unique joint person identification number in UUID format

createdOnstring · date-timeRequired

The date on which the joint person was created

modifiedOnstring · date-timeRequired

The date on which the joint person was modified the last time

globalIdstring · min: 12 · max: 12Required

Global ID of the joint person

jointPersonStatusstring · enumRequiredPossible values:

400

Bad Request

application/json

404

Not Found

application/json

get

/entities/joint-persons/{jointPersonId}

HTTPcURLJavaScriptPython

GET /entities/joint-persons/{jointPersonId} HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "annualIncomeNet": 1,
  "sourceOfIncome": [
    "INCOME_FROM_EMPLOYMENT"
  ],
  "availableAssets": 1,
  "originOfAssets": [
    "NON_EMPLOYED_LABOR"
  ],
  "firstNaturalPersonId": "123e4567-e89b-12d3-a456-426614174000",
  "secondNaturalPersonId": "123e4567-e89b-12d3-a456-426614174000",
  "contact": {
    "phone": "text",
    "email": "text",
    "fax": "text",
    "website": "text"
  },
  "mainAddress": {
    "street": "text",
    "streetNumber": "text",
    "city": "text",
    "zip": "text",
    "state": "text",
    "country": "AF",
    "additionalInfo": "text"
  },
  "correspondenceAddress": {
    "street": "text",
    "streetNumber": "text",
    "city": "text",
    "zip": "text",
    "state": "text",
    "country": "AF",
    "additionalInfo": "text"
  },
  "externalId": "text",
  "jointPersonId": "123e4567-e89b-12d3-a456-426614174000",
  "createdOn": "2026-03-18T07:14:22.600Z",
  "modifiedOn": "2026-03-18T07:14:22.600Z",
  "globalId": "text",
  "jointPersonStatus": "CREATED"
}