search
tradevest.ai

Proxies

hashtag
Create Proxy

post
/roles/proxies

Assign natural persons the role of authorized proxy.

Authorizations
OAuth2clientCredentialsRequired
Token URL:
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
chevron-right
200

OK

application/json
post
/roles/proxies

hashtag
Get Proxies

get
/roles/proxies

Get a list of proxies.

Authorizations
OAuth2clientCredentialsRequired
Token URL:
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
chevron-right
200

OK

application/json
get
/roles/proxies

hashtag
Get Proxy

get
/roles/proxies/{proxyId}

Get proxy

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
proxyIdstring · uuidRequired

Proxy ID

Responses
chevron-right
200

OK

application/json
get
/roles/proxies/{proxyId}

hashtag
Update Proxy

patch
/roles/proxies/{proxyId}

Update proxy

Authorizations
OAuth2clientCredentialsRequired
Token URL:
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
patch
/roles/proxies/{proxyId}
No content

Last updated