Set Account Settings (set_settings)¶

Set User Settings (this call should be used in conjunction with get_settings)

Auth Scope(s): admin

set_settings(account_opening_reason: Optional[str] = None, address_city: Optional[str] = None, address_line_1: Optional[str] = None, address_line_2: Optional[str] = None, address_postcode: Optional[str] = None, address_state: Optional[str] = None, allow_copiers: Optional[int] = None, citizen: Optional[str] = None, date_of_birth: Optional[str] = None, email_consent: Optional[int] = None, feature_flag=None, first_name: Optional[str] = None, last_name: Optional[str] = None, non_pep_declaration: Optional[int] = None, phone: Optional[str] = None, place_of_birth: Optional[str] = None, preferred_language: Optional[str] = None, request_professional_status: Optional[int] = None, residence: Optional[str] = None, salutation: Optional[str] = None, secret_answer: Optional[str] = None, secret_question: Optional[str] = None, tax_identification_number: Optional[str] = None, tax_residence: Optional[str] = None, passthrough: Optional[Any] = None, req_id: Optional[int] = None) → int¶

Parameters:	account_opening_reason (Optional[str]) – [Optional] Purpose and reason for requesting the account opening. Only applicable for real money account. Required for clients that have not set it yet. Can only be set once. address_city (Optional[str]) – [Optional] Note: not applicable for virtual account. Required field for real money account. address_line_1 (Optional[str]) – [Optional] Note: not applicable for virtual account. Required field for real money account. address_line_2 (Optional[str]) – [Optional] Note: not applicable for virtual account. Optional field for real money account. address_postcode (Optional[str]) – [Optional] Note: not applicable for virtual account. Optional field for real money account. address_state (Optional[str]) – [Optional] Note: not applicable for virtual account. Optional field for real money account. allow_copiers (Optional[int]) – [Optional] Boolean value 1 or 0, indicating permission to allow others to follow your trades. Note: not applicable for Virtual account. Only allow for real money account. citizen (Optional[str]) – [Optional] Country of legal citizenship, 2-letter country code. date_of_birth (Optional[str]) – [Optional] Date of birth format: yyyy-mm-dd (can only be changed on unauthenticated svg accounts). email_consent (Optional[int]) – [Optional] Boolean value 1 or 0, indicating permission to use email address for any contact which may include marketing feature_flag – [Optional] Enable or disable one or multiple features. first_name (Optional[str]) – [Optional] Within 2-50 characters, use only letters, spaces, hyphens, full-stops or apostrophes (can only be changed on unauthenticated svg accounts). last_name (Optional[str]) – [Optional] Within 2-50 characters, use only letters, spaces, hyphens, full-stops or apostrophes (can only be changed on unauthenticated svg accounts). non_pep_declaration (Optional[int]) – [Optional] Indicates client’s self-declaration of not being a PEP/RCA (Politically Exposed Person/Relatives and Close Associates). Effective for real accounts only. phone (Optional[str]) – [Optional] Note: not applicable for virtual account. Starting with + followed by 9-35 digits, hyphens or space. place_of_birth (Optional[str]) – [Optional] Place of birth, 2-letter country code. preferred_language (Optional[str]) – [Optional] User’s preferred language, ISO standard language code request_professional_status (Optional[int]) – [Optional] Required when client wants to be treated as professional. Applicable for financial accounts only. residence (Optional[str]) – [Optional] 2-letter country code. Note: not applicable for real money account. Only allow for Virtual account without residence set. salutation (Optional[str]) – [Optional] Accept any value in enum list (can only be changed on unauthenticated svg accounts). secret_answer (Optional[str]) – [Optional] Answer to secret question, within 4-50 characters. Required for new account and existing client details will be used if client opens another account. secret_question (Optional[str]) – [Optional] Accept any value in enum list. Required for new account and existing client details will be used if client opens another account. tax_identification_number (Optional[str]) – [Optional] Tax identification number. Only applicable for real money account. Required for maltainvest landing company. tax_residence (Optional[str]) – [Optional] Residence for tax purpose. Comma separated iso country code if multiple jurisdictions. Only applicable for real money account. Required for maltainvest landing company. passthrough (Optional[Any]) – [Optional] Used to pass data through the websocket, which may be retrieved via the echo_req output field. req_id (Optional[int]) – [Optional] Used to map request to response.
Returns:	req_id
Return type:	int

Example¶

binary.api.set_settings(
    account_opening_reason='Speculative'
    address_city='Test City'
    address_line_1='Test Address Line 1'
    address_line_2='Test Address Line 2'
    address_postcode='123456'
    allow_copiers=1
    email_consent=0
    phone='+15417543010'
    place_of_birth='ar'
    preferred_language='EN'
    request_professional_status=1
    tax_identification_number='987654321'
    tax_residence='hk'
)