Proxies

Create Proxy

post

Assign natural persons the role of authorized proxy.

Authorizations
Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body
proxyTypestring · enumRequiredPossible values:
naturalPersonIdstring · uuidRequired

Identifier of the natural person, who will be assigned as proxy.

entityIdstring · uuidRequired

Identifier of the entity, natural person, joint person or legal entity, who will be managed by the proxy.

entityTypestring · enumRequired

Defines the type of entity for which the proxy is assigned.The proxy can be assigned to a natural person, legal entity, or joint person.

Possible values:
productIdsstring · uuid[]Optional

IDs of the customers products for which the proxy is allowed to take actions in behalf of the entity which is customer (multiple products possible).

validityTypestring · enumRequired

Defines the period of validity of the power of proxy.

Possible values:
scopeTypestring · enumOptional

Only mandatory for proxyType SIGNATORY
Defines the scope of the power of representation, which is dependent on the underlying signature authorisation of the legal representative:

  • INDIVIDUAL: If soleSignatureAuthorized of the legal representative = YES
  • JOINT: If soleSignatureAuthorized of the legal representative = NO
Possible values:
custodyTypestring · enumOptional

Only mandatory for proxyType GUARDIAN. Specifies the type of custody associated with the guardian.

  • SINGLE_CUSTODY: Indicates that only one guardian holds legal and physical custody of the child.
  • JOINT_CUSTODY: Indicates that the custody of the child is shared between two guardians, typically implying both have legal rights concerning the child's upbringing.
Possible values:
Responses
200

OK

application/json
post
POST /roles/proxies 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: 325

{
  "proxyType": "GENERAL_POWER_OF_ATTORNEY",
  "naturalPersonId": "123e4567-e89b-12d3-a456-426614174000",
  "entityId": "123e4567-e89b-12d3-a456-426614174000",
  "entityType": "NATURAL_PERSON",
  "productIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "validityType": "UNTIL_CASE_OF_DEATH",
  "scopeType": "INDIVIDUAL",
  "custodyType": "SINGLE_CUSTODY"
}
{
  "proxyId": "123e4567-e89b-12d3-a456-426614174000"
}

Get Proxies

get

Get a list of proxies.

Authorizations
Query parameters
cursorstringOptional

String value used for pagination

limitinteger · min: 1Required

Maximum number of items to return

Default: 20
naturalPersonIdstring · uuidOptional

Natural Person ID

entityIdstring · uuidOptional

Entity ID

proxyStatusstring · enumOptional

Proxy status

Possible values:
proxyTypestring · enumOptional

Proxy type

Possible values:
proxyValidityTypestring · enumOptional

Defines the period of validity of the power of proxy.

Possible values:
customerProductIdsstring · uuid[]Optional

IDs of the customers products for which the proxy is allowed to take actions in behalf of the customer (multiple products possible).

Responses
200

OK

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

{
  "data": [
    {
      "proxyId": "123e4567-e89b-12d3-a456-426614174000",
      "proxyStatus": "CREATED",
      "createdOn": "2025-08-29T15:02:15.135Z",
      "modifiedOn": "2025-08-29T15:02:15.135Z",
      "proxyType": "GENERAL_POWER_OF_ATTORNEY",
      "naturalPersonId": "123e4567-e89b-12d3-a456-426614174000",
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "entityType": "NATURAL_PERSON",
      "productIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "validityType": "UNTIL_CASE_OF_DEATH",
      "scopeType": "INDIVIDUAL",
      "custodyType": "SINGLE_CUSTODY"
    }
  ],
  "pagination": {
    "cursor": "text",
    "limit": 1
  }
}

Get Proxy

get

Get proxy

Authorizations
Path parameters
proxyIdstring · uuidRequired

Proxy ID

Responses
200

OK

application/json
get
GET /roles/proxies/{proxyId} HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "proxyId": "123e4567-e89b-12d3-a456-426614174000",
  "proxyStatus": "CREATED",
  "createdOn": "2025-08-29T15:02:15.135Z",
  "modifiedOn": "2025-08-29T15:02:15.135Z",
  "proxyType": "GENERAL_POWER_OF_ATTORNEY",
  "naturalPersonId": "123e4567-e89b-12d3-a456-426614174000",
  "entityId": "123e4567-e89b-12d3-a456-426614174000",
  "entityType": "NATURAL_PERSON",
  "productIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "validityType": "UNTIL_CASE_OF_DEATH",
  "scopeType": "INDIVIDUAL",
  "custodyType": "SINGLE_CUSTODY"
}

Update Proxy

patch

Update proxy

Authorizations
Path parameters
proxyIdstring · uuidRequired

Proxy ID

Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body
documentIdstring · uuidOptional

Document ID in UUID format for those params where a document upload is required (scopeType, custodyType)

Responses
202

Accepted

No content
patch
PATCH /roles/proxies/{proxyId} 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: 268

{
  "proxyUpdateData": {
    "customerProductIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "validityType": "UNTIL_CASE_OF_DEATH",
    "proxyType": "GENERAL_POWER_OF_ATTORNEY",
    "scopeType": "INDIVIDUAL",
    "custodyType": "SINGLE_CUSTODY"
  },
  "documentId": "123e4567-e89b-12d3-a456-426614174000"
}
No content

Last updated