Joint Persons

Create Joint Person

post

Create new joint person

Authorizations
Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body
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
post
POST /entities/joint-persons 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: 592

{
  "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",
    "country": "AF",
    "additionalInfo": "text"
  },
  "correspondenceAddress": {
    "street": "text",
    "streetNumber": "text",
    "city": "text",
    "zip": "text",
    "country": "AF",
    "additionalInfo": "text"
  },
  "externalId": "text"
}
{
  "jointPersonId": "123e4567-e89b-12d3-a456-426614174000"
}

Get Joint Persons

get

Get joint persons

Authorizations
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
get
GET /entities/joint-persons 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",
        "country": "AF",
        "additionalInfo": "text"
      },
      "correspondenceAddress": {
        "street": "text",
        "streetNumber": "text",
        "city": "text",
        "zip": "text",
        "country": "AF",
        "additionalInfo": "text"
      },
      "externalId": "text",
      "jointPersonId": "123e4567-e89b-12d3-a456-426614174000",
      "createdOn": "2025-08-30T17:51:10.229Z",
      "modifiedOn": "2025-08-30T17:51:10.229Z",
      "globalId": "text",
      "jointPersonStatus": "CREATED"
    }
  ],
  "pagination": {
    "cursor": "text",
    "limit": 1
  }
}

Update Joint Person

patch

Update existing joint person

Authorizations
Path parameters
jointPersonIdstring · uuidRequired

Joint Person ID

Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body
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

patch
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: 467

{
  "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",
    "country": "AF",
    "additionalInfo": "text"
  },
  "correspondenceAddress": {
    "street": "text",
    "streetNumber": "text",
    "city": "text",
    "zip": "text",
    "country": "AF",
    "additionalInfo": "text"
  },
  "externalId": "text"
}
No content

Get Joint Person

get

Get joint person

Authorizations
Path parameters
jointPersonIdstring · uuidRequired

Joint Person ID

Responses
200

OK

application/json
get
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",
    "country": "AF",
    "additionalInfo": "text"
  },
  "correspondenceAddress": {
    "street": "text",
    "streetNumber": "text",
    "city": "text",
    "zip": "text",
    "country": "AF",
    "additionalInfo": "text"
  },
  "externalId": "text",
  "jointPersonId": "123e4567-e89b-12d3-a456-426614174000",
  "createdOn": "2025-08-30T17:51:10.229Z",
  "modifiedOn": "2025-08-30T17:51:10.229Z",
  "globalId": "text",
  "jointPersonStatus": "CREATED"
}

Last updated