# Get Form Detail Retrieves the JSON schema for the specified form code and version. # 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/forms/get", "method": "get", "tags": [ "Forms" ], "description": "Retrieves the JSON schema for the specified form code and version.", "operationId": "getFormContent", "parameters": [ { "name": "form_code", "in": "query", "description": "Unique identifier of the form, typically used to distinguish different form definitions.", "required": true, "schema": { "type": "String" }, "example": "NEW_ACCOUNT_BASIC_FORM" }, { "name": "version", "in": "query", "description": "Version number of the form definition", "required": true, "schema": { "type": "String" }, "example": "1.0" }, { "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": "Request successful", "content": { "application/json": { "schema": { "required": [ "form_code", "version" ], "type": "object", "properties": { "required": { "type": "array", "description": "List of required property names for the current schema object.", "example": [ "first_name", "last_name" ], "items": { "type": "string", "description": "List of required property names for the current schema object.", "example": "[\"first_name\",\"last_name\"]" } }, "type": { "type": "string", "description": "Enumeration of supported JSON Schema property types used for form definition and validation.", "example": "object", "enum": [ "string", "number", "boolean", "object", "array" ] }, "enum_values": { "type": "string", "description": "Enumerated values allowed for this property. Applies when the schema defines a fixed set of permitted values.", "example": "NEW_ACCOUNT_FORM" }, "format": { "type": "string", "description": "Format keyword that further constrains the property type (e.g., date, date-time).", "example": "yyyy-MM-dd" }, "description": { "type": "string", "description": "Description of the property, explaining its purpose or usage within the schema.", "example": "User age" }, "example": { "type": "string", "description": "Representative example value to illustrate the expected input format.", "example": "2001-12-02" }, "min_items": { "type": "integer", "description": "Minimum number of items allowed in the array. Applicable only when the property type is array.", "format": "int32", "example": 1 }, "max_items": { "type": "integer", "description": "Maximum number of items allowed in the array. Applicable only when the property type is array.", "format": "int32", "example": 5 }, "max_length": { "type": "integer", "description": "Maximum length allowed for string-type properties.", "format": "int32", "example": 64 }, "form_code": { "type": "string", "description": "Unique identifier of the form, typically used to distinguish different form definitions.", "example": "NEW_ACCOUNT_BASIC_FORM" }, "version": { "type": "string", "description": "Version number of the form definition, used for compatibility and evolutionary control.", "example": "1.0" } }, "description": "Form Content Response", "title": "FormContentResult" }, "examples": { "NEW_ACCOUNT_BASIC_FORM": { "description": "NEW_ACCOUNT_BASIC_FORM", "value": { "type": "object", "description": "The New Account Basic Form collects the core information required for account opening. This form cannot be submitted independently and must be used in combination with one or more applicable additional forms, depending on the account features or products being applied for.", "form_code": "NEW_ACCOUNT_BASIC_FORM", "properties": { "customer_info": { "type": "object", "description": "Identity information", "properties": { "ip_address": { "type": "string", "description": "The IP address when the user submits the application." }, "first_name": { "type": "string", "description": "First name of the applicant as it appears on the identification document.", "max_length": 32 }, "middle_name": { "type": "string", "description": "Middle name of the applicant as it appears on the identification document, if applicable.", "max_length": 32 }, "last_name": { "type": "string", "description": "Last name of the applicant as it appears on the identification document.", "max_length": 32 }, "date_of_birth": { "type": "string", "description": "Date of birth of the applicant as shown on the identification document.", "format": "yyyy-MM-dd" }, "gender": { "type": "string", "description": "Gender of the account holder. Allowed values: F (Female), M (Male)." }, "country_of_citizenship": { "type": "string", "description": "Country of citizenship of the account holder. The value must be a valid ISO 3166-1 alpha-3 country code in uppercase format (3-letter code)." }, "id_doc_type": { "type": "string", "description": "Type of identification document provided by the applicant. The value must be retrieved from the Master Data API where data_type = ID_DOC_TYPE." }, "id_number": { "type": "string", "description": "Identification document number exactly as shown on the provided ID." }, "id_expiry_date": { "type": "string", "description": "Expiration date of the identification document.", "format": "yyyy-MM-dd" }, "permanent_resident": { "type": "string", "description": "Permanent resident. Allowed values: YES, NO." }, "marital_status": { "type": "string", "description": "Marital status of the account holder. Value must be obtained from the Master Data API with data_type = MARITAL_STATUS." }, "num_dependents": { "type": "number", "description": "Number of dependents financially or legally associated with the account holder.", "example": "1" }, "ext_attr_list": { "type": "array", "description": "Ext attr list", "items": { "type": "object", "description": "Item", "properties": { "name": { "type": "string", "description": "The name of the extension." }, "value": { "type": "string", "description": "Value" } } } } }, "required": [ "ip_address", "first_name", "last_name", "date_of_birth", "gender", "country_of_citizenship", "id_doc_type", "id_number", "id_expiry_date", "permanent_resident", "marital_status", "num_dependents" ] }, "contact_info": { "type": "object", "description": "Contact info", "properties": { "phone_country": { "type": "string", "description": "Phone country. The value must be a valid ISO 3166-1 alpha-3 country code in uppercase format (3-letter code)." }, "phone_number": { "type": "string", "description": "Primary contact phone number associated with the account, in international format (E.164). Used for account notifications, verification, and security-related communications.", "example": "+1-2025550123", "max_length": 20 }, "email_address": { "type": "string", "description": "Email address", "max_length": 256 }, "id_address": { "type": "object", "description": "Residential address of the account holder as recorded for identity verification and regulatory purposes.", "properties": { "country": { "type": "string", "description": "Country of residence. The value must be a valid ISO 3166-1 alpha-3 country code in uppercase format (3-letter code)." }, "state": { "type": "string", "description": "State or province of residence. The value must follow the ISO 3166-2 subdivision standard and include the country code prefix. Format: -", "example": "USA-CA" }, "city": { "type": "string", "description": "City of residence.", "max_length": 256 }, "street_address": { "type": "string", "description": "Street address of the residence of the account holder.", "max_length": 512 }, "postal_code": { "type": "string", "description": "Postal or ZIP code of the residential address.", "max_length": 80 }, "neighborhood_code": { "type": "string", "description": "Neighborhood or district code of the residential address.", "max_length": 128 }, "apartment_number": { "type": "string", "description": "Apartment number of the residential address.", "max_length": 128 }, "building_number": { "type": "string", "description": "Building number of the residential address.", "max_length": 128 } }, "required": [ "country", "state", "city", "street_address", "postal_code" ] }, "mail_address": { "type": "object", "description": "Mailing address used for receiving account-related correspondence, if different from the residential address.", "properties": { "country": { "type": "string", "description": "Mailing address country. The value must be a valid ISO 3166-1 alpha-3 country code in uppercase format (3-letter code)." }, "state": { "type": "string", "description": "State or province of the mailing address. The value must follow the ISO 3166-2 subdivision standard and include the country code prefix. Format: -" }, "city": { "type": "string", "description": "City of the mailing address.", "max_length": 256 }, "street_address": { "type": "string", "description": "Street address of the mailing address.", "max_length": 512 }, "postal_code": { "type": "string", "description": "Postal or ZIP code of the mailing address.", "max_length": 80 }, "neighborhood_code": { "type": "string", "description": "Neighborhood or district code of the mailing address.", "max_length": 128 }, "apartment_number": { "type": "string", "description": "Apartment number of the mailing address.", "max_length": 128 }, "building_number": { "type": "string", "description": "Building number of the mailing address.", "max_length": 128 } }, "required": [ "country", "state", "city", "street_address", "postal_code" ] } }, "required": [ "phone_country", "phone_number", "email_address", "id_address", "mail_address" ] }, "trusted_contact_info": { "type": "object", "description": "Trusted contact info", "properties": { "first_name": { "type": "string", "description": "First name of the trusted contact person." }, "middle_name": { "type": "string", "description": "Middle name of the trusted contact person, if applicable." }, "last_name": { "type": "string", "description": "Last name of the trusted contact person." }, "phone_country": { "type": "string", "description": "Phone country. The value must be a valid ISO 3166-1 alpha-3 country code in uppercase format (3-letter code)." }, "phone_number": { "type": "string", "description": "Primary contact phone number of the trusted contact person.", "example": "+1-2025550124", "max_length": 20 }, "relationship": { "type": "string", "description": "Relationship between the account holder and the trusted contact person. ", "max_length": 32 }, "trusted_address": { "type": "object", "description": "Residential or mailing address of the trusted contact person.", "properties": { "country": { "type": "string", "description": "Country of the trusted contact address. The value must be a valid ISO 3166-1 alpha-3 country code in uppercase format (3-letter code)." }, "state": { "type": "string", "description": "State or province of the address of the trusted contact person. The value must follow the ISO 3166-2 subdivision standard and include the country code prefix. Format: ISO 3166-1 alpha-3 country code followed by a hyphen and the subdivision code (for example: USA-CA)." }, "city": { "type": "string", "description": "City of the trusted contact address.", "max_length": 256 }, "street_address": { "type": "string", "description": "Street address of the trusted contact person.", "max_length": 512 }, "postal_code": { "type": "string", "description": "Postal or ZIP code of the trusted contact address.", "max_length": 80 }, "neighborhood_code": { "type": "string", "description": "Neighborhood or district code of the trusted contact address.", "max_length": 128 }, "apartment_number": { "type": "string", "description": "Apartment or unit number of the trusted contact address.", "max_length": 128 }, "building_number": { "type": "string", "description": "Building number of the trusted contact address.", "max_length": 128 } }, "required": [ "country", "state", "city", "street_address", "postal_code" ] } }, "required": [ "first_name", "last_name", "phone_country", "phone_number", "relationship", "trusted_address" ] }, "employment_info": { "type": "object", "description": "Employment info", "properties": { "employment_type": { "type": "string", "description": "Type of employment. Value must be obtained from the Master Data API with data_type = EMPLOYMENT_TYPE." }, "company_name": { "type": "string", "description": "Name of the applicant current employer.", "max_length": 128 }, "occupation": { "type": "string", "description": "Specific occupation under the employment type. Value must be obtained from the Master Data API with data_type = OCCUPATION." }, "position": { "type": "string", "description": "Job position or title. Value must be obtained from the Master Data API with data_type = POSITION." }, "years_employed": { "type": "number", "description": "Total duration (in years) the applicant has been employed with the current employer. Decimal values are allowed to represent partial years (e.g. 1.5).", "example": "1.5" }, "employment_address": { "type": "object", "description": "Address of the applicant current employer.", "properties": { "country": { "type": "string", "description": "Employer address country. The value must be a valid ISO 3166-1 alpha-3 country code in uppercase format (3-letter code)." }, "state": { "type": "string", "description": "Employer address state. The value must follow the ISO 3166-2 subdivision standard and include the country code prefix. Format: -" }, "city": { "type": "string", "description": "Employer address city.", "max_length": 256 }, "street_address": { "type": "string", "description": "Street address of the employer.", "max_length": 512 }, "postal_code": { "type": "string", "description": "Postal code of the employer address.", "max_length": 80 }, "neighborhood_code": { "type": "string", "description": "Neighborhood or district code of the employer address.", "max_length": 128 }, "apartment_number": { "type": "string", "description": "Apartment number of the employer address.", "max_length": 128 }, "building_number": { "type": "string", "description": "Building number of the employer address.", "max_length": 128 } }, "required": [ "country", "state", "city", "street_address", "postal_code" ] } }, "required": [ "employment_type", "company_name", "occupation", "position", "years_employed", "employment_address" ] }, "financial_info": { "type": "object", "description": "Financial information of the account holder.", "properties": { "liquidity_needs": { "type": "string", "description": "Indicates the client liquidity needs or preference for cash accessibility. Value must be obtained from the Master Data API with data_type = LIQUIDITY_NEEDS." }, "annual_income": { "type": "string", "description": "Represents the client annual income. Value must be obtained from the Master Data API with data_type = ANNUAL_INCOME." }, "total_net_worth": { "type": "string", "description": "Represents the client total net worth in USD. Value must be obtained from the Master Data API with data_type = TOTAL_NET_WORTH." }, "liquid_net_worth": { "type": "string", "description": "Represents the client liquid net worth (USD), including cash and easily marketable assets. Value must be obtained from the Master Data API with data_type = LIQUID_NET_WORTH." } }, "required": [ "liquidity_needs", "annual_income", "total_net_worth", "liquid_net_worth" ] }, "disclosure_info": { "type": "object", "description": "Disclosure", "properties": { "is_politically_exposed": { "type": "boolean", "description": "Indicates whether the account holder or any close associate or immediate family member is a Politically Exposed Person (PEP). If true, the politically_exposed_info object must be provided with detailed disclosure information. Please note: PEP accounts are currently not supported. Any request submitted with is_politically_exposed = true will be rejected and a failure response will be returned." }, "politically_exposed_info": { "type": "object", "description": "Detail information about Politically Exposed Person (PEP) associated with the account holder.", "properties": { "pep_organization": { "type": "string", "description": "Name of the related political organization.", "max_length": 256 }, "immediate_family": { "type": "array", "description": "Name of family members, including former spouses.", "items": { "type": "string", "description": "" } } }, "required": [ "pep_organization", "immediate_family" ] }, "is_company_control_person": { "type": "boolean", "description": "Indicates whether the applicant is a control person of a public company. If true, `public_company_infos` must be provided with details of the companies controlled." }, "public_company_infos": { "type": "array", "description": "List of public companies controlled by the applicant. Each item must include the company stock symbol.", "items": { "type": "object", "description": "", "properties": { "symbol": { "type": "string", "description": "Stock symbol of the public company controlled by the applicant, as listed on the exchange." } }, "required": [ "symbol" ] } } }, "required": [ "is_politically_exposed", "is_company_control_person" ] }, "tax_info": { "type": "object", "description": "Tax info", "properties": { "tax_type": { "type": "string", "description": "Tax type. Value must be obtained from the Master Data API with data_type = TAX_TYPE." }, "tax_id": { "type": "string", "description": "Tax id. SSN format is (123-45-6789).", "example": "123-45-6789" } }, "required": [ "tax_type", "tax_id" ] }, "w8ben_info": { "type": "object", "description": "W8ben info", "properties": { "foreign_tax_id": { "type": "string", "description": "Foreign tax ID (FTIN) issued by non-U.S. authority (W-8BEN Line 6)" }, "treaty_country": { "type": "string", "description": "Tax treaty country for reduced withholding. The value must be a valid ISO 3166-1 alpha-3 country code in uppercase format (3-letter code)." }, "sign_date": { "type": "string", "description": "Certification date. Using UTC time.", "format": "yyyy-MM-dd" } }, "required": [ "sign_date" ] }, "document_attachments": { "type": "array", "description": "Document attachments", "min_items": 1, "max_items": 10, "items": { "type": "object", "description": "Item", "properties": { "doc_type": { "type": "string", "description": "Doc type" }, "document_id": { "type": "string", "description": "Document id. Retrieved from the Upload Document API response." } }, "required": [ "doc_type", "document_id" ] } } }, "required": [ "customer_info", "contact_info", "trusted_contact_info", "employment_info", "financial_info", "disclosure_info", "tax_info" ] } }, "BROKERAGE_ADDITIONAL_FORM": { "description": "BROKERAGE_ADDITIONAL_FORM", "value": { "type": "object", "description": "The Brokerage Additional Form is used to collect supplemental information required to enable and configure brokerage trading services during the account opening process. This form captures brokerage-specific settings, investment profile details, and agreement acknowledgements necessary for regulatory compliance, risk assessment, and account configuration. It cannot be submitted independently and must be submitted together with the New Account Basic Form as part of the brokerage account opening workflow.", "form_code": "BROKERAGE_ADDITIONAL_FORM", "properties": { "rep_code": { "type": "string", "description": "Specific code that Webull assigned to the Introducing broker, to distinguish between different IB customers, e.g. REP_DEMO." }, "account_type": { "type": "string", "description": "Account type", "example": "CASH" }, "commission_code": { "type": "string", "description": "Commission Code for account, determining the commission structure" }, "investment_knowledge": { "type": "string", "description": "Investment knowledge. Value must be obtained from the Master Data API with data_type = INVESTMENT_KNOWLEDGE." }, "investment_objective": { "type": "string", "description": "Investment objective. Value must be obtained from the Master Data API with data_type = INVESTMENT_OBJECTIVE." }, "time_horizon": { "type": "string", "description": "Time horizon. Value must be obtained from the Master Data API with data_type = TIME_HORIZON." }, "is_exchange_or_finra_affiliated": { "type": "boolean", "description": "Indicates whether the applicant is employed by, or directly associated with, an exchange or a FINRA member firm. If true, exchange_affiliations details must be provided." }, "exchange_affiliations": { "type": "array", "description": "List of the applicant affiliations with exchanges or FINRA member firms. Required if is_exchange_or_finra_affiliated is true.", "items": { "type": "object", "description": "", "properties": { "company_name": { "type": "string", "description": "Name of the exchange or FINRA member firm the applicant is affiliated with.", "max_length": 128 }, "country": { "type": "string", "description": "Country of the affiliated exchange or FINRA firm. The value must be a valid ISO 3166-1 alpha-3 country code in uppercase format (3-letter code)." }, "state": { "type": "string", "description": "State or province of the affiliated exchange or FINRA firm. The value must follow the ISO 3166-2 subdivision standard and include the country code prefix. Format: -" }, "city": { "type": "string", "description": "City of the affiliated exchange or FINRA firm.", "max_length": 256 }, "street_address": { "type": "string", "description": "Street address of the affiliated exchange or FINRA firm.", "max_length": 512 }, "postal_code": { "type": "string", "description": "Postal or ZIP code of the affiliated exchange or FINRA firm.", "max_length": 80 } }, "required": [ "company_name", "country", "state", "city", "street_address", "postal_code" ] } }, "agreement_infos": { "type": "object", "description": "Agreement infos", "properties": { "accepted_at": { "type": "string", "description": "Accepted at. Agreement Confirmation Date (ET). If an agreement is signed, it must be filled in.", "format": "yyyy-MM-dd" }, "webull_financial_customer_agreement": { "type": "object", "description": "Webull Financial Customer Agreement (Omnibus)", "properties": { "agreement_id": { "type": "string", "description": "Agreement id" }, "sign_method": { "type": "string", "description": "Signature method. Value must be obtained from the Master Data API with data_type = AGREEMENT_SIGN_METHOD." }, "is_accepted": { "type": "boolean", "description": "Whether the user accepted the agreement." } }, "required": [ "agreement_id", "is_accepted" ] }, "webull_financial_annual_disclosure_statement": { "type": "object", "description": "Webull Financial Annual Disclosure Statement (Omnibus)", "properties": { "agreement_id": { "type": "string", "description": "Agreement id" }, "sign_method": { "type": "string", "description": "Signature method. Value must be obtained from the Master Data API with data_type = AGREEMENT_SIGN_METHOD." }, "is_accepted": { "type": "boolean", "description": "Whether the user accepted the agreement." } }, "required": [ "agreement_id", "is_accepted" ] }, "statement_of_financial_condition": { "type": "object", "description": "Statement of Financial Condition", "properties": { "agreement_id": { "type": "string", "description": "Agreement id" }, "sign_method": { "type": "string", "description": "Signature method. Value must be obtained from the Master Data API with data_type = AGREEMENT_SIGN_METHOD." }, "is_accepted": { "type": "boolean", "description": "Whether the user accepted the agreement." } }, "required": [ "agreement_id", "is_accepted" ] }, "finra_customer_identification_notice": { "type": "object", "description": "FINRA - Customer Identification Notice (Omnibus)", "properties": { "agreement_id": { "type": "string", "description": "Agreement id" }, "sign_method": { "type": "string", "description": "Signature method. Value must be obtained from the Master Data API with data_type = AGREEMENT_SIGN_METHOD." }, "is_accepted": { "type": "boolean", "description": "Whether the user accepted the agreement." } }, "required": [ "agreement_id", "is_accepted" ] }, "investor_education_and_protection": { "type": "object", "description": "Investor Education and Protection (Omnibus)", "properties": { "agreement_id": { "type": "string", "description": "Agreement id" }, "sign_method": { "type": "string", "description": "Signature method. Value must be obtained from the Master Data API with data_type = AGREEMENT_SIGN_METHOD." }, "is_accepted": { "type": "boolean", "description": "Whether the user accepted the agreement." } }, "required": [ "agreement_id", "is_accepted" ] }, "electronic_delivery_of_trade_and_e_signature": { "type": "object", "description": "Electronic Delivery of Trade and E-Signature (Omnibus)", "properties": { "agreement_id": { "type": "string", "description": "Agreement id" }, "sign_method": { "type": "string", "description": "Signature method. Value must be obtained from the Master Data API with data_type = AGREEMENT_SIGN_METHOD." }, "is_accepted": { "type": "boolean", "description": "Whether the user accepted the agreement." } }, "required": [ "agreement_id", "is_accepted" ] }, "webull_financial_sipc_and_excess_sipc_information": { "type": "object", "description": "Webull Financial SIPC and Excess SIPC Information", "properties": { "agreement_id": { "type": "string", "description": "Agreement id" }, "sign_method": { "type": "string", "description": "Signature method. Value must be obtained from the Master Data API with data_type = AGREEMENT_SIGN_METHOD." }, "is_accepted": { "type": "boolean", "description": "Whether the user accepted the agreement." } }, "required": [ "agreement_id", "is_accepted" ] }, "webull_financial_customer_relationship_summary": { "type": "object", "description": "Webull Financial Customer Relationship Summary", "properties": { "agreement_id": { "type": "string", "description": "Agreement id" }, "sign_method": { "type": "string", "description": "Signature method. Value must be obtained from the Master Data API with data_type = AGREEMENT_SIGN_METHOD." }, "is_accepted": { "type": "boolean", "description": "Whether the user accepted the agreement." } }, "required": [ "agreement_id", "is_accepted" ] }, "stop_and_advanced_orders_disclosure": { "type": "object", "description": "Stop & Advanced Orders Disclosure (Omnibus)", "properties": { "agreement_id": { "type": "string", "description": "Agreement id" }, "sign_method": { "type": "string", "description": "Signature method. Value must be obtained from the Master Data API with data_type = AGREEMENT_SIGN_METHOD." }, "is_accepted": { "type": "boolean", "description": "Whether the user accepted the agreement." } }, "required": [ "agreement_id", "is_accepted" ] }, "order_handling_and_sec_rule_606_and_607_disclosures": { "type": "object", "description": "Order Handling and SEC Rule 606 and 607 Disclosures", "properties": { "agreement_id": { "type": "string", "description": "Agreement id" }, "sign_method": { "type": "string", "description": "Signature method. Value must be obtained from the Master Data API with data_type = AGREEMENT_SIGN_METHOD." }, "is_accepted": { "type": "boolean", "description": "Whether the user accepted the agreement." } }, "required": [ "agreement_id", "is_accepted" ] }, "webull_business_continuity_plan_statement": { "type": "object", "description": "Webull Business Continuity Plan Statement (Omnibus)", "properties": { "agreement_id": { "type": "string", "description": "Agreement id" }, "sign_method": { "type": "string", "description": "Signature method. Value must be obtained from the Master Data API with data_type = AGREEMENT_SIGN_METHOD." }, "is_accepted": { "type": "boolean", "description": "Is accepted" } }, "required": [ "agreement_id", "is_accepted" ] }, "webull_financial_llc_privacy_notice": { "type": "object", "description": "Webull Financial LLC Privacy Notice (Omnibus)", "properties": { "agreement_id": { "type": "string", "description": "Agreement id" }, "sign_method": { "type": "string", "description": "Signature method. Value must be obtained from the Master Data API with data_type = AGREEMENT_SIGN_METHOD." }, "is_accepted": { "type": "boolean", "description": "Whether the user accepted the agreement." } }, "required": [ "agreement_id", "is_accepted" ] }, "day_trading_risk_disclosure": { "type": "object", "description": "Day Trading Risk Disclosure (Omnibus)", "properties": { "agreement_id": { "type": "string", "description": "Agreement id" }, "sign_method": { "type": "string", "description": "Signature method. Value must be obtained from the Master Data API with data_type = AGREEMENT_SIGN_METHOD." }, "is_accepted": { "type": "boolean", "description": "Whether the user accepted the agreement." } }, "required": [ "agreement_id", "is_accepted" ] }, "extended_hours_trading_disclosure": { "type": "object", "description": "Extended Hours Trading Disclosure (Omnibus)", "properties": { "agreement_id": { "type": "string", "description": "Agreement id" }, "sign_method": { "type": "string", "description": "Signature method. Value must be obtained from the Master Data API with data_type = AGREEMENT_SIGN_METHOD." }, "is_accepted": { "type": "boolean", "description": "Whether the user accepted the agreement." } }, "required": [ "agreement_id", "is_accepted" ] }, "low_priced_securities_alert": { "type": "object", "description": "Low-Priced Securities Alert (Omnibus)", "properties": { "agreement_id": { "type": "string", "description": "Agreement id" }, "sign_method": { "type": "string", "description": "Signature method. Value must be obtained from the Master Data API with data_type = AGREEMENT_SIGN_METHOD." }, "is_accepted": { "type": "boolean", "description": "Whether the user accepted the agreement." } }, "required": [ "agreement_id", "is_accepted" ] }, "webull_financial_customer_agreement_margin": { "type": "object", "description": "Webull Financial Customer Agreement - Margin(Omnibus)", "properties": { "agreement_id": { "type": "string", "description": "Agreement id" }, "sign_method": { "type": "string", "description": "Signature method. Value must be obtained from the Master Data API with data_type = AGREEMENT_SIGN_METHOD." }, "is_accepted": { "type": "boolean", "description": "Whether the user accepted the agreement." } }, "required": [ "agreement_id", "is_accepted" ] }, "webull_financial_margin_disclosure": { "type": "object", "description": "Webull Financial Margin Disclosure (Omnibus)", "properties": { "agreement_id": { "type": "string", "description": "Agreement id" }, "sign_method": { "type": "string", "description": "Signature method. Value must be obtained from the Master Data API with data_type = AGREEMENT_SIGN_METHOD." }, "is_accepted": { "type": "boolean", "description": "Whether the user accepted the agreement." } }, "required": [ "agreement_id", "is_accepted" ] } } } }, "required": [ "rep_code", "account_type", "commission_code", "investment_knowledge", "investment_objective", "time_horizon", "is_exchange_or_finra_affiliated", "agreement_infos" ] } }, "EVENT_CONTRACT_ADDITIONAL_FORM": { "description": "EVENT_CONTRACT_ADDITIONAL_FORM", "value": { "type": "object", "description": "The Event Contract Additional Form collects supplemental information required for enabling event contract trading. This form cannot be submitted independently and must be submitted together with the New Account Basic Form as part of the account opening process.", "form_code": "EVENT_CONTRACT_ADDITIONAL_FORM", "properties": { "rep_code": { "type": "string", "description": "Specific code that Webull assigned to the Introducing broker, to distinguish between different IB customers, e.g. REP_DEMO." }, "commission_code": { "type": "string", "description": "Commission Code for account, determining the commission structure" }, "investment_experience": { "type": "string", "description": "Event contract investment experience. Value must be obtained from the Master Data API with data_type = INVESTMENT_EXPERIENCE." }, "investment_knowledge": { "type": "string", "description": "Event contract investment knowledge. Value must be obtained from the Master Data API with data_type = INVESTMENT_KNOWLEDGE_V2." }, "trade_per_year": { "type": "string", "description": "Event contract trade per year. Value must be obtained from the Master Data API with data_type = TRADE_PER_YEAR." }, "is_cftc_or_nfa_registered": { "type": "boolean", "description": "Indicates whether the applicant is registered with the CFTC or is a member of the NFA." }, "is_exchange_affiliated": { "type": "boolean", "description": "Indicates whether the applicant is employed by, or directly associated with, an exchange member. If true, exchange_affiliations details must be provided." }, "is_bp_shared": { "type": "boolean", "description": "Whether to enable buying power sharing. true: Enable buying power sharing. false: Do not enable buying power sharing. By default, it will share with the CASH account; if no CASH account exists, it will share with the MARGIN account. " }, "exchange_affiliations": { "type": "array", "description": "List of the applicant affiliations with exchanges member. Required if is_exchange_affiliated is true.", "items": { "type": "object", "description": "", "properties": { "company_name": { "type": "string", "description": "Name of the exchange member the applicant is affiliated with.", "max_length": 128 }, "country": { "type": "string", "description": "Country of the affiliated exchange. The value must be a valid ISO 3166-1 alpha-3 country code in uppercase format (3-letter code)." }, "state": { "type": "string", "description": "State or province of the affiliated exchange. The value must follow the ISO 3166-2 subdivision standard and include the country code prefix. Format: -" }, "city": { "type": "string", "description": "City of the affiliated exchange.", "max_length": 256 }, "street_address": { "type": "string", "description": "Street address of the affiliated exchange.", "max_length": 512 }, "postal_code": { "type": "string", "description": "Postal or ZIP code of the affiliated exchange.", "max_length": 80 } }, "required": [ "company_name", "country", "state", "city", "street_address", "postal_code" ] } }, "agreement_infos": { "type": "object", "description": "Agreement infos", "properties": { "accepted_at": { "type": "string", "description": "Accepted at. Agreement Confirmation Date (ET). If an agreement is signed, it must be filled in.", "format": "yyyy-MM-dd" }, "cleared_swap_arbitration_agreement": { "type": "object", "description": "Cleared Swap Arbitration Agreement", "properties": { "agreement_id": { "type": "string", "description": "Agreement id" }, "sign_method": { "type": "string", "description": "Signature method. Value must be obtained from the Master Data API with data_type = AGREEMENT_SIGN_METHOD." }, "is_accepted": { "type": "boolean", "description": "Whether the user accepted the agreement." } }, "required": [ "agreement_id", "is_accepted" ] }, "event_contract_heightened_risk_disclosure": { "type": "object", "description": "Event Contract Heightened Risk Disclosure", "properties": { "agreement_id": { "type": "string", "description": "Agreement id" }, "sign_method": { "type": "string", "description": "Signature method. Value must be obtained from the Master Data API with data_type = AGREEMENT_SIGN_METHOD." }, "is_accepted": { "type": "boolean", "description": "Whether the user accepted the agreement." } }, "required": [ "agreement_id", "is_accepted" ] }, "event_contract_sports_disclaimer": { "type": "object", "description": "Event Contract Sports Disclaimer", "properties": { "agreement_id": { "type": "string", "description": "Agreement id" }, "sign_method": { "type": "string", "description": "Signature method. Value must be obtained from the Master Data API with data_type = AGREEMENT_SIGN_METHOD." }, "is_accepted": { "type": "boolean", "description": "Whether the user accepted the agreement." } }, "required": [ "agreement_id", "is_accepted" ] }, "form_1_55k_firm_specific_disclosure_document": { "type": "object", "description": "1.55(k) Firm Specific Disclosure Document", "properties": { "agreement_id": { "type": "string", "description": "Agreement id" }, "sign_method": { "type": "string", "description": "Signature method. Value must be obtained from the Master Data API with data_type = AGREEMENT_SIGN_METHOD." }, "is_accepted": { "type": "boolean", "description": "Whether the user accepted the agreement." } }, "required": [ "agreement_id", "is_accepted" ] }, "event_contract_customer_agreement": { "type": "object", "description": "Event Contract Customer Agreement", "properties": { "agreement_id": { "type": "string", "description": "Agreement id" }, "sign_method": { "type": "string", "description": "Signature method. Value must be obtained from the Master Data API with data_type = AGREEMENT_SIGN_METHOD." }, "is_accepted": { "type": "boolean", "description": "Whether the user accepted the agreement." } }, "required": [ "agreement_id", "is_accepted" ] }, "event_contract_risk_disclosure": { "type": "object", "description": "Event Contract Risk Disclosure", "properties": { "agreement_id": { "type": "string", "description": "Agreement id" }, "sign_method": { "type": "string", "description": "Signature method. Value must be obtained from the Master Data API with data_type = AGREEMENT_SIGN_METHOD." }, "is_accepted": { "type": "boolean", "description": "Whether the user accepted the agreement." } }, "required": [ "agreement_id", "is_accepted" ] }, "investment_and_trading_disclosures_booklet_futures": { "type": "object", "description": "Investment and Trading Disclosures Booklet - Futures", "properties": { "agreement_id": { "type": "string", "description": "Agreement id" }, "sign_method": { "type": "string", "description": "Signature method. Value must be obtained from the Master Data API with data_type = AGREEMENT_SIGN_METHOD." }, "is_accepted": { "type": "boolean", "description": "Whether the user accepted the agreement." } }, "required": [ "agreement_id", "is_accepted" ] } } } }, "required": [ "rep_code", "commission_code", "investment_experience", "investment_knowledge", "trade_per_year", "is_cftc_or_nfa_registered", "is_exchange_affiliated", "agreement_infos" ] } }, "APPLICATION_RESUBMISSION_FORM": { "description": "APPLICATION_RESUBMISSION_FORM", "value": { "type": "object", "description": "This form is used to collect additional information or supporting documents required during the account opening process. It is triggered by KYC/AML screening, Enhanced Due Diligence (EDD), or compliance review, and is conditionally required to complete the account application.", "form_code": "APPLICATION_RESUBMISSION_FORM", "properties": { "codes": { "type": "array", "description": "List of resubmission codes and the corresponding fields that need to be provided: -- OCR_SUSPENDED: Provide picture_front_doc_id and picture_back_doc_id for identity document images. -- CIP_SUSPENDED, UNMATCHED_SSN_PICTURE: Provide tax_id_doc_id for tax/SSN verification. -- NOT_A_GOVERNMENT_ISSUED, EXPIRED_ID, ID_CARD_ILLEGIBLE, ID_ON_SCREEN, UNMATCHED_ID_NUMBER_WITH_THE_ID_PICTURE: Provide id_doc_type, id_expiry_date, picture_front_doc_id, picture_back_doc_id. -- UNMATCHED_ID_EXPIRE_DATE: Provide id_expiry_date. -- UNMATCHED_NATIONALITY_WITH_THE_ID_PICTURE: Provide country_of_citizenship. -- UNMATCHED_NAME_WITH_THE_ID_PICTURE: Provide first_name, middle_name, last_name. -- UNMATCHED_DOB_WITH_THE_ID_PICTURE: Provide date_of_birth. -- SELFIE_NOT_MEET_THE_REQUIREMENTS: Provide selfie_img_key for selfie verification. -- NEED_407_LETTERS: Provide rule_3210_doc_id when is_exchange_or_finra_affiliated is true.", "items": { "type": "string", "description": "Resubmission code indicating which type of information is required." } }, "id_doc_type": { "type": "string", "description": "Type of identification document provided by the applicant. The value must be retrieved from the Master Data API where data_type = ID_DOC_TYPE." }, "id_number": { "type": "string", "description": "Identification document number exactly as shown on the provided ID." }, "id_expiry_date": { "type": "string", "description": "Expiration date of the identification document." }, "picture_front_doc_id": { "type": "string", "description": "Document ID referencing the uploaded image of the front side of the identification document." }, "picture_back_doc_id": { "type": "string", "description": "Document ID referencing the uploaded image of the back side of the identification document." }, "first_name": { "type": "string", "description": "First name of the applicant as it appears on the identification document." }, "middle_name": { "type": "string", "description": "Middle name of the applicant as it appears on the identification document, if applicable." }, "last_name": { "type": "string", "description": "Last name of the applicant as it appears on the identification document." }, "date_of_birth": { "type": "string", "description": "Date of birth of the applicant as shown on the identification document." }, "country_of_citizenship": { "type": "string", "description": "Country of citizenship of the account holder. The value must be a valid ISO 3166-1 alpha-3 country code in uppercase format (3-letter code)." }, "selfie_img_key": { "type": "string", "description": "Document ID referencing the uploaded selfie image used for identity verification." }, "tax_id_doc_id": { "type": "string", "description": "Document ID referencing the uploaded supporting document for tax identification or SSN verification." }, "rule_3210_doc_id": { "type": "string", "description": "Document ID referencing the uploaded Rule 3210 Approval Form. Required when is_exchange_or_finra_affiliated is true." } }, "required": [ "codes" ] } }, "ACCOUNT_UPDATE_FORM": { "description": "ACCOUNT_UPDATE_FORM", "value": { "type": "object", "description": "This form is used to submit post-onboarding account update requests for an existing account. It serves as a unified entry point for multiple account maintenance and compliance-related update scenarios after the account has been successfully opened. The specific update scenario is determined by the `type` field. Based on the selected type, the corresponding update information object must be provided. This form is commonly used for periodic reviews, regulatory compliance verification, risk control follow-ups, and other account data maintenance processes to ensure that account records remain accurate, valid, and up to date.", "form_code": "ACCOUNT_UPDATE_FORM", "properties": { "type": { "type": "string", "description": "Specifies the category of account update to be performed after account opening. This field determines which account update scenario applies and which corresponding information object is required in the request. Each type represents a distinct account maintenance or compliance update operation." }, "commission_info": { "type": "object", "description": "This object is applicable when the update type is COMMISSION_UPDATE.", "properties": { "commission_code": { "type": "string", "description": "Commission Code for account, determining the commission structure." } }, "required": [ "commission_code" ] }, "identity_info": { "type": "object", "description": "This object is applicable when the update type is IDENTITY_UPDATE. This form is used to collect updated identification information for an existing account. It is required during account maintenance, periodic review, or compliance verification to ensure the accuracy and validity of identity records.", "properties": { "id_doc_type": { "type": "string", "description": "Type of identification document provided by the applicant. The value must be retrieved from the Master Data API where data_type = ID_DOC_TYPE." }, "id_number": { "type": "string", "description": "Identification document number exactly as shown on the provided ID." }, "id_expiry_date": { "type": "string", "description": "Expiration date of the identification document.", "format": "yyyy-MM-dd" }, "picture_front_doc_id": { "type": "string", "description": "Document ID referencing the uploaded image of the front side of the identification document." }, "picture_back_doc_id": { "type": "string", "description": "Document ID referencing the uploaded image of the back side of the identification document." } }, "required": [ "id_doc_type", "id_number", "id_expiry_date", "picture_front_doc_id", "picture_back_doc_id" ] }, "bp_share_info": { "type": "object", "description": "This object is applicable when the update type is SHARE_ACCOUNT_UPDATE. Buypower share info", "properties": { "share_direction": { "type": "string", "description": "Buypower share direction" } }, "required": [ "share_direction" ] }, "employment_info": { "type": "object", "description": "This object is applicable when the update type is EMPLOYMENT_UPDATE. Collects updated employment information required during account maintenance or compliance review.", "properties": { "employment_type": { "type": "string", "description": "Type of employment. Value must be obtained from the Master Data API with data_type = EMPLOYMENT_TYPE." }, "company_name": { "type": "string", "description": "Name of the applicant current employer.", "max_length": 128 }, "occupation": { "type": "string", "description": "Specific occupation under the employment type. Value must be obtained from the Master Data API with data_type = OCCUPATION." }, "position": { "type": "string", "description": "Job position or title. Value must be obtained from the Master Data API with data_type = POSITION." }, "years_employed": { "type": "number", "description": "Total duration (in years) the applicant has been employed with the current employer. Decimal values are allowed to represent partial years (e.g. 1.5)." }, "employment_address": { "type": "object", "description": "Address of the applicant current employer.", "properties": { "country": { "type": "string", "description": "Employer address country. The value must be a valid ISO 3166-1 alpha-3 country code in uppercase format (3-letter code)." }, "state": { "type": "string", "description": "Employer address state. The value must follow the ISO 3166-2 subdivision standard and include the country code prefix. Format: -" }, "city": { "type": "string", "description": "Employer address city.", "max_length": 256 }, "street_address": { "type": "string", "description": "Street address of the employer. Multiple lines are allowed.", "max_length": 512 }, "postal_code": { "type": "string", "description": "Postal code of the employer address.", "max_length": 80 }, "neighborhood_code": { "type": "string", "description": "Neighborhood or district code of the employer address, if applicable.", "max_length": 128 }, "apartment_number": { "type": "string", "description": "Apartment number of the employer address, if applicable.", "max_length": 128 }, "building_number": { "type": "string", "description": "Building number of the employer address, if applicable.", "max_length": 128 } }, "required": [ "country", "state", "city", "street_address", "postal_code" ] } }, "required": [ "employment_type", "company_name", "occupation", "position", "years_employed", "employment_address" ] }, "trusted_contact_info": { "type": "object", "description": "This object is applicable when the update type is TRUSTED_UPDATE. Collects or updates trusted contact information for an account, used for account protection, compliance review, or situations where the account holder cannot be contacted.", "properties": { "first_name": { "type": "string", "description": "First name of the trusted contact person." }, "middle_name": { "type": "string", "description": "Middle name of the trusted contact person, if applicable." }, "last_name": { "type": "string", "description": "Last name of the trusted contact person." }, "phone_country": { "type": "string", "description": "Phone country. The value must be a valid ISO 3166-1 alpha-3 country code in uppercase format (3-letter code)." }, "phone_number": { "type": "string", "description": "Primary contact phone number of the trusted contact person.", "example": "+1-2025550124", "max_length": 20 }, "relationship": { "type": "string", "description": "Relationship between the account holder and the trusted contact person.", "max_length": 32 }, "trusted_address": { "type": "object", "description": "Residential or mailing address of the trusted contact person.", "properties": { "country": { "type": "string", "description": "Country of the trusted contact person address. The value must be a valid ISO 3166-1 alpha-3 country code in uppercase format (3-letter code)." }, "state": { "type": "string", "description": "State or province of the trusted contact person address. The value must follow the ISO 3166-2 subdivision standard and include the country code prefix. Format: -" }, "city": { "type": "string", "description": "City of the trusted contact person address.", "max_length": 256 }, "street_address": { "type": "string", "description": "Street address of the trusted contact person. Multiple address lines are allowed.", "max_length": 512 }, "postal_code": { "type": "string", "description": "Postal or ZIP code of the trusted contact person address.", "max_length": 80 }, "neighborhood_code": { "type": "string", "description": "Neighborhood or district code of the trusted contact person address, if applicable.", "max_length": 128 }, "apartment_number": { "type": "string", "description": "Apartment or unit number of the trusted contact person address, if applicable.", "max_length": 128 }, "building_number": { "type": "string", "description": "Building number of the trusted contact person address, if applicable.", "max_length": 128 } }, "required": [ "country", "state", "city", "street_address", "postal_code" ] } }, "required": [ "first_name", "last_name", "phone_country", "phone_number", "relationship", "trusted_address" ] }, "email_address_info": { "type": "object", "description": "This object is applicable when the update type is EMAIL_ADDRESS_UPDATE. Collects or updates the primary email address associated with an account. This information is used for account communication, security notifications, and compliance-related correspondence.", "properties": { "email_address": { "type": "string", "description": "Email address", "max_length": 256 } }, "required": [ "email_address" ] }, "address_info": { "type": "object", "description": "This object is applicable when the update type is ADDRESS_UPDATE. Collects or updates address information associated with an account, including residential and mailing addresses. This information is used for account administration, regulatory compliance, and official correspondence.", "properties": { "id_address": { "type": "object", "description": "Residential address of the account holder as recorded for identity verification and regulatory purposes.", "properties": { "country": { "type": "string", "description": "Country of residence. The value must be a valid ISO 3166-1 alpha-3 country code in uppercase format (3-letter code)." }, "state": { "type": "string", "description": "State or province of residence. The value must follow the ISO 3166-2 subdivision standard and include the country code prefix. Format: -" }, "city": { "type": "string", "description": "City of residence.", "max_length": 256 }, "street_address": { "type": "string", "description": "Street address of the account holder residence. Multiple address lines are allowed.", "max_length": 512 }, "postal_code": { "type": "string", "description": "Postal or ZIP code of the residential address.", "max_length": 80 }, "neighborhood_code": { "type": "string", "description": "Neighborhood or district code of the id address, if applicable.", "max_length": 128 }, "apartment_number": { "type": "string", "description": "Apartment number of the id address, if applicable.", "max_length": 128 }, "building_number": { "type": "string", "description": "Building number of the id address, if applicable.", "max_length": 128 } }, "required": [ "country", "state", "city", "street_address", "postal_code" ] }, "mail_address": { "type": "object", "description": "Mailing address used for receiving account-related correspondence, if different from the residential address.", "properties": { "country": { "type": "string", "description": "Mailing address country. The value must be a valid ISO 3166-1 alpha-3 country code in uppercase format (3-letter code)." }, "state": { "type": "string", "description": "State or province of the mailing address. The value must follow the ISO 3166-2 subdivision standard and include the country code prefix. Format: -" }, "city": { "type": "string", "description": "City of the mailing address.", "max_length": 256 }, "street_address": { "type": "string", "description": "Street address of the mailing address. Multiple address lines are allowed.", "max_length": 512 }, "postal_code": { "type": "string", "description": "Postal or ZIP code of the mailing address.", "max_length": 80 }, "neighborhood_code": { "type": "string", "description": "Neighborhood or district code of the mailing address.", "max_length": 128 }, "apartment_number": { "type": "string", "description": "Apartment number of the mailing address.", "max_length": 128 }, "building_number": { "type": "string", "description": "Building number of the mailing address.", "max_length": 128 } }, "required": [ "country", "state", "city", "street_address", "postal_code" ] } }, "required": [ "id_address", "mail_address" ] }, "phone_number_info": { "type": "object", "description": "This object is applicable when the update type is PHONE_NUMBER_UPDATE. Collects or updates the primary phone number associated with an account, used for account communication, security verification, and regulatory notifications.", "properties": { "phone_country": { "type": "string", "description": "Phone country. The value must be a valid ISO 3166-1 alpha-3 country code in uppercase format (3-letter code)." }, "phone_number": { "type": "string", "description": "Primary contact phone number associated with the account, in international format (E.164). Used for account notifications, verification, and security-related communications.", "example": "+1-2025550123", "max_length": 20 } }, "required": [ "phone_country", "phone_number" ] }, "politically_exposed_info": { "type": "object", "description": "This object is applicable when the update type is PEP_UPDATE. Collects or updates Politically Exposed Person (PEP) information for an account. This information is used for compliance review, enhanced due diligence (EDD), and regulatory reporting.", "properties": { "is_politically_exposed": { "type": "boolean", "description": "Indicates whether the account holder or any close associate or immediate family member is a Politically Exposed Person (PEP). If true, the politically_exposed_info object must be provided with detailed disclosure information. Please note: PEP accounts are currently not supported. Any request submitted with is_politically_exposed = true will be rejected and a failure response will be returned." }, "politically_exposed_info": { "type": "object", "description": "Detail information about Politically Exposed Person (PEP) associated with the account holder.", "properties": { "pep_organization": { "type": "string", "description": "Name of the related political organization.", "max_length": 256 }, "immediate_family": { "type": "array", "description": "Name of family members, including former spouses.", "items": { "type": "string", "description": "" } } }, "required": [ "pep_organization", "immediate_family" ] } }, "required": [ "is_politically_exposed" ] }, "company_control_info": { "type": "object", "description": "This object is applicable when the update type is COMPANY_CONTROL_UPDATE. Collects or updates information about the applicant status as a control person of a public company. This information is used for compliance review, enhanced due diligence (EDD), and regulatory reporting.", "properties": { "is_company_control_person": { "type": "boolean", "description": "Indicates whether the applicant is a control person of a public company. If true, `public_company_infos` must be provided with details of the companies controlled." }, "public_company_infos": { "type": "array", "description": "List of public companies controlled by the applicant. Each item must include the company stock symbol.", "items": { "type": "object", "description": "", "properties": { "symbol": { "type": "string", "description": "Stock symbol of the public company controlled by the applicant, as listed on the exchange." } }, "required": [ "symbol" ] } } }, "required": [ "is_company_control_person" ] }, "disclosure_info": { "type": "object", "description": "This object is applicable when the update type is DISCLOSURE_UPDATE. Collects or updates the applicant regulatory and compliance-related affiliations or disclosures. This form is used for compliance review, enhanced due diligence (EDD), and regulatory reporting, and may include multiple types of information beyond exchange or FINRA affiliations.", "properties": { "brokerage_disclosure_info": { "type": "object", "description": "Brokerage disclosure info", "properties": { "is_exchange_or_finra_affiliated": { "type": "boolean", "description": "Indicates whether the applicant is employed by, or directly associated with, an exchange or a FINRA member firm. If true, exchange_affiliations details must be provided." }, "exchange_affiliations": { "type": "array", "description": "List of the applicant affiliations with exchanges or FINRA member firms. Required if is_exchange_or_finra_affiliated is true.", "items": { "type": "object", "description": "", "properties": { "company_name": { "type": "string", "description": "Name of the exchange or FINRA member firm the applicant is affiliated with.", "max_length": 128 }, "country": { "type": "string", "description": "Country of the affiliated exchange or FINRA firm. The value must be a valid ISO 3166-1 alpha-3 country code in uppercase format (3-letter code)." }, "state": { "type": "string", "description": "State or province of the affiliated exchange or FINRA firm. Value must be obtained from the Master Data API with data_type = STATE." }, "city": { "type": "string", "description": "City of the affiliated exchange or FINRA firm.", "max_length": 256 }, "street_address": { "type": "string", "description": "Street address of the affiliated exchange or FINRA firm. Multiple lines are allowed.", "max_length": 512 }, "postal_code": { "type": "string", "description": "Postal or ZIP code of the affiliated exchange or FINRA firm.", "max_length": 80 } }, "required": [ "company_name", "country", "state", "city", "street_address", "postal_code" ] } } }, "required": [ "is_exchange_or_finra_affiliated" ] } }, "required": [ "brokerage_disclosure_info" ] }, "dependent_info": { "type": "object", "description": "This object is applicable when the update type is DEPENDENT_UPDATE. Collects or updates the number of dependents associated with an account holder. This information is used for account maintenance, compliance review, and regulatory reporting purposes.", "properties": { "num_dependents": { "type": "number", "description": "Number of dependents financially or legally associated with the account holder." } }, "required": [ "num_dependents" ] }, "citizenship_info": { "type": "object", "description": "This object is applicable when the update type is CITIZENSHIP_UPDATE. Collects or updates the country of citizenship for an account holder. This information is used for account maintenance, compliance review, and regulatory reporting.", "properties": { "country_of_citizenship": { "type": "string", "description": "Country of citizenship of the account holder. The value must be retrieved from the Master Data API with data_type = COUNTRY." } }, "required": [ "country_of_citizenship" ] }, "gender_info": { "type": "object", "description": "This object is applicable when the update type is GENDER_UPDATE. Collects or updates the gender of an account holder. This information is used for account maintenance, compliance review, and regulatory reporting.", "properties": { "gender": { "type": "string", "description": "Gender of the account holder. Allowed values: F (Female), M (Male)." } }, "required": [ "gender" ] }, "marital_info": { "type": "object", "description": "This object is applicable when the update type is MARITAL_UPDATE. Collects or updates the marital status of an account holder. This information is used for account maintenance, compliance review, and regulatory reporting.", "properties": { "marital_status": { "type": "string", "description": "Marital status of the account holder. Value must be obtained from the Master Data API with data_type = MARITAL_STATUS." } }, "required": [ "marital_status" ] }, "financial_investment_info": { "type": "object", "description": "This object is applicable when the update type is FINANCIAL_INVESTMENT_UPDATE. Collects or updates the investment profile and financial information of an account holder. This information is used for account maintenance, risk assessment, and regulatory compliance.", "properties": { "financial_info": { "type": "object", "description": "Financial information of the account holder.", "properties": { "liquidity_needs": { "type": "string", "description": "Indicates the client liquidity needs or preference for cash accessibility. Value must be obtained from the Master Data API with data_type = LIQUIDITY_NEEDS." }, "annual_income": { "type": "string", "description": "Represents the client annual income. Value must be obtained from the Master Data API with data_type = ANNUAL_INCOME." }, "total_net_worth": { "type": "string", "description": "Represents the client total net worth in USD. Value must be obtained from the Master Data API with data_type = TOTAL_NET_WORTH." }, "liquid_net_worth": { "type": "string", "description": "Represents the client liquid net worth (USD), including cash and easily marketable assets. Value must be obtained from the Master Data API with data_type = LIQUID_NET_WORTH." } }, "required": [ "liquidity_needs", "annual_income", "total_net_worth", "liquid_net_worth" ] }, "event_contract_investment_info": { "type": "object", "description": "Event contract account investment info", "properties": { "investment_experience": { "type": "string", "description": "Event contract investment experience. Value must be obtained from the Master Data API with data_type = INVESTMENT_EXPERIENCE." }, "investment_knowledge": { "type": "string", "description": "Event contract investment knowledge. Value must be obtained from the Master Data API with data_type = INVESTMENT_KNOWLEDGE_V2." }, "trade_per_year": { "type": "string", "description": "Event contract trade per year. Value must be obtained from the Master Data API with data_type = TRADE_PER_YEAR." } }, "required": [ "investment_experience", "investment_knowledge", "trade_per_year" ] }, "brokerage_investment_info": { "type": "object", "description": "Brokerage account investment info", "properties": { "investment_knowledge": { "type": "string", "description": "Investment knowledge. Value must be obtained from the Master Data API with data_type = INVESTMENT_KNOWLEDGE." }, "investment_objective": { "type": "string", "description": "Investment objective. Value must be obtained from the Master Data API with data_type = INVESTMENT_OBJECTIVE." }, "time_horizon": { "type": "string", "description": "Time horizon. Value must be obtained from the Master Data API with data_type = TIME_HORIZON." } }, "required": [ "investment_knowledge", "investment_objective", "time_horizon" ] } } } }, "required": [ "type" ] } } } } } }, "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": "Get Form Detail", "description": { "content": "Retrieves the JSON schema for the specified form code and version.", "type": "text/plain" }, "url": { "path": [ "broker", "forms", "get" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Unique identifier of the form, typically used to distinguish different form definitions.", "type": "text/plain" }, "key": "form_code", "value": "" }, { "disabled": false, "description": { "content": "(Required) Version number of the form definition", "type": "text/plain" }, "key": "version", "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" } } ```