# Schemas

## The CustomerData object

```json
{"openapi":"3.0.1","info":{"title":"Roles","version":"1.0"},"components":{"schemas":{"CustomerData":{"title":"CustomerData","type":"object","required":["entityId","entityType"],"properties":{"entityId":{"type":"string","format":"uuid","description":"Identifier of the entity, natural person, joint person or legal entity, who will become a customer."},"entityType":{"$ref":"#/components/schemas/CustomerEntityTypeEnum"},"refAccounts":{"type":"array","items":{"$ref":"#/components/schemas/RefAccountData"}},"labels":{"type":"array","maxLength":16,"items":{"type":"string","minLength":1},"description":"Up to 16 user-defined labels can be provided to allow grouping of customers as per required logic"}}},"CustomerEntityTypeEnum":{"title":"CustomerEntityTypeEnum","type":"string","enum":["NATURAL_PERSON","LEGAL_ENTITY","JOINT_PERSON"]},"RefAccountData":{"title":"RefAccountData","type":"object","properties":{"bankName":{"type":"string","description":"Name of the bank","minLength":1,"maxLength":255,"pattern":"^.*\\S+.*$"},"iban":{"type":"string","description":"IBAN","pattern":"^[A-Z]{2}[0-9A-Z]{14,31}$","maxLength":33},"bic":{"type":"string","description":"BIC (Business Identifier Code) or SWIFT (Society for Worldwide Interbank Financial Telecommunication) code used to identify a bank internationally","minLength":8,"maxLength":11,"pattern":"^[A-Z]{6}[A-Z\\d]{2}(?:[A-Z\\d]{3})?$"},"type":{"$ref":"#/components/schemas/RefAccountTypeEnum"},"ownerName":{"type":"string","description":"full name of the ref account owner or full name of the company owning the ref account","minLength":1,"maxLength":255,"pattern":"^.*\\S+.*$"}},"required":["iban","ownerName"]},"RefAccountTypeEnum":{"title":"RefAccountTypeEnum","type":"string","enum":["PRIMARY","OTHER"],"description":"Reference account type enum"}}}}
```

## The Customer object

```json
{"openapi":"3.0.1","info":{"title":"Roles","version":"1.0"},"components":{"schemas":{"Customer":{"type":"object","required":["createdOn","customerId","customerStatus","entityId","entityType","modifiedOn"],"properties":{"customerId":{"type":"string","format":"uuid"},"customerStatus":{"$ref":"#/components/schemas/CustomerStatusEnum"},"signedDocumentsRelatedToCustomer":{"type":"array","items":{"$ref":"#/components/schemas/DocumentSignatureRelatedToCustomer"}},"createdOn":{"type":"string","format":"date-time","description":"The date on which the customer was created"},"modifiedOn":{"type":"string","format":"date-time","description":"The date on which the customer was updated"},"cancellationDate":{"type":"string","format":"date-time","description":"The date on which the customer was cancelled (date of offboarding)"},"reassessment":{"$ref":"#/components/schemas/Reassessment"},"entityId":{"type":"string","format":"uuid","description":"Identifier of the entity, natural person, joint person or legal entity, who will become a customer."},"entityType":{"$ref":"#/components/schemas/CustomerEntityTypeEnum"},"refAccounts":{"type":"array","items":{"$ref":"#/components/schemas/RefAccountData"}},"labels":{"type":"array","maxLength":16,"items":{"type":"string","minLength":1},"description":"Up to 16 user-defined labels can be provided to allow grouping of customers as per required logic"}},"title":"Customer"},"CustomerStatusEnum":{"title":"CustomerStatusEnum","type":"string","description":"Current customer status","enum":["CREATED","REVIEW","REJECTED","INACTIVE","ACTIVE","SUSPENDED","ARCHIVED","RECEIVED","INVALID","PENDING","SUSPENDED_COMPLIANCE","ESTATE","OFFBOARDING"]},"DocumentSignatureRelatedToCustomer":{"title":"DocumentSignatureRelatedToCustomer","type":"object","properties":{"partnerDocumentId":{"type":"string","format":"uuid","description":"Id of the partner document which was signed"},"name":{"type":"string","minLength":1,"description":"Name of the document"},"documentType":{"$ref":"#/components/schemas/DocumentSignatureTypeEnum"},"version":{"type":"integer","description":"Version of the document"},"naturalPersonId":{"type":"string","format":"uuid","description":"Id of the natural person, which signed the TERMS_AND_CONDITIONS document for the customer"},"naturalPersonFullName":{"type":"string","minLength":1,"description":"Full name of the natural person, which signed the TERMS_AND_CONDITIONS document for the customer"},"createdOn":{"type":"string","format":"date-time","description":"The date on which the document signature was created","readOnly":true},"modifiedOn":{"type":"string","format":"date-time","description":"The date on which the document signature was modified the last time","readOnly":true}},"required":["partnerDocumentId","name","documentType","version","naturalPersonId","naturalPersonFullName","createdOn","modifiedOn"]},"DocumentSignatureTypeEnum":{"title":"DocumentSignatureTypeEnum","type":"string","enum":["TERMS_AND_CONDITIONS","DATA_PRIVACY_POLICY"]},"Reassessment":{"title":"Reassessment","type":"object","properties":{"reassessmentDate":{"type":"string","format":"date"},"reassessmentType":{"$ref":"#/components/schemas/ReassessmentTypeEnum"},"reassessmentStatus":{"$ref":"#/components/schemas/ReassessmentStatusEnum"}},"required":["reassessmentDate","reassessmentType","reassessmentStatus"]},"ReassessmentTypeEnum":{"title":"ReassessmentTypeEnum","type":"string","enum":["PERIODIC","EVENT_DRIVEN"]},"ReassessmentStatusEnum":{"title":"ReassessmentStatusEnum","type":"string","enum":["SCHEDULED","PENDING","OVERDUE","COMPLETED"]},"CustomerEntityTypeEnum":{"title":"CustomerEntityTypeEnum","type":"string","enum":["NATURAL_PERSON","LEGAL_ENTITY","JOINT_PERSON"]},"RefAccountData":{"title":"RefAccountData","type":"object","properties":{"bankName":{"type":"string","description":"Name of the bank","minLength":1,"maxLength":255,"pattern":"^.*\\S+.*$"},"iban":{"type":"string","description":"IBAN","pattern":"^[A-Z]{2}[0-9A-Z]{14,31}$","maxLength":33},"bic":{"type":"string","description":"BIC (Business Identifier Code) or SWIFT (Society for Worldwide Interbank Financial Telecommunication) code used to identify a bank internationally","minLength":8,"maxLength":11,"pattern":"^[A-Z]{6}[A-Z\\d]{2}(?:[A-Z\\d]{3})?$"},"type":{"$ref":"#/components/schemas/RefAccountTypeEnum"},"ownerName":{"type":"string","description":"full name of the ref account owner or full name of the company owning the ref account","minLength":1,"maxLength":255,"pattern":"^.*\\S+.*$"}},"required":["iban","ownerName"]},"RefAccountTypeEnum":{"title":"RefAccountTypeEnum","type":"string","enum":["PRIMARY","OTHER"],"description":"Reference account type enum"}}}}
```

## The Customers object

```json
{"openapi":"3.0.1","info":{"title":"Roles","version":"1.0"},"components":{"schemas":{"Customers":{"title":"Customers","type":"object","properties":{"data":{"type":"array","description":"Array of customers","items":{"$ref":"#/components/schemas/Customer"}},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data","pagination"]},"Customer":{"type":"object","required":["createdOn","customerId","customerStatus","entityId","entityType","modifiedOn"],"properties":{"customerId":{"type":"string","format":"uuid"},"customerStatus":{"$ref":"#/components/schemas/CustomerStatusEnum"},"signedDocumentsRelatedToCustomer":{"type":"array","items":{"$ref":"#/components/schemas/DocumentSignatureRelatedToCustomer"}},"createdOn":{"type":"string","format":"date-time","description":"The date on which the customer was created"},"modifiedOn":{"type":"string","format":"date-time","description":"The date on which the customer was updated"},"cancellationDate":{"type":"string","format":"date-time","description":"The date on which the customer was cancelled (date of offboarding)"},"reassessment":{"$ref":"#/components/schemas/Reassessment"},"entityId":{"type":"string","format":"uuid","description":"Identifier of the entity, natural person, joint person or legal entity, who will become a customer."},"entityType":{"$ref":"#/components/schemas/CustomerEntityTypeEnum"},"refAccounts":{"type":"array","items":{"$ref":"#/components/schemas/RefAccountData"}},"labels":{"type":"array","maxLength":16,"items":{"type":"string","minLength":1},"description":"Up to 16 user-defined labels can be provided to allow grouping of customers as per required logic"}},"title":"Customer"},"CustomerStatusEnum":{"title":"CustomerStatusEnum","type":"string","description":"Current customer status","enum":["CREATED","REVIEW","REJECTED","INACTIVE","ACTIVE","SUSPENDED","ARCHIVED","RECEIVED","INVALID","PENDING","SUSPENDED_COMPLIANCE","ESTATE","OFFBOARDING"]},"DocumentSignatureRelatedToCustomer":{"title":"DocumentSignatureRelatedToCustomer","type":"object","properties":{"partnerDocumentId":{"type":"string","format":"uuid","description":"Id of the partner document which was signed"},"name":{"type":"string","minLength":1,"description":"Name of the document"},"documentType":{"$ref":"#/components/schemas/DocumentSignatureTypeEnum"},"version":{"type":"integer","description":"Version of the document"},"naturalPersonId":{"type":"string","format":"uuid","description":"Id of the natural person, which signed the TERMS_AND_CONDITIONS document for the customer"},"naturalPersonFullName":{"type":"string","minLength":1,"description":"Full name of the natural person, which signed the TERMS_AND_CONDITIONS document for the customer"},"createdOn":{"type":"string","format":"date-time","description":"The date on which the document signature was created","readOnly":true},"modifiedOn":{"type":"string","format":"date-time","description":"The date on which the document signature was modified the last time","readOnly":true}},"required":["partnerDocumentId","name","documentType","version","naturalPersonId","naturalPersonFullName","createdOn","modifiedOn"]},"DocumentSignatureTypeEnum":{"title":"DocumentSignatureTypeEnum","type":"string","enum":["TERMS_AND_CONDITIONS","DATA_PRIVACY_POLICY"]},"Reassessment":{"title":"Reassessment","type":"object","properties":{"reassessmentDate":{"type":"string","format":"date"},"reassessmentType":{"$ref":"#/components/schemas/ReassessmentTypeEnum"},"reassessmentStatus":{"$ref":"#/components/schemas/ReassessmentStatusEnum"}},"required":["reassessmentDate","reassessmentType","reassessmentStatus"]},"ReassessmentTypeEnum":{"title":"ReassessmentTypeEnum","type":"string","enum":["PERIODIC","EVENT_DRIVEN"]},"ReassessmentStatusEnum":{"title":"ReassessmentStatusEnum","type":"string","enum":["SCHEDULED","PENDING","OVERDUE","COMPLETED"]},"CustomerEntityTypeEnum":{"title":"CustomerEntityTypeEnum","type":"string","enum":["NATURAL_PERSON","LEGAL_ENTITY","JOINT_PERSON"]},"RefAccountData":{"title":"RefAccountData","type":"object","properties":{"bankName":{"type":"string","description":"Name of the bank","minLength":1,"maxLength":255,"pattern":"^.*\\S+.*$"},"iban":{"type":"string","description":"IBAN","pattern":"^[A-Z]{2}[0-9A-Z]{14,31}$","maxLength":33},"bic":{"type":"string","description":"BIC (Business Identifier Code) or SWIFT (Society for Worldwide Interbank Financial Telecommunication) code used to identify a bank internationally","minLength":8,"maxLength":11,"pattern":"^[A-Z]{6}[A-Z\\d]{2}(?:[A-Z\\d]{3})?$"},"type":{"$ref":"#/components/schemas/RefAccountTypeEnum"},"ownerName":{"type":"string","description":"full name of the ref account owner or full name of the company owning the ref account","minLength":1,"maxLength":255,"pattern":"^.*\\S+.*$"}},"required":["iban","ownerName"]},"RefAccountTypeEnum":{"title":"RefAccountTypeEnum","type":"string","enum":["PRIMARY","OTHER"],"description":"Reference account type enum"},"Pagination":{"title":"Pagination","type":"object","properties":{"cursor":{"type":"string","description":"String value used for pagination, which should be set in next page request."},"limit":{"type":"integer","description":"Maximum number of returned items"}},"required":["cursor","limit"]}}}}
```

## The CustomerUpdate object

```json
{"openapi":"3.0.1","info":{"title":"Roles","version":"1.0"},"components":{"schemas":{"CustomerUpdate":{"title":"CustomerUpdate","type":"object","properties":{"labels":{"type":"array","maxLength":16,"description":"Up to 16 user-defined labels can be provided to allow grouping of customers as per required logic","items":{"type":"string","minLength":1}},"refAccounts":{"type":"array","items":{"$ref":"#/components/schemas/RefAccountData"}}}},"RefAccountData":{"title":"RefAccountData","type":"object","properties":{"bankName":{"type":"string","description":"Name of the bank","minLength":1,"maxLength":255,"pattern":"^.*\\S+.*$"},"iban":{"type":"string","description":"IBAN","pattern":"^[A-Z]{2}[0-9A-Z]{14,31}$","maxLength":33},"bic":{"type":"string","description":"BIC (Business Identifier Code) or SWIFT (Society for Worldwide Interbank Financial Telecommunication) code used to identify a bank internationally","minLength":8,"maxLength":11,"pattern":"^[A-Z]{6}[A-Z\\d]{2}(?:[A-Z\\d]{3})?$"},"type":{"$ref":"#/components/schemas/RefAccountTypeEnum"},"ownerName":{"type":"string","description":"full name of the ref account owner or full name of the company owning the ref account","minLength":1,"maxLength":255,"pattern":"^.*\\S+.*$"}},"required":["iban","ownerName"]},"RefAccountTypeEnum":{"title":"RefAccountTypeEnum","type":"string","enum":["PRIMARY","OTHER"],"description":"Reference account type enum"}}}}
```

## The CreateCustomerResult object

```json
{"openapi":"3.0.1","info":{"title":"Roles","version":"1.0"},"components":{"schemas":{"CreateCustomerResult":{"title":"CreateCustomerResult","type":"object","properties":{"customerId":{"type":"string","format":"uuid","readOnly":true}},"required":["customerId"]}}}}
```

## The ProxyData object

```json
{"openapi":"3.0.1","info":{"title":"Roles","version":"1.0"},"components":{"schemas":{"ProxyData":{"title":"ProxyData","type":"object","required":["naturalPersonId","entityId","entityType","validityType"],"properties":{"naturalPersonId":{"type":"string","format":"uuid","description":"Identifier of the natural person, who will be assigned as proxy."},"entityId":{"type":"string","format":"uuid","description":"Identifier of the entity, natural person, joint person or legal entity, who will be managed by the proxy."},"entityType":{"$ref":"#/components/schemas/ProxyEntityTypeEnum"},"productIds":{"type":"array","description":"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).","items":{"type":"string","format":"uuid"}},"validityType":{"$ref":"#/components/schemas/ProxyValidityTypeEnum"},"scopeType":{"$ref":"#/components/schemas/ProxyScopeTypeEnum"},"custodyType":{"$ref":"#/components/schemas/ProxyCustodyTypeEnum"}}},"ProxyEntityTypeEnum":{"title":"ProxyEntityTypeEnum","type":"string","description":"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.","enum":["NATURAL_PERSON","LEGAL_ENTITY","JOINT_PERSON"]},"ProxyValidityTypeEnum":{"title":"ProxyValidityTypeEnum","type":"string","description":"Defines the period of validity of the power of proxy.","enum":["UNTIL_CASE_OF_DEATH","IN_CASE_OF_DEATH","UNTIL_LEGAL_AGE","UNLIMITED"]},"ProxyScopeTypeEnum":{"title":"ProxyScopeTypeEnum","type":"string","enum":["INDIVIDUAL","JOINT"],"description":"Only mandatory for proxyType `SIGNATORY`\\\nDefines the scope of the power of representation, which is dependent on the underlying signature authorisation of the legal representative:\n- INDIVIDUAL: If soleSignatureAuthorized of the legal representative = YES\n- JOINT: If soleSignatureAuthorized of the legal representative = NO\n"},"ProxyCustodyTypeEnum":{"title":"ProxyCustodyTypeEnum","type":"string","enum":["SINGLE_CUSTODY","JOINT_CUSTODY"],"description":"Only mandatory for proxyType `GUARDIAN`.\nSpecifies the type of custody associated with the guardian. \n- `SINGLE_CUSTODY`: Indicates that only one guardian holds legal and physical custody of the child.\n- `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.\n"}}}}
```

## The ProxyCreateData object

```json
{"openapi":"3.0.1","info":{"title":"Roles","version":"1.0"},"components":{"schemas":{"ProxyCreateData":{"type":"object","required":["entityId","entityType","naturalPersonId","proxyType","validityType"],"properties":{"proxyType":{"$ref":"#/components/schemas/ProxyTypeAssignableEnum"},"naturalPersonId":{"type":"string","format":"uuid","description":"Identifier of the natural person, who will be assigned as proxy."},"entityId":{"type":"string","format":"uuid","description":"Identifier of the entity, natural person, joint person or legal entity, who will be managed by the proxy."},"entityType":{"$ref":"#/components/schemas/ProxyEntityTypeEnum"},"productIds":{"type":"array","description":"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).","items":{"type":"string","format":"uuid"}},"validityType":{"$ref":"#/components/schemas/ProxyValidityTypeEnum"},"scopeType":{"$ref":"#/components/schemas/ProxyScopeTypeEnum"},"custodyType":{"$ref":"#/components/schemas/ProxyCustodyTypeEnum"}},"title":"ProxyCreateData"},"ProxyTypeAssignableEnum":{"title":"ProxyTypeAssignableEnum","type":"string","enum":["GENERAL_POWER_OF_ATTORNEY","INFORMATION_PROXY","LIQUIDATOR","GUARDIAN","SIGNATORY"]},"ProxyEntityTypeEnum":{"title":"ProxyEntityTypeEnum","type":"string","description":"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.","enum":["NATURAL_PERSON","LEGAL_ENTITY","JOINT_PERSON"]},"ProxyValidityTypeEnum":{"title":"ProxyValidityTypeEnum","type":"string","description":"Defines the period of validity of the power of proxy.","enum":["UNTIL_CASE_OF_DEATH","IN_CASE_OF_DEATH","UNTIL_LEGAL_AGE","UNLIMITED"]},"ProxyScopeTypeEnum":{"title":"ProxyScopeTypeEnum","type":"string","enum":["INDIVIDUAL","JOINT"],"description":"Only mandatory for proxyType `SIGNATORY`\\\nDefines the scope of the power of representation, which is dependent on the underlying signature authorisation of the legal representative:\n- INDIVIDUAL: If soleSignatureAuthorized of the legal representative = YES\n- JOINT: If soleSignatureAuthorized of the legal representative = NO\n"},"ProxyCustodyTypeEnum":{"title":"ProxyCustodyTypeEnum","type":"string","enum":["SINGLE_CUSTODY","JOINT_CUSTODY"],"description":"Only mandatory for proxyType `GUARDIAN`.\nSpecifies the type of custody associated with the guardian. \n- `SINGLE_CUSTODY`: Indicates that only one guardian holds legal and physical custody of the child.\n- `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.\n"}}}}
```

## The Proxy object

```json
{"openapi":"3.0.1","info":{"title":"Roles","version":"1.0"},"components":{"schemas":{"Proxy":{"type":"object","required":["createdOn","entityId","entityType","modifiedOn","naturalPersonId","proxyId","proxyStatus","proxyType","validityType"],"properties":{"proxyId":{"type":"string","format":"uuid"},"proxyStatus":{"$ref":"#/components/schemas/ProxyStatusEnum"},"createdOn":{"type":"string","format":"date-time","description":"The date on which the proxy was created"},"modifiedOn":{"type":"string","format":"date-time","description":"The date on which the proxy was updated"},"proxyType":{"$ref":"#/components/schemas/ProxyTypeEnum"},"naturalPersonId":{"type":"string","format":"uuid","description":"Identifier of the natural person, who will be assigned as proxy."},"entityId":{"type":"string","format":"uuid","description":"Identifier of the entity, natural person, joint person or legal entity, who will be managed by the proxy."},"entityType":{"$ref":"#/components/schemas/ProxyEntityTypeEnum"},"productIds":{"type":"array","description":"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).","items":{"type":"string","format":"uuid"}},"validityType":{"$ref":"#/components/schemas/ProxyValidityTypeEnum"},"scopeType":{"$ref":"#/components/schemas/ProxyScopeTypeEnum"},"custodyType":{"$ref":"#/components/schemas/ProxyCustodyTypeEnum"}},"title":"Proxy"},"ProxyStatusEnum":{"title":"ProxyStatusEnum","type":"string","enum":["CREATED","REVIEW","REJECTED","ACTIVE","INACTIVE","RECEIVED","INVALID","PENDING","SUSPENDED","SUSPENDED_COMPLIANCE"]},"ProxyTypeEnum":{"title":"ProxyTypeEnum","type":"string","enum":["GENERAL_POWER_OF_ATTORNEY","INFORMATION_PROXY","LIQUIDATOR","GUARDIAN","SIGNATORY","JOINT_ACCOUNT_HOLDER"]},"ProxyEntityTypeEnum":{"title":"ProxyEntityTypeEnum","type":"string","description":"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.","enum":["NATURAL_PERSON","LEGAL_ENTITY","JOINT_PERSON"]},"ProxyValidityTypeEnum":{"title":"ProxyValidityTypeEnum","type":"string","description":"Defines the period of validity of the power of proxy.","enum":["UNTIL_CASE_OF_DEATH","IN_CASE_OF_DEATH","UNTIL_LEGAL_AGE","UNLIMITED"]},"ProxyScopeTypeEnum":{"title":"ProxyScopeTypeEnum","type":"string","enum":["INDIVIDUAL","JOINT"],"description":"Only mandatory for proxyType `SIGNATORY`\\\nDefines the scope of the power of representation, which is dependent on the underlying signature authorisation of the legal representative:\n- INDIVIDUAL: If soleSignatureAuthorized of the legal representative = YES\n- JOINT: If soleSignatureAuthorized of the legal representative = NO\n"},"ProxyCustodyTypeEnum":{"title":"ProxyCustodyTypeEnum","type":"string","enum":["SINGLE_CUSTODY","JOINT_CUSTODY"],"description":"Only mandatory for proxyType `GUARDIAN`.\nSpecifies the type of custody associated with the guardian. \n- `SINGLE_CUSTODY`: Indicates that only one guardian holds legal and physical custody of the child.\n- `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.\n"}}}}
```

## The Proxies object

```json
{"openapi":"3.0.1","info":{"title":"Roles","version":"1.0"},"components":{"schemas":{"Proxies":{"title":"Proxies","type":"object","properties":{"data":{"type":"array","description":"Array of proxies","items":{"$ref":"#/components/schemas/Proxy"}},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data","pagination"]},"Proxy":{"type":"object","required":["createdOn","entityId","entityType","modifiedOn","naturalPersonId","proxyId","proxyStatus","proxyType","validityType"],"properties":{"proxyId":{"type":"string","format":"uuid"},"proxyStatus":{"$ref":"#/components/schemas/ProxyStatusEnum"},"createdOn":{"type":"string","format":"date-time","description":"The date on which the proxy was created"},"modifiedOn":{"type":"string","format":"date-time","description":"The date on which the proxy was updated"},"proxyType":{"$ref":"#/components/schemas/ProxyTypeEnum"},"naturalPersonId":{"type":"string","format":"uuid","description":"Identifier of the natural person, who will be assigned as proxy."},"entityId":{"type":"string","format":"uuid","description":"Identifier of the entity, natural person, joint person or legal entity, who will be managed by the proxy."},"entityType":{"$ref":"#/components/schemas/ProxyEntityTypeEnum"},"productIds":{"type":"array","description":"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).","items":{"type":"string","format":"uuid"}},"validityType":{"$ref":"#/components/schemas/ProxyValidityTypeEnum"},"scopeType":{"$ref":"#/components/schemas/ProxyScopeTypeEnum"},"custodyType":{"$ref":"#/components/schemas/ProxyCustodyTypeEnum"}},"title":"Proxy"},"ProxyStatusEnum":{"title":"ProxyStatusEnum","type":"string","enum":["CREATED","REVIEW","REJECTED","ACTIVE","INACTIVE","RECEIVED","INVALID","PENDING","SUSPENDED","SUSPENDED_COMPLIANCE"]},"ProxyTypeEnum":{"title":"ProxyTypeEnum","type":"string","enum":["GENERAL_POWER_OF_ATTORNEY","INFORMATION_PROXY","LIQUIDATOR","GUARDIAN","SIGNATORY","JOINT_ACCOUNT_HOLDER"]},"ProxyEntityTypeEnum":{"title":"ProxyEntityTypeEnum","type":"string","description":"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.","enum":["NATURAL_PERSON","LEGAL_ENTITY","JOINT_PERSON"]},"ProxyValidityTypeEnum":{"title":"ProxyValidityTypeEnum","type":"string","description":"Defines the period of validity of the power of proxy.","enum":["UNTIL_CASE_OF_DEATH","IN_CASE_OF_DEATH","UNTIL_LEGAL_AGE","UNLIMITED"]},"ProxyScopeTypeEnum":{"title":"ProxyScopeTypeEnum","type":"string","enum":["INDIVIDUAL","JOINT"],"description":"Only mandatory for proxyType `SIGNATORY`\\\nDefines the scope of the power of representation, which is dependent on the underlying signature authorisation of the legal representative:\n- INDIVIDUAL: If soleSignatureAuthorized of the legal representative = YES\n- JOINT: If soleSignatureAuthorized of the legal representative = NO\n"},"ProxyCustodyTypeEnum":{"title":"ProxyCustodyTypeEnum","type":"string","enum":["SINGLE_CUSTODY","JOINT_CUSTODY"],"description":"Only mandatory for proxyType `GUARDIAN`.\nSpecifies the type of custody associated with the guardian. \n- `SINGLE_CUSTODY`: Indicates that only one guardian holds legal and physical custody of the child.\n- `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.\n"},"Pagination":{"title":"Pagination","type":"object","properties":{"cursor":{"type":"string","description":"String value used for pagination, which should be set in next page request."},"limit":{"type":"integer","description":"Maximum number of returned items"}},"required":["cursor","limit"]}}}}
```

## The CreateProxyResult object

```json
{"openapi":"3.0.1","info":{"title":"Roles","version":"1.0"},"components":{"schemas":{"CreateProxyResult":{"title":"CreateProxyResult","type":"object","properties":{"proxyId":{"type":"string","format":"uuid","readOnly":true}},"required":["proxyId"]}}}}
```

## The ProxyUpdate object

```json
{"openapi":"3.0.1","info":{"title":"Roles","version":"1.0"},"components":{"schemas":{"ProxyUpdate":{"title":"ProxyUpdate","type":"object","properties":{"proxyUpdateData":{"$ref":"#/components/schemas/ProxyUpdateData"},"documentId":{"type":"string","format":"uuid","description":"Document ID in UUID format for those params where a document upload is required (scopeType, custodyType)"}},"required":["proxyUpdateData"]},"ProxyUpdateData":{"title":"ProxyUpdateData","type":"object","properties":{"customerProductIds":{"type":"array","description":"Update only possible for proxyType `POWER_OF_ATTORNEY` and `INFORMATION_PROXY`.\\\nIDs of the customers products for which the proxy is allowed to take actions in behalf of the customer (multiple products possible).\n","items":{"type":"string","format":"uuid"}},"validityType":{"$ref":"#/components/schemas/ProxyUpdateValidityTypeEnum"},"proxyType":{"$ref":"#/components/schemas/ProxyUpdateTypeEnum"},"scopeType":{"title":"ProxyScopeTypeEnum","type":"string","enum":["INDIVIDUAL","JOINT"],"description":"Update only possible for for proxyType `SIGNATORY`\nDefines the scope of the power of representation, which is dependent on the underlying signature authorisation of the legal representative:\n- INDIVIDUAL: If soleSignatureAuthorized of the legal representative = YES\n- JOINT: If soleSignatureAuthorized of the legal representative = NO\nA corresponding document (registry extract) must be submitted to update the scope type. When uploading the document via respecting endpoint, the exact document name must be specified under ‘name’ and ‘CURRENT_REGISTRY_EXTRACT’ must be selected as the type.\n"},"custodyType":{"title":"ProxyCustodyTypeEnum","type":"string","enum":["SINGLE_CUSTODY","JOINT_CUSTODY"],"description":"Update only possible for proxyType `GUARDIAN`.\nSpecifies the type of custody associated with the guardian.\n- `SINGLE_CUSTODY`: Indicates that only one guardian holds legal and physical custody of the child.\n- `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.\nA corresponding document (proof of single custody) must be submitted to update the custody type. When uploading the document via respecting endpoint, the exact document name must be specified under ‘name’ and ‘PROOF_OF_SINGLE_CUSTODY’ must be selected as the type.\n"}}},"ProxyUpdateValidityTypeEnum":{"title":"ProxyUpdateValidityTypeEnum","type":"string","description":"Update only possible for proxyType `POWER_OF_ATTORNEY` and `INFORMATION_PROXY`. Defines the period of validity of the power of proxy.","enum":["UNTIL_CASE_OF_DEATH","UNLIMITED"]},"ProxyUpdateTypeEnum":{"title":"ProxyUpdateTypeEnum","type":"string","enum":["GENERAL_POWER_OF_ATTORNEY","INFORMATION_PROXY","LIQUIDATOR","GUARDIAN","SIGNATORY"]}}}}
```

## The ProxyUpdateData object

```json
{"openapi":"3.0.1","info":{"title":"Roles","version":"1.0"},"components":{"schemas":{"ProxyUpdateData":{"title":"ProxyUpdateData","type":"object","properties":{"customerProductIds":{"type":"array","description":"Update only possible for proxyType `POWER_OF_ATTORNEY` and `INFORMATION_PROXY`.\\\nIDs of the customers products for which the proxy is allowed to take actions in behalf of the customer (multiple products possible).\n","items":{"type":"string","format":"uuid"}},"validityType":{"$ref":"#/components/schemas/ProxyUpdateValidityTypeEnum"},"proxyType":{"$ref":"#/components/schemas/ProxyUpdateTypeEnum"},"scopeType":{"title":"ProxyScopeTypeEnum","type":"string","enum":["INDIVIDUAL","JOINT"],"description":"Update only possible for for proxyType `SIGNATORY`\nDefines the scope of the power of representation, which is dependent on the underlying signature authorisation of the legal representative:\n- INDIVIDUAL: If soleSignatureAuthorized of the legal representative = YES\n- JOINT: If soleSignatureAuthorized of the legal representative = NO\nA corresponding document (registry extract) must be submitted to update the scope type. When uploading the document via respecting endpoint, the exact document name must be specified under ‘name’ and ‘CURRENT_REGISTRY_EXTRACT’ must be selected as the type.\n"},"custodyType":{"title":"ProxyCustodyTypeEnum","type":"string","enum":["SINGLE_CUSTODY","JOINT_CUSTODY"],"description":"Update only possible for proxyType `GUARDIAN`.\nSpecifies the type of custody associated with the guardian.\n- `SINGLE_CUSTODY`: Indicates that only one guardian holds legal and physical custody of the child.\n- `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.\nA corresponding document (proof of single custody) must be submitted to update the custody type. When uploading the document via respecting endpoint, the exact document name must be specified under ‘name’ and ‘PROOF_OF_SINGLE_CUSTODY’ must be selected as the type.\n"}}},"ProxyUpdateValidityTypeEnum":{"title":"ProxyUpdateValidityTypeEnum","type":"string","description":"Update only possible for proxyType `POWER_OF_ATTORNEY` and `INFORMATION_PROXY`. Defines the period of validity of the power of proxy.","enum":["UNTIL_CASE_OF_DEATH","UNLIMITED"]},"ProxyUpdateTypeEnum":{"title":"ProxyUpdateTypeEnum","type":"string","enum":["GENERAL_POWER_OF_ATTORNEY","INFORMATION_PROXY","LIQUIDATOR","GUARDIAN","SIGNATORY"]}}}}
```

## The RefAccountData object

```json
{"openapi":"3.0.1","info":{"title":"Roles","version":"1.0"},"components":{"schemas":{"RefAccountData":{"title":"RefAccountData","type":"object","properties":{"bankName":{"type":"string","description":"Name of the bank","minLength":1,"maxLength":255,"pattern":"^.*\\S+.*$"},"iban":{"type":"string","description":"IBAN","pattern":"^[A-Z]{2}[0-9A-Z]{14,31}$","maxLength":33},"bic":{"type":"string","description":"BIC (Business Identifier Code) or SWIFT (Society for Worldwide Interbank Financial Telecommunication) code used to identify a bank internationally","minLength":8,"maxLength":11,"pattern":"^[A-Z]{6}[A-Z\\d]{2}(?:[A-Z\\d]{3})?$"},"type":{"$ref":"#/components/schemas/RefAccountTypeEnum"},"ownerName":{"type":"string","description":"full name of the ref account owner or full name of the company owning the ref account","minLength":1,"maxLength":255,"pattern":"^.*\\S+.*$"}},"required":["iban","ownerName"]},"RefAccountTypeEnum":{"title":"RefAccountTypeEnum","type":"string","enum":["PRIMARY","OTHER"],"description":"Reference account type enum"}}}}
```

## The DocumentSignatureRelatedToCustomer object

```json
{"openapi":"3.0.1","info":{"title":"Roles","version":"1.0"},"components":{"schemas":{"DocumentSignatureRelatedToCustomer":{"title":"DocumentSignatureRelatedToCustomer","type":"object","properties":{"partnerDocumentId":{"type":"string","format":"uuid","description":"Id of the partner document which was signed"},"name":{"type":"string","minLength":1,"description":"Name of the document"},"documentType":{"$ref":"#/components/schemas/DocumentSignatureTypeEnum"},"version":{"type":"integer","description":"Version of the document"},"naturalPersonId":{"type":"string","format":"uuid","description":"Id of the natural person, which signed the TERMS_AND_CONDITIONS document for the customer"},"naturalPersonFullName":{"type":"string","minLength":1,"description":"Full name of the natural person, which signed the TERMS_AND_CONDITIONS document for the customer"},"createdOn":{"type":"string","format":"date-time","description":"The date on which the document signature was created","readOnly":true},"modifiedOn":{"type":"string","format":"date-time","description":"The date on which the document signature was modified the last time","readOnly":true}},"required":["partnerDocumentId","name","documentType","version","naturalPersonId","naturalPersonFullName","createdOn","modifiedOn"]},"DocumentSignatureTypeEnum":{"title":"DocumentSignatureTypeEnum","type":"string","enum":["TERMS_AND_CONDITIONS","DATA_PRIVACY_POLICY"]}}}}
```

## The CustomerLabelWithAssignedCustomersCount object

```json
{"openapi":"3.0.1","info":{"title":"Roles","version":"1.0"},"components":{"schemas":{"CustomerLabelWithAssignedCustomersCount":{"title":"CustomerLabelWithAssignedCustomersCount","type":"object","properties":{"label":{"type":"string","minLength":1,"description":"name of customer label"},"customersCount":{"type":"integer","description":"number of customers assigned to label"}},"required":["label","customersCount"]}}}}
```

## The CustomerLabelUpdate object

```json
{"openapi":"3.0.1","info":{"title":"Roles","version":"1.0"},"components":{"schemas":{"CustomerLabelUpdate":{"title":"CustomerLabelUpdate","type":"object","properties":{"name":{"type":"string","minLength":1,"description":"name of customer label"}},"required":["name"]}}}}
```

## The StartOnboardingResult object

```json
{"openapi":"3.0.1","info":{"title":"Roles","version":"1.0"},"components":{"schemas":{"StartOnboardingResult":{"title":"StartOnboardingResult","type":"object","properties":{"onboardingId":{"type":"string","format":"uuid","readOnly":true}},"required":["onboardingId"]}}}}
```

## The RoleOnboardingData object

```json
{"openapi":"3.0.1","info":{"title":"Roles","version":"1.0"},"components":{"schemas":{"RoleOnboardingData":{"title":"RoleOnboardingData","type":"object","properties":{"roleType":{"$ref":"#/components/schemas/OnboardingRoleTypeEnum"},"roleId":{"type":"string","format":"uuid","description":"Identification number in UUID format of the role (customer or proxy)"}},"required":["roleType","roleId"]},"OnboardingRoleTypeEnum":{"title":"OnboardingRoleTypeEnum","type":"string","enum":["CUSTOMER","PROXY"]}}}}
```

## The RoleOnboarding object

```json
{"openapi":"3.0.1","info":{"title":"Roles","version":"1.0"},"components":{"schemas":{"RoleOnboarding":{"type":"object","properties":{"onboardingId":{"type":"string","format":"uuid","readOnly":true},"status":{"$ref":"#/components/schemas/OnboardingStatusEnum"},"roleType":{"$ref":"#/components/schemas/OnboardingRoleTypeEnum"},"roleId":{"type":"string","format":"uuid","description":"Identification number in UUID format of the role (customer or proxy)"},"createdOn":{"type":"string","format":"date-time","readOnly":true},"modifiedOn":{"type":"string","format":"date-time","readOnly":true}},"required":["createdOn","modifiedOn","onboardingId","roleId","roleType","status"],"title":"RoleOnboarding"},"OnboardingStatusEnum":{"title":"OnboardingStatusEnum","type":"string","enum":["CREATED","PENDING","APPROVED","REJECTED","RECEIVED","INVALID"],"readOnly":true},"OnboardingRoleTypeEnum":{"title":"OnboardingRoleTypeEnum","type":"string","enum":["CUSTOMER","PROXY"]}}}}
```

## The StartOffboardingResult object

```json
{"openapi":"3.0.1","info":{"title":"Roles","version":"1.0"},"components":{"schemas":{"StartOffboardingResult":{"title":"StartOffboardingResult","type":"object","properties":{"offboardingId":{"type":"string","format":"uuid","readOnly":true}},"required":["offboardingId"]}}}}
```

## The RoleOffboardingData object

```json
{"openapi":"3.0.1","info":{"title":"Roles","version":"1.0"},"components":{"schemas":{"RoleOffboardingData":{"title":"RoleOnboardingData","type":"object","properties":{"roleType":{"$ref":"#/components/schemas/OffboardingRoleTypeEnum"},"roleId":{"type":"string","format":"uuid","description":"Identification number in UUID format of the role (customer or proxy)"},"reason":{"$ref":"#/components/schemas/OffboardingReasonEnum"}},"required":["roleType","roleId","reason"]},"OffboardingRoleTypeEnum":{"title":"OffboardingRoleTypeEnum","type":"string","enum":["CUSTOMER","PROXY"]},"OffboardingReasonEnum":{"title":"OffboardingReasonEnum","type":"string","enum":["CUSTOMER_REQUEST_IMMEDIATE","CANCELLATION_BY_PARTNER_ORDINARY","CANCELLATION_BY_PARTNER_IMMEDIATE","DEATH_IMMEDIATE","DISSOLUTION_IMMEDIATE","INSOLVENCY_IMMEDIATE","COMPANY_STRUCTURE_CHANGES_IMMEDIATE"]}}}}
```

## The RoleOffboarding object

```json
{"openapi":"3.0.1","info":{"title":"Roles","version":"1.0"},"components":{"schemas":{"RoleOffboarding":{"type":"object","properties":{"offboardingId":{"type":"string","format":"uuid","readOnly":true},"status":{"$ref":"#/components/schemas/OffboardingStatusEnum"},"roleType":{"$ref":"#/components/schemas/OffboardingRoleTypeEnum"},"roleId":{"type":"string","format":"uuid","description":"Identification number in UUID format of the role (customer or proxy)"},"reason":{"$ref":"#/components/schemas/OffboardingReasonEnum"},"createdOn":{"type":"string","format":"date-time","readOnly":true},"modifiedOn":{"type":"string","format":"date-time","readOnly":true}},"required":["createdOn","modifiedOn","offboardingId","reason","roleId","roleType","status"],"title":"RoleOffboarding"},"OffboardingStatusEnum":{"title":"OffboardingStatusEnum","type":"string","enum":["RECEIVED","CREATED","PENDING","INVALID","REJECTED","CANCELED","APPROVED"],"readOnly":true},"OffboardingRoleTypeEnum":{"title":"OffboardingRoleTypeEnum","type":"string","enum":["CUSTOMER","PROXY"]},"OffboardingReasonEnum":{"title":"OffboardingReasonEnum","type":"string","enum":["CUSTOMER_REQUEST_IMMEDIATE","CANCELLATION_BY_PARTNER_ORDINARY","CANCELLATION_BY_PARTNER_IMMEDIATE","DEATH_IMMEDIATE","DISSOLUTION_IMMEDIATE","INSOLVENCY_IMMEDIATE","COMPANY_STRUCTURE_CHANGES_IMMEDIATE"]}}}}
```

## The CustomerStatusCounts object

```json
{"openapi":"3.0.1","info":{"title":"Roles","version":"1.0"},"components":{"schemas":{"CustomerStatusCounts":{"title":"CustomerStatusCounts","type":"array","items":{"$ref":"#/components/schemas/CustomerStatusCount"}},"CustomerStatusCount":{"title":"CustomerStatusCount","type":"object","properties":{"status":{"$ref":"#/components/schemas/CustomerStatusEnum"},"count":{"type":"integer","description":"Number of customers with this status"}},"required":["status","count"]},"CustomerStatusEnum":{"title":"CustomerStatusEnum","type":"string","description":"Current customer status","enum":["CREATED","REVIEW","REJECTED","INACTIVE","ACTIVE","SUSPENDED","ARCHIVED","RECEIVED","INVALID","PENDING","SUSPENDED_COMPLIANCE","ESTATE","OFFBOARDING"]}}}}
```

## The CustomerStatusCount object

```json
{"openapi":"3.0.1","info":{"title":"Roles","version":"1.0"},"components":{"schemas":{"CustomerStatusCount":{"title":"CustomerStatusCount","type":"object","properties":{"status":{"$ref":"#/components/schemas/CustomerStatusEnum"},"count":{"type":"integer","description":"Number of customers with this status"}},"required":["status","count"]},"CustomerStatusEnum":{"title":"CustomerStatusEnum","type":"string","description":"Current customer status","enum":["CREATED","REVIEW","REJECTED","INACTIVE","ACTIVE","SUSPENDED","ARCHIVED","RECEIVED","INVALID","PENDING","SUSPENDED_COMPLIANCE","ESTATE","OFFBOARDING"]}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.tradevest.ai/api-reference/roles/schemas.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.