> For the complete documentation index, see [llms.txt](https://docs.tradevest.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tradevest.ai/api-reference/user-management/schemas.md).

# Schemas

## The UserData object

```json
{"openapi":"3.0.1","info":{"title":"Users","version":"1.0"},"components":{"schemas":{"UserData":{"title":"UserData","type":"object","properties":{"gender":{"$ref":"#/components/schemas/GenderEnum"},"firstName":{"type":"string","maxLength":255,"pattern":"^\\S+( \\S+)*$","description":"All first names of the person according to the identification document"},"lastName":{"type":"string","maxLength":255},"birthDay":{"type":"string","format":"date"},"birthPlace":{"type":"string","maxLength":255},"birthCountry":{"$ref":"#/components/schemas/CountryEnum"},"nationalities":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/CountryEnum"}},"mainAddress":{"$ref":"#/components/schemas/Address"},"contact":{"$ref":"#/components/schemas/Contact"},"type":{"$ref":"#/components/schemas/UserTypeEnum"}},"required":["gender","firstName","lastName","birthDay","birthPlace","birthCountry","nationalities","mainAddress","contact","type"]},"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","maxLength":255},"streetNumber":{"type":"string","maxLength":20},"city":{"type":"string","maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":12},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string"}},"required":["street","streetNumber","city","zip","country"]},"Contact":{"title":"Contact","type":"object","description":"⚠️ **Important Note on Partial Updates:** Although update endpoints use the `PATCH` method, the `contact` object requires a **full representation** of the data. If optional fields (such as `fax` or `website`) are omitted from the request, they will be overwritten with `null` in the database. To preserve existing data, ensure all current contact values are included in your request payload.","properties":{"phone":{"type":"string","description":"Mobile telephone number","pattern":"^\\+[1-9][0-9]{0,24}$"},"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"]},"UserTypeEnum":{"title":"UserTypeEnum","type":"string","enum":["ADMIN"]}}}}
```

## The UserUpdate object

```json
{"openapi":"3.0.1","info":{"title":"Users","version":"1.0"},"components":{"schemas":{"UserUpdate":{"title":"UserUpdate","type":"object","properties":{"lastName":{"type":"string","maxLength":255},"nationalities":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/CountryEnum"}},"mainAddress":{"$ref":"#/components/schemas/Address"},"contact":{"$ref":"#/components/schemas/ContactUpdate"},"status":{"$ref":"#/components/schemas/UserStatusUpdateEnum"},"mfaType":{"$ref":"#/components/schemas/UserMFATypeUpdateEnum"}}},"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","maxLength":255},"streetNumber":{"type":"string","maxLength":20},"city":{"type":"string","maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":12},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string"}},"required":["street","streetNumber","city","zip","country"]},"ContactUpdate":{"title":"ContactUpdate","type":"object","description":"⚠️ **Important Note on Partial Updates:** Although this endpoint uses the `PATCH` method, the `contact` object requires a **full representation** of the data. If optional fields (such as `fax` or `website`) are omitted from the request, they will be overwritten with `null` in the database. To preserve existing data, ensure all current contact values are included in your request payload.","properties":{"phone":{"type":"string","description":"Mobile telephone number","pattern":"^\\+[1-9][0-9]{0,24}$"},"fax":{"type":"string","description":"Fax number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"website":{"type":"string","description":"website address","maxLength":320}},"required":["phone"]},"UserStatusUpdateEnum":{"title":"UserStatusUpdateEnum","description":"Update to INACTIVE or SUSPENDED is possible only from ACTIVE status. It will disable user access to API. Update to ACTIVE is possible only from SUSPENDED. It will enable user access to API.","type":"string","enum":["INACTIVE","SUSPENDED","ACTIVE"]},"UserMFATypeUpdateEnum":{"title":"UserMFATypeUpdateEnum","description":"Sending request with `SMS` will switch MFA to SMS until the next time user login. After that method will be switched to TOTP again.","type":"string","enum":["SMS"]}}}}
```

## The CreateUserResult object

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

## The User object

```json
{"openapi":"3.0.1","info":{"title":"Users","version":"1.0"},"components":{"schemas":{"User":{"type":"object","properties":{"userId":{"type":"string","format":"uuid","description":"Unique identification number in UUID format","readOnly":true},"globalId":{"type":"string","minLength":12,"maxLength":12,"description":"Global ID of the user"},"status":{"$ref":"#/components/schemas/UserStatusEnum"},"createdOn":{"type":"string","format":"date-time","description":"The date of creation","readOnly":true},"modifiedOn":{"type":"string","format":"date-time","description":"The date of last modification","readOnly":true},"gender":{"$ref":"#/components/schemas/GenderEnum"},"firstName":{"type":"string","maxLength":255,"pattern":"^\\S+( \\S+)*$","description":"All first names of the person according to the identification document"},"lastName":{"type":"string","maxLength":255},"birthDay":{"type":"string","format":"date"},"birthPlace":{"type":"string","maxLength":255},"birthCountry":{"$ref":"#/components/schemas/CountryEnum"},"nationalities":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/CountryEnum"}},"mainAddress":{"$ref":"#/components/schemas/Address"},"contact":{"$ref":"#/components/schemas/Contact"},"type":{"$ref":"#/components/schemas/UserTypeEnum"}},"required":["birthCountry","birthDay","birthPlace","contact","createdOn","firstName","gender","globalId","lastName","mainAddress","modifiedOn","nationalities","status","type","userId"],"title":"User"},"UserStatusEnum":{"title":"UserStatusEnum","type":"string","enum":["RECEIVED","INVALID","CREATED","ACTIVE","REJECTED","SUSPENDED","INACTIVE"],"description":"Current customer status","readOnly":true},"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","maxLength":255},"streetNumber":{"type":"string","maxLength":20},"city":{"type":"string","maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":12},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string"}},"required":["street","streetNumber","city","zip","country"]},"Contact":{"title":"Contact","type":"object","description":"⚠️ **Important Note on Partial Updates:** Although update endpoints use the `PATCH` method, the `contact` object requires a **full representation** of the data. If optional fields (such as `fax` or `website`) are omitted from the request, they will be overwritten with `null` in the database. To preserve existing data, ensure all current contact values are included in your request payload.","properties":{"phone":{"type":"string","description":"Mobile telephone number","pattern":"^\\+[1-9][0-9]{0,24}$"},"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"]},"UserTypeEnum":{"title":"UserTypeEnum","type":"string","enum":["ADMIN"]}}}}
```

## The Users object

```json
{"openapi":"3.0.1","info":{"title":"Users","version":"1.0"},"components":{"schemas":{"Users":{"title":"Users","type":"object","properties":{"data":{"type":"array","description":"Array of users","items":{"$ref":"#/components/schemas/User"}},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data","pagination"]},"User":{"type":"object","properties":{"userId":{"type":"string","format":"uuid","description":"Unique identification number in UUID format","readOnly":true},"globalId":{"type":"string","minLength":12,"maxLength":12,"description":"Global ID of the user"},"status":{"$ref":"#/components/schemas/UserStatusEnum"},"createdOn":{"type":"string","format":"date-time","description":"The date of creation","readOnly":true},"modifiedOn":{"type":"string","format":"date-time","description":"The date of last modification","readOnly":true},"gender":{"$ref":"#/components/schemas/GenderEnum"},"firstName":{"type":"string","maxLength":255,"pattern":"^\\S+( \\S+)*$","description":"All first names of the person according to the identification document"},"lastName":{"type":"string","maxLength":255},"birthDay":{"type":"string","format":"date"},"birthPlace":{"type":"string","maxLength":255},"birthCountry":{"$ref":"#/components/schemas/CountryEnum"},"nationalities":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/CountryEnum"}},"mainAddress":{"$ref":"#/components/schemas/Address"},"contact":{"$ref":"#/components/schemas/Contact"},"type":{"$ref":"#/components/schemas/UserTypeEnum"}},"required":["birthCountry","birthDay","birthPlace","contact","createdOn","firstName","gender","globalId","lastName","mainAddress","modifiedOn","nationalities","status","type","userId"],"title":"User"},"UserStatusEnum":{"title":"UserStatusEnum","type":"string","enum":["RECEIVED","INVALID","CREATED","ACTIVE","REJECTED","SUSPENDED","INACTIVE"],"description":"Current customer status","readOnly":true},"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","maxLength":255},"streetNumber":{"type":"string","maxLength":20},"city":{"type":"string","maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":12},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string"}},"required":["street","streetNumber","city","zip","country"]},"Contact":{"title":"Contact","type":"object","description":"⚠️ **Important Note on Partial Updates:** Although update endpoints use the `PATCH` method, the `contact` object requires a **full representation** of the data. If optional fields (such as `fax` or `website`) are omitted from the request, they will be overwritten with `null` in the database. To preserve existing data, ensure all current contact values are included in your request payload.","properties":{"phone":{"type":"string","description":"Mobile telephone number","pattern":"^\\+[1-9][0-9]{0,24}$"},"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"]},"UserTypeEnum":{"title":"UserTypeEnum","type":"string","enum":["ADMIN"]},"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 GenderEnum object

```json
{"openapi":"3.0.1","info":{"title":"Users","version":"1.0"},"components":{"schemas":{"GenderEnum":{"title":"GenderEnum","type":"string","description":"Gender","enum":["MALE","FEMALE","DIVERSE"]}}}}
```

## The Contact object

```json
{"openapi":"3.0.1","info":{"title":"Users","version":"1.0"},"components":{"schemas":{"Contact":{"title":"Contact","type":"object","description":"⚠️ **Important Note on Partial Updates:** Although update endpoints use the `PATCH` method, the `contact` object requires a **full representation** of the data. If optional fields (such as `fax` or `website`) are omitted from the request, they will be overwritten with `null` in the database. To preserve existing data, ensure all current contact values are included in your request payload.","properties":{"phone":{"type":"string","description":"Mobile telephone number","pattern":"^\\+[1-9][0-9]{0,24}$"},"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 ContactUpdate object

```json
{"openapi":"3.0.1","info":{"title":"Users","version":"1.0"},"components":{"schemas":{"ContactUpdate":{"title":"ContactUpdate","type":"object","description":"⚠️ **Important Note on Partial Updates:** Although this endpoint uses the `PATCH` method, the `contact` object requires a **full representation** of the data. If optional fields (such as `fax` or `website`) are omitted from the request, they will be overwritten with `null` in the database. To preserve existing data, ensure all current contact values are included in your request payload.","properties":{"phone":{"type":"string","description":"Mobile telephone number","pattern":"^\\+[1-9][0-9]{0,24}$"},"fax":{"type":"string","description":"Fax number","minLength":3,"maxLength":20,"pattern":"^[\\+\\-\\(\\)\\d ]{3,20}$"},"website":{"type":"string","description":"website address","maxLength":320}},"required":["phone"]}}}}
```

## The Address object

```json
{"openapi":"3.0.1","info":{"title":"Users","version":"1.0"},"components":{"schemas":{"Address":{"title":"Address","type":"object","description":"Address","properties":{"street":{"type":"string","maxLength":255},"streetNumber":{"type":"string","maxLength":20},"city":{"type":"string","maxLength":255},"zip":{"type":"string","minLength":3,"maxLength":12},"state":{"type":"string","minLength":1,"maxLength":35},"country":{"$ref":"#/components/schemas/CountryEnum"},"additionalInfo":{"type":"string"}},"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 UserTypeEnum object

```json
{"openapi":"3.0.1","info":{"title":"Users","version":"1.0"},"components":{"schemas":{"UserTypeEnum":{"title":"UserTypeEnum","type":"string","enum":["ADMIN"]}}}}
```

## The UserMFATypeUpdateEnum object

```json
{"openapi":"3.0.1","info":{"title":"Users","version":"1.0"},"components":{"schemas":{"UserMFATypeUpdateEnum":{"title":"UserMFATypeUpdateEnum","description":"Sending request with `SMS` will switch MFA to SMS until the next time user login. After that method will be switched to TOTP again.","type":"string","enum":["SMS"]}}}}
```

## The UserStatusEnum object

```json
{"openapi":"3.0.1","info":{"title":"Users","version":"1.0"},"components":{"schemas":{"UserStatusEnum":{"title":"UserStatusEnum","type":"string","enum":["RECEIVED","INVALID","CREATED","ACTIVE","REJECTED","SUSPENDED","INACTIVE"],"description":"Current customer status","readOnly":true}}}}
```

## The UserStatusUpdateEnum object

```json
{"openapi":"3.0.1","info":{"title":"Users","version":"1.0"},"components":{"schemas":{"UserStatusUpdateEnum":{"title":"UserStatusUpdateEnum","description":"Update to INACTIVE or SUSPENDED is possible only from ACTIVE status. It will disable user access to API. Update to ACTIVE is possible only from SUSPENDED. It will enable user access to API.","type":"string","enum":["INACTIVE","SUSPENDED","ACTIVE"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

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

```
GET https://docs.tradevest.ai/api-reference/user-management/schemas.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

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