# List Enums Get master data by data type and optional parent code. Master Data definition, hierarchy, and code description: | data_type | description | |-----------|-------------| | ID_DOC_TYPE | Identification document type | | MARITAL_STATUS | Marital status options | | EMPLOYMENT_TYPE | Type of employment | | OCCUPATION | Specific occupation under the employment type | | POSITION | Job position or title | | LIQUIDITY_NEEDS | Liquidity needs options | | ANNUAL_INCOME | Annual income range | | TOTAL_NET_WORTH | Estimated total net worth range | | LIQUID_NET_WORTH | Liquid net worth range | | INVESTMENT_KNOWLEDGE | Investment knowledge level (old) | | INVESTMENT_OBJECTIVE | Investment goal or objective | | TIME_HORIZON | Investment time horizon | | INVESTMENT_EXPERIENCE | Experience level in investments | | INVESTMENT_KNOWLEDGE_V2 | Investment knowledge level | | TRADE_PER_YEAR | Estimated number of trades per year | | TAX_TYPE | Tax classification type | | AGREEMENT_TYPE | Agreement type | | AGREEMENT_CONTENT_TYPE | Agreement content type | | AGREEMENT_SIGN_METHOD | Agreement signing method | # OpenAPI definition ```json { "info": { "title": "Webull Open API Reference", "description": "application.yml\\ncom\\ni18n\\nMETA-INF\\nstatic\\n\\r\\n", "contact": { "name": "", "url": "", "email": "" }, "version": "2.0", "x-logo": { "url": "static/png/logo.png" } }, "servers": [ { "url": "https://broker-api.sandbox.webull.com" } ], "path": "/broker/master-data/enums/list", "method": "get", "tags": [ "Master Data" ], "description": "Get master data by data type and optional parent code.\nMaster Data definition, hierarchy, and code description:\n\n| data_type | description |\n|-----------|-------------|\n| ID_DOC_TYPE | Identification document type |\n| MARITAL_STATUS | Marital status options |\n| EMPLOYMENT_TYPE | Type of employment |\n| OCCUPATION | Specific occupation under the employment type |\n| POSITION | Job position or title |\n| LIQUIDITY_NEEDS | Liquidity needs options |\n| ANNUAL_INCOME | Annual income range |\n| TOTAL_NET_WORTH | Estimated total net worth range |\n| LIQUID_NET_WORTH | Liquid net worth range |\n| INVESTMENT_KNOWLEDGE | Investment knowledge level (old) |\n| INVESTMENT_OBJECTIVE | Investment goal or objective |\n| TIME_HORIZON | Investment time horizon |\n| INVESTMENT_EXPERIENCE | Experience level in investments |\n| INVESTMENT_KNOWLEDGE_V2 | Investment knowledge level |\n| TRADE_PER_YEAR | Estimated number of trades per year |\n| TAX_TYPE | Tax classification type |\n| AGREEMENT_TYPE | Agreement type |\n| AGREEMENT_CONTENT_TYPE | Agreement content type |\n| AGREEMENT_SIGN_METHOD | Agreement signing method |", "operationId": "listEnums", "parameters": [ { "name": "data_type", "in": "query", "description": "Type of master data", "required": true, "schema": { "type": "string", "description": "Enumeration of master data types used for account opening, profile management, and questionnaire configuration.", "enum": [ "ID_DOC_TYPE", "MARITAL_STATUS", "EMPLOYMENT_TYPE", "OCCUPATION", "POSITION", "LIQUIDITY_NEEDS", "ANNUAL_INCOME", "TOTAL_NET_WORTH", "LIQUID_NET_WORTH", "INVESTMENT_KNOWLEDGE_OLD", "INVESTMENT_OBJECTIVE", "TIME_HORIZON", "INVESTMENT_EXPERIENCE", "INVESTMENT_KNOWLEDGE", "TRADE_PER_YEAR", "TAX_TYPE", "AGREEMENT_CONTENT_TYPE", "AGREEMENT_SIGN_METHOD", "COUNTRY", "STATE", "CITY", "CONTACT_RELATIONSHIP" ] }, "example": "AGREEMENT_TYPE" }, { "name": "parent_code", "in": "query", "description": "Parent code of the master data, used for hierarchical queries", "required": false, "schema": { "type": "string" }, "example": 121 }, { "name": "x-app-key", "in": "header", "description": "A unique identifier issued to a developer for accessing an application's API.", "required": true, "schema": { "type": "string" } }, { "name": "x-app-secret", "in": "header", "description": "A unique key issued to developers to access the application's API.", "required": true, "schema": { "type": "string" } }, { "name": "x-timestamp", "in": "header", "description": "Timestamp of the request, follows ISO8601 format: YYYY-MM-DDThh:mm:ssZ, e.g. 2023-07-16T19:23:51Z, only supports UTC time zone.", "required": true, "schema": { "type": "string" } }, { "name": "x-signature-version", "in": "header", "description": "Signature algorithm version, default is 1.0.", "required": true, "schema": { "type": "string", "default": "1.0" }, "examples": { "1.0": { "value": "1.0" } } }, { "name": "x-signature-algorithm", "in": "header", "description": "Signature algorithm, default is HMAC-SHA1.", "required": true, "schema": { "type": "string", "default": "HMAC-SHA1" }, "examples": { "HMAC-SHA1": { "value": "HMAC-SHA1" } } }, { "name": "x-signature-nonce", "in": "header", "description": "Signature unique random number.", "required": true, "schema": { "type": "string" } }, { "name": "x-version", "in": "header", "description": "API interface version. Supported values: `v2`, `v3`.", "required": true, "schema": { "type": "string", "default": "v3" }, "examples": { "v3": { "value": "v3" } } }, { "name": "x-signature", "in": "header", "description": "A signature is a unique digital fingerprint, typically encrypted, that verifies the authenticity and integrity of a message or transaction, ensuring it has not been tampered with during transmission.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Business code of the master data item, typically used as a stable reference value.", "example": "LIMITED" }, "name": { "type": "string", "description": "Display name of the master data item in the default language.", "example": "Limited" }, "parent_code": { "type": "string", "description": "Parent code of the master data item, used to represent hierarchical relationships.", "example": "121" } }, "description": "Response object representing a master data item, commonly used for dictionaries, reference data, or configurable options.", "title": "MasterDataResp" } } } } }, "401": { "description": "Unauthorized: Authentication required", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_code": { "type": "string", "description": "Internal logic error code", "example": "UNAUTHORIZED" }, "message": { "type": "string", "description": "Error message", "example": "Insufficient permission" } } } } } }, "417": { "description": "A business logic error triggered when the request cannot be processed due to domain-specific constraints.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_code": { "type": "string", "description": "Internal logic error code", "example": "INVALID_PARAMETER" }, "message": { "type": "string", "description": "Error message", "example": "Parameter error, phone" } } } } } }, "500": { "description": "Internal Server Error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_code": { "type": "string", "description": "Internal logic error code", "example": "SYSTEM_ERROR" }, "message": { "type": "string", "description": "Error message", "example": "Internal Server Error" } } } } } } }, "postman": { "name": "List Enums", "description": { "content": "Get master data by data type and optional parent code.\nMaster Data definition, hierarchy, and code description:\n\n| data_type | description |\n|-----------|-------------|\n| ID_DOC_TYPE | Identification document type |\n| MARITAL_STATUS | Marital status options |\n| EMPLOYMENT_TYPE | Type of employment |\n| OCCUPATION | Specific occupation under the employment type |\n| POSITION | Job position or title |\n| LIQUIDITY_NEEDS | Liquidity needs options |\n| ANNUAL_INCOME | Annual income range |\n| TOTAL_NET_WORTH | Estimated total net worth range |\n| LIQUID_NET_WORTH | Liquid net worth range |\n| INVESTMENT_KNOWLEDGE | Investment knowledge level (old) |\n| INVESTMENT_OBJECTIVE | Investment goal or objective |\n| TIME_HORIZON | Investment time horizon |\n| INVESTMENT_EXPERIENCE | Experience level in investments |\n| INVESTMENT_KNOWLEDGE_V2 | Investment knowledge level |\n| TRADE_PER_YEAR | Estimated number of trades per year |\n| TAX_TYPE | Tax classification type |\n| AGREEMENT_TYPE | Agreement type |\n| AGREEMENT_CONTENT_TYPE | Agreement content type |\n| AGREEMENT_SIGN_METHOD | Agreement signing method |", "type": "text/plain" }, "url": { "path": [ "broker", "master-data", "enums", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Type of master data", "type": "text/plain" }, "key": "data_type", "value": "" }, { "disabled": false, "description": { "content": "Parent code of the master data, used for hierarchical queries", "type": "text/plain" }, "key": "parent_code", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) A unique identifier issued to a developer for accessing an application's API.", "type": "text/plain" }, "key": "x-app-key", "value": "" }, { "disabled": false, "description": { "content": "(Required) A unique key issued to developers to access the application's API.", "type": "text/plain" }, "key": "x-app-secret", "value": "" }, { "disabled": false, "description": { "content": "(Required) Timestamp of the request, follows ISO8601 format: YYYY-MM-DDThh:mm:ssZ, e.g. 2023-07-16T19:23:51Z, only supports UTC time zone.", "type": "text/plain" }, "key": "x-timestamp", "value": "" }, { "disabled": false, "description": { "content": "(Required) Signature algorithm version, default is 1.0.", "type": "text/plain" }, "key": "x-signature-version", "value": "" }, { "disabled": false, "description": { "content": "(Required) Signature algorithm, default is HMAC-SHA1.", "type": "text/plain" }, "key": "x-signature-algorithm", "value": "" }, { "disabled": false, "description": { "content": "(Required) Signature unique random number.", "type": "text/plain" }, "key": "x-signature-nonce", "value": "" }, { "disabled": false, "description": { "content": "(Required) API interface version. Supported values: `v2`, `v3`.", "type": "text/plain" }, "key": "x-version", "value": "" }, { "disabled": false, "description": { "content": "(Required) A signature is a unique digital fingerprint, typically encrypted, that verifies the authenticity and integrity of a message or transaction, ensuring it has not been tampered with during transmission.", "type": "text/plain" }, "key": "x-signature", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" } } ```