# Schemas

## The Entities object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"Entities":{"title":"Entities","type":"object","properties":{"data":{"type":"array","description":"Array of entities ordered by creation date (newest first)","items":{"$ref":"#/components/schemas/Entity"}},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data","pagination"]},"Entity":{"title":"Entity","type":"object","properties":{"globalId":{"type":"string","minLength":12,"maxLength":12,"description":"Global ID of the entity"},"entityId":{"type":"string","format":"uuid","description":"Unique entity identification number in UUID format"},"entityName":{"type":"string","minLength":1,"description":"Name of the entity:\n* For Natural Person, Beneficial Owner, Legal Representative: firstName + lastName\n* For Joint Person: firstName + lastName of 1st natural person + \" & \" + firstName + lastName of 2nd natural person\n* For Legal Entity: legalName\n"},"entityType":{"$ref":"#/components/schemas/EntityTypeEnum"},"entityStatus":{"$ref":"#/components/schemas/EntityStatusEnum"},"contactPhone":{"type":"string","minLength":1,"description":"Contact phone number of the entity"},"createdOn":{"type":"string","format":"date-time","description":"The date on which the entity was created"},"roles":{"type":"array","description":"List of roles assigned to the entity","items":{"$ref":"#/components/schemas/EntityRole"}}},"required":["globalId","entityId","entityName","entityType","entityStatus","contactPhone","createdOn","roles"]},"EntityTypeEnum":{"title":"EntityTypeEnum","type":"string","enum":["NATURAL_PERSON","LEGAL_ENTITY","JOINT_PERSON","BENEFICIAL_OWNER","LEGAL_REPRESENTATIVE"],"description":"Type of the entity."},"EntityStatusEnum":{"title":"EntityStatusEnum","type":"string","enum":["ACTIVE","INACTIVE","CREATED","REVIEW","REJECTED","PENDING","SUSPENDED","ARCHIVED","RECEIVED","INVALID","SUSPENDED_COMPLIANCE","DECEASED"],"description":"Status of the entity. Available values depend on entity type."},"EntityRole":{"title":"EntityRole","type":"object","properties":{"roleType":{"$ref":"#/components/schemas/EntityRoleEnum"},"roleId":{"type":"string","format":"uuid","description":"Unique role identification number in UUID format"}},"required":["roleType","roleId"]},"EntityRoleEnum":{"title":"EntityRoleEnum","type":"string","enum":["CUSTOMER","PROXY"],"description":"Role of the entity:\n* `CUSTOMER` - Entity is a customer\n* `PROXY` - Entity is a proxy\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 Entity object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"Entity":{"title":"Entity","type":"object","properties":{"globalId":{"type":"string","minLength":12,"maxLength":12,"description":"Global ID of the entity"},"entityId":{"type":"string","format":"uuid","description":"Unique entity identification number in UUID format"},"entityName":{"type":"string","minLength":1,"description":"Name of the entity:\n* For Natural Person, Beneficial Owner, Legal Representative: firstName + lastName\n* For Joint Person: firstName + lastName of 1st natural person + \" & \" + firstName + lastName of 2nd natural person\n* For Legal Entity: legalName\n"},"entityType":{"$ref":"#/components/schemas/EntityTypeEnum"},"entityStatus":{"$ref":"#/components/schemas/EntityStatusEnum"},"contactPhone":{"type":"string","minLength":1,"description":"Contact phone number of the entity"},"createdOn":{"type":"string","format":"date-time","description":"The date on which the entity was created"},"roles":{"type":"array","description":"List of roles assigned to the entity","items":{"$ref":"#/components/schemas/EntityRole"}}},"required":["globalId","entityId","entityName","entityType","entityStatus","contactPhone","createdOn","roles"]},"EntityTypeEnum":{"title":"EntityTypeEnum","type":"string","enum":["NATURAL_PERSON","LEGAL_ENTITY","JOINT_PERSON","BENEFICIAL_OWNER","LEGAL_REPRESENTATIVE"],"description":"Type of the entity."},"EntityStatusEnum":{"title":"EntityStatusEnum","type":"string","enum":["ACTIVE","INACTIVE","CREATED","REVIEW","REJECTED","PENDING","SUSPENDED","ARCHIVED","RECEIVED","INVALID","SUSPENDED_COMPLIANCE","DECEASED"],"description":"Status of the entity. Available values depend on entity type."},"EntityRole":{"title":"EntityRole","type":"object","properties":{"roleType":{"$ref":"#/components/schemas/EntityRoleEnum"},"roleId":{"type":"string","format":"uuid","description":"Unique role identification number in UUID format"}},"required":["roleType","roleId"]},"EntityRoleEnum":{"title":"EntityRoleEnum","type":"string","enum":["CUSTOMER","PROXY"],"description":"Role of the entity:\n* `CUSTOMER` - Entity is a customer\n* `PROXY` - Entity is a proxy\n"}}}}
```

## The EntityRole object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"EntityRole":{"title":"EntityRole","type":"object","properties":{"roleType":{"$ref":"#/components/schemas/EntityRoleEnum"},"roleId":{"type":"string","format":"uuid","description":"Unique role identification number in UUID format"}},"required":["roleType","roleId"]},"EntityRoleEnum":{"title":"EntityRoleEnum","type":"string","enum":["CUSTOMER","PROXY"],"description":"Role of the entity:\n* `CUSTOMER` - Entity is a customer\n* `PROXY` - Entity is a proxy\n"}}}}
```

## The JointPersonData object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"JointPersonData":{"title":"JointPersonData","type":"object","properties":{"annualIncomeNet":{"type":"number","multipleOf":0.01,"description":"Annual income net"},"sourceOfIncome":{"type":"array","items":{"$ref":"#/components/schemas/NaturalPersonSourceOfIncomeEnum"}},"availableAssets":{"type":"number","multipleOf":0.01,"description":"Available assets"},"originOfAssets":{"type":"array","items":{"$ref":"#/components/schemas/NaturalPersonAssetOriginEnum"}},"firstNaturalPersonId":{"type":"string","format":"uuid","description":"Identifier for the first **Natural Person**"},"secondNaturalPersonId":{"type":"string","format":"uuid","description":"Identifier for the second **Natural Person**"},"contact":{"$ref":"#/components/schemas/Contact"},"mainAddress":{"$ref":"#/components/schemas/Address"},"correspondenceAddress":{"$ref":"#/components/schemas/Address"},"externalId":{"type":"string","minLength":1,"description":"External Id in partner's system. This value has to be unique"}},"required":["firstNaturalPersonId","secondNaturalPersonId","contact","mainAddress"]},"NaturalPersonSourceOfIncomeEnum":{"title":"NaturalPersonSourceOfIncomeEnum","type":"string","enum":["INCOME_FROM_EMPLOYMENT","INCOME_FROM_CAPITAL_ASSETS","INCOME_FROM_RENTING_AND_LEASING","INCOME_FROM_AGRICULTURE_AND_FORESTRY","INCOME_FROM_BUSINESS_OPERATIONS","INCOME_FROM_SELF_EMPLOYMENT","OTHER_INCOME","SALES_OF_ASSETS","FAMILY_INCOME_OR_DONATIONS","INHERITANCE","PENSION","PUBLIC_SUBSIDES"],"description":"source of income"},"NaturalPersonAssetOriginEnum":{"title":"NaturalPersonAssetOriginEnum","type":"string","enum":["NON_EMPLOYED_LABOR","CAPITAL_ASSETS","REAL_ESTATE","INHERITANCE","DONATION","AGRICULTURE_AND_FORESTRY","TRADE","SELF_EMPLOYED_WORK"],"description":"source of income"},"Contact":{"title":"Contact","type":"object","properties":{"phone":{"type":"string","description":"Mobile telephone number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"email":{"type":"string","description":"E-mail address","maxLength":255,"pattern":"^[a-zA-Z0-9.!#$%&'*+\\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$"},"fax":{"type":"string","description":"Fax number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"website":{"type":"string","description":"website address","maxLength":320}},"required":["phone","email"]},"Address":{"title":"Address","type":"object","description":"Address","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":10},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string","minLength":1}},"required":["street","streetNumber","city","zip","country"]},"CountryEnum":{"title":"CountryEnum","type":"string","description":"Country code in **ISO 3166-1 alpha-2** standard","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]}}}}
```

## The JointPersons object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"JointPersons":{"title":"JointPersons","type":"object","properties":{"data":{"type":"array","description":"Array of joint persons","items":{"$ref":"#/components/schemas/JointPerson"}},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data","pagination"]},"JointPerson":{"title":"JointPerson","type":"object","properties":{"annualIncomeNet":{"type":"number","multipleOf":0.01,"description":"Annual income net"},"sourceOfIncome":{"type":"array","items":{"$ref":"#/components/schemas/NaturalPersonSourceOfIncomeEnum"}},"availableAssets":{"type":"number","multipleOf":0.01,"description":"Available assets"},"originOfAssets":{"type":"array","items":{"$ref":"#/components/schemas/NaturalPersonAssetOriginEnum"}},"firstNaturalPersonId":{"type":"string","format":"uuid","description":"Identifier for the first **Natural Person**"},"secondNaturalPersonId":{"type":"string","format":"uuid","description":"Identifier for the second **Natural Person**"},"contact":{"$ref":"#/components/schemas/Contact"},"mainAddress":{"$ref":"#/components/schemas/Address"},"correspondenceAddress":{"$ref":"#/components/schemas/Address"},"externalId":{"type":"string","minLength":1,"description":"External Id in partner's system. This value has to be unique"},"jointPersonId":{"type":"string","format":"uuid","description":"Unique joint person identification number in UUID format"},"createdOn":{"type":"string","format":"date-time","description":"The date on which the joint person was created"},"modifiedOn":{"type":"string","format":"date-time","description":"The date on which the joint person was modified the last time"},"globalId":{"type":"string","minLength":12,"maxLength":12,"description":"Global ID of the joint person"},"jointPersonStatus":{"$ref":"#/components/schemas/JointPersonStatusEnum"}},"required":["contact","createdOn","firstNaturalPersonId","globalId","jointPersonId","jointPersonStatus","mainAddress","modifiedOn","secondNaturalPersonId"]},"NaturalPersonSourceOfIncomeEnum":{"title":"NaturalPersonSourceOfIncomeEnum","type":"string","enum":["INCOME_FROM_EMPLOYMENT","INCOME_FROM_CAPITAL_ASSETS","INCOME_FROM_RENTING_AND_LEASING","INCOME_FROM_AGRICULTURE_AND_FORESTRY","INCOME_FROM_BUSINESS_OPERATIONS","INCOME_FROM_SELF_EMPLOYMENT","OTHER_INCOME","SALES_OF_ASSETS","FAMILY_INCOME_OR_DONATIONS","INHERITANCE","PENSION","PUBLIC_SUBSIDES"],"description":"source of income"},"NaturalPersonAssetOriginEnum":{"title":"NaturalPersonAssetOriginEnum","type":"string","enum":["NON_EMPLOYED_LABOR","CAPITAL_ASSETS","REAL_ESTATE","INHERITANCE","DONATION","AGRICULTURE_AND_FORESTRY","TRADE","SELF_EMPLOYED_WORK"],"description":"source of income"},"Contact":{"title":"Contact","type":"object","properties":{"phone":{"type":"string","description":"Mobile telephone number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"email":{"type":"string","description":"E-mail address","maxLength":255,"pattern":"^[a-zA-Z0-9.!#$%&'*+\\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$"},"fax":{"type":"string","description":"Fax number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"website":{"type":"string","description":"website address","maxLength":320}},"required":["phone","email"]},"Address":{"title":"Address","type":"object","description":"Address","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":10},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string","minLength":1}},"required":["street","streetNumber","city","zip","country"]},"CountryEnum":{"title":"CountryEnum","type":"string","description":"Country code in **ISO 3166-1 alpha-2** standard","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]},"JointPersonStatusEnum":{"title":"JointPersonStatusEnum","type":"string","enum":["CREATED","REVIEW","REJECTED","INACTIVE","PENDING","ACTIVE","SUSPENDED","ARCHIVED","RECEIVED","INVALID","SUSPENDED_COMPLIANCE"]},"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 JointPerson object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"JointPerson":{"title":"JointPerson","type":"object","properties":{"annualIncomeNet":{"type":"number","multipleOf":0.01,"description":"Annual income net"},"sourceOfIncome":{"type":"array","items":{"$ref":"#/components/schemas/NaturalPersonSourceOfIncomeEnum"}},"availableAssets":{"type":"number","multipleOf":0.01,"description":"Available assets"},"originOfAssets":{"type":"array","items":{"$ref":"#/components/schemas/NaturalPersonAssetOriginEnum"}},"firstNaturalPersonId":{"type":"string","format":"uuid","description":"Identifier for the first **Natural Person**"},"secondNaturalPersonId":{"type":"string","format":"uuid","description":"Identifier for the second **Natural Person**"},"contact":{"$ref":"#/components/schemas/Contact"},"mainAddress":{"$ref":"#/components/schemas/Address"},"correspondenceAddress":{"$ref":"#/components/schemas/Address"},"externalId":{"type":"string","minLength":1,"description":"External Id in partner's system. This value has to be unique"},"jointPersonId":{"type":"string","format":"uuid","description":"Unique joint person identification number in UUID format"},"createdOn":{"type":"string","format":"date-time","description":"The date on which the joint person was created"},"modifiedOn":{"type":"string","format":"date-time","description":"The date on which the joint person was modified the last time"},"globalId":{"type":"string","minLength":12,"maxLength":12,"description":"Global ID of the joint person"},"jointPersonStatus":{"$ref":"#/components/schemas/JointPersonStatusEnum"}},"required":["contact","createdOn","firstNaturalPersonId","globalId","jointPersonId","jointPersonStatus","mainAddress","modifiedOn","secondNaturalPersonId"]},"NaturalPersonSourceOfIncomeEnum":{"title":"NaturalPersonSourceOfIncomeEnum","type":"string","enum":["INCOME_FROM_EMPLOYMENT","INCOME_FROM_CAPITAL_ASSETS","INCOME_FROM_RENTING_AND_LEASING","INCOME_FROM_AGRICULTURE_AND_FORESTRY","INCOME_FROM_BUSINESS_OPERATIONS","INCOME_FROM_SELF_EMPLOYMENT","OTHER_INCOME","SALES_OF_ASSETS","FAMILY_INCOME_OR_DONATIONS","INHERITANCE","PENSION","PUBLIC_SUBSIDES"],"description":"source of income"},"NaturalPersonAssetOriginEnum":{"title":"NaturalPersonAssetOriginEnum","type":"string","enum":["NON_EMPLOYED_LABOR","CAPITAL_ASSETS","REAL_ESTATE","INHERITANCE","DONATION","AGRICULTURE_AND_FORESTRY","TRADE","SELF_EMPLOYED_WORK"],"description":"source of income"},"Contact":{"title":"Contact","type":"object","properties":{"phone":{"type":"string","description":"Mobile telephone number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"email":{"type":"string","description":"E-mail address","maxLength":255,"pattern":"^[a-zA-Z0-9.!#$%&'*+\\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$"},"fax":{"type":"string","description":"Fax number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"website":{"type":"string","description":"website address","maxLength":320}},"required":["phone","email"]},"Address":{"title":"Address","type":"object","description":"Address","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":10},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string","minLength":1}},"required":["street","streetNumber","city","zip","country"]},"CountryEnum":{"title":"CountryEnum","type":"string","description":"Country code in **ISO 3166-1 alpha-2** standard","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]},"JointPersonStatusEnum":{"title":"JointPersonStatusEnum","type":"string","enum":["CREATED","REVIEW","REJECTED","INACTIVE","PENDING","ACTIVE","SUSPENDED","ARCHIVED","RECEIVED","INVALID","SUSPENDED_COMPLIANCE"]}}}}
```

## The JointPersonUpdate object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"JointPersonUpdate":{"title":"JointPersonUpdate","type":"object","properties":{"annualIncomeNet":{"type":"number","multipleOf":0.01,"description":"Annual income net"},"sourceOfIncome":{"type":"array","items":{"$ref":"#/components/schemas/NaturalPersonSourceOfIncomeEnum"}},"availableAssets":{"type":"number","multipleOf":0.01,"description":"Available assets"},"originOfAssets":{"type":"array","items":{"$ref":"#/components/schemas/NaturalPersonAssetOriginEnum"}},"contact":{"$ref":"#/components/schemas/Contact"},"mainAddress":{"$ref":"#/components/schemas/Address"},"correspondenceAddress":{"$ref":"#/components/schemas/Address"},"externalId":{"type":"string","minLength":1,"description":"External Id in partner's system. This value has to be unique"}}},"NaturalPersonSourceOfIncomeEnum":{"title":"NaturalPersonSourceOfIncomeEnum","type":"string","enum":["INCOME_FROM_EMPLOYMENT","INCOME_FROM_CAPITAL_ASSETS","INCOME_FROM_RENTING_AND_LEASING","INCOME_FROM_AGRICULTURE_AND_FORESTRY","INCOME_FROM_BUSINESS_OPERATIONS","INCOME_FROM_SELF_EMPLOYMENT","OTHER_INCOME","SALES_OF_ASSETS","FAMILY_INCOME_OR_DONATIONS","INHERITANCE","PENSION","PUBLIC_SUBSIDES"],"description":"source of income"},"NaturalPersonAssetOriginEnum":{"title":"NaturalPersonAssetOriginEnum","type":"string","enum":["NON_EMPLOYED_LABOR","CAPITAL_ASSETS","REAL_ESTATE","INHERITANCE","DONATION","AGRICULTURE_AND_FORESTRY","TRADE","SELF_EMPLOYED_WORK"],"description":"source of income"},"Contact":{"title":"Contact","type":"object","properties":{"phone":{"type":"string","description":"Mobile telephone number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"email":{"type":"string","description":"E-mail address","maxLength":255,"pattern":"^[a-zA-Z0-9.!#$%&'*+\\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$"},"fax":{"type":"string","description":"Fax number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"website":{"type":"string","description":"website address","maxLength":320}},"required":["phone","email"]},"Address":{"title":"Address","type":"object","description":"Address","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":10},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string","minLength":1}},"required":["street","streetNumber","city","zip","country"]},"CountryEnum":{"title":"CountryEnum","type":"string","description":"Country code in **ISO 3166-1 alpha-2** standard","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]}}}}
```

## The RequestIdentificationVerificationResult object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"RequestIdentificationVerificationResult":{"title":"RequestIdentificationVerificationResult","type":"object","properties":{"identificationVerificationId":{"type":"string","format":"uuid"}},"required":["identificationVerificationId"]}}}}
```

## The IdentificationVerificationData object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"IdentificationVerificationData":{"title":"IdentificationVerificationData","type":"object","properties":{"naturalPersonId":{"type":"string","format":"uuid"},"externalVerifier":{"$ref":"#/components/schemas/ExternalVerifierEnum"},"identificationType":{"$ref":"#/components/schemas/IdentificationTypeEnum"},"redirectUrl":{"type":"string","minLength":1,"pattern":"^https?://.+","description":"Redirect URL passed to the external verifier. After the identification process is done, the user will be redirected to this URL."}},"required":["naturalPersonId","externalVerifier","identificationType"]},"ExternalVerifierEnum":{"title":"ExternalVerifierEnum","description":"The legal name of the vendor/company performing the identification for this natural person","type":"string","enum":["WEB_ID","ID_NOW","DEUTSCHE_POST","PARTNER","OTHER"]},"IdentificationTypeEnum":{"title":"IdentificationTypeEnum","description":"Method used to identify the customer","type":"string","enum":["VIDEO_IDENT","IN_PERSON","POST_IDENT","E_ID","ID_COPY"]}}}}
```

## The IdentificationVerifications object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"IdentificationVerifications":{"title":"IdentificationVerifications","type":"object","properties":{"data":{"type":"array","description":"Array of identification verifications","items":{"$ref":"#/components/schemas/IdentificationVerification"}},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data","pagination"]},"IdentificationVerification":{"title":"IdentificationVerification","type":"object","properties":{"naturalPersonId":{"type":"string","format":"uuid"},"identificationVerificationId":{"type":"string","format":"uuid","readOnly":true},"externalVerifier":{"$ref":"#/components/schemas/ExternalVerifierEnum"},"identificationType":{"$ref":"#/components/schemas/IdentificationTypeEnum"},"identificationUrl":{"type":"string","minLength":1},"documentId":{"type":"string","format":"uuid"},"naturalPersonIdentificationId":{"type":"string","format":"uuid"},"createdOn":{"type":"string","format":"date-time","description":"The date on which the wizard was created","readOnly":true},"modifiedOn":{"type":"string","format":"date-time","description":"The date on which the wizard was modified the last time","readOnly":true},"status":{"$ref":"#/components/schemas/IdentificationVerificationStatusEnum"}},"required":["externalVerifier","identificationType","naturalPersonId","identificationUrl","identificationVerificationId","createdOn","modifiedOn","status"]},"ExternalVerifierEnum":{"title":"ExternalVerifierEnum","description":"The legal name of the vendor/company performing the identification for this natural person","type":"string","enum":["WEB_ID","ID_NOW","DEUTSCHE_POST","PARTNER","OTHER"]},"IdentificationTypeEnum":{"title":"IdentificationTypeEnum","description":"Method used to identify the customer","type":"string","enum":["VIDEO_IDENT","IN_PERSON","POST_IDENT","E_ID","ID_COPY"]},"IdentificationVerificationStatusEnum":{"title":"IdentificationVerificationStatusEnum","type":"string","enum":["RECEIVED","INVALID","PENDING","APPROVED","REJECTED","EXPIRED"]},"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 IdentificationVerification object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"IdentificationVerification":{"title":"IdentificationVerification","type":"object","properties":{"naturalPersonId":{"type":"string","format":"uuid"},"identificationVerificationId":{"type":"string","format":"uuid","readOnly":true},"externalVerifier":{"$ref":"#/components/schemas/ExternalVerifierEnum"},"identificationType":{"$ref":"#/components/schemas/IdentificationTypeEnum"},"identificationUrl":{"type":"string","minLength":1},"documentId":{"type":"string","format":"uuid"},"naturalPersonIdentificationId":{"type":"string","format":"uuid"},"createdOn":{"type":"string","format":"date-time","description":"The date on which the wizard was created","readOnly":true},"modifiedOn":{"type":"string","format":"date-time","description":"The date on which the wizard was modified the last time","readOnly":true},"status":{"$ref":"#/components/schemas/IdentificationVerificationStatusEnum"}},"required":["externalVerifier","identificationType","naturalPersonId","identificationUrl","identificationVerificationId","createdOn","modifiedOn","status"]},"ExternalVerifierEnum":{"title":"ExternalVerifierEnum","description":"The legal name of the vendor/company performing the identification for this natural person","type":"string","enum":["WEB_ID","ID_NOW","DEUTSCHE_POST","PARTNER","OTHER"]},"IdentificationTypeEnum":{"title":"IdentificationTypeEnum","description":"Method used to identify the customer","type":"string","enum":["VIDEO_IDENT","IN_PERSON","POST_IDENT","E_ID","ID_COPY"]},"IdentificationVerificationStatusEnum":{"title":"IdentificationVerificationStatusEnum","type":"string","enum":["RECEIVED","INVALID","PENDING","APPROVED","REJECTED","EXPIRED"]}}}}
```

## The CreateNaturalPersonResult object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"CreateNaturalPersonResult":{"title":"CreateNaturalPersonResult","type":"object","properties":{"naturalPersonId":{"type":"string","format":"uuid","description":"Unique natural person identification number in UUID format","readOnly":true}},"required":["naturalPersonId"]}}}}
```

## The CreateJointPersonResult object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"CreateJointPersonResult":{"title":"CreateJointPersonResult","type":"object","properties":{"jointPersonId":{"type":"string","format":"uuid","description":"Unique joint person identification number in UUID format","readOnly":true}},"required":["jointPersonId"]}}}}
```

## The NaturalPersons object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"NaturalPersons":{"title":"NaturalPersons","type":"object","properties":{"data":{"type":"array","description":"Array of natural persons","items":{"$ref":"#/components/schemas/NaturalPerson"}},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data","pagination"]},"NaturalPerson":{"type":"object","required":["birthCountry","birthDay","birthPlace","contact","createdOn","firstName","gender","globalId","isUsNationality","lastName","mainAddress","modifiedOn","nationalities","naturalPersonId","naturalPersonStatus","taxDetails"],"properties":{"deathDay":{"type":"string","format":"date"},"naturalPersonId":{"type":"string","format":"uuid","description":"Unique natural person identification number in UUID format"},"globalId":{"type":"string","minLength":12,"maxLength":12,"description":"Unique identifier for any natural persons, joint persons and legal entities. The respective data set indicates what the data is about."},"createdOn":{"type":"string","format":"date-time","description":"The date on which the natural person was created"},"modifiedOn":{"type":"string","format":"date-time","description":"The date on which the natural person was modified the last time"},"verifiedOn":{"type":"string","format":"date-time","description":"The date on which the natural person was verified"},"isPep":{"type":"boolean","description":"Indication of whether the person is a politically exposed person."},"isPepRelated":{"type":"boolean","description":"Indication of whether the person is directly related to a politically exposed person."},"isSanction":{"type":"boolean","description":"Indication of whether the person is on sanction list."},"riskLevel":{"$ref":"#/components/schemas/RiskLevelEnum"},"naturalPersonStatus":{"$ref":"#/components/schemas/NaturalPersonStatusEnum"},"naturalPersonIdentifications":{"type":"array","items":{"$ref":"#/components/schemas/NaturalPersonIdentification"}},"naturalPersonSignedDocuments":{"type":"array","items":{"$ref":"#/components/schemas/NaturalPersonDocumentSignature"}},"tradingProfile":{"$ref":"#/components/schemas/TradingProfile"},"gender":{"$ref":"#/components/schemas/GenderEnum"},"title":{"$ref":"#/components/schemas/NaturalPersonTitleEnum"},"firstName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^\\S+( \\S+)*$","description":"All first names of the person according to the identification document"},"lastName":{"type":"string","minLength":1,"maxLength":255,"description":"Natural person last name"},"maritalStatus":{"$ref":"#/components/schemas/NaturalPersonMaritalStatusEnum"},"birthDay":{"type":"string","format":"date"},"birthPlace":{"type":"string","minLength":1,"maxLength":255},"birthCountry":{"$ref":"#/components/schemas/CountryEnum"},"nationalities":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/Nationality"}},"language":{"$ref":"#/components/schemas/LanguageEnum"},"taxDetails":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/TaxDetail"}},"isUsNationality":{"type":"boolean","description":"FATCA - Question whether the customer is subject to US tax liability (nationality or other references due to a green card, registration address, etc.)."},"profession":{"type":"string","minLength":1,"maxLength":255},"professionGroup":{"$ref":"#/components/schemas/NaturalPersonProfessionGroupEnum"},"naceSectors":{"description":"Specification of the sector in which the natural person is professionally active. The information should be provided according to the main classes of the NACE codes (Sections A-V) without subclasses. (Level 1)","type":"array","items":{"$ref":"#/components/schemas/NaturalPersonNaceSector"}},"mainAddress":{"$ref":"#/components/schemas/Address"},"correspondenceAddress":{"$ref":"#/components/schemas/Address"},"annualIncomeNet":{"type":"number","multipleOf":0.01,"description":"Annual income net"},"sourceOfIncome":{"type":"array","items":{"$ref":"#/components/schemas/NaturalPersonSourceOfIncomeEnum"}},"availableAssets":{"type":"number","multipleOf":0.01,"description":"Available assets"},"originOfAssets":{"type":"array","items":{"$ref":"#/components/schemas/NaturalPersonAssetOriginEnum"}},"contact":{"$ref":"#/components/schemas/Contact"},"externalId":{"type":"string","minLength":1,"description":"External Id in partner's system. This value has to be unique"}},"title":"NaturalPerson","description":""},"RiskLevelEnum":{"title":"RiskLevelEnum","type":"string","enum":["LOW","MEDIUM","HIGH","CRITICAL"]},"NaturalPersonStatusEnum":{"title":"NaturalPersonStatusEnum","type":"string","enum":["CREATED","REVIEW","REJECTED","INACTIVE","PENDING","ACTIVE","SUSPENDED","ARCHIVED","RECEIVED","INVALID","SUSPENDED_COMPLIANCE","DECEASED"]},"NaturalPersonIdentification":{"type":"object","properties":{"identificationId":{"type":"string","format":"uuid","description":"Unique identification number in UUID format","readOnly":true},"createdOn":{"type":"string","format":"date-time","description":"The date on which the wizard was created","readOnly":true},"modifiedOn":{"type":"string","format":"date-time","description":"The date on which the wizard was modified the last time","readOnly":true},"externalVerifier":{"$ref":"#/components/schemas/ExternalVerifierEnum"},"identificationType":{"$ref":"#/components/schemas/IdentificationTypeEnum"},"identificationDate":{"description":"Date on which the identification was carried out. The date must be within the last 24 months.","type":"string","format":"date"},"identificationDocumentType":{"$ref":"#/components/schemas/IdentificationDocumentTypeEnum"},"documentNumber":{"description":"Document number of the identification document.","type":"string","minLength":1,"maxLength":255},"documentCountry":{"title":"CountryEnum","type":"string","description":"Issuing country of the identification document.","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]},"documentIssuer":{"description":"Issuing authority of the identification document","type":"string","minLength":1,"maxLength":255},"documentIssueDate":{"description":"Issue date of the identification document","type":"string","format":"date"},"documentExpiryDate":{"description":"Expiry date of the identification document. If the identification document is a birth certificate, the date on which the person comes of age must be entered as the expiry date.","type":"string","format":"date"},"documentMotherFullName":{"description":"Full name of the mother, only mandatory for identificationDocumentType = BIRTH_CERTIFICATE","type":"string","minLength":1,"maxLength":255},"documentMotherResidenceCity":{"description":"Residence city of the mother, only mandatory for identificationDocumentType = BIRTH_CERTIFICATE","type":"string","minLength":1,"maxLength":255},"documentFatherFullName":{"description":"Full name of the father, only mandatory for identificationDocumentType = BIRTH_CERTIFICATE","type":"string","minLength":1,"maxLength":255},"documentFatherResidenceCity":{"description":"Residence city of the father, only mandatory for identificationDocumentType = BIRTH_CERTIFICATE","type":"string","minLength":1,"maxLength":255}},"required":["createdOn","documentCountry","documentExpiryDate","documentIssueDate","documentIssuer","documentNumber","externalVerifier","identificationDate","identificationDocumentType","identificationId","identificationType","modifiedOn"],"title":"NaturalPersonIdentification"},"ExternalVerifierEnum":{"title":"ExternalVerifierEnum","description":"The legal name of the vendor/company performing the identification for this natural person","type":"string","enum":["WEB_ID","ID_NOW","DEUTSCHE_POST","PARTNER","OTHER"]},"IdentificationTypeEnum":{"title":"IdentificationTypeEnum","description":"Method used to identify the customer","type":"string","enum":["VIDEO_IDENT","IN_PERSON","POST_IDENT","E_ID","ID_COPY"]},"IdentificationDocumentTypeEnum":{"title":"IdentificationDocumentTypeEnum","description":"Type of the identification document which has been used for identification of the natural person.","type":"string","enum":["ID","PASSPORT","BIRTH_CERTIFICATE"]},"NaturalPersonDocumentSignature":{"title":"NaturalPersonDocumentSignature","type":"object","properties":{"partnerDocumentId":{"type":"string","format":"uuid","description":"Id of the partner document which was signed"},"name":{"type":"string","description":"Name of the document"},"documentType":{"$ref":"#/components/schemas/DocumentSignatureTypeEnum"},"version":{"type":"integer","description":"Version of the document"},"customerId":{"type":"string","format":"uuid","description":"Id of the customer in whose context the natural person is active. Required only for TERMS_AND_CONDITIONS document type."},"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","createdOn","modifiedOn"]},"DocumentSignatureTypeEnum":{"title":"DocumentSignatureTypeEnum","type":"string","enum":["TERMS_AND_CONDITIONS","DATA_PRIVACY_POLICY"]},"TradingProfile":{"title":"TradingProfile","type":"object","description":"Trading profile for a natural person","properties":{"assetTypeProfiles":{"type":"array","description":"Trading profile details per asset type","items":{"$ref":"#/components/schemas/AssetTypeTradingProfile"}},"investmentObjectives":{"$ref":"#/components/schemas/InvestmentObjectives"}}},"AssetTypeTradingProfile":{"title":"AssetTypeTradingProfile","type":"object","required":["assetType","hasKnowledge","hasExperience","createdOn","modifiedOn","riskAcknowledged"],"properties":{"assetType":{"$ref":"#/components/schemas/CreateUpdateTraditionalAssetTypeEnum"},"hasKnowledge":{"type":"boolean","description":"Indicates if the person has trading knowledge"},"hasExperience":{"type":"boolean","description":"Indicates if the person has trading experience"},"tradingExperience":{"$ref":"#/components/schemas/TradingExperience"},"createdOn":{"type":"string","format":"date-time","description":"The date on which the trading profile was created for asset type"},"modifiedOn":{"type":"string","format":"date-time","description":"The date on which the trading profile was modified the last time for asset type"},"appropriatenessTestPassed":{"type":"boolean"},"riskAcknowledged":{"type":"boolean"}}},"CreateUpdateTraditionalAssetTypeEnum":{"title":"CreateUpdateTraditionalAssetTypeEnum","type":"string","description":"The type of the traditional asset for create and update operations","enum":["BOND","ETF","EQUITY","FUND","COMMODITY","DERIVATIVE","ETN","SECURITY_TOKEN"]},"TradingExperience":{"title":"TradingExperience","type":"object","description":"Trading experience details","properties":{"yearsOfExperience":{"type":"integer","description":"Number of years of trading experience","minimum":0},"numberOfTrades":{"type":"integer","description":"Number of trades executed","minimum":0},"tradeVolume":{"type":"number","description":"Total volume of trades","minimum":0}},"required":["yearsOfExperience","numberOfTrades","tradeVolume"]},"InvestmentObjectives":{"title":"InvestmentObjectives","type":"object","description":"Investment objectives categorized by purpose","properties":{"growthAndSavings":{"type":"array","description":"Growth and savings investment purposes","items":{"$ref":"#/components/schemas/GrowthAndSavingsPurposeEnum"}},"capitalProtectionAndHedging":{"type":"array","description":"Capital protection and hedging investment purposes","items":{"$ref":"#/components/schemas/CapitalProtectionAndHedgingPurposeEnum"}},"incomeAndLiquidity":{"type":"array","description":"Income and liquidity investment purposes","items":{"$ref":"#/components/schemas/IncomeAndLiquidityPurposeEnum"}},"retirementAndFuturePlanning":{"type":"array","description":"Retirement and future planning investment purposes","items":{"$ref":"#/components/schemas/RetirementAndFuturePlanningPurposeEnum"}},"specificInvestmentTypes":{"type":"array","description":"Specific investment types purposes","items":{"$ref":"#/components/schemas/SpecificInvestmentTypesPurposeEnum"}},"taxAndEstatePlanning":{"type":"array","description":"Tax and estate planning investment purposes","items":{"$ref":"#/components/schemas/TaxAndEstatePlanningPurposeEnum"}}}},"GrowthAndSavingsPurposeEnum":{"title":"GrowthAndSavingsPurposeEnum","type":"string","enum":["CAPITAL_GROWTH","LONG_TERM_SAVING","PERSONAL_INVESTMENTS"]},"CapitalProtectionAndHedgingPurposeEnum":{"title":"CapitalProtectionAndHedgingPurposeEnum","type":"string","enum":["WEALTH_PRESERVATION","HEDGING","RISK_MANAGEMENT"]},"IncomeAndLiquidityPurposeEnum":{"title":"IncomeAndLiquidityPurposeEnum","type":"string","enum":["INCOME_GENERATION","CASH_MANAGEMENT","SHORT_TERM_LIQUIDITY"]},"RetirementAndFuturePlanningPurposeEnum":{"title":"RetirementAndFuturePlanningPurposeEnum","type":"string","enum":["PENSION_PLANNING","EDUCATION_FUNDING","FAMILY_SECURITY"]},"SpecificInvestmentTypesPurposeEnum":{"title":"SpecificInvestmentTypesPurposeEnum","type":"string","enum":["INVESTMENT_IN_LISTED_EQUITIES","SMALL_SCALE_INVESTMENTS","REAL_ESTATE_INVESTMENTS","ALTERNATIVE_INVESTMENTS","SPECULATIVE_INVESTMENTS","SHORT_TERM_TRADING"]},"TaxAndEstatePlanningPurposeEnum":{"title":"TaxAndEstatePlanningPurposeEnum","type":"string","enum":["TAX_PLANNING","ESTATE_PLANNING"]},"GenderEnum":{"title":"GenderEnum","type":"string","description":"Gender","enum":["MALE","FEMALE","DIVERSE"]},"NaturalPersonTitleEnum":{"title":"NaturalPersonTitleEnum","type":"string","enum":["PROFESSOR","MAGISTER","DR"]},"NaturalPersonMaritalStatusEnum":{"title":"NaturalPersonMaritalStatusEnum","type":"string","enum":["MARRIED","DIVORCED","WIDOWED","SINGLE","SEPARATED","REGISTERED_PARTNERSHIP"]},"CountryEnum":{"title":"CountryEnum","type":"string","description":"Country code in **ISO 3166-1 alpha-2** standard","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]},"Nationality":{"title":"Nationality","type":"object","description":"Nationality of the customer","properties":{"countryCode":{"$ref":"#/components/schemas/CountryEnum"},"nationalIdentifier":{"type":"string","description":"National identifier of the customer"},"nationalIdentifierType":{"$ref":"#/components/schemas/NationalIdentifierType"}},"required":["countryCode"]},"NationalIdentifierType":{"title":"NationalIdentifierType","type":"string","description":"National identifier type of the customer","enum":["CONCAT","NATIONAL_PASSPORT_NUMBER","BELGIAN_NATIONAL_NUMBER","BULGARIAN_PERSONAL_NUMBER","CZECH_NATIONAL_IDENTIFICATION_NUMBER","DENMARK_PERSONAL_IDENTITY_CODE","ESTONIAN_PERSONAL_IDENTIFICATION_CODE","SPAIN_TAX_IDENTIFICATION_NUMBER","FINLAND_PERSONAL_IDENTITY_CODE","GREECE_DSS_DIGIT_INVESTOR_SHARE","CROATIA_PERSONAL_IDENTIFICATION_NUMBER","ICELAND_PERSONAL_IDENTITY_CODE","ITALY_FISCAL_CODE","LITHUANIA_PERSONAL_CODE","LATVIA_PERSONAL_CODE","MALTA_NATIONAL_IDENTIFICATION_NUMBER","NORWAY_PERSONAL_ID","POLAND_NATIONAL_IDENTIFICATION_NUMBER","PORTUGAL_TAX_NUMBER","ROMANIA_NATIONAL_IDENTIFICATION_NUMBER","SWEDEN_PERSONAL_IDENTITY_NUMBER","SLOVENIA_PERSONAL_IDENTIFICATION_NUMBER","SLOVAKIA_PERSONAL_NUMBER"]},"LanguageEnum":{"title":"LanguageEnum","type":"string","description":"Language code in ISO 639-1 two-letter codes (EU only)","enum":["da","de","el","en","es","fi","fr","hu","it","lt","lv","mt","nl","pl","pt","ro","sk","sl","sv"]},"TaxDetail":{"title":"TaxDetail","type":"object","properties":{"taxId":{"type":"string","minLength":1,"maxLength":255},"taxResidency":{"$ref":"#/components/schemas/CountryEnum"},"noTinConfirmation":{"description":"Indicates that the customer does not have a Tax Identification Number (TIN), which should only be used in exceptional cases where no TIN exists. If this field is set to true, the customer must provide supporting document (docType: TIN_NA_CONFIRMATION) confirming that no TIN is available.","type":"boolean","default":false}},"required":["taxResidency"]},"NaturalPersonProfessionGroupEnum":{"title":"NaturalPersonProfessionGroupEnum","type":"string","enum":["EMPLOYED","INDEPENDENT","PENSIONER","MEMBER_OF_THE_BOARD","STUDENT_OR_PUPIL","UNEMPLOYED","PUBLIC_SECTOR_EMPLOYEE","PROFESSIONAL_SOLDIER","FREELANCER","HOUSEWORK","RETIRED"]},"NaturalPersonNaceSector":{"title":"NaturalPersonNaceSector","type":"object","properties":{"section":{"type":"string","minLength":1,"maxLength":1,"pattern":"^[A-V]$"},"description":{"type":"string","maxLength":255}},"required":["section"]},"Address":{"title":"Address","type":"object","description":"Address","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":10},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string","minLength":1}},"required":["street","streetNumber","city","zip","country"]},"NaturalPersonSourceOfIncomeEnum":{"title":"NaturalPersonSourceOfIncomeEnum","type":"string","enum":["INCOME_FROM_EMPLOYMENT","INCOME_FROM_CAPITAL_ASSETS","INCOME_FROM_RENTING_AND_LEASING","INCOME_FROM_AGRICULTURE_AND_FORESTRY","INCOME_FROM_BUSINESS_OPERATIONS","INCOME_FROM_SELF_EMPLOYMENT","OTHER_INCOME","SALES_OF_ASSETS","FAMILY_INCOME_OR_DONATIONS","INHERITANCE","PENSION","PUBLIC_SUBSIDES"],"description":"source of income"},"NaturalPersonAssetOriginEnum":{"title":"NaturalPersonAssetOriginEnum","type":"string","enum":["NON_EMPLOYED_LABOR","CAPITAL_ASSETS","REAL_ESTATE","INHERITANCE","DONATION","AGRICULTURE_AND_FORESTRY","TRADE","SELF_EMPLOYED_WORK"],"description":"source of income"},"Contact":{"title":"Contact","type":"object","properties":{"phone":{"type":"string","description":"Mobile telephone number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"email":{"type":"string","description":"E-mail address","maxLength":255,"pattern":"^[a-zA-Z0-9.!#$%&'*+\\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$"},"fax":{"type":"string","description":"Fax number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"website":{"type":"string","description":"website address","maxLength":320}},"required":["phone","email"]},"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 NaturalPerson object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"NaturalPerson":{"type":"object","required":["birthCountry","birthDay","birthPlace","contact","createdOn","firstName","gender","globalId","isUsNationality","lastName","mainAddress","modifiedOn","nationalities","naturalPersonId","naturalPersonStatus","taxDetails"],"properties":{"deathDay":{"type":"string","format":"date"},"naturalPersonId":{"type":"string","format":"uuid","description":"Unique natural person identification number in UUID format"},"globalId":{"type":"string","minLength":12,"maxLength":12,"description":"Unique identifier for any natural persons, joint persons and legal entities. The respective data set indicates what the data is about."},"createdOn":{"type":"string","format":"date-time","description":"The date on which the natural person was created"},"modifiedOn":{"type":"string","format":"date-time","description":"The date on which the natural person was modified the last time"},"verifiedOn":{"type":"string","format":"date-time","description":"The date on which the natural person was verified"},"isPep":{"type":"boolean","description":"Indication of whether the person is a politically exposed person."},"isPepRelated":{"type":"boolean","description":"Indication of whether the person is directly related to a politically exposed person."},"isSanction":{"type":"boolean","description":"Indication of whether the person is on sanction list."},"riskLevel":{"$ref":"#/components/schemas/RiskLevelEnum"},"naturalPersonStatus":{"$ref":"#/components/schemas/NaturalPersonStatusEnum"},"naturalPersonIdentifications":{"type":"array","items":{"$ref":"#/components/schemas/NaturalPersonIdentification"}},"naturalPersonSignedDocuments":{"type":"array","items":{"$ref":"#/components/schemas/NaturalPersonDocumentSignature"}},"tradingProfile":{"$ref":"#/components/schemas/TradingProfile"},"gender":{"$ref":"#/components/schemas/GenderEnum"},"title":{"$ref":"#/components/schemas/NaturalPersonTitleEnum"},"firstName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^\\S+( \\S+)*$","description":"All first names of the person according to the identification document"},"lastName":{"type":"string","minLength":1,"maxLength":255,"description":"Natural person last name"},"maritalStatus":{"$ref":"#/components/schemas/NaturalPersonMaritalStatusEnum"},"birthDay":{"type":"string","format":"date"},"birthPlace":{"type":"string","minLength":1,"maxLength":255},"birthCountry":{"$ref":"#/components/schemas/CountryEnum"},"nationalities":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/Nationality"}},"language":{"$ref":"#/components/schemas/LanguageEnum"},"taxDetails":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/TaxDetail"}},"isUsNationality":{"type":"boolean","description":"FATCA - Question whether the customer is subject to US tax liability (nationality or other references due to a green card, registration address, etc.)."},"profession":{"type":"string","minLength":1,"maxLength":255},"professionGroup":{"$ref":"#/components/schemas/NaturalPersonProfessionGroupEnum"},"naceSectors":{"description":"Specification of the sector in which the natural person is professionally active. The information should be provided according to the main classes of the NACE codes (Sections A-V) without subclasses. (Level 1)","type":"array","items":{"$ref":"#/components/schemas/NaturalPersonNaceSector"}},"mainAddress":{"$ref":"#/components/schemas/Address"},"correspondenceAddress":{"$ref":"#/components/schemas/Address"},"annualIncomeNet":{"type":"number","multipleOf":0.01,"description":"Annual income net"},"sourceOfIncome":{"type":"array","items":{"$ref":"#/components/schemas/NaturalPersonSourceOfIncomeEnum"}},"availableAssets":{"type":"number","multipleOf":0.01,"description":"Available assets"},"originOfAssets":{"type":"array","items":{"$ref":"#/components/schemas/NaturalPersonAssetOriginEnum"}},"contact":{"$ref":"#/components/schemas/Contact"},"externalId":{"type":"string","minLength":1,"description":"External Id in partner's system. This value has to be unique"}},"title":"NaturalPerson","description":""},"RiskLevelEnum":{"title":"RiskLevelEnum","type":"string","enum":["LOW","MEDIUM","HIGH","CRITICAL"]},"NaturalPersonStatusEnum":{"title":"NaturalPersonStatusEnum","type":"string","enum":["CREATED","REVIEW","REJECTED","INACTIVE","PENDING","ACTIVE","SUSPENDED","ARCHIVED","RECEIVED","INVALID","SUSPENDED_COMPLIANCE","DECEASED"]},"NaturalPersonIdentification":{"type":"object","properties":{"identificationId":{"type":"string","format":"uuid","description":"Unique identification number in UUID format","readOnly":true},"createdOn":{"type":"string","format":"date-time","description":"The date on which the wizard was created","readOnly":true},"modifiedOn":{"type":"string","format":"date-time","description":"The date on which the wizard was modified the last time","readOnly":true},"externalVerifier":{"$ref":"#/components/schemas/ExternalVerifierEnum"},"identificationType":{"$ref":"#/components/schemas/IdentificationTypeEnum"},"identificationDate":{"description":"Date on which the identification was carried out. The date must be within the last 24 months.","type":"string","format":"date"},"identificationDocumentType":{"$ref":"#/components/schemas/IdentificationDocumentTypeEnum"},"documentNumber":{"description":"Document number of the identification document.","type":"string","minLength":1,"maxLength":255},"documentCountry":{"title":"CountryEnum","type":"string","description":"Issuing country of the identification document.","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]},"documentIssuer":{"description":"Issuing authority of the identification document","type":"string","minLength":1,"maxLength":255},"documentIssueDate":{"description":"Issue date of the identification document","type":"string","format":"date"},"documentExpiryDate":{"description":"Expiry date of the identification document. If the identification document is a birth certificate, the date on which the person comes of age must be entered as the expiry date.","type":"string","format":"date"},"documentMotherFullName":{"description":"Full name of the mother, only mandatory for identificationDocumentType = BIRTH_CERTIFICATE","type":"string","minLength":1,"maxLength":255},"documentMotherResidenceCity":{"description":"Residence city of the mother, only mandatory for identificationDocumentType = BIRTH_CERTIFICATE","type":"string","minLength":1,"maxLength":255},"documentFatherFullName":{"description":"Full name of the father, only mandatory for identificationDocumentType = BIRTH_CERTIFICATE","type":"string","minLength":1,"maxLength":255},"documentFatherResidenceCity":{"description":"Residence city of the father, only mandatory for identificationDocumentType = BIRTH_CERTIFICATE","type":"string","minLength":1,"maxLength":255}},"required":["createdOn","documentCountry","documentExpiryDate","documentIssueDate","documentIssuer","documentNumber","externalVerifier","identificationDate","identificationDocumentType","identificationId","identificationType","modifiedOn"],"title":"NaturalPersonIdentification"},"ExternalVerifierEnum":{"title":"ExternalVerifierEnum","description":"The legal name of the vendor/company performing the identification for this natural person","type":"string","enum":["WEB_ID","ID_NOW","DEUTSCHE_POST","PARTNER","OTHER"]},"IdentificationTypeEnum":{"title":"IdentificationTypeEnum","description":"Method used to identify the customer","type":"string","enum":["VIDEO_IDENT","IN_PERSON","POST_IDENT","E_ID","ID_COPY"]},"IdentificationDocumentTypeEnum":{"title":"IdentificationDocumentTypeEnum","description":"Type of the identification document which has been used for identification of the natural person.","type":"string","enum":["ID","PASSPORT","BIRTH_CERTIFICATE"]},"NaturalPersonDocumentSignature":{"title":"NaturalPersonDocumentSignature","type":"object","properties":{"partnerDocumentId":{"type":"string","format":"uuid","description":"Id of the partner document which was signed"},"name":{"type":"string","description":"Name of the document"},"documentType":{"$ref":"#/components/schemas/DocumentSignatureTypeEnum"},"version":{"type":"integer","description":"Version of the document"},"customerId":{"type":"string","format":"uuid","description":"Id of the customer in whose context the natural person is active. Required only for TERMS_AND_CONDITIONS document type."},"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","createdOn","modifiedOn"]},"DocumentSignatureTypeEnum":{"title":"DocumentSignatureTypeEnum","type":"string","enum":["TERMS_AND_CONDITIONS","DATA_PRIVACY_POLICY"]},"TradingProfile":{"title":"TradingProfile","type":"object","description":"Trading profile for a natural person","properties":{"assetTypeProfiles":{"type":"array","description":"Trading profile details per asset type","items":{"$ref":"#/components/schemas/AssetTypeTradingProfile"}},"investmentObjectives":{"$ref":"#/components/schemas/InvestmentObjectives"}}},"AssetTypeTradingProfile":{"title":"AssetTypeTradingProfile","type":"object","required":["assetType","hasKnowledge","hasExperience","createdOn","modifiedOn","riskAcknowledged"],"properties":{"assetType":{"$ref":"#/components/schemas/CreateUpdateTraditionalAssetTypeEnum"},"hasKnowledge":{"type":"boolean","description":"Indicates if the person has trading knowledge"},"hasExperience":{"type":"boolean","description":"Indicates if the person has trading experience"},"tradingExperience":{"$ref":"#/components/schemas/TradingExperience"},"createdOn":{"type":"string","format":"date-time","description":"The date on which the trading profile was created for asset type"},"modifiedOn":{"type":"string","format":"date-time","description":"The date on which the trading profile was modified the last time for asset type"},"appropriatenessTestPassed":{"type":"boolean"},"riskAcknowledged":{"type":"boolean"}}},"CreateUpdateTraditionalAssetTypeEnum":{"title":"CreateUpdateTraditionalAssetTypeEnum","type":"string","description":"The type of the traditional asset for create and update operations","enum":["BOND","ETF","EQUITY","FUND","COMMODITY","DERIVATIVE","ETN","SECURITY_TOKEN"]},"TradingExperience":{"title":"TradingExperience","type":"object","description":"Trading experience details","properties":{"yearsOfExperience":{"type":"integer","description":"Number of years of trading experience","minimum":0},"numberOfTrades":{"type":"integer","description":"Number of trades executed","minimum":0},"tradeVolume":{"type":"number","description":"Total volume of trades","minimum":0}},"required":["yearsOfExperience","numberOfTrades","tradeVolume"]},"InvestmentObjectives":{"title":"InvestmentObjectives","type":"object","description":"Investment objectives categorized by purpose","properties":{"growthAndSavings":{"type":"array","description":"Growth and savings investment purposes","items":{"$ref":"#/components/schemas/GrowthAndSavingsPurposeEnum"}},"capitalProtectionAndHedging":{"type":"array","description":"Capital protection and hedging investment purposes","items":{"$ref":"#/components/schemas/CapitalProtectionAndHedgingPurposeEnum"}},"incomeAndLiquidity":{"type":"array","description":"Income and liquidity investment purposes","items":{"$ref":"#/components/schemas/IncomeAndLiquidityPurposeEnum"}},"retirementAndFuturePlanning":{"type":"array","description":"Retirement and future planning investment purposes","items":{"$ref":"#/components/schemas/RetirementAndFuturePlanningPurposeEnum"}},"specificInvestmentTypes":{"type":"array","description":"Specific investment types purposes","items":{"$ref":"#/components/schemas/SpecificInvestmentTypesPurposeEnum"}},"taxAndEstatePlanning":{"type":"array","description":"Tax and estate planning investment purposes","items":{"$ref":"#/components/schemas/TaxAndEstatePlanningPurposeEnum"}}}},"GrowthAndSavingsPurposeEnum":{"title":"GrowthAndSavingsPurposeEnum","type":"string","enum":["CAPITAL_GROWTH","LONG_TERM_SAVING","PERSONAL_INVESTMENTS"]},"CapitalProtectionAndHedgingPurposeEnum":{"title":"CapitalProtectionAndHedgingPurposeEnum","type":"string","enum":["WEALTH_PRESERVATION","HEDGING","RISK_MANAGEMENT"]},"IncomeAndLiquidityPurposeEnum":{"title":"IncomeAndLiquidityPurposeEnum","type":"string","enum":["INCOME_GENERATION","CASH_MANAGEMENT","SHORT_TERM_LIQUIDITY"]},"RetirementAndFuturePlanningPurposeEnum":{"title":"RetirementAndFuturePlanningPurposeEnum","type":"string","enum":["PENSION_PLANNING","EDUCATION_FUNDING","FAMILY_SECURITY"]},"SpecificInvestmentTypesPurposeEnum":{"title":"SpecificInvestmentTypesPurposeEnum","type":"string","enum":["INVESTMENT_IN_LISTED_EQUITIES","SMALL_SCALE_INVESTMENTS","REAL_ESTATE_INVESTMENTS","ALTERNATIVE_INVESTMENTS","SPECULATIVE_INVESTMENTS","SHORT_TERM_TRADING"]},"TaxAndEstatePlanningPurposeEnum":{"title":"TaxAndEstatePlanningPurposeEnum","type":"string","enum":["TAX_PLANNING","ESTATE_PLANNING"]},"GenderEnum":{"title":"GenderEnum","type":"string","description":"Gender","enum":["MALE","FEMALE","DIVERSE"]},"NaturalPersonTitleEnum":{"title":"NaturalPersonTitleEnum","type":"string","enum":["PROFESSOR","MAGISTER","DR"]},"NaturalPersonMaritalStatusEnum":{"title":"NaturalPersonMaritalStatusEnum","type":"string","enum":["MARRIED","DIVORCED","WIDOWED","SINGLE","SEPARATED","REGISTERED_PARTNERSHIP"]},"CountryEnum":{"title":"CountryEnum","type":"string","description":"Country code in **ISO 3166-1 alpha-2** standard","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]},"Nationality":{"title":"Nationality","type":"object","description":"Nationality of the customer","properties":{"countryCode":{"$ref":"#/components/schemas/CountryEnum"},"nationalIdentifier":{"type":"string","description":"National identifier of the customer"},"nationalIdentifierType":{"$ref":"#/components/schemas/NationalIdentifierType"}},"required":["countryCode"]},"NationalIdentifierType":{"title":"NationalIdentifierType","type":"string","description":"National identifier type of the customer","enum":["CONCAT","NATIONAL_PASSPORT_NUMBER","BELGIAN_NATIONAL_NUMBER","BULGARIAN_PERSONAL_NUMBER","CZECH_NATIONAL_IDENTIFICATION_NUMBER","DENMARK_PERSONAL_IDENTITY_CODE","ESTONIAN_PERSONAL_IDENTIFICATION_CODE","SPAIN_TAX_IDENTIFICATION_NUMBER","FINLAND_PERSONAL_IDENTITY_CODE","GREECE_DSS_DIGIT_INVESTOR_SHARE","CROATIA_PERSONAL_IDENTIFICATION_NUMBER","ICELAND_PERSONAL_IDENTITY_CODE","ITALY_FISCAL_CODE","LITHUANIA_PERSONAL_CODE","LATVIA_PERSONAL_CODE","MALTA_NATIONAL_IDENTIFICATION_NUMBER","NORWAY_PERSONAL_ID","POLAND_NATIONAL_IDENTIFICATION_NUMBER","PORTUGAL_TAX_NUMBER","ROMANIA_NATIONAL_IDENTIFICATION_NUMBER","SWEDEN_PERSONAL_IDENTITY_NUMBER","SLOVENIA_PERSONAL_IDENTIFICATION_NUMBER","SLOVAKIA_PERSONAL_NUMBER"]},"LanguageEnum":{"title":"LanguageEnum","type":"string","description":"Language code in ISO 639-1 two-letter codes (EU only)","enum":["da","de","el","en","es","fi","fr","hu","it","lt","lv","mt","nl","pl","pt","ro","sk","sl","sv"]},"TaxDetail":{"title":"TaxDetail","type":"object","properties":{"taxId":{"type":"string","minLength":1,"maxLength":255},"taxResidency":{"$ref":"#/components/schemas/CountryEnum"},"noTinConfirmation":{"description":"Indicates that the customer does not have a Tax Identification Number (TIN), which should only be used in exceptional cases where no TIN exists. If this field is set to true, the customer must provide supporting document (docType: TIN_NA_CONFIRMATION) confirming that no TIN is available.","type":"boolean","default":false}},"required":["taxResidency"]},"NaturalPersonProfessionGroupEnum":{"title":"NaturalPersonProfessionGroupEnum","type":"string","enum":["EMPLOYED","INDEPENDENT","PENSIONER","MEMBER_OF_THE_BOARD","STUDENT_OR_PUPIL","UNEMPLOYED","PUBLIC_SECTOR_EMPLOYEE","PROFESSIONAL_SOLDIER","FREELANCER","HOUSEWORK","RETIRED"]},"NaturalPersonNaceSector":{"title":"NaturalPersonNaceSector","type":"object","properties":{"section":{"type":"string","minLength":1,"maxLength":1,"pattern":"^[A-V]$"},"description":{"type":"string","maxLength":255}},"required":["section"]},"Address":{"title":"Address","type":"object","description":"Address","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":10},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string","minLength":1}},"required":["street","streetNumber","city","zip","country"]},"NaturalPersonSourceOfIncomeEnum":{"title":"NaturalPersonSourceOfIncomeEnum","type":"string","enum":["INCOME_FROM_EMPLOYMENT","INCOME_FROM_CAPITAL_ASSETS","INCOME_FROM_RENTING_AND_LEASING","INCOME_FROM_AGRICULTURE_AND_FORESTRY","INCOME_FROM_BUSINESS_OPERATIONS","INCOME_FROM_SELF_EMPLOYMENT","OTHER_INCOME","SALES_OF_ASSETS","FAMILY_INCOME_OR_DONATIONS","INHERITANCE","PENSION","PUBLIC_SUBSIDES"],"description":"source of income"},"NaturalPersonAssetOriginEnum":{"title":"NaturalPersonAssetOriginEnum","type":"string","enum":["NON_EMPLOYED_LABOR","CAPITAL_ASSETS","REAL_ESTATE","INHERITANCE","DONATION","AGRICULTURE_AND_FORESTRY","TRADE","SELF_EMPLOYED_WORK"],"description":"source of income"},"Contact":{"title":"Contact","type":"object","properties":{"phone":{"type":"string","description":"Mobile telephone number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"email":{"type":"string","description":"E-mail address","maxLength":255,"pattern":"^[a-zA-Z0-9.!#$%&'*+\\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$"},"fax":{"type":"string","description":"Fax number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"website":{"type":"string","description":"website address","maxLength":320}},"required":["phone","email"]}}}}
```

## The NaturalPersonData object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"NaturalPersonData":{"title":"NaturalPersonData","type":"object","properties":{"gender":{"$ref":"#/components/schemas/GenderEnum"},"title":{"$ref":"#/components/schemas/NaturalPersonTitleEnum"},"firstName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^\\S+( \\S+)*$","description":"All first names of the person according to the identification document"},"lastName":{"type":"string","minLength":1,"maxLength":255,"description":"Natural person last name"},"maritalStatus":{"$ref":"#/components/schemas/NaturalPersonMaritalStatusEnum"},"birthDay":{"type":"string","format":"date"},"birthPlace":{"type":"string","minLength":1,"maxLength":255},"birthCountry":{"$ref":"#/components/schemas/CountryEnum"},"nationalities":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/Nationality"}},"language":{"$ref":"#/components/schemas/LanguageEnum"},"taxDetails":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/TaxDetail"}},"isUsNationality":{"type":"boolean","description":"FATCA - Question whether the customer is subject to US tax liability (nationality or other references due to a green card, registration address, etc.)."},"profession":{"type":"string","minLength":1,"maxLength":255},"professionGroup":{"$ref":"#/components/schemas/NaturalPersonProfessionGroupEnum"},"naceSectors":{"description":"Specification of the sector in which the natural person is professionally active. The information should be provided according to the main classes of the NACE codes (Sections A-V) without subclasses. (Level 1)","type":"array","items":{"$ref":"#/components/schemas/NaturalPersonNaceSector"}},"mainAddress":{"$ref":"#/components/schemas/Address"},"correspondenceAddress":{"$ref":"#/components/schemas/Address"},"annualIncomeNet":{"type":"number","multipleOf":0.01,"description":"Annual income net"},"sourceOfIncome":{"type":"array","items":{"$ref":"#/components/schemas/NaturalPersonSourceOfIncomeEnum"}},"availableAssets":{"type":"number","multipleOf":0.01,"description":"Available assets"},"originOfAssets":{"type":"array","items":{"$ref":"#/components/schemas/NaturalPersonAssetOriginEnum"}},"contact":{"$ref":"#/components/schemas/Contact"},"externalId":{"type":"string","minLength":1,"description":"External Id in partner's system. This value has to be unique"}},"required":["birthCountry","birthDay","birthPlace","contact","firstName","gender","isUsNationality","lastName","mainAddress","nationalities","taxDetails"],"description":""},"GenderEnum":{"title":"GenderEnum","type":"string","description":"Gender","enum":["MALE","FEMALE","DIVERSE"]},"NaturalPersonTitleEnum":{"title":"NaturalPersonTitleEnum","type":"string","enum":["PROFESSOR","MAGISTER","DR"]},"NaturalPersonMaritalStatusEnum":{"title":"NaturalPersonMaritalStatusEnum","type":"string","enum":["MARRIED","DIVORCED","WIDOWED","SINGLE","SEPARATED","REGISTERED_PARTNERSHIP"]},"CountryEnum":{"title":"CountryEnum","type":"string","description":"Country code in **ISO 3166-1 alpha-2** standard","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]},"Nationality":{"title":"Nationality","type":"object","description":"Nationality of the customer","properties":{"countryCode":{"$ref":"#/components/schemas/CountryEnum"},"nationalIdentifier":{"type":"string","description":"National identifier of the customer"},"nationalIdentifierType":{"$ref":"#/components/schemas/NationalIdentifierType"}},"required":["countryCode"]},"NationalIdentifierType":{"title":"NationalIdentifierType","type":"string","description":"National identifier type of the customer","enum":["CONCAT","NATIONAL_PASSPORT_NUMBER","BELGIAN_NATIONAL_NUMBER","BULGARIAN_PERSONAL_NUMBER","CZECH_NATIONAL_IDENTIFICATION_NUMBER","DENMARK_PERSONAL_IDENTITY_CODE","ESTONIAN_PERSONAL_IDENTIFICATION_CODE","SPAIN_TAX_IDENTIFICATION_NUMBER","FINLAND_PERSONAL_IDENTITY_CODE","GREECE_DSS_DIGIT_INVESTOR_SHARE","CROATIA_PERSONAL_IDENTIFICATION_NUMBER","ICELAND_PERSONAL_IDENTITY_CODE","ITALY_FISCAL_CODE","LITHUANIA_PERSONAL_CODE","LATVIA_PERSONAL_CODE","MALTA_NATIONAL_IDENTIFICATION_NUMBER","NORWAY_PERSONAL_ID","POLAND_NATIONAL_IDENTIFICATION_NUMBER","PORTUGAL_TAX_NUMBER","ROMANIA_NATIONAL_IDENTIFICATION_NUMBER","SWEDEN_PERSONAL_IDENTITY_NUMBER","SLOVENIA_PERSONAL_IDENTIFICATION_NUMBER","SLOVAKIA_PERSONAL_NUMBER"]},"LanguageEnum":{"title":"LanguageEnum","type":"string","description":"Language code in ISO 639-1 two-letter codes (EU only)","enum":["da","de","el","en","es","fi","fr","hu","it","lt","lv","mt","nl","pl","pt","ro","sk","sl","sv"]},"TaxDetail":{"title":"TaxDetail","type":"object","properties":{"taxId":{"type":"string","minLength":1,"maxLength":255},"taxResidency":{"$ref":"#/components/schemas/CountryEnum"},"noTinConfirmation":{"description":"Indicates that the customer does not have a Tax Identification Number (TIN), which should only be used in exceptional cases where no TIN exists. If this field is set to true, the customer must provide supporting document (docType: TIN_NA_CONFIRMATION) confirming that no TIN is available.","type":"boolean","default":false}},"required":["taxResidency"]},"NaturalPersonProfessionGroupEnum":{"title":"NaturalPersonProfessionGroupEnum","type":"string","enum":["EMPLOYED","INDEPENDENT","PENSIONER","MEMBER_OF_THE_BOARD","STUDENT_OR_PUPIL","UNEMPLOYED","PUBLIC_SECTOR_EMPLOYEE","PROFESSIONAL_SOLDIER","FREELANCER","HOUSEWORK","RETIRED"]},"NaturalPersonNaceSector":{"title":"NaturalPersonNaceSector","type":"object","properties":{"section":{"type":"string","minLength":1,"maxLength":1,"pattern":"^[A-V]$"},"description":{"type":"string","maxLength":255}},"required":["section"]},"Address":{"title":"Address","type":"object","description":"Address","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":10},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string","minLength":1}},"required":["street","streetNumber","city","zip","country"]},"NaturalPersonSourceOfIncomeEnum":{"title":"NaturalPersonSourceOfIncomeEnum","type":"string","enum":["INCOME_FROM_EMPLOYMENT","INCOME_FROM_CAPITAL_ASSETS","INCOME_FROM_RENTING_AND_LEASING","INCOME_FROM_AGRICULTURE_AND_FORESTRY","INCOME_FROM_BUSINESS_OPERATIONS","INCOME_FROM_SELF_EMPLOYMENT","OTHER_INCOME","SALES_OF_ASSETS","FAMILY_INCOME_OR_DONATIONS","INHERITANCE","PENSION","PUBLIC_SUBSIDES"],"description":"source of income"},"NaturalPersonAssetOriginEnum":{"title":"NaturalPersonAssetOriginEnum","type":"string","enum":["NON_EMPLOYED_LABOR","CAPITAL_ASSETS","REAL_ESTATE","INHERITANCE","DONATION","AGRICULTURE_AND_FORESTRY","TRADE","SELF_EMPLOYED_WORK"],"description":"source of income"},"Contact":{"title":"Contact","type":"object","properties":{"phone":{"type":"string","description":"Mobile telephone number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"email":{"type":"string","description":"E-mail address","maxLength":255,"pattern":"^[a-zA-Z0-9.!#$%&'*+\\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$"},"fax":{"type":"string","description":"Fax number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"website":{"type":"string","description":"website address","maxLength":320}},"required":["phone","email"]}}}}
```

## The NaturalPersonUpdate object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"NaturalPersonUpdate":{"title":"NaturalPersonUpdate","type":"object","properties":{"naturalPersonUpdateData":{"$ref":"#/components/schemas/NaturalPersonUpdateData"},"documentId":{"type":"string","format":"uuid","description":"Document ID in UUID format for those params where a document upload is required (title, lastName, deathDay)"}},"required":["naturalPersonUpdateData"]},"NaturalPersonUpdateData":{"title":"NaturalPersonUpdateData","type":"object","properties":{"annualIncomeNet":{"type":"number","multipleOf":0.01,"description":"Annual income net"},"sourceOfIncome":{"type":"array","items":{"$ref":"#/components/schemas/NaturalPersonSourceOfIncomeEnum"}},"availableAssets":{"type":"number","multipleOf":0.01,"description":"Available assets"},"originOfAssets":{"type":"array","items":{"$ref":"#/components/schemas/NaturalPersonAssetOriginEnum"}},"contact":{"$ref":"#/components/schemas/Contact"},"mainAddress":{"title":"Address","type":"object","description":"Legal address of the natural person. \\\nIf the new address is outside DE: A corresponding document (proof of residence) must be submitted to update the legal address. When uploading the document via respecting endpoint, the exact document name must be specified under 'name' and 'PROOF_OF_RESIDENCE' must be selected as the type.\n","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":10},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string","minLength":1}},"required":["street","streetNumber","city","zip","country"]},"correspondenceAddress":{"$ref":"#/components/schemas/Address"},"title":{"title":"NaturalPersonTitleEnum","type":"string","enum":["PROFESSOR","MAGISTER","DR"],"description":"A corresponding document (proof of obtaining the respective title) must be submitted to update the title. When uploading the document via respecting endpoint, the exact document name must be specified under 'name' and 'KYC' must be selected as the type.\n"},"lastName":{"type":"string","description":"Natural person last name. \\\nA corresponding document (proof of respective name change) must be submitted to update the last name. When uploading the document via respecting endpoint, the exact document name must be specified under 'name' and 'KYC' must be selected as the type.\n","maxLength":255},"firstName":{"type":"string","description":"Natural person first name. \\\nA corresponding document (proof of respective name change) must be submitted to update the first name. When uploading the document via respecting endpoint, the exact document name must be specified under 'name' and 'KYC' must be selected as the type.\n"},"gender":{"title":"GenderEnum","type":"string","description":"A corresponding document (proof of respective gender change) must be submitted to update the gender. When uploading the document via respecting endpoint, the exact document name must be specified under 'name' and 'KYC' must be selected as the type.\n","enum":["MALE","FEMALE","DIVERSE"]},"maritalStatus":{"$ref":"#/components/schemas/NaturalPersonMaritalStatusEnum"},"profession":{"type":"string","minLength":1,"maxLength":255},"professionGroup":{"$ref":"#/components/schemas/NaturalPersonProfessionGroupEnum"},"naceSectors":{"description":"Specification of the sector in which the natural person is professionally active. The information should be provided according to the main classes of the NACE codes (Sections A-V) without subclasses. (Level 1)","type":"array","items":{"$ref":"#/components/schemas/NaturalPersonNaceSector"}},"taxDetails":{"type":"array","items":{"$ref":"#/components/schemas/TaxDetail"}},"nationalities":{"type":"array","items":{"title":"Nationality","type":"object","description":"A corresponding document (ID, passport) must be submitted to update the nationality. When uploading the document via respecting endpoint, the exact document name must be specified under 'name' and 'KYC' must be selected as the type.\n","properties":{"countryCode":{"$ref":"#/components/schemas/CountryEnum"},"nationalIdentifier":{"type":"string","description":"National identifier of the customer"},"nationalIdentifierType":{"$ref":"#/components/schemas/NationalIdentifierType"}},"required":["countryCode"]}},"externalId":{"type":"string","minLength":1,"description":"External Id in partner's system. This value has to be unique"},"deathDay":{"type":"string","format":"date","description":"A corresponding document (death certificate) must be submitted to update the death day. When uploading the document via respecting endpoint, the exact document name must be specified under 'name' and 'OTHER' must be selected as the type.\n"}}},"NaturalPersonSourceOfIncomeEnum":{"title":"NaturalPersonSourceOfIncomeEnum","type":"string","enum":["INCOME_FROM_EMPLOYMENT","INCOME_FROM_CAPITAL_ASSETS","INCOME_FROM_RENTING_AND_LEASING","INCOME_FROM_AGRICULTURE_AND_FORESTRY","INCOME_FROM_BUSINESS_OPERATIONS","INCOME_FROM_SELF_EMPLOYMENT","OTHER_INCOME","SALES_OF_ASSETS","FAMILY_INCOME_OR_DONATIONS","INHERITANCE","PENSION","PUBLIC_SUBSIDES"],"description":"source of income"},"NaturalPersonAssetOriginEnum":{"title":"NaturalPersonAssetOriginEnum","type":"string","enum":["NON_EMPLOYED_LABOR","CAPITAL_ASSETS","REAL_ESTATE","INHERITANCE","DONATION","AGRICULTURE_AND_FORESTRY","TRADE","SELF_EMPLOYED_WORK"],"description":"source of income"},"Contact":{"title":"Contact","type":"object","properties":{"phone":{"type":"string","description":"Mobile telephone number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"email":{"type":"string","description":"E-mail address","maxLength":255,"pattern":"^[a-zA-Z0-9.!#$%&'*+\\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$"},"fax":{"type":"string","description":"Fax number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"website":{"type":"string","description":"website address","maxLength":320}},"required":["phone","email"]},"CountryEnum":{"title":"CountryEnum","type":"string","description":"Country code in **ISO 3166-1 alpha-2** standard","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]},"Address":{"title":"Address","type":"object","description":"Address","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":10},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string","minLength":1}},"required":["street","streetNumber","city","zip","country"]},"NaturalPersonMaritalStatusEnum":{"title":"NaturalPersonMaritalStatusEnum","type":"string","enum":["MARRIED","DIVORCED","WIDOWED","SINGLE","SEPARATED","REGISTERED_PARTNERSHIP"]},"NaturalPersonProfessionGroupEnum":{"title":"NaturalPersonProfessionGroupEnum","type":"string","enum":["EMPLOYED","INDEPENDENT","PENSIONER","MEMBER_OF_THE_BOARD","STUDENT_OR_PUPIL","UNEMPLOYED","PUBLIC_SECTOR_EMPLOYEE","PROFESSIONAL_SOLDIER","FREELANCER","HOUSEWORK","RETIRED"]},"NaturalPersonNaceSector":{"title":"NaturalPersonNaceSector","type":"object","properties":{"section":{"type":"string","minLength":1,"maxLength":1,"pattern":"^[A-V]$"},"description":{"type":"string","maxLength":255}},"required":["section"]},"TaxDetail":{"title":"TaxDetail","type":"object","properties":{"taxId":{"type":"string","minLength":1,"maxLength":255},"taxResidency":{"$ref":"#/components/schemas/CountryEnum"},"noTinConfirmation":{"description":"Indicates that the customer does not have a Tax Identification Number (TIN), which should only be used in exceptional cases where no TIN exists. If this field is set to true, the customer must provide supporting document (docType: TIN_NA_CONFIRMATION) confirming that no TIN is available.","type":"boolean","default":false}},"required":["taxResidency"]},"NationalIdentifierType":{"title":"NationalIdentifierType","type":"string","description":"National identifier type of the customer","enum":["CONCAT","NATIONAL_PASSPORT_NUMBER","BELGIAN_NATIONAL_NUMBER","BULGARIAN_PERSONAL_NUMBER","CZECH_NATIONAL_IDENTIFICATION_NUMBER","DENMARK_PERSONAL_IDENTITY_CODE","ESTONIAN_PERSONAL_IDENTIFICATION_CODE","SPAIN_TAX_IDENTIFICATION_NUMBER","FINLAND_PERSONAL_IDENTITY_CODE","GREECE_DSS_DIGIT_INVESTOR_SHARE","CROATIA_PERSONAL_IDENTIFICATION_NUMBER","ICELAND_PERSONAL_IDENTITY_CODE","ITALY_FISCAL_CODE","LITHUANIA_PERSONAL_CODE","LATVIA_PERSONAL_CODE","MALTA_NATIONAL_IDENTIFICATION_NUMBER","NORWAY_PERSONAL_ID","POLAND_NATIONAL_IDENTIFICATION_NUMBER","PORTUGAL_TAX_NUMBER","ROMANIA_NATIONAL_IDENTIFICATION_NUMBER","SWEDEN_PERSONAL_IDENTITY_NUMBER","SLOVENIA_PERSONAL_IDENTIFICATION_NUMBER","SLOVAKIA_PERSONAL_NUMBER"]}}}}
```

## The NaturalPersonUpdateData object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"NaturalPersonUpdateData":{"title":"NaturalPersonUpdateData","type":"object","properties":{"annualIncomeNet":{"type":"number","multipleOf":0.01,"description":"Annual income net"},"sourceOfIncome":{"type":"array","items":{"$ref":"#/components/schemas/NaturalPersonSourceOfIncomeEnum"}},"availableAssets":{"type":"number","multipleOf":0.01,"description":"Available assets"},"originOfAssets":{"type":"array","items":{"$ref":"#/components/schemas/NaturalPersonAssetOriginEnum"}},"contact":{"$ref":"#/components/schemas/Contact"},"mainAddress":{"title":"Address","type":"object","description":"Legal address of the natural person. \\\nIf the new address is outside DE: A corresponding document (proof of residence) must be submitted to update the legal address. When uploading the document via respecting endpoint, the exact document name must be specified under 'name' and 'PROOF_OF_RESIDENCE' must be selected as the type.\n","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":10},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string","minLength":1}},"required":["street","streetNumber","city","zip","country"]},"correspondenceAddress":{"$ref":"#/components/schemas/Address"},"title":{"title":"NaturalPersonTitleEnum","type":"string","enum":["PROFESSOR","MAGISTER","DR"],"description":"A corresponding document (proof of obtaining the respective title) must be submitted to update the title. When uploading the document via respecting endpoint, the exact document name must be specified under 'name' and 'KYC' must be selected as the type.\n"},"lastName":{"type":"string","description":"Natural person last name. \\\nA corresponding document (proof of respective name change) must be submitted to update the last name. When uploading the document via respecting endpoint, the exact document name must be specified under 'name' and 'KYC' must be selected as the type.\n","maxLength":255},"firstName":{"type":"string","description":"Natural person first name. \\\nA corresponding document (proof of respective name change) must be submitted to update the first name. When uploading the document via respecting endpoint, the exact document name must be specified under 'name' and 'KYC' must be selected as the type.\n"},"gender":{"title":"GenderEnum","type":"string","description":"A corresponding document (proof of respective gender change) must be submitted to update the gender. When uploading the document via respecting endpoint, the exact document name must be specified under 'name' and 'KYC' must be selected as the type.\n","enum":["MALE","FEMALE","DIVERSE"]},"maritalStatus":{"$ref":"#/components/schemas/NaturalPersonMaritalStatusEnum"},"profession":{"type":"string","minLength":1,"maxLength":255},"professionGroup":{"$ref":"#/components/schemas/NaturalPersonProfessionGroupEnum"},"naceSectors":{"description":"Specification of the sector in which the natural person is professionally active. The information should be provided according to the main classes of the NACE codes (Sections A-V) without subclasses. (Level 1)","type":"array","items":{"$ref":"#/components/schemas/NaturalPersonNaceSector"}},"taxDetails":{"type":"array","items":{"$ref":"#/components/schemas/TaxDetail"}},"nationalities":{"type":"array","items":{"title":"Nationality","type":"object","description":"A corresponding document (ID, passport) must be submitted to update the nationality. When uploading the document via respecting endpoint, the exact document name must be specified under 'name' and 'KYC' must be selected as the type.\n","properties":{"countryCode":{"$ref":"#/components/schemas/CountryEnum"},"nationalIdentifier":{"type":"string","description":"National identifier of the customer"},"nationalIdentifierType":{"$ref":"#/components/schemas/NationalIdentifierType"}},"required":["countryCode"]}},"externalId":{"type":"string","minLength":1,"description":"External Id in partner's system. This value has to be unique"},"deathDay":{"type":"string","format":"date","description":"A corresponding document (death certificate) must be submitted to update the death day. When uploading the document via respecting endpoint, the exact document name must be specified under 'name' and 'OTHER' must be selected as the type.\n"}}},"NaturalPersonSourceOfIncomeEnum":{"title":"NaturalPersonSourceOfIncomeEnum","type":"string","enum":["INCOME_FROM_EMPLOYMENT","INCOME_FROM_CAPITAL_ASSETS","INCOME_FROM_RENTING_AND_LEASING","INCOME_FROM_AGRICULTURE_AND_FORESTRY","INCOME_FROM_BUSINESS_OPERATIONS","INCOME_FROM_SELF_EMPLOYMENT","OTHER_INCOME","SALES_OF_ASSETS","FAMILY_INCOME_OR_DONATIONS","INHERITANCE","PENSION","PUBLIC_SUBSIDES"],"description":"source of income"},"NaturalPersonAssetOriginEnum":{"title":"NaturalPersonAssetOriginEnum","type":"string","enum":["NON_EMPLOYED_LABOR","CAPITAL_ASSETS","REAL_ESTATE","INHERITANCE","DONATION","AGRICULTURE_AND_FORESTRY","TRADE","SELF_EMPLOYED_WORK"],"description":"source of income"},"Contact":{"title":"Contact","type":"object","properties":{"phone":{"type":"string","description":"Mobile telephone number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"email":{"type":"string","description":"E-mail address","maxLength":255,"pattern":"^[a-zA-Z0-9.!#$%&'*+\\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$"},"fax":{"type":"string","description":"Fax number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"website":{"type":"string","description":"website address","maxLength":320}},"required":["phone","email"]},"CountryEnum":{"title":"CountryEnum","type":"string","description":"Country code in **ISO 3166-1 alpha-2** standard","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]},"Address":{"title":"Address","type":"object","description":"Address","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":10},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string","minLength":1}},"required":["street","streetNumber","city","zip","country"]},"NaturalPersonMaritalStatusEnum":{"title":"NaturalPersonMaritalStatusEnum","type":"string","enum":["MARRIED","DIVORCED","WIDOWED","SINGLE","SEPARATED","REGISTERED_PARTNERSHIP"]},"NaturalPersonProfessionGroupEnum":{"title":"NaturalPersonProfessionGroupEnum","type":"string","enum":["EMPLOYED","INDEPENDENT","PENSIONER","MEMBER_OF_THE_BOARD","STUDENT_OR_PUPIL","UNEMPLOYED","PUBLIC_SECTOR_EMPLOYEE","PROFESSIONAL_SOLDIER","FREELANCER","HOUSEWORK","RETIRED"]},"NaturalPersonNaceSector":{"title":"NaturalPersonNaceSector","type":"object","properties":{"section":{"type":"string","minLength":1,"maxLength":1,"pattern":"^[A-V]$"},"description":{"type":"string","maxLength":255}},"required":["section"]},"TaxDetail":{"title":"TaxDetail","type":"object","properties":{"taxId":{"type":"string","minLength":1,"maxLength":255},"taxResidency":{"$ref":"#/components/schemas/CountryEnum"},"noTinConfirmation":{"description":"Indicates that the customer does not have a Tax Identification Number (TIN), which should only be used in exceptional cases where no TIN exists. If this field is set to true, the customer must provide supporting document (docType: TIN_NA_CONFIRMATION) confirming that no TIN is available.","type":"boolean","default":false}},"required":["taxResidency"]},"NationalIdentifierType":{"title":"NationalIdentifierType","type":"string","description":"National identifier type of the customer","enum":["CONCAT","NATIONAL_PASSPORT_NUMBER","BELGIAN_NATIONAL_NUMBER","BULGARIAN_PERSONAL_NUMBER","CZECH_NATIONAL_IDENTIFICATION_NUMBER","DENMARK_PERSONAL_IDENTITY_CODE","ESTONIAN_PERSONAL_IDENTIFICATION_CODE","SPAIN_TAX_IDENTIFICATION_NUMBER","FINLAND_PERSONAL_IDENTITY_CODE","GREECE_DSS_DIGIT_INVESTOR_SHARE","CROATIA_PERSONAL_IDENTIFICATION_NUMBER","ICELAND_PERSONAL_IDENTITY_CODE","ITALY_FISCAL_CODE","LITHUANIA_PERSONAL_CODE","LATVIA_PERSONAL_CODE","MALTA_NATIONAL_IDENTIFICATION_NUMBER","NORWAY_PERSONAL_ID","POLAND_NATIONAL_IDENTIFICATION_NUMBER","PORTUGAL_TAX_NUMBER","ROMANIA_NATIONAL_IDENTIFICATION_NUMBER","SWEDEN_PERSONAL_IDENTITY_NUMBER","SLOVENIA_PERSONAL_IDENTIFICATION_NUMBER","SLOVAKIA_PERSONAL_NUMBER"]}}}}
```

## The NaturalPersonDocumentSignature object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"NaturalPersonDocumentSignature":{"title":"NaturalPersonDocumentSignature","type":"object","properties":{"partnerDocumentId":{"type":"string","format":"uuid","description":"Id of the partner document which was signed"},"name":{"type":"string","description":"Name of the document"},"documentType":{"$ref":"#/components/schemas/DocumentSignatureTypeEnum"},"version":{"type":"integer","description":"Version of the document"},"customerId":{"type":"string","format":"uuid","description":"Id of the customer in whose context the natural person is active. Required only for TERMS_AND_CONDITIONS document type."},"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","createdOn","modifiedOn"]},"DocumentSignatureTypeEnum":{"title":"DocumentSignatureTypeEnum","type":"string","enum":["TERMS_AND_CONDITIONS","DATA_PRIVACY_POLICY"]}}}}
```

## The NaturalPersonPersonalData object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"NaturalPersonPersonalData":{"title":"NaturalPersonPersonalData","type":"object","properties":{"gender":{"$ref":"#/components/schemas/GenderEnum"},"title":{"$ref":"#/components/schemas/NaturalPersonTitleEnum"},"firstName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^\\S+( \\S+)*$","description":"All first names of the person according to the identification document"},"lastName":{"type":"string","minLength":1,"maxLength":255,"description":"Natural person last name"},"maritalStatus":{"$ref":"#/components/schemas/NaturalPersonMaritalStatusEnum"}},"required":["gender","firstName","lastName"]},"GenderEnum":{"title":"GenderEnum","type":"string","description":"Gender","enum":["MALE","FEMALE","DIVERSE"]},"NaturalPersonTitleEnum":{"title":"NaturalPersonTitleEnum","type":"string","enum":["PROFESSOR","MAGISTER","DR"]},"NaturalPersonMaritalStatusEnum":{"title":"NaturalPersonMaritalStatusEnum","type":"string","enum":["MARRIED","DIVORCED","WIDOWED","SINGLE","SEPARATED","REGISTERED_PARTNERSHIP"]}}}}
```

## The NaturalPersonBirthData object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"NaturalPersonBirthData":{"title":"NaturalPersonBirthData","type":"object","properties":{"birthDay":{"type":"string","format":"date"},"birthPlace":{"type":"string","minLength":1,"maxLength":255},"birthCountry":{"$ref":"#/components/schemas/CountryEnum"},"nationalities":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/Nationality"}},"language":{"$ref":"#/components/schemas/LanguageEnum"}},"required":["nationalities","birthDay","birthPlace","birthCountry"]},"CountryEnum":{"title":"CountryEnum","type":"string","description":"Country code in **ISO 3166-1 alpha-2** standard","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]},"Nationality":{"title":"Nationality","type":"object","description":"Nationality of the customer","properties":{"countryCode":{"$ref":"#/components/schemas/CountryEnum"},"nationalIdentifier":{"type":"string","description":"National identifier of the customer"},"nationalIdentifierType":{"$ref":"#/components/schemas/NationalIdentifierType"}},"required":["countryCode"]},"NationalIdentifierType":{"title":"NationalIdentifierType","type":"string","description":"National identifier type of the customer","enum":["CONCAT","NATIONAL_PASSPORT_NUMBER","BELGIAN_NATIONAL_NUMBER","BULGARIAN_PERSONAL_NUMBER","CZECH_NATIONAL_IDENTIFICATION_NUMBER","DENMARK_PERSONAL_IDENTITY_CODE","ESTONIAN_PERSONAL_IDENTIFICATION_CODE","SPAIN_TAX_IDENTIFICATION_NUMBER","FINLAND_PERSONAL_IDENTITY_CODE","GREECE_DSS_DIGIT_INVESTOR_SHARE","CROATIA_PERSONAL_IDENTIFICATION_NUMBER","ICELAND_PERSONAL_IDENTITY_CODE","ITALY_FISCAL_CODE","LITHUANIA_PERSONAL_CODE","LATVIA_PERSONAL_CODE","MALTA_NATIONAL_IDENTIFICATION_NUMBER","NORWAY_PERSONAL_ID","POLAND_NATIONAL_IDENTIFICATION_NUMBER","PORTUGAL_TAX_NUMBER","ROMANIA_NATIONAL_IDENTIFICATION_NUMBER","SWEDEN_PERSONAL_IDENTITY_NUMBER","SLOVENIA_PERSONAL_IDENTIFICATION_NUMBER","SLOVAKIA_PERSONAL_NUMBER"]},"LanguageEnum":{"title":"LanguageEnum","type":"string","description":"Language code in ISO 639-1 two-letter codes (EU only)","enum":["da","de","el","en","es","fi","fr","hu","it","lt","lv","mt","nl","pl","pt","ro","sk","sl","sv"]}}}}
```

## The NaturalPersonAddressData object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"NaturalPersonAddressData":{"title":"NaturalPersonAddressData","type":"object","description":"","properties":{"mainAddress":{"$ref":"#/components/schemas/Address"},"correspondenceAddress":{"$ref":"#/components/schemas/Address"}},"required":["mainAddress"]},"Address":{"title":"Address","type":"object","description":"Address","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":10},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string","minLength":1}},"required":["street","streetNumber","city","zip","country"]},"CountryEnum":{"title":"CountryEnum","type":"string","description":"Country code in **ISO 3166-1 alpha-2** standard","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]}}}}
```

## The NaturalPersonClassificationAssetDisclosures object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"NaturalPersonClassificationAssetDisclosures":{"title":"NaturalPersonClassificationAssetDisclosures","type":"object","properties":{"annualIncomeNet":{"type":"number","multipleOf":0.01,"description":"Annual income net"},"sourceOfIncome":{"type":"array","items":{"$ref":"#/components/schemas/NaturalPersonSourceOfIncomeEnum"}},"availableAssets":{"type":"number","multipleOf":0.01,"description":"Available assets"},"originOfAssets":{"type":"array","items":{"$ref":"#/components/schemas/NaturalPersonAssetOriginEnum"}}}},"NaturalPersonSourceOfIncomeEnum":{"title":"NaturalPersonSourceOfIncomeEnum","type":"string","enum":["INCOME_FROM_EMPLOYMENT","INCOME_FROM_CAPITAL_ASSETS","INCOME_FROM_RENTING_AND_LEASING","INCOME_FROM_AGRICULTURE_AND_FORESTRY","INCOME_FROM_BUSINESS_OPERATIONS","INCOME_FROM_SELF_EMPLOYMENT","OTHER_INCOME","SALES_OF_ASSETS","FAMILY_INCOME_OR_DONATIONS","INHERITANCE","PENSION","PUBLIC_SUBSIDES"],"description":"source of income"},"NaturalPersonAssetOriginEnum":{"title":"NaturalPersonAssetOriginEnum","type":"string","enum":["NON_EMPLOYED_LABOR","CAPITAL_ASSETS","REAL_ESTATE","INHERITANCE","DONATION","AGRICULTURE_AND_FORESTRY","TRADE","SELF_EMPLOYED_WORK"],"description":"source of income"}}}}
```

## The NaturalPersonTaxData object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"NaturalPersonTaxData":{"title":"NaturalPersonTaxData","type":"object","properties":{"taxDetails":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/TaxDetail"}},"isUsNationality":{"type":"boolean","description":"FATCA - Question whether the customer is subject to US tax liability (nationality or other references due to a green card, registration address, etc.)."}},"required":["isUsNationality","taxDetails"]},"TaxDetail":{"title":"TaxDetail","type":"object","properties":{"taxId":{"type":"string","minLength":1,"maxLength":255},"taxResidency":{"$ref":"#/components/schemas/CountryEnum"},"noTinConfirmation":{"description":"Indicates that the customer does not have a Tax Identification Number (TIN), which should only be used in exceptional cases where no TIN exists. If this field is set to true, the customer must provide supporting document (docType: TIN_NA_CONFIRMATION) confirming that no TIN is available.","type":"boolean","default":false}},"required":["taxResidency"]},"CountryEnum":{"title":"CountryEnum","type":"string","description":"Country code in **ISO 3166-1 alpha-2** standard","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]}}}}
```

## The NaturalPersonEmploymentData object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"NaturalPersonEmploymentData":{"title":"NaturalPersonEmploymentData","type":"object","properties":{"profession":{"type":"string","minLength":1,"maxLength":255},"professionGroup":{"$ref":"#/components/schemas/NaturalPersonProfessionGroupEnum"},"naceSectors":{"description":"Specification of the sector in which the natural person is professionally active. The information should be provided according to the main classes of the NACE codes (Sections A-V) without subclasses. (Level 1)","type":"array","items":{"$ref":"#/components/schemas/NaturalPersonNaceSector"}}}},"NaturalPersonProfessionGroupEnum":{"title":"NaturalPersonProfessionGroupEnum","type":"string","enum":["EMPLOYED","INDEPENDENT","PENSIONER","MEMBER_OF_THE_BOARD","STUDENT_OR_PUPIL","UNEMPLOYED","PUBLIC_SECTOR_EMPLOYEE","PROFESSIONAL_SOLDIER","FREELANCER","HOUSEWORK","RETIRED"]},"NaturalPersonNaceSector":{"title":"NaturalPersonNaceSector","type":"object","properties":{"section":{"type":"string","minLength":1,"maxLength":1,"pattern":"^[A-V]$"},"description":{"type":"string","maxLength":255}},"required":["section"]}}}}
```

## The NaturalPersonIdentificationData object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"NaturalPersonIdentificationData":{"title":"NaturalPersonIdentificationData","type":"object","properties":{"externalVerifier":{"$ref":"#/components/schemas/ExternalVerifierEnum"},"identificationType":{"$ref":"#/components/schemas/IdentificationTypeEnum"},"identificationDate":{"description":"Date on which the identification was carried out. The date must be within the last 24 months.","type":"string","format":"date"},"identificationDocumentType":{"$ref":"#/components/schemas/IdentificationDocumentTypeEnum"},"documentNumber":{"description":"Document number of the identification document.","type":"string","minLength":1,"maxLength":255},"documentCountry":{"title":"CountryEnum","type":"string","description":"Issuing country of the identification document.","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]},"documentIssuer":{"description":"Issuing authority of the identification document","type":"string","minLength":1,"maxLength":255},"documentIssueDate":{"description":"Issue date of the identification document","type":"string","format":"date"},"documentExpiryDate":{"description":"Expiry date of the identification document. If the identification document is a birth certificate, the date on which the person comes of age must be entered as the expiry date.","type":"string","format":"date"},"documentMotherFullName":{"description":"Full name of the mother, only mandatory for identificationDocumentType = BIRTH_CERTIFICATE","type":"string","minLength":1,"maxLength":255},"documentMotherResidenceCity":{"description":"Residence city of the mother, only mandatory for identificationDocumentType = BIRTH_CERTIFICATE","type":"string","minLength":1,"maxLength":255},"documentFatherFullName":{"description":"Full name of the father, only mandatory for identificationDocumentType = BIRTH_CERTIFICATE","type":"string","minLength":1,"maxLength":255},"documentFatherResidenceCity":{"description":"Residence city of the father, only mandatory for identificationDocumentType = BIRTH_CERTIFICATE","type":"string","minLength":1,"maxLength":255}},"required":["externalVerifier","identificationType","identificationDocumentType","documentNumber","documentCountry","documentIssuer","documentIssueDate","documentExpiryDate","identificationDate"]},"ExternalVerifierEnum":{"title":"ExternalVerifierEnum","description":"The legal name of the vendor/company performing the identification for this natural person","type":"string","enum":["WEB_ID","ID_NOW","DEUTSCHE_POST","PARTNER","OTHER"]},"IdentificationTypeEnum":{"title":"IdentificationTypeEnum","description":"Method used to identify the customer","type":"string","enum":["VIDEO_IDENT","IN_PERSON","POST_IDENT","E_ID","ID_COPY"]},"IdentificationDocumentTypeEnum":{"title":"IdentificationDocumentTypeEnum","description":"Type of the identification document which has been used for identification of the natural person.","type":"string","enum":["ID","PASSPORT","BIRTH_CERTIFICATE"]}}}}
```

## The NaturalPersonIdentification object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"NaturalPersonIdentification":{"type":"object","properties":{"identificationId":{"type":"string","format":"uuid","description":"Unique identification number in UUID format","readOnly":true},"createdOn":{"type":"string","format":"date-time","description":"The date on which the wizard was created","readOnly":true},"modifiedOn":{"type":"string","format":"date-time","description":"The date on which the wizard was modified the last time","readOnly":true},"externalVerifier":{"$ref":"#/components/schemas/ExternalVerifierEnum"},"identificationType":{"$ref":"#/components/schemas/IdentificationTypeEnum"},"identificationDate":{"description":"Date on which the identification was carried out. The date must be within the last 24 months.","type":"string","format":"date"},"identificationDocumentType":{"$ref":"#/components/schemas/IdentificationDocumentTypeEnum"},"documentNumber":{"description":"Document number of the identification document.","type":"string","minLength":1,"maxLength":255},"documentCountry":{"title":"CountryEnum","type":"string","description":"Issuing country of the identification document.","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]},"documentIssuer":{"description":"Issuing authority of the identification document","type":"string","minLength":1,"maxLength":255},"documentIssueDate":{"description":"Issue date of the identification document","type":"string","format":"date"},"documentExpiryDate":{"description":"Expiry date of the identification document. If the identification document is a birth certificate, the date on which the person comes of age must be entered as the expiry date.","type":"string","format":"date"},"documentMotherFullName":{"description":"Full name of the mother, only mandatory for identificationDocumentType = BIRTH_CERTIFICATE","type":"string","minLength":1,"maxLength":255},"documentMotherResidenceCity":{"description":"Residence city of the mother, only mandatory for identificationDocumentType = BIRTH_CERTIFICATE","type":"string","minLength":1,"maxLength":255},"documentFatherFullName":{"description":"Full name of the father, only mandatory for identificationDocumentType = BIRTH_CERTIFICATE","type":"string","minLength":1,"maxLength":255},"documentFatherResidenceCity":{"description":"Residence city of the father, only mandatory for identificationDocumentType = BIRTH_CERTIFICATE","type":"string","minLength":1,"maxLength":255}},"required":["createdOn","documentCountry","documentExpiryDate","documentIssueDate","documentIssuer","documentNumber","externalVerifier","identificationDate","identificationDocumentType","identificationId","identificationType","modifiedOn"],"title":"NaturalPersonIdentification"},"ExternalVerifierEnum":{"title":"ExternalVerifierEnum","description":"The legal name of the vendor/company performing the identification for this natural person","type":"string","enum":["WEB_ID","ID_NOW","DEUTSCHE_POST","PARTNER","OTHER"]},"IdentificationTypeEnum":{"title":"IdentificationTypeEnum","description":"Method used to identify the customer","type":"string","enum":["VIDEO_IDENT","IN_PERSON","POST_IDENT","E_ID","ID_COPY"]},"IdentificationDocumentTypeEnum":{"title":"IdentificationDocumentTypeEnum","description":"Type of the identification document which has been used for identification of the natural person.","type":"string","enum":["ID","PASSPORT","BIRTH_CERTIFICATE"]}}}}
```

## The Address object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"Address":{"title":"Address","type":"object","description":"Address","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":10},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string","minLength":1}},"required":["street","streetNumber","city","zip","country"]},"CountryEnum":{"title":"CountryEnum","type":"string","description":"Country code in **ISO 3166-1 alpha-2** standard","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]}}}}
```

## The CreateLegalEntityResult object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"CreateLegalEntityResult":{"title":"CreateLegalEntityResult","type":"object","properties":{"legalEntityId":{"type":"string","format":"uuid","description":"Unique legal entity identification number in UUID format","readOnly":true}},"required":["legalEntityId"]}}}}
```

## The LegalEntities object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"LegalEntities":{"title":"LegalEntities","type":"object","properties":{"data":{"type":"array","description":"Array of legal entities","items":{"$ref":"#/components/schemas/LegalEntity"}},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data","pagination"]},"LegalEntity":{"type":"object","properties":{"legalEntityId":{"type":"string","format":"uuid","description":"Unique legal entity identification number in UUID format"},"globalId":{"type":"string","minLength":12,"maxLength":12},"lei":{"$ref":"#/components/schemas/Lei"},"createdOn":{"type":"string","format":"date-time","description":"The date on which the natural person was created"},"modifiedOn":{"type":"string","format":"date-time","description":"The date on which the natural person was modified the last time"},"verifiedOn":{"type":"string","format":"date-time","description":"The date on which the natural person was verified"},"isSanction":{"type":"boolean","description":"Indication of whether the person is on sanction list."},"riskLevel":{"$ref":"#/components/schemas/RiskLevelEnum"},"legalEntityStatus":{"$ref":"#/components/schemas/LegalEntityStatusEnum"},"legalName":{"type":"string","description":"The legal name of the entity","pattern":"^[^,]*$","maxLength":255},"legalForm":{"$ref":"#/components/schemas/LegalFormEnum"},"naceSectors":{"type":"array","description":"Specification of the sector in which the company is mainly economically active. The information should be provided according to the groups of the NACE codes (Sections A-V, Groups 01.11 - 99.00) without subclasses. (Level 4)","items":{"$ref":"#/components/schemas/LegalEntityNaceSector"}},"registerCountry":{"$ref":"#/components/schemas/CountryEnum"},"registerNumber":{"type":"string","minLength":1,"maxLength":255,"description":"Number at which the company is registered"},"registerCourt":{"type":"string","minLength":1,"maxLength":255,"description":"An administrative court in which the company was registered"},"registerCourtZipCode":{"type":"string","minLength":1,"maxLength":255,"description":"An administrative court zip code in which the company was registered"},"registeredOn":{"type":"string","format":"date","description":"The date on which the entity was registered"},"foundedOn":{"type":"string","format":"date","description":"The date on which the entity was founded"},"vatId":{"type":"string","minLength":11,"maxLength":11,"description":"The value-added tax id of the legal entity"},"purpose":{"type":"string","minLength":1,"maxLength":255,"description":"The purpose of the legal entity"},"mainAddress":{"$ref":"#/components/schemas/Address"},"correspondenceAddress":{"$ref":"#/components/schemas/Address"},"invoiceAddress":{"$ref":"#/components/schemas/Address"},"contact":{"$ref":"#/components/schemas/Contact"},"searchId":{"type":"string","format":"uuid"},"taxNumber":{"type":"string","minLength":1,"maxLength":255,"description":"The tax number of the legal entity"},"isListed":{"type":"boolean","description":"Determine whether the shares of that company are on the list (or board) of stock that are officially traded on a stock exchange"},"listedAt":{"type":"string","minLength":1,"maxLength":255,"description":"Determine where the shares of that company are officially traded on a stock exchange. Only when entity is listed"},"averageProfit":{"type":"number","multipleOf":0.01,"description":"Average profit for the year (after tax)"},"averageRevenue":{"type":"number","multipleOf":0.01,"description":"Average revenue for the year"},"liquidAssets":{"type":"number","multipleOf":0.01,"description":"Liquid assets"},"lastAnnualFinancialStatement":{"type":"string","format":"date","description":"Last annual financial statement date"},"fatcaCrsDeclaration":{"$ref":"#/components/schemas/FatcaCrsDeclaration"},"externalId":{"type":"string","minLength":1,"description":"External Id in partner's system. This value has to be unique"}},"required":["contact","createdOn","fatcaCrsDeclaration","foundedOn","globalId","legalEntityId","legalEntityStatus","legalForm","legalName","mainAddress","modifiedOn","naceSectors","registerCountry","registerCourt","registerNumber","taxNumber"],"title":"LegalEntity"},"Lei":{"title":"Lei","properties":{"legalEntityIdentifier":{"type":"string","minLength":20,"maxLength":20,"description":"Unique global identifier for legal entities participating in financial transactions","pattern":"^\\d{4}[0]{2}[A-Z\\d]{12}\\d{2}$"},"leiStatus":{"$ref":"#/components/schemas/LeiStatusEnum"},"leiValidUntil":{"type":"string","format":"date"}},"required":["legalEntityIdentifier"]},"LeiStatusEnum":{"title":"LeiStatusEnum","type":"string","enum":["ISSUED","LAPSED","MERGED","RETIRED","PENDING_TRANSFER","PENDING_ARCHIVAL","DUPLICATE","ANNULLED"]},"RiskLevelEnum":{"title":"RiskLevelEnum","type":"string","enum":["LOW","MEDIUM","HIGH","CRITICAL"]},"LegalEntityStatusEnum":{"title":"LegalEntityStatusEnum","type":"string","enum":["CREATED","REVIEW","REJECTED","INACTIVE","PENDING","ACTIVE","SUSPENDED","ARCHIVED","RECEIVED","INVALID","SUSPENDED_COMPLIANCE"]},"LegalFormEnum":{"title":"LegalFormEnum","type":"string","description":"LegalFormEnum","enum":["LIMITED_LIABILITY_COMPANY","PUBLIC_LIMITED_COMPANY","PRIVATE_CORPORATION","FOUNDATION","ASSOCIATION","REGISTERED_BUSINESSMAN","REGISTERED_COMPANY","LIMITED_PARTNERSHIP","GENERAL_PARTNERSHIP","LIMITED_LIABILITY_COMPANY_AND_LIMITED_PARTNERSHIP","PARTNERSHIP","SINGLE_PARTNERSHIP","OTHER","UNACCEPTABLE"]},"LegalEntityNaceSector":{"title":"LegalEntityNaceSector","type":"object","properties":{"section":{"type":"string"},"code":{"type":"string","minLength":2},"description":{"type":"string","maxLength":255}},"required":["code"]},"CountryEnum":{"title":"CountryEnum","type":"string","description":"Country code in **ISO 3166-1 alpha-2** standard","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]},"Address":{"title":"Address","type":"object","description":"Address","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":10},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string","minLength":1}},"required":["street","streetNumber","city","zip","country"]},"Contact":{"title":"Contact","type":"object","properties":{"phone":{"type":"string","description":"Mobile telephone number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"email":{"type":"string","description":"E-mail address","maxLength":255,"pattern":"^[a-zA-Z0-9.!#$%&'*+\\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$"},"fax":{"type":"string","description":"Fax number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"website":{"type":"string","description":"website address","maxLength":320}},"required":["phone","email"]},"FatcaCrsDeclaration":{"title":"FatcaCrsDeclaration","type":"object","properties":{"isForeignTaxResidency":{"type":"boolean","description":"Indication of whether the legal entity is resident for tax purposes outside Germany"},"isSanctionedCountries":{"type":"boolean","description":"Indication of whether the company conducts business activities with parties from a country  that is on a sanctions list of Germany, the EU, or the USA or has been categorized as a high-risk country  by one of the aforementioned, e.g. Iran, Ukraine, Russia or Belarus"},"fatcaClassification":{"$ref":"#/components/schemas/FatcaClassificationEnum"},"activeNfeType":{"$ref":"#/components/schemas/ActiveNfeTypeEnum"}},"required":["isForeignTaxResidency","isSanctionedCountries","fatcaClassification"]},"FatcaClassificationEnum":{"title":"FatcaClassificationEnum","type":"string","enum":["ACTIVE_NFE","PASSIVE_NFE"],"description":"FATCA/CRS classification of the legal entity. Active NFE = Entity that derives less than half of its total income from passive income and is not a Financial Institution.  Possible passive income would be, for example, interest, dividends, license fees or rents - if not generated as part of an  active business - as well as gains from the sale of assets that were used to generate passive income. Passive NFE = the Entity derives more than half of its total income from passive income and is not a Financial Institution."},"ActiveNfeTypeEnum":{"title":"ActiveNfeTypeEnum","type":"string","enum":["LE_BY_INCOME_ASSETS","NON_PROFIT_ORGANISATION","OTHER"],"description":"Its required only if fatcaClassification = ACTIVE_NFE"},"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 LegalEntity object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"LegalEntity":{"type":"object","properties":{"legalEntityId":{"type":"string","format":"uuid","description":"Unique legal entity identification number in UUID format"},"globalId":{"type":"string","minLength":12,"maxLength":12},"lei":{"$ref":"#/components/schemas/Lei"},"createdOn":{"type":"string","format":"date-time","description":"The date on which the natural person was created"},"modifiedOn":{"type":"string","format":"date-time","description":"The date on which the natural person was modified the last time"},"verifiedOn":{"type":"string","format":"date-time","description":"The date on which the natural person was verified"},"isSanction":{"type":"boolean","description":"Indication of whether the person is on sanction list."},"riskLevel":{"$ref":"#/components/schemas/RiskLevelEnum"},"legalEntityStatus":{"$ref":"#/components/schemas/LegalEntityStatusEnum"},"legalName":{"type":"string","description":"The legal name of the entity","pattern":"^[^,]*$","maxLength":255},"legalForm":{"$ref":"#/components/schemas/LegalFormEnum"},"naceSectors":{"type":"array","description":"Specification of the sector in which the company is mainly economically active. The information should be provided according to the groups of the NACE codes (Sections A-V, Groups 01.11 - 99.00) without subclasses. (Level 4)","items":{"$ref":"#/components/schemas/LegalEntityNaceSector"}},"registerCountry":{"$ref":"#/components/schemas/CountryEnum"},"registerNumber":{"type":"string","minLength":1,"maxLength":255,"description":"Number at which the company is registered"},"registerCourt":{"type":"string","minLength":1,"maxLength":255,"description":"An administrative court in which the company was registered"},"registerCourtZipCode":{"type":"string","minLength":1,"maxLength":255,"description":"An administrative court zip code in which the company was registered"},"registeredOn":{"type":"string","format":"date","description":"The date on which the entity was registered"},"foundedOn":{"type":"string","format":"date","description":"The date on which the entity was founded"},"vatId":{"type":"string","minLength":11,"maxLength":11,"description":"The value-added tax id of the legal entity"},"purpose":{"type":"string","minLength":1,"maxLength":255,"description":"The purpose of the legal entity"},"mainAddress":{"$ref":"#/components/schemas/Address"},"correspondenceAddress":{"$ref":"#/components/schemas/Address"},"invoiceAddress":{"$ref":"#/components/schemas/Address"},"contact":{"$ref":"#/components/schemas/Contact"},"searchId":{"type":"string","format":"uuid"},"taxNumber":{"type":"string","minLength":1,"maxLength":255,"description":"The tax number of the legal entity"},"isListed":{"type":"boolean","description":"Determine whether the shares of that company are on the list (or board) of stock that are officially traded on a stock exchange"},"listedAt":{"type":"string","minLength":1,"maxLength":255,"description":"Determine where the shares of that company are officially traded on a stock exchange. Only when entity is listed"},"averageProfit":{"type":"number","multipleOf":0.01,"description":"Average profit for the year (after tax)"},"averageRevenue":{"type":"number","multipleOf":0.01,"description":"Average revenue for the year"},"liquidAssets":{"type":"number","multipleOf":0.01,"description":"Liquid assets"},"lastAnnualFinancialStatement":{"type":"string","format":"date","description":"Last annual financial statement date"},"fatcaCrsDeclaration":{"$ref":"#/components/schemas/FatcaCrsDeclaration"},"externalId":{"type":"string","minLength":1,"description":"External Id in partner's system. This value has to be unique"}},"required":["contact","createdOn","fatcaCrsDeclaration","foundedOn","globalId","legalEntityId","legalEntityStatus","legalForm","legalName","mainAddress","modifiedOn","naceSectors","registerCountry","registerCourt","registerNumber","taxNumber"],"title":"LegalEntity"},"Lei":{"title":"Lei","properties":{"legalEntityIdentifier":{"type":"string","minLength":20,"maxLength":20,"description":"Unique global identifier for legal entities participating in financial transactions","pattern":"^\\d{4}[0]{2}[A-Z\\d]{12}\\d{2}$"},"leiStatus":{"$ref":"#/components/schemas/LeiStatusEnum"},"leiValidUntil":{"type":"string","format":"date"}},"required":["legalEntityIdentifier"]},"LeiStatusEnum":{"title":"LeiStatusEnum","type":"string","enum":["ISSUED","LAPSED","MERGED","RETIRED","PENDING_TRANSFER","PENDING_ARCHIVAL","DUPLICATE","ANNULLED"]},"RiskLevelEnum":{"title":"RiskLevelEnum","type":"string","enum":["LOW","MEDIUM","HIGH","CRITICAL"]},"LegalEntityStatusEnum":{"title":"LegalEntityStatusEnum","type":"string","enum":["CREATED","REVIEW","REJECTED","INACTIVE","PENDING","ACTIVE","SUSPENDED","ARCHIVED","RECEIVED","INVALID","SUSPENDED_COMPLIANCE"]},"LegalFormEnum":{"title":"LegalFormEnum","type":"string","description":"LegalFormEnum","enum":["LIMITED_LIABILITY_COMPANY","PUBLIC_LIMITED_COMPANY","PRIVATE_CORPORATION","FOUNDATION","ASSOCIATION","REGISTERED_BUSINESSMAN","REGISTERED_COMPANY","LIMITED_PARTNERSHIP","GENERAL_PARTNERSHIP","LIMITED_LIABILITY_COMPANY_AND_LIMITED_PARTNERSHIP","PARTNERSHIP","SINGLE_PARTNERSHIP","OTHER","UNACCEPTABLE"]},"LegalEntityNaceSector":{"title":"LegalEntityNaceSector","type":"object","properties":{"section":{"type":"string"},"code":{"type":"string","minLength":2},"description":{"type":"string","maxLength":255}},"required":["code"]},"CountryEnum":{"title":"CountryEnum","type":"string","description":"Country code in **ISO 3166-1 alpha-2** standard","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]},"Address":{"title":"Address","type":"object","description":"Address","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":10},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string","minLength":1}},"required":["street","streetNumber","city","zip","country"]},"Contact":{"title":"Contact","type":"object","properties":{"phone":{"type":"string","description":"Mobile telephone number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"email":{"type":"string","description":"E-mail address","maxLength":255,"pattern":"^[a-zA-Z0-9.!#$%&'*+\\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$"},"fax":{"type":"string","description":"Fax number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"website":{"type":"string","description":"website address","maxLength":320}},"required":["phone","email"]},"FatcaCrsDeclaration":{"title":"FatcaCrsDeclaration","type":"object","properties":{"isForeignTaxResidency":{"type":"boolean","description":"Indication of whether the legal entity is resident for tax purposes outside Germany"},"isSanctionedCountries":{"type":"boolean","description":"Indication of whether the company conducts business activities with parties from a country  that is on a sanctions list of Germany, the EU, or the USA or has been categorized as a high-risk country  by one of the aforementioned, e.g. Iran, Ukraine, Russia or Belarus"},"fatcaClassification":{"$ref":"#/components/schemas/FatcaClassificationEnum"},"activeNfeType":{"$ref":"#/components/schemas/ActiveNfeTypeEnum"}},"required":["isForeignTaxResidency","isSanctionedCountries","fatcaClassification"]},"FatcaClassificationEnum":{"title":"FatcaClassificationEnum","type":"string","enum":["ACTIVE_NFE","PASSIVE_NFE"],"description":"FATCA/CRS classification of the legal entity. Active NFE = Entity that derives less than half of its total income from passive income and is not a Financial Institution.  Possible passive income would be, for example, interest, dividends, license fees or rents - if not generated as part of an  active business - as well as gains from the sale of assets that were used to generate passive income. Passive NFE = the Entity derives more than half of its total income from passive income and is not a Financial Institution."},"ActiveNfeTypeEnum":{"title":"ActiveNfeTypeEnum","type":"string","enum":["LE_BY_INCOME_ASSETS","NON_PROFIT_ORGANISATION","OTHER"],"description":"Its required only if fatcaClassification = ACTIVE_NFE"}}}}
```

## The CreateLegalEntityData object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"CreateLegalEntityData":{"type":"object","properties":{"legalEntityIdentifier":{"type":"string","minLength":20,"maxLength":20,"description":"Unique global identifier for legal entities participating in financial transactions","pattern":"^\\d{4}[0]{2}[A-Z\\d]{12}\\d{2}$"},"legalName":{"type":"string","description":"The legal name of the entity","pattern":"^[^,]*$","maxLength":255},"legalForm":{"$ref":"#/components/schemas/LegalFormEnum"},"naceSectors":{"type":"array","description":"Specification of the sector in which the company is mainly economically active. The information should be provided according to the groups of the NACE codes (Sections A-V, Groups 01.11 - 99.00) without subclasses. (Level 4)","items":{"$ref":"#/components/schemas/LegalEntityNaceSector"}},"registerCountry":{"$ref":"#/components/schemas/CountryEnum"},"registerNumber":{"type":"string","minLength":1,"maxLength":255,"description":"Number at which the company is registered"},"registerCourt":{"type":"string","minLength":1,"maxLength":255,"description":"An administrative court in which the company was registered"},"registerCourtZipCode":{"type":"string","minLength":1,"maxLength":255,"description":"An administrative court zip code in which the company was registered"},"registeredOn":{"type":"string","format":"date","description":"The date on which the entity was registered"},"foundedOn":{"type":"string","format":"date","description":"The date on which the entity was founded"},"vatId":{"type":"string","minLength":11,"maxLength":11,"description":"The value-added tax id of the legal entity"},"purpose":{"type":"string","minLength":1,"maxLength":255,"description":"The purpose of the legal entity"},"mainAddress":{"$ref":"#/components/schemas/Address"},"correspondenceAddress":{"$ref":"#/components/schemas/Address"},"invoiceAddress":{"$ref":"#/components/schemas/Address"},"contact":{"$ref":"#/components/schemas/Contact"},"searchId":{"type":"string","format":"uuid"},"taxNumber":{"type":"string","minLength":1,"maxLength":255,"description":"The tax number of the legal entity"},"isListed":{"type":"boolean","description":"Determine whether the shares of that company are on the list (or board) of stock that are officially traded on a stock exchange"},"listedAt":{"type":"string","minLength":1,"maxLength":255,"description":"Determine where the shares of that company are officially traded on a stock exchange. Only when entity is listed"},"averageProfit":{"type":"number","multipleOf":0.01,"description":"Average profit for the year (after tax)"},"averageRevenue":{"type":"number","multipleOf":0.01,"description":"Average revenue for the year"},"liquidAssets":{"type":"number","multipleOf":0.01,"description":"Liquid assets"},"lastAnnualFinancialStatement":{"type":"string","format":"date","description":"Last annual financial statement date"},"fatcaCrsDeclaration":{"$ref":"#/components/schemas/FatcaCrsDeclaration"},"externalId":{"type":"string","minLength":1,"description":"External Id in partner's system. This value has to be unique"}},"title":"CreateLegalEntityData","required":["legalName","legalForm","registerCountry","naceSectors","registerNumber","registerCourt","foundedOn","mainAddress","contact","taxNumber","fatcaCrsDeclaration"]},"LegalFormEnum":{"title":"LegalFormEnum","type":"string","description":"LegalFormEnum","enum":["LIMITED_LIABILITY_COMPANY","PUBLIC_LIMITED_COMPANY","PRIVATE_CORPORATION","FOUNDATION","ASSOCIATION","REGISTERED_BUSINESSMAN","REGISTERED_COMPANY","LIMITED_PARTNERSHIP","GENERAL_PARTNERSHIP","LIMITED_LIABILITY_COMPANY_AND_LIMITED_PARTNERSHIP","PARTNERSHIP","SINGLE_PARTNERSHIP","OTHER","UNACCEPTABLE"]},"LegalEntityNaceSector":{"title":"LegalEntityNaceSector","type":"object","properties":{"section":{"type":"string"},"code":{"type":"string","minLength":2},"description":{"type":"string","maxLength":255}},"required":["code"]},"CountryEnum":{"title":"CountryEnum","type":"string","description":"Country code in **ISO 3166-1 alpha-2** standard","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]},"Address":{"title":"Address","type":"object","description":"Address","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":10},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string","minLength":1}},"required":["street","streetNumber","city","zip","country"]},"Contact":{"title":"Contact","type":"object","properties":{"phone":{"type":"string","description":"Mobile telephone number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"email":{"type":"string","description":"E-mail address","maxLength":255,"pattern":"^[a-zA-Z0-9.!#$%&'*+\\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$"},"fax":{"type":"string","description":"Fax number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"website":{"type":"string","description":"website address","maxLength":320}},"required":["phone","email"]},"FatcaCrsDeclaration":{"title":"FatcaCrsDeclaration","type":"object","properties":{"isForeignTaxResidency":{"type":"boolean","description":"Indication of whether the legal entity is resident for tax purposes outside Germany"},"isSanctionedCountries":{"type":"boolean","description":"Indication of whether the company conducts business activities with parties from a country  that is on a sanctions list of Germany, the EU, or the USA or has been categorized as a high-risk country  by one of the aforementioned, e.g. Iran, Ukraine, Russia or Belarus"},"fatcaClassification":{"$ref":"#/components/schemas/FatcaClassificationEnum"},"activeNfeType":{"$ref":"#/components/schemas/ActiveNfeTypeEnum"}},"required":["isForeignTaxResidency","isSanctionedCountries","fatcaClassification"]},"FatcaClassificationEnum":{"title":"FatcaClassificationEnum","type":"string","enum":["ACTIVE_NFE","PASSIVE_NFE"],"description":"FATCA/CRS classification of the legal entity. Active NFE = Entity that derives less than half of its total income from passive income and is not a Financial Institution.  Possible passive income would be, for example, interest, dividends, license fees or rents - if not generated as part of an  active business - as well as gains from the sale of assets that were used to generate passive income. Passive NFE = the Entity derives more than half of its total income from passive income and is not a Financial Institution."},"ActiveNfeTypeEnum":{"title":"ActiveNfeTypeEnum","type":"string","enum":["LE_BY_INCOME_ASSETS","NON_PROFIT_ORGANISATION","OTHER"],"description":"Its required only if fatcaClassification = ACTIVE_NFE"}}}}
```

## The LegalEntityData object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"LegalEntityData":{"title":"LegalEntityData","properties":{"legalName":{"type":"string","description":"The legal name of the entity","pattern":"^[^,]*$","maxLength":255},"legalForm":{"$ref":"#/components/schemas/LegalFormEnum"},"naceSectors":{"type":"array","description":"Specification of the sector in which the company is mainly economically active. The information should be provided according to the groups of the NACE codes (Sections A-V, Groups 01.11 - 99.00) without subclasses. (Level 4)","items":{"$ref":"#/components/schemas/LegalEntityNaceSector"}},"registerCountry":{"$ref":"#/components/schemas/CountryEnum"},"registerNumber":{"type":"string","minLength":1,"maxLength":255,"description":"Number at which the company is registered"},"registerCourt":{"type":"string","minLength":1,"maxLength":255,"description":"An administrative court in which the company was registered"},"registerCourtZipCode":{"type":"string","minLength":1,"maxLength":255,"description":"An administrative court zip code in which the company was registered"},"registeredOn":{"type":"string","format":"date","description":"The date on which the entity was registered"},"foundedOn":{"type":"string","format":"date","description":"The date on which the entity was founded"},"vatId":{"type":"string","minLength":11,"maxLength":11,"description":"The value-added tax id of the legal entity"},"purpose":{"type":"string","minLength":1,"maxLength":255,"description":"The purpose of the legal entity"},"mainAddress":{"$ref":"#/components/schemas/Address"},"correspondenceAddress":{"$ref":"#/components/schemas/Address"},"invoiceAddress":{"$ref":"#/components/schemas/Address"},"contact":{"$ref":"#/components/schemas/Contact"},"searchId":{"type":"string","format":"uuid"},"taxNumber":{"type":"string","minLength":1,"maxLength":255,"description":"The tax number of the legal entity"},"isListed":{"type":"boolean","description":"Determine whether the shares of that company are on the list (or board) of stock that are officially traded on a stock exchange"},"listedAt":{"type":"string","minLength":1,"maxLength":255,"description":"Determine where the shares of that company are officially traded on a stock exchange. Only when entity is listed"},"averageProfit":{"type":"number","multipleOf":0.01,"description":"Average profit for the year (after tax)"},"averageRevenue":{"type":"number","multipleOf":0.01,"description":"Average revenue for the year"},"liquidAssets":{"type":"number","multipleOf":0.01,"description":"Liquid assets"},"lastAnnualFinancialStatement":{"type":"string","format":"date","description":"Last annual financial statement date"},"fatcaCrsDeclaration":{"$ref":"#/components/schemas/FatcaCrsDeclaration"},"externalId":{"type":"string","minLength":1,"description":"External Id in partner's system. This value has to be unique"}},"required":["legalName","legalForm","registerCountry","naceSectors","registerNumber","registerCourt","foundedOn","mainAddress","contact","taxNumber","fatcaCrsDeclaration"]},"LegalFormEnum":{"title":"LegalFormEnum","type":"string","description":"LegalFormEnum","enum":["LIMITED_LIABILITY_COMPANY","PUBLIC_LIMITED_COMPANY","PRIVATE_CORPORATION","FOUNDATION","ASSOCIATION","REGISTERED_BUSINESSMAN","REGISTERED_COMPANY","LIMITED_PARTNERSHIP","GENERAL_PARTNERSHIP","LIMITED_LIABILITY_COMPANY_AND_LIMITED_PARTNERSHIP","PARTNERSHIP","SINGLE_PARTNERSHIP","OTHER","UNACCEPTABLE"]},"LegalEntityNaceSector":{"title":"LegalEntityNaceSector","type":"object","properties":{"section":{"type":"string"},"code":{"type":"string","minLength":2},"description":{"type":"string","maxLength":255}},"required":["code"]},"CountryEnum":{"title":"CountryEnum","type":"string","description":"Country code in **ISO 3166-1 alpha-2** standard","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]},"Address":{"title":"Address","type":"object","description":"Address","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":10},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string","minLength":1}},"required":["street","streetNumber","city","zip","country"]},"Contact":{"title":"Contact","type":"object","properties":{"phone":{"type":"string","description":"Mobile telephone number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"email":{"type":"string","description":"E-mail address","maxLength":255,"pattern":"^[a-zA-Z0-9.!#$%&'*+\\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$"},"fax":{"type":"string","description":"Fax number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"website":{"type":"string","description":"website address","maxLength":320}},"required":["phone","email"]},"FatcaCrsDeclaration":{"title":"FatcaCrsDeclaration","type":"object","properties":{"isForeignTaxResidency":{"type":"boolean","description":"Indication of whether the legal entity is resident for tax purposes outside Germany"},"isSanctionedCountries":{"type":"boolean","description":"Indication of whether the company conducts business activities with parties from a country  that is on a sanctions list of Germany, the EU, or the USA or has been categorized as a high-risk country  by one of the aforementioned, e.g. Iran, Ukraine, Russia or Belarus"},"fatcaClassification":{"$ref":"#/components/schemas/FatcaClassificationEnum"},"activeNfeType":{"$ref":"#/components/schemas/ActiveNfeTypeEnum"}},"required":["isForeignTaxResidency","isSanctionedCountries","fatcaClassification"]},"FatcaClassificationEnum":{"title":"FatcaClassificationEnum","type":"string","enum":["ACTIVE_NFE","PASSIVE_NFE"],"description":"FATCA/CRS classification of the legal entity. Active NFE = Entity that derives less than half of its total income from passive income and is not a Financial Institution.  Possible passive income would be, for example, interest, dividends, license fees or rents - if not generated as part of an  active business - as well as gains from the sale of assets that were used to generate passive income. Passive NFE = the Entity derives more than half of its total income from passive income and is not a Financial Institution."},"ActiveNfeTypeEnum":{"title":"ActiveNfeTypeEnum","type":"string","enum":["LE_BY_INCOME_ASSETS","NON_PROFIT_ORGANISATION","OTHER"],"description":"Its required only if fatcaClassification = ACTIVE_NFE"}}}}
```

## The Lei object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"Lei":{"title":"Lei","properties":{"legalEntityIdentifier":{"type":"string","minLength":20,"maxLength":20,"description":"Unique global identifier for legal entities participating in financial transactions","pattern":"^\\d{4}[0]{2}[A-Z\\d]{12}\\d{2}$"},"leiStatus":{"$ref":"#/components/schemas/LeiStatusEnum"},"leiValidUntil":{"type":"string","format":"date"}},"required":["legalEntityIdentifier"]},"LeiStatusEnum":{"title":"LeiStatusEnum","type":"string","enum":["ISSUED","LAPSED","MERGED","RETIRED","PENDING_TRANSFER","PENDING_ARCHIVAL","DUPLICATE","ANNULLED"]}}}}
```

## The LegalEntityUpdate object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"LegalEntityUpdate":{"title":"LegalEntityUpdate","type":"object","properties":{"legalEntityUpdateData":{"$ref":"#/components/schemas/LegalEntityUpdateData"},"documentIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Document IDs in UUID format for parameters where a document upload is required (legalName, legalForm, mainAddress, correspondenceAddress, invoiceAddress)"}},"required":["legalEntityUpdateData"]},"LegalEntityUpdateData":{"title":"LegalEntityUpdateData","type":"object","properties":{"legalName":{"type":"string","description":"The legal name of the entity","maxLength":255},"legalForm":{"$ref":"#/components/schemas/LegalFormEnum"},"naceSectors":{"type":"array","description":"Specification of the sector in which the company is mainly economically active. The information should be provided according to the groups of the NACE codes (Sections A-V, Groups 01.11 - 99.00) without subclasses. (Level 4)","items":{"$ref":"#/components/schemas/LegalEntityNaceSector"}},"taxNumber":{"type":"string","minLength":1,"maxLength":255,"description":"The tax number of the legal entity"},"vatId":{"type":"string","minLength":11,"maxLength":11,"description":"The value-added tax id of the legal entity"},"isListed":{"type":"boolean","description":"Determine whether the shares of that company are on the list (or board) of stock that are officially traded on a stock exchange"},"listedAt":{"type":"string","minLength":1,"maxLength":255,"description":"Determine where the shares of that company are officially traded on a stock exchange. Only when entity is listed"},"legalEntityIdentifier":{"type":"string","minLength":20,"maxLength":20,"description":"Unique global identifier for legal entities participating in financial transactions","pattern":"^\\d{4}[0]{2}[A-Z\\d]{12}\\d{2}$"},"purpose":{"type":"string","minLength":1,"maxLength":255,"description":"The purpose of the legal entity"},"fatcaCrsDeclaration":{"$ref":"#/components/schemas/FatcaCrsDeclaration"},"averageProfit":{"type":"number","multipleOf":0.01,"description":"Average profit for the year (after tax)"},"averageRevenue":{"type":"number","multipleOf":0.01,"description":"Average revenue for the year"},"liquidAssets":{"type":"number","multipleOf":0.01,"description":"Liquid assets"},"lastAnnualFinancialStatement":{"type":"string","format":"date","description":"Last annual financial statement date"},"mainAddress":{"$ref":"#/components/schemas/Address"},"correspondenceAddress":{"$ref":"#/components/schemas/Address"},"invoiceAddress":{"$ref":"#/components/schemas/Address"},"externalId":{"type":"string","minLength":1,"description":"External Id in partner's system. This value has to be unique"}}},"LegalFormEnum":{"title":"LegalFormEnum","type":"string","description":"LegalFormEnum","enum":["LIMITED_LIABILITY_COMPANY","PUBLIC_LIMITED_COMPANY","PRIVATE_CORPORATION","FOUNDATION","ASSOCIATION","REGISTERED_BUSINESSMAN","REGISTERED_COMPANY","LIMITED_PARTNERSHIP","GENERAL_PARTNERSHIP","LIMITED_LIABILITY_COMPANY_AND_LIMITED_PARTNERSHIP","PARTNERSHIP","SINGLE_PARTNERSHIP","OTHER","UNACCEPTABLE"]},"LegalEntityNaceSector":{"title":"LegalEntityNaceSector","type":"object","properties":{"section":{"type":"string"},"code":{"type":"string","minLength":2},"description":{"type":"string","maxLength":255}},"required":["code"]},"FatcaCrsDeclaration":{"title":"FatcaCrsDeclaration","type":"object","properties":{"isForeignTaxResidency":{"type":"boolean","description":"Indication of whether the legal entity is resident for tax purposes outside Germany"},"isSanctionedCountries":{"type":"boolean","description":"Indication of whether the company conducts business activities with parties from a country  that is on a sanctions list of Germany, the EU, or the USA or has been categorized as a high-risk country  by one of the aforementioned, e.g. Iran, Ukraine, Russia or Belarus"},"fatcaClassification":{"$ref":"#/components/schemas/FatcaClassificationEnum"},"activeNfeType":{"$ref":"#/components/schemas/ActiveNfeTypeEnum"}},"required":["isForeignTaxResidency","isSanctionedCountries","fatcaClassification"]},"FatcaClassificationEnum":{"title":"FatcaClassificationEnum","type":"string","enum":["ACTIVE_NFE","PASSIVE_NFE"],"description":"FATCA/CRS classification of the legal entity. Active NFE = Entity that derives less than half of its total income from passive income and is not a Financial Institution.  Possible passive income would be, for example, interest, dividends, license fees or rents - if not generated as part of an  active business - as well as gains from the sale of assets that were used to generate passive income. Passive NFE = the Entity derives more than half of its total income from passive income and is not a Financial Institution."},"ActiveNfeTypeEnum":{"title":"ActiveNfeTypeEnum","type":"string","enum":["LE_BY_INCOME_ASSETS","NON_PROFIT_ORGANISATION","OTHER"],"description":"Its required only if fatcaClassification = ACTIVE_NFE"},"Address":{"title":"Address","type":"object","description":"Address","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":10},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string","minLength":1}},"required":["street","streetNumber","city","zip","country"]},"CountryEnum":{"title":"CountryEnum","type":"string","description":"Country code in **ISO 3166-1 alpha-2** standard","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]}}}}
```

## The CreateBeneficialOwnerResult object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"CreateBeneficialOwnerResult":{"title":"CreateBeneficialOwnerResult","type":"object","properties":{"beneficialOwnerId":{"type":"string","format":"uuid","description":"Unique beneficial owner identification number in UUID format","readOnly":true}},"required":["beneficialOwnerId"]}}}}
```

## The BeneficialOwners object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"BeneficialOwners":{"title":"BeneficialOwners","type":"object","properties":{"data":{"type":"array","description":"Array of beneficial owners","items":{"$ref":"#/components/schemas/BeneficialOwner"}},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data","pagination"]},"BeneficialOwner":{"title":"BeneficialOwner","type":"object","properties":{"firstName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^\\S+( \\S+)*$","description":"All first names of the person according to the identification document"},"lastName":{"type":"string","minLength":1,"maxLength":255,"description":"Natural person last name"},"birthDay":{"type":"string","format":"date"},"birthPlace":{"type":"string","minLength":1,"description":"Location ","maxLength":255},"birthCountry":{"$ref":"#/components/schemas/CountryEnum"},"taxDetails":{"type":"array","items":{"$ref":"#/components/schemas/TaxDetail"}},"isUsNationality":{"type":"boolean","description":"FATCA - Question whether the customer is subject to US tax liability (nationality or other references due to a green card, registration address, etc.)."},"mainAddress":{"$ref":"#/components/schemas/Address"},"nationalities":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/CountryEnum"}},"uboRelationship":{"$ref":"#/components/schemas/UboRelationshipEnum"},"share":{"type":"number","multipleOf":0.01,"minimum":0,"exclusiveMinimum":true,"maximum":100},"votingRights":{"type":"number","multipleOf":0.01,"minimum":0,"exclusiveMinimum":true,"maximum":100},"fatcaControllingPerson":{"type":"boolean","description":"Indication of whether this person is a controlling person under FATCA. \\\n`TRUE` = if **fatcaClassification** = `PASSIVE_NFE`\n"},"deathDay":{"type":"string","format":"date"},"beneficialOwnerId":{"type":"string","format":"uuid","readOnly":true},"globalId":{"type":"string","minLength":12,"maxLength":12,"description":"Global ID of the beneficial owner"},"status":{"$ref":"#/components/schemas/BeneficialOwnerStatusEnum"},"boType":{"$ref":"#/components/schemas/BeneficialOwnerTypeEnum"},"isPep":{"type":"boolean","description":"Indication of whether the person is a politically exposed person."},"isPepRelated":{"type":"boolean","description":"Indication of whether the person is directly related to a politically exposed person."},"isSanction":{"type":"boolean","description":"Indication of whether the person is on sanction list."},"riskLevel":{"$ref":"#/components/schemas/RiskLevelEnum"},"createdOn":{"type":"string","format":"date-time","readOnly":true},"modifiedOn":{"type":"string","format":"date-time","readOnly":true},"verifiedOn":{"type":"string","format":"date-time","description":"The date on which the Beneficial Owner was verified","readOnly":true}},"required":["firstName","lastName","birthDay","birthPlace","birthCountry","isUsNationality","nationalities","taxDetails","share","votingRights","beneficialOwnerId","globalId","status","boType","createdOn","modifiedOn"]},"CountryEnum":{"title":"CountryEnum","type":"string","description":"Country code in **ISO 3166-1 alpha-2** standard","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]},"TaxDetail":{"title":"TaxDetail","type":"object","properties":{"taxId":{"type":"string","minLength":1,"maxLength":255},"taxResidency":{"$ref":"#/components/schemas/CountryEnum"},"noTinConfirmation":{"description":"Indicates that the customer does not have a Tax Identification Number (TIN), which should only be used in exceptional cases where no TIN exists. If this field is set to true, the customer must provide supporting document (docType: TIN_NA_CONFIRMATION) confirming that no TIN is available.","type":"boolean","default":false}},"required":["taxResidency"]},"Address":{"title":"Address","type":"object","description":"Address","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":10},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string","minLength":1}},"required":["street","streetNumber","city","zip","country"]},"UboRelationshipEnum":{"title":"UboRelationshipEnum","type":"string","description":"This enum is used to specify the type of relationship a person has with a company, particularly in terms of shareholding or control.The possible values are:\n- `DIRECTLY_HOLDING_25` - a person directly holds shares in the capital or voting rights of a company.\n- `INDIRECTLY_HOLDING_25`- a person indirectly holds shares in the capital or voting rights through intermediary entities or trust arrangements.\n- `DOMINANT_INFLUENCE_OVER_SHARE_CAPITAL` - a person exercises control over the company in any other way, such as through voting agreements, special rights, or trust relationships, even without (or with only minor) direct or indirect shareholdings.\n","enum":["DIRECTLY_HOLDING_25","INDIRECTLY_HOLDING_25","DOMINANT_INFLUENCE_OVER_SHARE_CAPITAL"]},"BeneficialOwnerStatusEnum":{"title":"BeneficialOwnerStatusEnum","type":"string","enum":["CREATED","ACTIVE","INACTIVE","RECEIVED","INVALID","REJECTED","REVIEW","PENDING","SUSPENDED_COMPLIANCE"]},"BeneficialOwnerTypeEnum":{"title":"BeneficialOwnerTypeEnum","type":"string","description":"Indication of the type of beneficial owner:\\\nIn the context of legal entity customers:\\\n`REAL_UBO_25` = person who holds more than 25% of the company shares\\\n`FICTIVE_UBO` = Legal Representative, if no person exists who holds more than 25% of the company shares\n","enum":["FICTIVE_UBO","REAL_UBO_25"]},"RiskLevelEnum":{"title":"RiskLevelEnum","type":"string","enum":["LOW","MEDIUM","HIGH","CRITICAL"]},"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 BeneficialOwner object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"BeneficialOwner":{"title":"BeneficialOwner","type":"object","properties":{"firstName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^\\S+( \\S+)*$","description":"All first names of the person according to the identification document"},"lastName":{"type":"string","minLength":1,"maxLength":255,"description":"Natural person last name"},"birthDay":{"type":"string","format":"date"},"birthPlace":{"type":"string","minLength":1,"description":"Location ","maxLength":255},"birthCountry":{"$ref":"#/components/schemas/CountryEnum"},"taxDetails":{"type":"array","items":{"$ref":"#/components/schemas/TaxDetail"}},"isUsNationality":{"type":"boolean","description":"FATCA - Question whether the customer is subject to US tax liability (nationality or other references due to a green card, registration address, etc.)."},"mainAddress":{"$ref":"#/components/schemas/Address"},"nationalities":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/CountryEnum"}},"uboRelationship":{"$ref":"#/components/schemas/UboRelationshipEnum"},"share":{"type":"number","multipleOf":0.01,"minimum":0,"exclusiveMinimum":true,"maximum":100},"votingRights":{"type":"number","multipleOf":0.01,"minimum":0,"exclusiveMinimum":true,"maximum":100},"fatcaControllingPerson":{"type":"boolean","description":"Indication of whether this person is a controlling person under FATCA. \\\n`TRUE` = if **fatcaClassification** = `PASSIVE_NFE`\n"},"deathDay":{"type":"string","format":"date"},"beneficialOwnerId":{"type":"string","format":"uuid","readOnly":true},"globalId":{"type":"string","minLength":12,"maxLength":12,"description":"Global ID of the beneficial owner"},"status":{"$ref":"#/components/schemas/BeneficialOwnerStatusEnum"},"boType":{"$ref":"#/components/schemas/BeneficialOwnerTypeEnum"},"isPep":{"type":"boolean","description":"Indication of whether the person is a politically exposed person."},"isPepRelated":{"type":"boolean","description":"Indication of whether the person is directly related to a politically exposed person."},"isSanction":{"type":"boolean","description":"Indication of whether the person is on sanction list."},"riskLevel":{"$ref":"#/components/schemas/RiskLevelEnum"},"createdOn":{"type":"string","format":"date-time","readOnly":true},"modifiedOn":{"type":"string","format":"date-time","readOnly":true},"verifiedOn":{"type":"string","format":"date-time","description":"The date on which the Beneficial Owner was verified","readOnly":true}},"required":["firstName","lastName","birthDay","birthPlace","birthCountry","isUsNationality","nationalities","taxDetails","share","votingRights","beneficialOwnerId","globalId","status","boType","createdOn","modifiedOn"]},"CountryEnum":{"title":"CountryEnum","type":"string","description":"Country code in **ISO 3166-1 alpha-2** standard","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]},"TaxDetail":{"title":"TaxDetail","type":"object","properties":{"taxId":{"type":"string","minLength":1,"maxLength":255},"taxResidency":{"$ref":"#/components/schemas/CountryEnum"},"noTinConfirmation":{"description":"Indicates that the customer does not have a Tax Identification Number (TIN), which should only be used in exceptional cases where no TIN exists. If this field is set to true, the customer must provide supporting document (docType: TIN_NA_CONFIRMATION) confirming that no TIN is available.","type":"boolean","default":false}},"required":["taxResidency"]},"Address":{"title":"Address","type":"object","description":"Address","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":10},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string","minLength":1}},"required":["street","streetNumber","city","zip","country"]},"UboRelationshipEnum":{"title":"UboRelationshipEnum","type":"string","description":"This enum is used to specify the type of relationship a person has with a company, particularly in terms of shareholding or control.The possible values are:\n- `DIRECTLY_HOLDING_25` - a person directly holds shares in the capital or voting rights of a company.\n- `INDIRECTLY_HOLDING_25`- a person indirectly holds shares in the capital or voting rights through intermediary entities or trust arrangements.\n- `DOMINANT_INFLUENCE_OVER_SHARE_CAPITAL` - a person exercises control over the company in any other way, such as through voting agreements, special rights, or trust relationships, even without (or with only minor) direct or indirect shareholdings.\n","enum":["DIRECTLY_HOLDING_25","INDIRECTLY_HOLDING_25","DOMINANT_INFLUENCE_OVER_SHARE_CAPITAL"]},"BeneficialOwnerStatusEnum":{"title":"BeneficialOwnerStatusEnum","type":"string","enum":["CREATED","ACTIVE","INACTIVE","RECEIVED","INVALID","REJECTED","REVIEW","PENDING","SUSPENDED_COMPLIANCE"]},"BeneficialOwnerTypeEnum":{"title":"BeneficialOwnerTypeEnum","type":"string","description":"Indication of the type of beneficial owner:\\\nIn the context of legal entity customers:\\\n`REAL_UBO_25` = person who holds more than 25% of the company shares\\\n`FICTIVE_UBO` = Legal Representative, if no person exists who holds more than 25% of the company shares\n","enum":["FICTIVE_UBO","REAL_UBO_25"]},"RiskLevelEnum":{"title":"RiskLevelEnum","type":"string","enum":["LOW","MEDIUM","HIGH","CRITICAL"]}}}}
```

## The BeneficialOwnerData object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"BeneficialOwnerData":{"title":"BeneficialOwnerData","type":"object","properties":{"firstName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^\\S+( \\S+)*$","description":"All first names of the person according to the identification document"},"lastName":{"type":"string","minLength":1,"maxLength":255,"description":"Natural person last name"},"birthDay":{"type":"string","format":"date"},"birthPlace":{"type":"string","minLength":1,"description":"Location ","maxLength":255},"birthCountry":{"$ref":"#/components/schemas/CountryEnum"},"taxDetails":{"type":"array","items":{"$ref":"#/components/schemas/TaxDetail"}},"isUsNationality":{"type":"boolean","description":"FATCA - Question whether the customer is subject to US tax liability (nationality or other references due to a green card, registration address, etc.)."},"mainAddress":{"$ref":"#/components/schemas/Address"},"nationalities":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/CountryEnum"}},"uboRelationship":{"$ref":"#/components/schemas/UboRelationshipEnum"},"share":{"type":"number","multipleOf":0.01,"minimum":0,"exclusiveMinimum":true,"maximum":100},"votingRights":{"type":"number","multipleOf":0.01,"minimum":0,"exclusiveMinimum":true,"maximum":100},"fatcaControllingPerson":{"type":"boolean","description":"Indication of whether this person is a controlling person under FATCA. \\\n`TRUE` = if **fatcaClassification** = `PASSIVE_NFE`\n"}},"required":["firstName","lastName","birthDay","birthPlace","birthCountry","isUsNationality","nationalities","taxDetails","uboRelationship","share","votingRights"]},"CountryEnum":{"title":"CountryEnum","type":"string","description":"Country code in **ISO 3166-1 alpha-2** standard","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]},"TaxDetail":{"title":"TaxDetail","type":"object","properties":{"taxId":{"type":"string","minLength":1,"maxLength":255},"taxResidency":{"$ref":"#/components/schemas/CountryEnum"},"noTinConfirmation":{"description":"Indicates that the customer does not have a Tax Identification Number (TIN), which should only be used in exceptional cases where no TIN exists. If this field is set to true, the customer must provide supporting document (docType: TIN_NA_CONFIRMATION) confirming that no TIN is available.","type":"boolean","default":false}},"required":["taxResidency"]},"Address":{"title":"Address","type":"object","description":"Address","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":10},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string","minLength":1}},"required":["street","streetNumber","city","zip","country"]},"UboRelationshipEnum":{"title":"UboRelationshipEnum","type":"string","description":"This enum is used to specify the type of relationship a person has with a company, particularly in terms of shareholding or control.The possible values are:\n- `DIRECTLY_HOLDING_25` - a person directly holds shares in the capital or voting rights of a company.\n- `INDIRECTLY_HOLDING_25`- a person indirectly holds shares in the capital or voting rights through intermediary entities or trust arrangements.\n- `DOMINANT_INFLUENCE_OVER_SHARE_CAPITAL` - a person exercises control over the company in any other way, such as through voting agreements, special rights, or trust relationships, even without (or with only minor) direct or indirect shareholdings.\n","enum":["DIRECTLY_HOLDING_25","INDIRECTLY_HOLDING_25","DOMINANT_INFLUENCE_OVER_SHARE_CAPITAL"]}}}}
```

## The BeneficialOwnerUpdate object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"BeneficialOwnerUpdate":{"title":"BeneficialOwnerUpdate","type":"object","properties":{"firstName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^\\S+( \\S+)*$","description":"All first names of the person according to the identification document"},"lastName":{"type":"string","minLength":1,"maxLength":255,"description":"Natural person last name"},"birthDay":{"type":"string","format":"date"},"birthPlace":{"type":"string","minLength":1,"description":"Location ","maxLength":255},"birthCountry":{"$ref":"#/components/schemas/CountryEnum"},"taxDetails":{"type":"array","items":{"$ref":"#/components/schemas/TaxDetail"}},"isUsNationality":{"type":"boolean","description":"FATCA - Question whether the customer is subject to US tax liability (nationality or other references due to a green card, registration address, etc.)."},"mainAddress":{"$ref":"#/components/schemas/Address"},"nationalities":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/CountryEnum"}},"uboRelationship":{"$ref":"#/components/schemas/UboRelationshipEnum"},"share":{"type":"number","multipleOf":0.01,"minimum":0,"exclusiveMinimum":true,"maximum":100},"votingRights":{"type":"number","multipleOf":0.01,"minimum":0,"exclusiveMinimum":true,"maximum":100},"fatcaControllingPerson":{"type":"boolean","description":"Indication of whether this person is a controlling person under FATCA. \\\n`TRUE` = if **fatcaClassification** = `PASSIVE_NFE`\n"}}},"CountryEnum":{"title":"CountryEnum","type":"string","description":"Country code in **ISO 3166-1 alpha-2** standard","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]},"TaxDetail":{"title":"TaxDetail","type":"object","properties":{"taxId":{"type":"string","minLength":1,"maxLength":255},"taxResidency":{"$ref":"#/components/schemas/CountryEnum"},"noTinConfirmation":{"description":"Indicates that the customer does not have a Tax Identification Number (TIN), which should only be used in exceptional cases where no TIN exists. If this field is set to true, the customer must provide supporting document (docType: TIN_NA_CONFIRMATION) confirming that no TIN is available.","type":"boolean","default":false}},"required":["taxResidency"]},"Address":{"title":"Address","type":"object","description":"Address","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":10},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string","minLength":1}},"required":["street","streetNumber","city","zip","country"]},"UboRelationshipEnum":{"title":"UboRelationshipEnum","type":"string","description":"This enum is used to specify the type of relationship a person has with a company, particularly in terms of shareholding or control.The possible values are:\n- `DIRECTLY_HOLDING_25` - a person directly holds shares in the capital or voting rights of a company.\n- `INDIRECTLY_HOLDING_25`- a person indirectly holds shares in the capital or voting rights through intermediary entities or trust arrangements.\n- `DOMINANT_INFLUENCE_OVER_SHARE_CAPITAL` - a person exercises control over the company in any other way, such as through voting agreements, special rights, or trust relationships, even without (or with only minor) direct or indirect shareholdings.\n","enum":["DIRECTLY_HOLDING_25","INDIRECTLY_HOLDING_25","DOMINANT_INFLUENCE_OVER_SHARE_CAPITAL"]}}}}
```

## The CreateLegalRepresentativeResult object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"CreateLegalRepresentativeResult":{"title":"CreateLegalRepresentativeResult","type":"object","properties":{"legalRepresentativeId":{"type":"string","format":"uuid","description":"Unique legal representative identification number in UUID format","readOnly":true}},"required":["legalRepresentativeId"]}}}}
```

## The LegalRepresentatives object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"LegalRepresentatives":{"title":"LegalRepresentatives","type":"object","properties":{"data":{"type":"array","description":"Array of legal representatives","items":{"$ref":"#/components/schemas/LegalRepresentative"}},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data","pagination"]},"LegalRepresentative":{"title":"LegalRepresentative","type":"object","properties":{"firstName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^\\S+( \\S+)*$","description":"All first names of the person according to the identification document"},"lastName":{"type":"string","minLength":1,"maxLength":255,"description":"Natural person last name"},"birthDay":{"type":"string","format":"date"},"birthPlace":{"type":"string","minLength":1,"description":"Location ","maxLength":255},"birthCountry":{"$ref":"#/components/schemas/CountryEnum"},"taxDetails":{"type":"array","description":"TaxDetails is required if fatcaControllingPerson = `TRUE`","items":{"$ref":"#/components/schemas/TaxDetail"}},"isUsNationality":{"type":"boolean","description":"FATCA - Question whether the customer is subject to US tax liability (nationality or other references due to a green card, registration address, etc.)."},"mainAddress":{"$ref":"#/components/schemas/Address"},"nationalities":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/CountryEnum"}},"function":{"$ref":"#/components/schemas/LegalRepresentativeFunctionEnum"},"soleSignatureAuthorized":{"description":"Indication of whether or not the legal representative is authorized to represent the company individually.","type":"boolean"},"fatcaControllingPerson":{"description":"Indication of whether this person is a controlling person under FATCA.\\\n`TRUE` = if fatcaClassification = `PASSIVE_NFE`\n","type":"boolean"},"deathDay":{"type":"string","format":"date"},"legalRepresentativeId":{"type":"string","format":"uuid","readOnly":true},"globalId":{"type":"string","minLength":12,"maxLength":12,"description":"Global ID of the legal representative"},"status":{"$ref":"#/components/schemas/LegalRepresentativeStatusEnum"},"createdOn":{"type":"string","format":"date-time","readOnly":true},"modifiedOn":{"type":"string","format":"date-time","readOnly":true}},"required":["birthCountry","birthDay","birthPlace","createdOn","fatcaControllingPerson","firstName","function","globalId","isUsNationality","lastName","legalRepresentativeId","modifiedOn","nationalities","soleSignatureAuthorized","status"]},"CountryEnum":{"title":"CountryEnum","type":"string","description":"Country code in **ISO 3166-1 alpha-2** standard","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]},"TaxDetail":{"title":"TaxDetail","type":"object","properties":{"taxId":{"type":"string","minLength":1,"maxLength":255},"taxResidency":{"$ref":"#/components/schemas/CountryEnum"},"noTinConfirmation":{"description":"Indicates that the customer does not have a Tax Identification Number (TIN), which should only be used in exceptional cases where no TIN exists. If this field is set to true, the customer must provide supporting document (docType: TIN_NA_CONFIRMATION) confirming that no TIN is available.","type":"boolean","default":false}},"required":["taxResidency"]},"Address":{"title":"Address","type":"object","description":"Address","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":10},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string","minLength":1}},"required":["street","streetNumber","city","zip","country"]},"LegalRepresentativeFunctionEnum":{"title":"LegalRepresentativeFunctionEnum","type":"string","enum":["MANAGING_DIRECTOR","SUPERVISORY_BOARD","SHAREHOLDER","OTHER"]},"LegalRepresentativeStatusEnum":{"title":"LegalRepresentativeStatusEnum","type":"string","enum":["ACTIVE","INACTIVE","REVIEW","RECEIVED","INVALID"]},"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 LegalRepresentative object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"LegalRepresentative":{"title":"LegalRepresentative","type":"object","properties":{"firstName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^\\S+( \\S+)*$","description":"All first names of the person according to the identification document"},"lastName":{"type":"string","minLength":1,"maxLength":255,"description":"Natural person last name"},"birthDay":{"type":"string","format":"date"},"birthPlace":{"type":"string","minLength":1,"description":"Location ","maxLength":255},"birthCountry":{"$ref":"#/components/schemas/CountryEnum"},"taxDetails":{"type":"array","description":"TaxDetails is required if fatcaControllingPerson = `TRUE`","items":{"$ref":"#/components/schemas/TaxDetail"}},"isUsNationality":{"type":"boolean","description":"FATCA - Question whether the customer is subject to US tax liability (nationality or other references due to a green card, registration address, etc.)."},"mainAddress":{"$ref":"#/components/schemas/Address"},"nationalities":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/CountryEnum"}},"function":{"$ref":"#/components/schemas/LegalRepresentativeFunctionEnum"},"soleSignatureAuthorized":{"description":"Indication of whether or not the legal representative is authorized to represent the company individually.","type":"boolean"},"fatcaControllingPerson":{"description":"Indication of whether this person is a controlling person under FATCA.\\\n`TRUE` = if fatcaClassification = `PASSIVE_NFE`\n","type":"boolean"},"deathDay":{"type":"string","format":"date"},"legalRepresentativeId":{"type":"string","format":"uuid","readOnly":true},"globalId":{"type":"string","minLength":12,"maxLength":12,"description":"Global ID of the legal representative"},"status":{"$ref":"#/components/schemas/LegalRepresentativeStatusEnum"},"createdOn":{"type":"string","format":"date-time","readOnly":true},"modifiedOn":{"type":"string","format":"date-time","readOnly":true}},"required":["birthCountry","birthDay","birthPlace","createdOn","fatcaControllingPerson","firstName","function","globalId","isUsNationality","lastName","legalRepresentativeId","modifiedOn","nationalities","soleSignatureAuthorized","status"]},"CountryEnum":{"title":"CountryEnum","type":"string","description":"Country code in **ISO 3166-1 alpha-2** standard","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]},"TaxDetail":{"title":"TaxDetail","type":"object","properties":{"taxId":{"type":"string","minLength":1,"maxLength":255},"taxResidency":{"$ref":"#/components/schemas/CountryEnum"},"noTinConfirmation":{"description":"Indicates that the customer does not have a Tax Identification Number (TIN), which should only be used in exceptional cases where no TIN exists. If this field is set to true, the customer must provide supporting document (docType: TIN_NA_CONFIRMATION) confirming that no TIN is available.","type":"boolean","default":false}},"required":["taxResidency"]},"Address":{"title":"Address","type":"object","description":"Address","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":10},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string","minLength":1}},"required":["street","streetNumber","city","zip","country"]},"LegalRepresentativeFunctionEnum":{"title":"LegalRepresentativeFunctionEnum","type":"string","enum":["MANAGING_DIRECTOR","SUPERVISORY_BOARD","SHAREHOLDER","OTHER"]},"LegalRepresentativeStatusEnum":{"title":"LegalRepresentativeStatusEnum","type":"string","enum":["ACTIVE","INACTIVE","REVIEW","RECEIVED","INVALID"]}}}}
```

## The LegalRepresentativeData object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"LegalRepresentativeData":{"title":"LegalRepresentativeData","type":"object","properties":{"firstName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^\\S+( \\S+)*$","description":"All first names of the person according to the identification document"},"lastName":{"type":"string","minLength":1,"maxLength":255,"description":"Natural person last name"},"birthDay":{"type":"string","format":"date"},"birthPlace":{"type":"string","minLength":1,"description":"Location ","maxLength":255},"birthCountry":{"$ref":"#/components/schemas/CountryEnum"},"taxDetails":{"type":"array","description":"TaxDetails is required if fatcaControllingPerson = `TRUE`","items":{"$ref":"#/components/schemas/TaxDetail"}},"isUsNationality":{"type":"boolean","description":"FATCA - Question whether the customer is subject to US tax liability (nationality or other references due to a green card, registration address, etc.)."},"mainAddress":{"$ref":"#/components/schemas/Address"},"nationalities":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/CountryEnum"}},"function":{"$ref":"#/components/schemas/LegalRepresentativeFunctionEnum"},"soleSignatureAuthorized":{"description":"Indication of whether or not the legal representative is authorized to represent the company individually.","type":"boolean"},"fatcaControllingPerson":{"description":"Indication of whether this person is a controlling person under FATCA.\\\n`TRUE` = if fatcaClassification = `PASSIVE_NFE`\n","type":"boolean"}},"required":["firstName","lastName","birthDay","birthPlace","birthCountry","isUsNationality","nationalities","function","soleSignatureAuthorized","fatcaControllingPerson"]},"CountryEnum":{"title":"CountryEnum","type":"string","description":"Country code in **ISO 3166-1 alpha-2** standard","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]},"TaxDetail":{"title":"TaxDetail","type":"object","properties":{"taxId":{"type":"string","minLength":1,"maxLength":255},"taxResidency":{"$ref":"#/components/schemas/CountryEnum"},"noTinConfirmation":{"description":"Indicates that the customer does not have a Tax Identification Number (TIN), which should only be used in exceptional cases where no TIN exists. If this field is set to true, the customer must provide supporting document (docType: TIN_NA_CONFIRMATION) confirming that no TIN is available.","type":"boolean","default":false}},"required":["taxResidency"]},"Address":{"title":"Address","type":"object","description":"Address","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":10},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string","minLength":1}},"required":["street","streetNumber","city","zip","country"]},"LegalRepresentativeFunctionEnum":{"title":"LegalRepresentativeFunctionEnum","type":"string","enum":["MANAGING_DIRECTOR","SUPERVISORY_BOARD","SHAREHOLDER","OTHER"]}}}}
```

## The LegalRepresentativeUpdate object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"LegalRepresentativeUpdate":{"title":"LegalRepresentativeUpdate","type":"object","properties":{"firstName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^\\S+( \\S+)*$","description":"All first names of the person according to the identification document"},"lastName":{"type":"string","minLength":1,"maxLength":255,"description":"Natural person last name"},"birthDay":{"type":"string","format":"date"},"birthPlace":{"type":"string","minLength":1,"description":"Location ","maxLength":255},"birthCountry":{"$ref":"#/components/schemas/CountryEnum"},"taxDetails":{"type":"array","items":{"$ref":"#/components/schemas/TaxDetail"}},"isUsNationality":{"type":"boolean","description":"FATCA - Question whether the customer is subject to US tax liability (nationality or other references due to a green card, registration address, etc.)."},"mainAddress":{"$ref":"#/components/schemas/Address"},"nationalities":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/CountryEnum"}},"function":{"$ref":"#/components/schemas/LegalRepresentativeFunctionEnum"},"soleSignatureAuthorized":{"description":"Indication of whether or not the legal representative is authorized to represent the company individually.","type":"boolean"},"fatcaControllingPerson":{"description":"Indication of whether this person is a controlling person under FATCA.\\\n`TRUE` = if fatcaClassification = `PASSIVE_NFE`\n","type":"boolean"}}},"CountryEnum":{"title":"CountryEnum","type":"string","description":"Country code in **ISO 3166-1 alpha-2** standard","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]},"TaxDetail":{"title":"TaxDetail","type":"object","properties":{"taxId":{"type":"string","minLength":1,"maxLength":255},"taxResidency":{"$ref":"#/components/schemas/CountryEnum"},"noTinConfirmation":{"description":"Indicates that the customer does not have a Tax Identification Number (TIN), which should only be used in exceptional cases where no TIN exists. If this field is set to true, the customer must provide supporting document (docType: TIN_NA_CONFIRMATION) confirming that no TIN is available.","type":"boolean","default":false}},"required":["taxResidency"]},"Address":{"title":"Address","type":"object","description":"Address","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":10},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string","minLength":1}},"required":["street","streetNumber","city","zip","country"]},"LegalRepresentativeFunctionEnum":{"title":"LegalRepresentativeFunctionEnum","type":"string","enum":["MANAGING_DIRECTOR","SUPERVISORY_BOARD","SHAREHOLDER","OTHER"]}}}}
```

## The PrepareLegalEntityResult object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"PrepareLegalEntityResult":{"title":"PrepareLegalEntityResult","type":"object","properties":{"searchId":{"type":"string","format":"uuid","description":"Unique identification number in UUID format","readOnly":true}},"required":["searchId"]}}}}
```

## The PrepareLegalEntityData object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"PrepareLegalEntityData":{"title":"PrepareLegalEntityData","type":"object","properties":{"companyName":{"type":"string","description":"The name of the company","minLength":1,"maxLength":255},"providerId":{"type":"string","description":"The provider id of the company","minLength":1,"maxLength":255}},"required":["companyName"]}}}}
```

## The LegalEntitySearchLiteResult object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"LegalEntitySearchLiteResult":{"type":"object","required":["address"],"properties":{"address":{"$ref":"#/components/schemas/Address"},"businessOfficeType":{"type":"string","enum":["Branch","Headquarters","Unknown"]},"legalForm":{"type":"string"},"name":{"type":"string"},"providerId":{"type":"string"},"registerCourt":{"type":"string"},"registrationNumber":{"type":"string"}}},"Address":{"title":"Address","type":"object","description":"Address","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":10},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string","minLength":1}},"required":["street","streetNumber","city","zip","country"]},"CountryEnum":{"title":"CountryEnum","type":"string","description":"Country code in **ISO 3166-1 alpha-2** standard","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]}}}}
```

## The LegalEntityCompoundSearchResult object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"LegalEntityCompoundSearchResult":{"title":"LegalEntityCompoundSearchResult","type":"object","properties":{"search":{"$ref":"#/components/schemas/LegalEntitySearchDetails"},"legalEntity":{"$ref":"#/components/schemas/LegalEntitySearchResult"},"legalRepresentatives":{"type":"array","items":{"$ref":"#/components/schemas/LegalRepresentativeSearchResult"}},"beneficialOwners":{"type":"array","items":{"$ref":"#/components/schemas/BeneficialOwnerSearchResult"}},"documents":{"type":"array","items":{"$ref":"#/components/schemas/LegalEntityDocumentSearchResult"}}},"required":["search"]},"LegalEntitySearchDetails":{"title":"LegalEntitySearchDetails","type":"object","properties":{"searchId":{"type":"string","format":"uuid"},"status":{"$ref":"#/components/schemas/LegalEntitySearchStatusEnum"},"documentTypes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentTypeEnum"}}},"required":["searchId","status"]},"LegalEntitySearchStatusEnum":{"title":"LegalEntitySearchStatusEnum","type":"string","enum":["WAITING_FOR_DATA","WAITING_FOR_DOCUMENTS","READY_DATA","READY_DOCUMENTS","PREPARING","COMPLETED","FAILED","ERROR"],"description":"status of the search"},"DocumentTypeEnum":{"title":"DocumentTypeEnum","type":"string","description":"This list may change in the future.","enum":["KYC","OTHER","PROOF_OF_SINGLE_CUSTODY","PROOF_OF_CUSTODY","PROOF_OF_RESIDENCE","BIRTH_CERTIFICATE","IDENTIFICATION_CERTIFICATE","CURRENT_REGISTRY_EXTRACT","CHRONOLOGICAL_REGISTRY_EXTRACT","SHAREHOLDER_LIST","PARTNERSHIP_AGREEMENT","TRANSPARENCY_REGISTER_EXTRACT","BUSINESS_REGISTRATION","STATUTE","INHERITANCE_LEGITIMATION","INSOLVENCY_ORDER","TIN_NA_CONFIRMATION","SOURCE_OF_INCOME","SOURCE_OF_FUNDS","DEATH_CERTIFICATE","W_8BEN_E","CRYPTO_RECEIPT","TRADE_INVOICE","EX_ANTE","CORPORATE_ACTION","TRANSFER_RECEIPT"]},"LegalEntitySearchResult":{"title":"LegalEntitySearchResult","type":"object","properties":{"legalName":{"type":"string","description":"The legal name of the entity","maxLength":255},"legalForm":{"$ref":"#/components/schemas/LegalFormEnum"},"naceSectors":{"type":"array","description":"Specification of the sector in which the company is mainly economically active. The information should be provided according to the groups of the NACE codes (Sections A-V, Groups 01.11 - 99.00) without subclasses. (Level 4)","items":{"$ref":"#/components/schemas/LegalEntityNaceSector"}},"registerCountry":{"$ref":"#/components/schemas/CountryEnum"},"registerNumber":{"type":"string","description":"Number at which the company is registered","maxLength":255},"registerCourt":{"type":"string","minLength":1,"maxLength":255,"description":"An administrative court in which the company was registered"},"registerCourtZipCode":{"type":"string","minLength":1,"maxLength":255,"description":"An administrative court zip code in which the company was registered"},"registeredOn":{"type":"string","format":"date","description":"The date on which the entity was registered"},"foundedOn":{"type":"string","format":"date","description":"The date on which the entity was founded"},"vendorRecordId":{"type":"string","minLength":1,"maxLength":255,"description":"The vendor record id of the entity"},"legalEntityIdentifier":{"type":"string","minLength":1,"maxLength":20,"description":"Unique global identifier for legal entities participating in financial transactions","pattern":"^\\d{4}[0]{2}[A-Z\\d]{12}\\d{2}$"},"purpose":{"type":"string","minLength":1,"maxLength":255,"description":"The purpose of the legal entity"},"vatId":{"type":"string","minLength":11,"maxLength":11,"description":"The value-added tax id of the legal entity"},"mainAddress":{"$ref":"#/components/schemas/Address"},"correspondenceAddress":{"$ref":"#/components/schemas/Address"},"invoiceAddress":{"$ref":"#/components/schemas/Address"},"contact":{"$ref":"#/components/schemas/Contact"}},"required":["legalName","vendorRecordId"]},"LegalFormEnum":{"title":"LegalFormEnum","type":"string","description":"LegalFormEnum","enum":["LIMITED_LIABILITY_COMPANY","PUBLIC_LIMITED_COMPANY","PRIVATE_CORPORATION","FOUNDATION","ASSOCIATION","REGISTERED_BUSINESSMAN","REGISTERED_COMPANY","LIMITED_PARTNERSHIP","GENERAL_PARTNERSHIP","LIMITED_LIABILITY_COMPANY_AND_LIMITED_PARTNERSHIP","PARTNERSHIP","SINGLE_PARTNERSHIP","OTHER","UNACCEPTABLE"]},"LegalEntityNaceSector":{"title":"LegalEntityNaceSector","type":"object","properties":{"section":{"type":"string"},"code":{"type":"string","minLength":2},"description":{"type":"string","maxLength":255}},"required":["code"]},"CountryEnum":{"title":"CountryEnum","type":"string","description":"Country code in **ISO 3166-1 alpha-2** standard","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]},"Address":{"title":"Address","type":"object","description":"Address","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":10},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string","minLength":1}},"required":["street","streetNumber","city","zip","country"]},"Contact":{"title":"Contact","type":"object","properties":{"phone":{"type":"string","description":"Mobile telephone number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"email":{"type":"string","description":"E-mail address","maxLength":255,"pattern":"^[a-zA-Z0-9.!#$%&'*+\\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$"},"fax":{"type":"string","description":"Fax number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"website":{"type":"string","description":"website address","maxLength":320}},"required":["phone","email"]},"LegalRepresentativeSearchResult":{"title":"LegalRepresentativeSearchResult","type":"object","properties":{"firstName":{"type":"string","maxLength":255,"description":"All first names of the person received from the provider"},"lastName":{"type":"string","maxLength":255},"gender":{"$ref":"#/components/schemas/GenderEnum"},"birthDay":{"type":"string","format":"date"},"birthPlace":{"type":"string","minLength":1},"academicDegree":{"type":"string","minLength":1},"title":{"type":"string","minLength":1},"position":{"$ref":"#/components/schemas/LegalRepresentativeFunctionEnum"},"taxId":{"type":"string","minLength":1},"representationCompetence":{"type":"string","minLength":1},"nationalities":{"type":"array","items":{"$ref":"#/components/schemas/CountryEnum"}},"address":{"$ref":"#/components/schemas/Address"}},"required":["firstName","lastName"]},"GenderEnum":{"title":"GenderEnum","type":"string","description":"Gender","enum":["MALE","FEMALE","DIVERSE"]},"LegalRepresentativeFunctionEnum":{"title":"LegalRepresentativeFunctionEnum","type":"string","enum":["MANAGING_DIRECTOR","SUPERVISORY_BOARD","SHAREHOLDER","OTHER"]},"BeneficialOwnerSearchResult":{"title":"BeneficialOwnerSearchResult","type":"object","properties":{"firstName":{"type":"string","maxLength":255,"description":"All first names of the person received from the provider"},"lastName":{"type":"string","maxLength":255},"gender":{"$ref":"#/components/schemas/GenderEnum"},"birthDay":{"type":"string","format":"date"},"birthPlace":{"type":"string","minLength":1},"academicDegree":{"type":"string","minLength":1},"title":{"type":"string","minLength":1},"taxId":{"type":"string","minLength":1},"scope":{"type":"string","minLength":1},"representationCompetence":{"type":"string","minLength":1},"share":{"type":"number","minimum":0,"exclusiveMinimum":true,"maximum":100},"nationalities":{"type":"array","items":{"$ref":"#/components/schemas/CountryEnum"}},"address":{"$ref":"#/components/schemas/Address"}},"required":["firstName","lastName","share","nationalities"]},"LegalEntityDocumentSearchResult":{"title":"LegalEntityDocumentSearchResult","type":"object","properties":{"contentType":{"type":"string","minLength":1},"documentId":{"type":"string","minLength":1},"documentType":{"$ref":"#/components/schemas/DocumentTypeEnum"},"length":{"type":"integer"},"name":{"type":"string","minLength":1},"timestamp":{"type":"string","format":"date-time"}}}}}}
```

## The LegalEntitySearchDetails object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"LegalEntitySearchDetails":{"title":"LegalEntitySearchDetails","type":"object","properties":{"searchId":{"type":"string","format":"uuid"},"status":{"$ref":"#/components/schemas/LegalEntitySearchStatusEnum"},"documentTypes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentTypeEnum"}}},"required":["searchId","status"]},"LegalEntitySearchStatusEnum":{"title":"LegalEntitySearchStatusEnum","type":"string","enum":["WAITING_FOR_DATA","WAITING_FOR_DOCUMENTS","READY_DATA","READY_DOCUMENTS","PREPARING","COMPLETED","FAILED","ERROR"],"description":"status of the search"},"DocumentTypeEnum":{"title":"DocumentTypeEnum","type":"string","description":"This list may change in the future.","enum":["KYC","OTHER","PROOF_OF_SINGLE_CUSTODY","PROOF_OF_CUSTODY","PROOF_OF_RESIDENCE","BIRTH_CERTIFICATE","IDENTIFICATION_CERTIFICATE","CURRENT_REGISTRY_EXTRACT","CHRONOLOGICAL_REGISTRY_EXTRACT","SHAREHOLDER_LIST","PARTNERSHIP_AGREEMENT","TRANSPARENCY_REGISTER_EXTRACT","BUSINESS_REGISTRATION","STATUTE","INHERITANCE_LEGITIMATION","INSOLVENCY_ORDER","TIN_NA_CONFIRMATION","SOURCE_OF_INCOME","SOURCE_OF_FUNDS","DEATH_CERTIFICATE","W_8BEN_E","CRYPTO_RECEIPT","TRADE_INVOICE","EX_ANTE","CORPORATE_ACTION","TRANSFER_RECEIPT"]}}}}
```

## The LegalEntitySearchResult object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"LegalEntitySearchResult":{"title":"LegalEntitySearchResult","type":"object","properties":{"legalName":{"type":"string","description":"The legal name of the entity","maxLength":255},"legalForm":{"$ref":"#/components/schemas/LegalFormEnum"},"naceSectors":{"type":"array","description":"Specification of the sector in which the company is mainly economically active. The information should be provided according to the groups of the NACE codes (Sections A-V, Groups 01.11 - 99.00) without subclasses. (Level 4)","items":{"$ref":"#/components/schemas/LegalEntityNaceSector"}},"registerCountry":{"$ref":"#/components/schemas/CountryEnum"},"registerNumber":{"type":"string","description":"Number at which the company is registered","maxLength":255},"registerCourt":{"type":"string","minLength":1,"maxLength":255,"description":"An administrative court in which the company was registered"},"registerCourtZipCode":{"type":"string","minLength":1,"maxLength":255,"description":"An administrative court zip code in which the company was registered"},"registeredOn":{"type":"string","format":"date","description":"The date on which the entity was registered"},"foundedOn":{"type":"string","format":"date","description":"The date on which the entity was founded"},"vendorRecordId":{"type":"string","minLength":1,"maxLength":255,"description":"The vendor record id of the entity"},"legalEntityIdentifier":{"type":"string","minLength":1,"maxLength":20,"description":"Unique global identifier for legal entities participating in financial transactions","pattern":"^\\d{4}[0]{2}[A-Z\\d]{12}\\d{2}$"},"purpose":{"type":"string","minLength":1,"maxLength":255,"description":"The purpose of the legal entity"},"vatId":{"type":"string","minLength":11,"maxLength":11,"description":"The value-added tax id of the legal entity"},"mainAddress":{"$ref":"#/components/schemas/Address"},"correspondenceAddress":{"$ref":"#/components/schemas/Address"},"invoiceAddress":{"$ref":"#/components/schemas/Address"},"contact":{"$ref":"#/components/schemas/Contact"}},"required":["legalName","vendorRecordId"]},"LegalFormEnum":{"title":"LegalFormEnum","type":"string","description":"LegalFormEnum","enum":["LIMITED_LIABILITY_COMPANY","PUBLIC_LIMITED_COMPANY","PRIVATE_CORPORATION","FOUNDATION","ASSOCIATION","REGISTERED_BUSINESSMAN","REGISTERED_COMPANY","LIMITED_PARTNERSHIP","GENERAL_PARTNERSHIP","LIMITED_LIABILITY_COMPANY_AND_LIMITED_PARTNERSHIP","PARTNERSHIP","SINGLE_PARTNERSHIP","OTHER","UNACCEPTABLE"]},"LegalEntityNaceSector":{"title":"LegalEntityNaceSector","type":"object","properties":{"section":{"type":"string"},"code":{"type":"string","minLength":2},"description":{"type":"string","maxLength":255}},"required":["code"]},"CountryEnum":{"title":"CountryEnum","type":"string","description":"Country code in **ISO 3166-1 alpha-2** standard","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]},"Address":{"title":"Address","type":"object","description":"Address","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":10},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string","minLength":1}},"required":["street","streetNumber","city","zip","country"]},"Contact":{"title":"Contact","type":"object","properties":{"phone":{"type":"string","description":"Mobile telephone number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"email":{"type":"string","description":"E-mail address","maxLength":255,"pattern":"^[a-zA-Z0-9.!#$%&'*+\\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$"},"fax":{"type":"string","description":"Fax number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"website":{"type":"string","description":"website address","maxLength":320}},"required":["phone","email"]}}}}
```

## The LegalRepresentativeSearchResult object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"LegalRepresentativeSearchResult":{"title":"LegalRepresentativeSearchResult","type":"object","properties":{"firstName":{"type":"string","maxLength":255,"description":"All first names of the person received from the provider"},"lastName":{"type":"string","maxLength":255},"gender":{"$ref":"#/components/schemas/GenderEnum"},"birthDay":{"type":"string","format":"date"},"birthPlace":{"type":"string","minLength":1},"academicDegree":{"type":"string","minLength":1},"title":{"type":"string","minLength":1},"position":{"$ref":"#/components/schemas/LegalRepresentativeFunctionEnum"},"taxId":{"type":"string","minLength":1},"representationCompetence":{"type":"string","minLength":1},"nationalities":{"type":"array","items":{"$ref":"#/components/schemas/CountryEnum"}},"address":{"$ref":"#/components/schemas/Address"}},"required":["firstName","lastName"]},"GenderEnum":{"title":"GenderEnum","type":"string","description":"Gender","enum":["MALE","FEMALE","DIVERSE"]},"LegalRepresentativeFunctionEnum":{"title":"LegalRepresentativeFunctionEnum","type":"string","enum":["MANAGING_DIRECTOR","SUPERVISORY_BOARD","SHAREHOLDER","OTHER"]},"CountryEnum":{"title":"CountryEnum","type":"string","description":"Country code in **ISO 3166-1 alpha-2** standard","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]},"Address":{"title":"Address","type":"object","description":"Address","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":10},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string","minLength":1}},"required":["street","streetNumber","city","zip","country"]}}}}
```

## The BeneficialOwnerSearchResult object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"BeneficialOwnerSearchResult":{"title":"BeneficialOwnerSearchResult","type":"object","properties":{"firstName":{"type":"string","maxLength":255,"description":"All first names of the person received from the provider"},"lastName":{"type":"string","maxLength":255},"gender":{"$ref":"#/components/schemas/GenderEnum"},"birthDay":{"type":"string","format":"date"},"birthPlace":{"type":"string","minLength":1},"academicDegree":{"type":"string","minLength":1},"title":{"type":"string","minLength":1},"taxId":{"type":"string","minLength":1},"scope":{"type":"string","minLength":1},"representationCompetence":{"type":"string","minLength":1},"share":{"type":"number","minimum":0,"exclusiveMinimum":true,"maximum":100},"nationalities":{"type":"array","items":{"$ref":"#/components/schemas/CountryEnum"}},"address":{"$ref":"#/components/schemas/Address"}},"required":["firstName","lastName","share","nationalities"]},"GenderEnum":{"title":"GenderEnum","type":"string","description":"Gender","enum":["MALE","FEMALE","DIVERSE"]},"CountryEnum":{"title":"CountryEnum","type":"string","description":"Country code in **ISO 3166-1 alpha-2** standard","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW","XK"]},"Address":{"title":"Address","type":"object","description":"Address","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"streetNumber":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":10},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string","minLength":1}},"required":["street","streetNumber","city","zip","country"]}}}}
```

## The LegalEntityDocumentSearchResult object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"LegalEntityDocumentSearchResult":{"title":"LegalEntityDocumentSearchResult","type":"object","properties":{"contentType":{"type":"string","minLength":1},"documentId":{"type":"string","minLength":1},"documentType":{"$ref":"#/components/schemas/DocumentTypeEnum"},"length":{"type":"integer"},"name":{"type":"string","minLength":1},"timestamp":{"type":"string","format":"date-time"}}},"DocumentTypeEnum":{"title":"DocumentTypeEnum","type":"string","description":"This list may change in the future.","enum":["KYC","OTHER","PROOF_OF_SINGLE_CUSTODY","PROOF_OF_CUSTODY","PROOF_OF_RESIDENCE","BIRTH_CERTIFICATE","IDENTIFICATION_CERTIFICATE","CURRENT_REGISTRY_EXTRACT","CHRONOLOGICAL_REGISTRY_EXTRACT","SHAREHOLDER_LIST","PARTNERSHIP_AGREEMENT","TRANSPARENCY_REGISTER_EXTRACT","BUSINESS_REGISTRATION","STATUTE","INHERITANCE_LEGITIMATION","INSOLVENCY_ORDER","TIN_NA_CONFIRMATION","SOURCE_OF_INCOME","SOURCE_OF_FUNDS","DEATH_CERTIFICATE","W_8BEN_E","CRYPTO_RECEIPT","TRADE_INVOICE","EX_ANTE","CORPORATE_ACTION","TRANSFER_RECEIPT"]}}}}
```

## The StartOnboardingResult object

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

## The EntityOnboardingData object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"EntityOnboardingData":{"title":"EntityOnboardingData","type":"object","properties":{"entityType":{"$ref":"#/components/schemas/OnboardingEntityTypeEnum"},"entityId":{"type":"string","format":"uuid","description":"Identification number in UUID format of the entity"}},"required":["entityType","entityId"]},"OnboardingEntityTypeEnum":{"title":"OnboardingEntityTypeEnum","type":"string","enum":["BENEFICIAL_OWNER"]}}}}
```

## The EntityOnboarding object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"EntityOnboarding":{"type":"object","properties":{"onboardingId":{"type":"string","format":"uuid","readOnly":true},"status":{"$ref":"#/components/schemas/OnboardingStatusEnum"},"entityType":{"$ref":"#/components/schemas/OnboardingEntityTypeEnum"},"entityId":{"type":"string","format":"uuid","description":"Identification number in UUID format of the entity"},"createdOn":{"type":"string","format":"date-time","readOnly":true},"modifiedOn":{"type":"string","format":"date-time","readOnly":true}},"required":["createdOn","entityId","entityType","modifiedOn","onboardingId","status"],"title":"EntityOnboarding"},"OnboardingStatusEnum":{"title":"OnboardingStatusEnum","type":"string","enum":["CREATED","PENDING","APPROVED","REJECTED","RECEIVED","INVALID"],"readOnly":true},"OnboardingEntityTypeEnum":{"title":"OnboardingEntityTypeEnum","type":"string","enum":["BENEFICIAL_OWNER"]}}}}
```

## The StartOffboardingResult object

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

## The EntityOffboardingData object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"EntityOffboardingData":{"title":"EntityOffboardingData","type":"object","properties":{"entityType":{"$ref":"#/components/schemas/OffboardingEntityTypeEnum"},"entityId":{"type":"string","format":"uuid","description":"Identification number in UUID format of the entity"},"reason":{"$ref":"#/components/schemas/OffboardingReasonEnum"}},"required":["entityType","entityId","reason"]},"OffboardingEntityTypeEnum":{"title":"OffboardingEntityTypeEnum","type":"string","enum":["BENEFICIAL_OWNER"]},"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 EntityOffboarding object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"EntityOffboarding":{"type":"object","properties":{"offboardingId":{"type":"string","format":"uuid","readOnly":true},"status":{"$ref":"#/components/schemas/OffboardingStatusEnum"},"entityType":{"$ref":"#/components/schemas/OffboardingEntityTypeEnum"},"entityId":{"type":"string","format":"uuid","description":"Identification number in UUID format of the entity"},"reason":{"$ref":"#/components/schemas/OffboardingReasonEnum"},"createdOn":{"type":"string","format":"date-time","readOnly":true},"modifiedOn":{"type":"string","format":"date-time","readOnly":true}},"required":["createdOn","entityId","entityType","modifiedOn","offboardingId","reason","status"],"title":"EntityOffboarding"},"OffboardingStatusEnum":{"title":"OffboardingStatusEnum","type":"string","enum":["RECEIVED","CREATED","PENDING","INVALID","REJECTED","CANCELED","APPROVED"],"readOnly":true},"OffboardingEntityTypeEnum":{"title":"OffboardingEntityTypeEnum","type":"string","enum":["BENEFICIAL_OWNER"]},"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 AppropriatenessTest object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"AppropriatenessTest":{"title":"AppropriatenessTest","type":"object","description":"Appropriateness test with version and questions","properties":{"appropriatenessTestId":{"type":"string","format":"uuid"},"version":{"type":"integer","description":"Version of the test"},"assetType":{"$ref":"#/components/schemas/AppropriatenessTestAssetTypeEnum"},"questions":{"type":"array","description":"List of test questions","items":{"$ref":"#/components/schemas/AppropriatenessTestQuestion"}},"createdOn":{"type":"string","format":"date-time"}},"required":["appropriatenessTestId","version","assetType","questions","createdOn"]},"AppropriatenessTestAssetTypeEnum":{"title":"AppropriatenessTestAssetTypeEnum","type":"string","description":"Asset type for appropriateness test","enum":["SECURITY_TOKEN"]},"AppropriatenessTestQuestion":{"title":"AppropriatenessTestQuestion","type":"object","description":"Appropriateness test question with answers","properties":{"questionCode":{"type":"string","description":"Unique identifier for the question"},"category":{"type":"string","description":"Category of the question"},"questionText":{"type":"string","description":"Text of the question"},"answers":{"type":"array","description":"List of possible answers","items":{"$ref":"#/components/schemas/AppropriatenessTestAnswer"}}},"required":["questionCode","category","questionText","answers"]},"AppropriatenessTestAnswer":{"title":"AppropriatenessTestAnswer","type":"object","description":"Answer option for appropriateness test question","properties":{"answerCode":{"type":"string","description":"Unique identifier for the answer"},"answerText":{"type":"string","description":"Text of the answer"}},"required":["answerCode","answerText"]}}}}
```

## The AppropriatenessTestQuestion object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"AppropriatenessTestQuestion":{"title":"AppropriatenessTestQuestion","type":"object","description":"Appropriateness test question with answers","properties":{"questionCode":{"type":"string","description":"Unique identifier for the question"},"category":{"type":"string","description":"Category of the question"},"questionText":{"type":"string","description":"Text of the question"},"answers":{"type":"array","description":"List of possible answers","items":{"$ref":"#/components/schemas/AppropriatenessTestAnswer"}}},"required":["questionCode","category","questionText","answers"]},"AppropriatenessTestAnswer":{"title":"AppropriatenessTestAnswer","type":"object","description":"Answer option for appropriateness test question","properties":{"answerCode":{"type":"string","description":"Unique identifier for the answer"},"answerText":{"type":"string","description":"Text of the answer"}},"required":["answerCode","answerText"]}}}}
```

## The AppropriatenessTestAnswer object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"AppropriatenessTestAnswer":{"title":"AppropriatenessTestAnswer","type":"object","description":"Answer option for appropriateness test question","properties":{"answerCode":{"type":"string","description":"Unique identifier for the answer"},"answerText":{"type":"string","description":"Text of the answer"}},"required":["answerCode","answerText"]}}}}
```

## The TradingProfile object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"TradingProfile":{"title":"TradingProfile","type":"object","description":"Trading profile for a natural person","properties":{"assetTypeProfiles":{"type":"array","description":"Trading profile details per asset type","items":{"$ref":"#/components/schemas/AssetTypeTradingProfile"}},"investmentObjectives":{"$ref":"#/components/schemas/InvestmentObjectives"}}},"AssetTypeTradingProfile":{"title":"AssetTypeTradingProfile","type":"object","required":["assetType","hasKnowledge","hasExperience","createdOn","modifiedOn","riskAcknowledged"],"properties":{"assetType":{"$ref":"#/components/schemas/CreateUpdateTraditionalAssetTypeEnum"},"hasKnowledge":{"type":"boolean","description":"Indicates if the person has trading knowledge"},"hasExperience":{"type":"boolean","description":"Indicates if the person has trading experience"},"tradingExperience":{"$ref":"#/components/schemas/TradingExperience"},"createdOn":{"type":"string","format":"date-time","description":"The date on which the trading profile was created for asset type"},"modifiedOn":{"type":"string","format":"date-time","description":"The date on which the trading profile was modified the last time for asset type"},"appropriatenessTestPassed":{"type":"boolean"},"riskAcknowledged":{"type":"boolean"}}},"CreateUpdateTraditionalAssetTypeEnum":{"title":"CreateUpdateTraditionalAssetTypeEnum","type":"string","description":"The type of the traditional asset for create and update operations","enum":["BOND","ETF","EQUITY","FUND","COMMODITY","DERIVATIVE","ETN","SECURITY_TOKEN"]},"TradingExperience":{"title":"TradingExperience","type":"object","description":"Trading experience details","properties":{"yearsOfExperience":{"type":"integer","description":"Number of years of trading experience","minimum":0},"numberOfTrades":{"type":"integer","description":"Number of trades executed","minimum":0},"tradeVolume":{"type":"number","description":"Total volume of trades","minimum":0}},"required":["yearsOfExperience","numberOfTrades","tradeVolume"]},"InvestmentObjectives":{"title":"InvestmentObjectives","type":"object","description":"Investment objectives categorized by purpose","properties":{"growthAndSavings":{"type":"array","description":"Growth and savings investment purposes","items":{"$ref":"#/components/schemas/GrowthAndSavingsPurposeEnum"}},"capitalProtectionAndHedging":{"type":"array","description":"Capital protection and hedging investment purposes","items":{"$ref":"#/components/schemas/CapitalProtectionAndHedgingPurposeEnum"}},"incomeAndLiquidity":{"type":"array","description":"Income and liquidity investment purposes","items":{"$ref":"#/components/schemas/IncomeAndLiquidityPurposeEnum"}},"retirementAndFuturePlanning":{"type":"array","description":"Retirement and future planning investment purposes","items":{"$ref":"#/components/schemas/RetirementAndFuturePlanningPurposeEnum"}},"specificInvestmentTypes":{"type":"array","description":"Specific investment types purposes","items":{"$ref":"#/components/schemas/SpecificInvestmentTypesPurposeEnum"}},"taxAndEstatePlanning":{"type":"array","description":"Tax and estate planning investment purposes","items":{"$ref":"#/components/schemas/TaxAndEstatePlanningPurposeEnum"}}}},"GrowthAndSavingsPurposeEnum":{"title":"GrowthAndSavingsPurposeEnum","type":"string","enum":["CAPITAL_GROWTH","LONG_TERM_SAVING","PERSONAL_INVESTMENTS"]},"CapitalProtectionAndHedgingPurposeEnum":{"title":"CapitalProtectionAndHedgingPurposeEnum","type":"string","enum":["WEALTH_PRESERVATION","HEDGING","RISK_MANAGEMENT"]},"IncomeAndLiquidityPurposeEnum":{"title":"IncomeAndLiquidityPurposeEnum","type":"string","enum":["INCOME_GENERATION","CASH_MANAGEMENT","SHORT_TERM_LIQUIDITY"]},"RetirementAndFuturePlanningPurposeEnum":{"title":"RetirementAndFuturePlanningPurposeEnum","type":"string","enum":["PENSION_PLANNING","EDUCATION_FUNDING","FAMILY_SECURITY"]},"SpecificInvestmentTypesPurposeEnum":{"title":"SpecificInvestmentTypesPurposeEnum","type":"string","enum":["INVESTMENT_IN_LISTED_EQUITIES","SMALL_SCALE_INVESTMENTS","REAL_ESTATE_INVESTMENTS","ALTERNATIVE_INVESTMENTS","SPECULATIVE_INVESTMENTS","SHORT_TERM_TRADING"]},"TaxAndEstatePlanningPurposeEnum":{"title":"TaxAndEstatePlanningPurposeEnum","type":"string","enum":["TAX_PLANNING","ESTATE_PLANNING"]}}}}
```

## The AssetTypeTradingProfile object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"AssetTypeTradingProfile":{"title":"AssetTypeTradingProfile","type":"object","required":["assetType","hasKnowledge","hasExperience","createdOn","modifiedOn","riskAcknowledged"],"properties":{"assetType":{"$ref":"#/components/schemas/CreateUpdateTraditionalAssetTypeEnum"},"hasKnowledge":{"type":"boolean","description":"Indicates if the person has trading knowledge"},"hasExperience":{"type":"boolean","description":"Indicates if the person has trading experience"},"tradingExperience":{"$ref":"#/components/schemas/TradingExperience"},"createdOn":{"type":"string","format":"date-time","description":"The date on which the trading profile was created for asset type"},"modifiedOn":{"type":"string","format":"date-time","description":"The date on which the trading profile was modified the last time for asset type"},"appropriatenessTestPassed":{"type":"boolean"},"riskAcknowledged":{"type":"boolean"}}},"CreateUpdateTraditionalAssetTypeEnum":{"title":"CreateUpdateTraditionalAssetTypeEnum","type":"string","description":"The type of the traditional asset for create and update operations","enum":["BOND","ETF","EQUITY","FUND","COMMODITY","DERIVATIVE","ETN","SECURITY_TOKEN"]},"TradingExperience":{"title":"TradingExperience","type":"object","description":"Trading experience details","properties":{"yearsOfExperience":{"type":"integer","description":"Number of years of trading experience","minimum":0},"numberOfTrades":{"type":"integer","description":"Number of trades executed","minimum":0},"tradeVolume":{"type":"number","description":"Total volume of trades","minimum":0}},"required":["yearsOfExperience","numberOfTrades","tradeVolume"]}}}}
```

## The AssetTypeTradingProfileData object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"AssetTypeTradingProfileData":{"title":"AssetTypeTradingProfileData","type":"object","description":"Trading profile data per asset type","properties":{"hasKnowledge":{"type":"boolean","description":"Indicates if the person has trading knowledge"},"hasExperience":{"type":"boolean","description":"Indicates if the person has trading experience"},"tradingExperience":{"$ref":"#/components/schemas/TradingExperience"}},"required":["hasKnowledge","hasExperience"]},"TradingExperience":{"title":"TradingExperience","type":"object","description":"Trading experience details","properties":{"yearsOfExperience":{"type":"integer","description":"Number of years of trading experience","minimum":0},"numberOfTrades":{"type":"integer","description":"Number of trades executed","minimum":0},"tradeVolume":{"type":"number","description":"Total volume of trades","minimum":0}},"required":["yearsOfExperience","numberOfTrades","tradeVolume"]}}}}
```

## The AssetTypeTradingProfileUpdate object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"AssetTypeTradingProfileUpdate":{"title":"AssetTypeTradingProfileUpdate","type":"object","description":"Trading profile data per asset type","properties":{"hasKnowledge":{"type":"boolean","description":"Indicates if the person has trading knowledge"},"hasExperience":{"type":"boolean","description":"Indicates if the person has trading experience"},"tradingExperience":{"$ref":"#/components/schemas/TradingExperience"}},"required":["hasKnowledge","hasExperience"]},"TradingExperience":{"title":"TradingExperience","type":"object","description":"Trading experience details","properties":{"yearsOfExperience":{"type":"integer","description":"Number of years of trading experience","minimum":0},"numberOfTrades":{"type":"integer","description":"Number of trades executed","minimum":0},"tradeVolume":{"type":"number","description":"Total volume of trades","minimum":0}},"required":["yearsOfExperience","numberOfTrades","tradeVolume"]}}}}
```

## The TradingExperience object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"TradingExperience":{"title":"TradingExperience","type":"object","description":"Trading experience details","properties":{"yearsOfExperience":{"type":"integer","description":"Number of years of trading experience","minimum":0},"numberOfTrades":{"type":"integer","description":"Number of trades executed","minimum":0},"tradeVolume":{"type":"number","description":"Total volume of trades","minimum":0}},"required":["yearsOfExperience","numberOfTrades","tradeVolume"]}}}}
```

## The InvestmentObjectives object

```json
{"openapi":"3.0.1","info":{"title":"Entities","version":"1.0"},"components":{"schemas":{"InvestmentObjectives":{"title":"InvestmentObjectives","type":"object","description":"Investment objectives categorized by purpose","properties":{"growthAndSavings":{"type":"array","description":"Growth and savings investment purposes","items":{"$ref":"#/components/schemas/GrowthAndSavingsPurposeEnum"}},"capitalProtectionAndHedging":{"type":"array","description":"Capital protection and hedging investment purposes","items":{"$ref":"#/components/schemas/CapitalProtectionAndHedgingPurposeEnum"}},"incomeAndLiquidity":{"type":"array","description":"Income and liquidity investment purposes","items":{"$ref":"#/components/schemas/IncomeAndLiquidityPurposeEnum"}},"retirementAndFuturePlanning":{"type":"array","description":"Retirement and future planning investment purposes","items":{"$ref":"#/components/schemas/RetirementAndFuturePlanningPurposeEnum"}},"specificInvestmentTypes":{"type":"array","description":"Specific investment types purposes","items":{"$ref":"#/components/schemas/SpecificInvestmentTypesPurposeEnum"}},"taxAndEstatePlanning":{"type":"array","description":"Tax and estate planning investment purposes","items":{"$ref":"#/components/schemas/TaxAndEstatePlanningPurposeEnum"}}}},"GrowthAndSavingsPurposeEnum":{"title":"GrowthAndSavingsPurposeEnum","type":"string","enum":["CAPITAL_GROWTH","LONG_TERM_SAVING","PERSONAL_INVESTMENTS"]},"CapitalProtectionAndHedgingPurposeEnum":{"title":"CapitalProtectionAndHedgingPurposeEnum","type":"string","enum":["WEALTH_PRESERVATION","HEDGING","RISK_MANAGEMENT"]},"IncomeAndLiquidityPurposeEnum":{"title":"IncomeAndLiquidityPurposeEnum","type":"string","enum":["INCOME_GENERATION","CASH_MANAGEMENT","SHORT_TERM_LIQUIDITY"]},"RetirementAndFuturePlanningPurposeEnum":{"title":"RetirementAndFuturePlanningPurposeEnum","type":"string","enum":["PENSION_PLANNING","EDUCATION_FUNDING","FAMILY_SECURITY"]},"SpecificInvestmentTypesPurposeEnum":{"title":"SpecificInvestmentTypesPurposeEnum","type":"string","enum":["INVESTMENT_IN_LISTED_EQUITIES","SMALL_SCALE_INVESTMENTS","REAL_ESTATE_INVESTMENTS","ALTERNATIVE_INVESTMENTS","SPECULATIVE_INVESTMENTS","SHORT_TERM_TRADING"]},"TaxAndEstatePlanningPurposeEnum":{"title":"TaxAndEstatePlanningPurposeEnum","type":"string","enum":["TAX_PLANNING","ESTATE_PLANNING"]}}}}
```
