From 5300dd51954b7c996ea0811be5877268dc4f174b Mon Sep 17 00:00:00 2001 From: sanjam chhatwal Date: Tue, 21 Nov 2023 15:36:34 +0400 Subject: [PATCH] chore: updated config to fix backend changes --- config/v3/landing_company/receive.json | 3084 +++++++++++------------- config/v3/landing_company/send.json | 48 +- 2 files changed, 1402 insertions(+), 1730 deletions(-) diff --git a/config/v3/landing_company/receive.json b/config/v3/landing_company/receive.json index 592b82d13..11075a375 100644 --- a/config/v3/landing_company/receive.json +++ b/config/v3/landing_company/receive.json @@ -1,1752 +1,1426 @@ { - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Landing Company (response)", - "description": "Returns the Landing Company for clients of a given country.", - "type": "object", - "required": [ - "echo_req", - "msg_type" - ], - "properties": { - "landing_company": { - "title": "landing_company", - "description": "Landing Company", - "type": "object", - "additionalProperties": false, - "properties": { - "address_parseable": { - "description": "Flag to indicate if address parseable or not", - "type": "integer", - "enum": [ - 1, - 0 - ] - }, - "all_company": { - "description": "Config for all account types (Synthetic Indices and Financials).", - "type": "string", - "enum": [ - "svg", - "none" - ] - }, - "config": { - "description": "Config structure with document types ,taxRequired ,tin format details.", - "type": "object" - }, - "ctrader": { - "description": "Available CTrader accounts.", - "type": "object", - "additionalProperties": false, - "properties": { - "all": { - "description": "CTrader all account types (Synthetic Indices and Financials).", - "type": "object", - "additionalProperties": false, - "properties": { - "standard": { - "description": "For standard client", - "type": "string", - "enum": [ - "svg", - "none" - ], - "additionalProperties": false - } - } + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Landing Company (response)", + "description": "Returns the Landing Company for clients of a given country.", + "type": "object", + "required": ["echo_req", "msg_type"], + "properties": { + "landing_company": { + "title": "landing_company", + "description": "Landing Company", + "type": "object", + "additionalProperties": false, + "properties": { + "address_parseable": { + "description": "Flag to indicate if address parseable or not", + "type": "integer", + "enum": [1, 0] + }, + "all_company": { + "description": "Config for all account types (Synthetic Indices and Financials).", + "type": "string", + "enum": ["svg", "none"] + }, + "config": { + "description": "Config structure with document types ,taxRequired ,tin format details.", + "type": "object" + }, + "ctrader": { + "description": "Available CTrader accounts.", + "type": "object", + "additionalProperties": false, + "properties": { + "all": { + "description": "CTrader all account types (Synthetic Indices and Financials).", + "type": "object", + "additionalProperties": false, + "properties": { + "standard": { + "description": "For standard client", + "type": "string", + "enum": ["svg", "none"], + "additionalProperties": false + } + } + } + } + }, + "derivez": { + "description": "Available DerivEZ accounts.", + "type": "object", + "additionalProperties": false, + "properties": { + "all": { + "description": "DerivEZ all account types (Synthetic Indices and Financials).", + "type": "object", + "additionalProperties": false, + "properties": { + "standard": { + "description": "For standard client", + "type": "string", + "enum": ["svg", "none"], + "additionalProperties": false + } + } + } + } + }, + "dxtrade_all_company": { + "description": "Available Deriv X all account types (Synthetic Indices and Financials).", + "type": "object", + "additionalProperties": false, + "properties": { + "standard": { + "description": "Landing Company details.", + "type": "object", + "additionalProperties": false, + "properties": { + "address": { + "description": "Landing Company address", + "type": ["array", "null"], + "items": { + "type": "string" + } + }, + "changeable_fields": { + "description": "Special conditions for changing sensitive fields", + "type": "object" + }, + "country": { + "description": "Landing Company country of incorporation", + "type": "string" + }, + "currency_config": { + "title": "Currency Config Structure", + "description": "The configuration of each currency.", + "type": "object" + }, + "has_reality_check": { + "description": "Flag to indicate whether reality check is applicable for this Landing Company. `1`: applicable, `0`: not applicable. The Reality Check is a feature that gives a summary of the client's trades and account balances on a regular basis throughout his session, and is a regulatory requirement for certain Landing Companies.", + "type": "integer", + "enum": [0, 1] + }, + "legal_allowed_contract_categories": { + "description": "Allowed contract types", + "type": "array", + "items": { + "type": "string" + } + }, + "legal_allowed_currencies": { + "description": "Allowable currencies", + "type": "array", + "items": { + "type": "string" + } + }, + "legal_allowed_markets": { + "description": "Allowable markets", + "type": "array", + "items": { + "type": "string" + } + }, + "legal_default_currency": { + "description": "Default account currency", + "type": "string" + }, + "name": { + "description": "Landing Company legal name", + "type": "string" + }, + "requirements": { + "description": "Legal requirements for the Landing Company", + "type": "object", + "additionalProperties": false, + "properties": { + "after_first_deposit": { + "description": "After first deposit requirements", + "type": "object", + "additionalProperties": false, + "properties": { + "financial_assessment": { + "description": "Financial assessment requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["financial_information", "trading_experience"] + } } + } + }, + "compliance": { + "description": "Compliance requirements", + "type": "object", + "additionalProperties": false, + "properties": { + "mt5": { + "description": "Compliance MT5 requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["expiration_check", "fully_authenticated"] + } + }, + "tax_information": { + "description": "Compliance tax information requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["tax_identification_number", "tax_residence"] + } + } + } + }, + "signup": { + "description": "Sign up requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["first_name", "residence", "salutation"] + } + }, + "withdrawal": { + "description": "Withdrawal requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["address_city", "address_line_1"] + } } + } + }, + "shortcode": { + "description": "Landing Company short code", + "type": "string" + }, + "support_professional_client": { + "description": "Flag that indicates whether the landing company supports professional accounts or not", + "type": "integer", + "enum": [0, 1] + }, + "tin_not_mandatory": { + "description": "Flag that indicates whether tax identifier number is not mandatory for the current country and landing company.", + "type": "integer", + "enum": [0, 1] + } + } + } + } + }, + "dxtrade_financial_company": { + "description": "Available Deriv X financial account types (all except Synthetic Indices).", + "type": "object", + "additionalProperties": false, + "properties": { + "standard": { + "description": "Landing Company details.", + "type": "object", + "additionalProperties": false, + "properties": { + "address": { + "description": "Landing Company address", + "type": ["array", "null"], + "items": { + "type": "string" + } + }, + "changeable_fields": { + "description": "Special conditions for changing sensitive fields", + "type": "object" + }, + "country": { + "description": "Landing Company country of incorporation", + "type": "string" + }, + "currency_config": { + "title": "Currency Config Structure", + "description": "The configuration of each currency.", + "type": "object" + }, + "has_reality_check": { + "description": "Flag to indicate whether reality check is applicable for this Landing Company. `1`: applicable, `0`: not applicable. The Reality Check is a feature that gives a summary of the client's trades and account balances on a regular basis throughout his session, and is a regulatory requirement for certain Landing Companies.", + "type": "integer", + "enum": [0, 1] + }, + "legal_allowed_contract_categories": { + "description": "Allowed contract types", + "type": "array", + "items": { + "type": "string" + } }, - "derivez": { - "description": "Available DerivEZ accounts.", - "type": "object", - "additionalProperties": false, - "properties": { - "all": { - "description": "DerivEZ all account types (Synthetic Indices and Financials).", - "type": "object", - "additionalProperties": false, - "properties": { - "standard": { - "description": "For standard client", - "type": "string", - "enum": [ - "svg", - "none" - ], - "additionalProperties": false - } - } + "legal_allowed_currencies": { + "description": "Allowable currencies", + "type": "array", + "items": { + "type": "string" + } + }, + "legal_allowed_markets": { + "description": "Allowable markets", + "type": "array", + "items": { + "type": "string" + } + }, + "legal_default_currency": { + "description": "Default account currency", + "type": "string" + }, + "name": { + "description": "Landing Company legal name", + "type": "string" + }, + "requirements": { + "description": "Legal requirements for the Landing Company", + "type": "object", + "additionalProperties": false, + "properties": { + "after_first_deposit": { + "description": "After first deposit requirements", + "type": "object", + "additionalProperties": false, + "properties": { + "financial_assessment": { + "description": "Financial assessment requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["financial_information", "trading_experience"] + } } + } + }, + "compliance": { + "description": "Compliance requirements", + "type": "object", + "additionalProperties": false, + "properties": { + "mt5": { + "description": "Compliance MT5 requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["expiration_check", "fully_authenticated"] + } + }, + "tax_information": { + "description": "Compliance tax information requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["tax_identification_number", "tax_residence"] + } + } + } + }, + "signup": { + "description": "Sign up requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["first_name", "residence", "salutation"] + } + }, + "withdrawal": { + "description": "Withdrawal requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["address_city", "address_line_1"] + } } + } + }, + "shortcode": { + "description": "Landing Company short code", + "type": "string" + }, + "support_professional_client": { + "description": "Flag that indicates whether the landing company supports professional accounts or not", + "type": "integer", + "enum": [0, 1] }, - "dxtrade_all_company": { - "description": "Available Deriv X all account types (Synthetic Indices and Financials).", - "type": "object", - "additionalProperties": false, - "properties": { - "standard": { - "description": "Landing Company details.", - "type": "object", - "additionalProperties": false, - "properties": { - "address": { - "description": "Landing Company address", - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - }, - "changeable_fields": { - "description": "Special conditions for changing sensitive fields", - "type": "object" - }, - "country": { - "description": "Landing Company country of incorporation", - "type": "string" - }, - "currency_config": { - "title": "Currency Config Structure", - "description": "The configuration of each currency.", - "type": "object" - }, - "has_reality_check": { - "description": "Flag to indicate whether reality check is applicable for this Landing Company. `1`: applicable, `0`: not applicable. The Reality Check is a feature that gives a summary of the client's trades and account balances on a regular basis throughout his session, and is a regulatory requirement for certain Landing Companies.", - "type": "integer", - "enum": [ - 0, - 1 - ] - }, - "legal_allowed_contract_categories": { - "description": "Allowed contract types", - "type": "array", - "items": { - "type": "string" - } - }, - "legal_allowed_currencies": { - "description": "Allowable currencies", - "type": "array", - "items": { - "type": "string" - } - }, - "legal_allowed_markets": { - "description": "Allowable markets", - "type": "array", - "items": { - "type": "string" - } - }, - "legal_default_currency": { - "description": "Default account currency", - "type": "string" - }, - "name": { - "description": "Landing Company legal name", - "type": "string" - }, - "requirements": { - "description": "Legal requirements for the Landing Company", - "type": "object", - "additionalProperties": false, - "properties": { - "after_first_deposit": { - "description": "After first deposit requirements", - "type": "object", - "additionalProperties": false, - "properties": { - "financial_assessment": { - "description": "Financial assessment requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "financial_information", - "trading_experience" - ] - } - } - } - }, - "compliance": { - "description": "Compliance requirements", - "type": "object", - "additionalProperties": false, - "properties": { - "mt5": { - "description": "Compliance MT5 requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "expiration_check", - "fully_authenticated" - ] - } - }, - "tax_information": { - "description": "Compliance tax information requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "tax_identification_number", - "tax_residence" - ] - } - } - } - }, - "signup": { - "description": "Sign up requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "first_name", - "residence", - "salutation" - ] - } - }, - "withdrawal": { - "description": "Withdrawal requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "address_city", - "address_line_1" - ] - } - } - } - }, - "shortcode": { - "description": "Landing Company short code", - "type": "string" - }, - "support_professional_client": { - "description": "Flag that indicates whether the landing company supports professional accounts or not", - "type": "integer", - "enum": [ - 0, - 1 - ] - }, - "tin_not_mandatory": { - "description": "Flag that indicates whether tax identifier number is not mandatory for the current country and landing company.", - "type": "integer", - "enum": [ - 0, - 1 - ] - } - } + "tin_not_mandatory": { + "description": "Flag that indicates whether tax identifier number is not mandatory for the current country and landing company.", + "type": "integer", + "enum": [0, 1] + } + } + } + } + }, + "dxtrade_gaming_company": { + "description": "Available Deriv X derived account types (Synthetic Indices).", + "type": "object", + "additionalProperties": false, + "properties": { + "standard": { + "description": "Landing Company details.", + "type": "object", + "additionalProperties": false, + "properties": { + "address": { + "description": "Landing Company address", + "type": ["array", "null"], + "items": { + "type": "string" + } + }, + "changeable_fields": { + "description": "Special conditions for changing sensitive fields", + "type": "object" + }, + "country": { + "description": "Landing Company country of incorporation", + "type": "string" + }, + "currency_config": { + "title": "Currency Config Structure", + "description": "The configuration of each currency.", + "type": "object" + }, + "has_reality_check": { + "description": "Flag to indicate whether reality check is applicable for this Landing Company. `1`: applicable, `0`: not applicable. The Reality Check is a feature that gives a summary of the client's trades and account balances on a regular basis throughout his session, and is a regulatory requirement for certain Landing Companies.", + "type": "integer", + "enum": [0, 1] + }, + "legal_allowed_contract_categories": { + "description": "Allowed contract types", + "type": "array", + "items": { + "type": "string" + } + }, + "legal_allowed_currencies": { + "description": "Allowable currencies", + "type": "array", + "items": { + "type": "string" + } + }, + "legal_allowed_markets": { + "description": "Allowable markets", + "type": "array", + "items": { + "type": "string" + } + }, + "legal_default_currency": { + "description": "Default account currency", + "type": "string" + }, + "name": { + "description": "Landing Company legal name", + "type": "string" + }, + "requirements": { + "description": "Legal requirements for the Landing Company", + "type": "object", + "additionalProperties": false, + "properties": { + "after_first_deposit": { + "description": "After first deposit requirements", + "type": "object", + "additionalProperties": false, + "properties": { + "financial_assessment": { + "description": "Financial assessment requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["financial_information", "trading_experience"] + } + } + } + }, + "compliance": { + "description": "Compliance requirements", + "type": "object", + "additionalProperties": false, + "properties": { + "mt5": { + "description": "Compliance MT5 requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["expiration_check", "fully_authenticated"] + } + }, + "tax_information": { + "description": "Compliance tax information requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["tax_identification_number", "tax_residence"] + } } + } + }, + "signup": { + "description": "Sign up requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["first_name", "residence", "salutation"] + } + }, + "withdrawal": { + "description": "Withdrawal requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["address_city", "address_line_1"] + } } + } }, - "dxtrade_financial_company": { - "description": "Available Deriv X financial account types (all except Synthetic Indices).", - "type": "object", - "additionalProperties": false, - "properties": { - "standard": { - "description": "Landing Company details.", - "type": "object", - "additionalProperties": false, - "properties": { - "address": { - "description": "Landing Company address", - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - }, - "changeable_fields": { - "description": "Special conditions for changing sensitive fields", - "type": "object" - }, - "country": { - "description": "Landing Company country of incorporation", - "type": "string" - }, - "currency_config": { - "title": "Currency Config Structure", - "description": "The configuration of each currency.", - "type": "object" - }, - "has_reality_check": { - "description": "Flag to indicate whether reality check is applicable for this Landing Company. `1`: applicable, `0`: not applicable. The Reality Check is a feature that gives a summary of the client's trades and account balances on a regular basis throughout his session, and is a regulatory requirement for certain Landing Companies.", - "type": "integer", - "enum": [ - 0, - 1 - ] - }, - "legal_allowed_contract_categories": { - "description": "Allowed contract types", - "type": "array", - "items": { - "type": "string" - } - }, - "legal_allowed_currencies": { - "description": "Allowable currencies", - "type": "array", - "items": { - "type": "string" - } - }, - "legal_allowed_markets": { - "description": "Allowable markets", - "type": "array", - "items": { - "type": "string" - } - }, - "legal_default_currency": { - "description": "Default account currency", - "type": "string" - }, - "name": { - "description": "Landing Company legal name", - "type": "string" - }, - "requirements": { - "description": "Legal requirements for the Landing Company", - "type": "object", - "additionalProperties": false, - "properties": { - "after_first_deposit": { - "description": "After first deposit requirements", - "type": "object", - "additionalProperties": false, - "properties": { - "financial_assessment": { - "description": "Financial assessment requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "financial_information", - "trading_experience" - ] - } - } - } - }, - "compliance": { - "description": "Compliance requirements", - "type": "object", - "additionalProperties": false, - "properties": { - "mt5": { - "description": "Compliance MT5 requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "expiration_check", - "fully_authenticated" - ] - } - }, - "tax_information": { - "description": "Compliance tax information requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "tax_identification_number", - "tax_residence" - ] - } - } - } - }, - "signup": { - "description": "Sign up requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "first_name", - "residence", - "salutation" - ] - } - }, - "withdrawal": { - "description": "Withdrawal requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "address_city", - "address_line_1" - ] - } - } - } - }, - "shortcode": { - "description": "Landing Company short code", - "type": "string" - }, - "support_professional_client": { - "description": "Flag that indicates whether the landing company supports professional accounts or not", - "type": "integer", - "enum": [ - 0, - 1 - ] - }, - "tin_not_mandatory": { - "description": "Flag that indicates whether tax identifier number is not mandatory for the current country and landing company.", - "type": "integer", - "enum": [ - 0, - 1 - ] - } - } - } + "shortcode": { + "description": "Landing Company short code", + "type": "string" + }, + "support_professional_client": { + "description": "Flag that indicates whether the landing company supports professional accounts or not", + "type": "integer", + "enum": [0, 1] + }, + "tin_not_mandatory": { + "description": "Flag that indicates whether tax identifier number is not mandatory for the current country and landing company.", + "type": "integer", + "enum": [0, 1] + } + } + } + } + }, + "financial_company": { + "description": "Landing Company for financial contracts (all except Synthetic Indices)", + "type": ["null", "object"], + "additionalProperties": false, + "properties": { + "address": { + "description": "Landing Company address", + "type": ["array", "null"], + "items": { + "type": "string" + } + }, + "changeable_fields": { + "description": "Special conditions for changing sensitive fields", + "type": "object" + }, + "country": { + "description": "Landing Company country of incorporation", + "type": "string" + }, + "currency_config": { + "title": "Currency Config Structure", + "description": "The configuration of each currency.", + "type": "object" + }, + "has_reality_check": { + "description": "Flag to indicate whether reality check is applicable for this Landing Company. `1`: applicable, `0`: not applicable. The Reality Check is a feature that gives a summary of the client's trades and account balances on a regular basis throughout his session, and is a regulatory requirement for certain Landing Companies.", + "type": "integer", + "enum": [1, 0] + }, + "legal_allowed_contract_categories": { + "description": "Allowed contract types for this Landing Company", + "type": "array", + "items": { + "type": "string" + } + }, + "legal_allowed_currencies": { + "description": "Allowed account currencies for this Landing Company", + "type": "array", + "items": { + "type": "string", + "pattern": "^[a-zA-Z0-9]{2,20}$" + } + }, + "legal_allowed_markets": { + "description": "Allowed markets for this Landing Company", + "type": "array", + "items": { + "type": "string" + } + }, + "legal_default_currency": { + "description": "Default account currency", + "type": "string", + "pattern": "^[a-zA-Z0-9]{2,20}$" + }, + "name": { + "description": "Landing Company legal name", + "type": "string" + }, + "requirements": { + "description": "Legal requirements for the Landing Company", + "type": "object", + "additionalProperties": false, + "properties": { + "after_first_deposit": { + "description": "After first deposit requirements", + "type": "object", + "additionalProperties": false, + "properties": { + "financial_assessment": { + "description": "Financial assessment requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["financial_information", "trading_experience"] + } } + } }, - "dxtrade_gaming_company": { - "description": "Available Deriv X gaming account types (Synthetic Indices).", - "type": "object", - "additionalProperties": false, - "properties": { - "standard": { - "description": "Landing Company details.", - "type": "object", - "additionalProperties": false, - "properties": { - "address": { - "description": "Landing Company address", - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - }, - "changeable_fields": { - "description": "Special conditions for changing sensitive fields", - "type": "object" - }, - "country": { - "description": "Landing Company country of incorporation", - "type": "string" - }, - "currency_config": { - "title": "Currency Config Structure", - "description": "The configuration of each currency.", - "type": "object" - }, - "has_reality_check": { - "description": "Flag to indicate whether reality check is applicable for this Landing Company. `1`: applicable, `0`: not applicable. The Reality Check is a feature that gives a summary of the client's trades and account balances on a regular basis throughout his session, and is a regulatory requirement for certain Landing Companies.", - "type": "integer", - "enum": [ - 0, - 1 - ] - }, - "legal_allowed_contract_categories": { - "description": "Allowed contract types", - "type": "array", - "items": { - "type": "string" - } - }, - "legal_allowed_currencies": { - "description": "Allowable currencies", - "type": "array", - "items": { - "type": "string" - } - }, - "legal_allowed_markets": { - "description": "Allowable markets", - "type": "array", - "items": { - "type": "string" - } - }, - "legal_default_currency": { - "description": "Default account currency", - "type": "string" - }, - "name": { - "description": "Landing Company legal name", - "type": "string" - }, - "requirements": { - "description": "Legal requirements for the Landing Company", - "type": "object", - "additionalProperties": false, - "properties": { - "after_first_deposit": { - "description": "After first deposit requirements", - "type": "object", - "additionalProperties": false, - "properties": { - "financial_assessment": { - "description": "Financial assessment requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "financial_information", - "trading_experience" - ] - } - } - } - }, - "compliance": { - "description": "Compliance requirements", - "type": "object", - "additionalProperties": false, - "properties": { - "mt5": { - "description": "Compliance MT5 requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "expiration_check", - "fully_authenticated" - ] - } - }, - "tax_information": { - "description": "Compliance tax information requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "tax_identification_number", - "tax_residence" - ] - } - } - } - }, - "signup": { - "description": "Sign up requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "first_name", - "residence", - "salutation" - ] - } - }, - "withdrawal": { - "description": "Withdrawal requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "address_city", - "address_line_1" - ] - } - } - } - }, - "shortcode": { - "description": "Landing Company short code", - "type": "string" - }, - "support_professional_client": { - "description": "Flag that indicates whether the landing company supports professional accounts or not", - "type": "integer", - "enum": [ - 0, - 1 - ] - }, - "tin_not_mandatory": { - "description": "Flag that indicates whether tax identifier number is not mandatory for the current country and landing company.", - "type": "integer", - "enum": [ - 0, - 1 - ] - } - } - } + "compliance": { + "description": "Compliance requirements", + "type": "object", + "additionalProperties": false, + "properties": { + "mt5": { + "description": "Compliance MT5 requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["expiration_check", "fully_authenticated"] + } + }, + "tax_information": { + "description": "Compliance tax information requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["tax_identification_number", "tax_residence"] + } } + } }, - "financial_company": { - "description": "Landing Company for financial contracts (all except Synthetic Indices)", - "type": [ - "null", - "object" - ], - "additionalProperties": false, - "properties": { - "address": { - "description": "Landing Company address", - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - }, - "changeable_fields": { - "description": "Special conditions for changing sensitive fields", - "type": "object" - }, - "country": { - "description": "Landing Company country of incorporation", - "type": "string" - }, - "currency_config": { - "title": "Currency Config Structure", - "description": "The configuration of each currency.", - "type": "object" - }, - "has_reality_check": { - "description": "Flag to indicate whether reality check is applicable for this Landing Company. `1`: applicable, `0`: not applicable. The Reality Check is a feature that gives a summary of the client's trades and account balances on a regular basis throughout his session, and is a regulatory requirement for certain Landing Companies.", - "type": "integer", - "enum": [ - 1, - 0 - ] - }, - "legal_allowed_contract_categories": { - "description": "Allowed contract types for this Landing Company", - "type": "array", - "items": { - "type": "string" - } - }, - "legal_allowed_currencies": { - "description": "Allowed account currencies for this Landing Company", - "type": "array", - "items": { - "type": "string", - "pattern": "^[a-zA-Z0-9]{2,20}$" - } - }, - "legal_allowed_markets": { - "description": "Allowed markets for this Landing Company", - "type": "array", - "items": { - "type": "string" - } - }, - "legal_default_currency": { - "description": "Default account currency", + "signup": { + "description": "Sign up requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["first_name", "residence", "salutation"] + } + }, + "withdrawal": { + "description": "Withdrawal requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["address_city", "address_line_1"] + } + } + } + }, + "shortcode": { + "description": "Landing Company short code", + "type": "string" + }, + "support_professional_client": { + "description": "Flag that indicates whether the landing company supports professional accounts or not", + "type": "integer", + "enum": [0, 1] + }, + "tin_not_mandatory": { + "description": "Flag that indicates whether tax identifier number is not mandatory for the current country and landing company.", + "type": "integer", + "enum": [0, 1] + } + } + }, + "forbidden_postcode_pattern": { + "description": "Forbidden postcode pattern", + "type": "string" + }, + "gaming_company": { + "description": "Landing Company for derived contracts (Synthetic Indices)", + "type": ["null", "object"], + "additionalProperties": false, + "properties": { + "address": { + "description": "Landing Company address", + "type": ["array", "null"], + "items": { + "type": "string" + } + }, + "changeable_fields": { + "description": "Special conditions for changing sensitive fields", + "type": "object" + }, + "country": { + "description": "Landing Company country of incorporation", + "type": "string" + }, + "currency_config": { + "title": "Currency Config Structure", + "description": "The configuration of each currency.", + "type": "object" + }, + "has_reality_check": { + "description": "Flag to indicate whether reality check is applicable for this Landing Company. `1`: applicable, `0`: not applicable. The Reality Check is a feature that gives a summary of the client's trades and account balances on a regular basis throughout his session, and is a regulatory requirement for certain Landing Companies.", + "type": "integer", + "enum": [0, 1] + }, + "legal_allowed_contract_categories": { + "description": "Allowed contract types", + "type": "array", + "items": { + "type": "string" + } + }, + "legal_allowed_currencies": { + "description": "Allowable currencies", + "type": "array", + "items": { + "type": "string" + } + }, + "legal_allowed_markets": { + "description": "Allowable markets", + "type": "array", + "items": { + "type": "string" + } + }, + "legal_default_currency": { + "description": "Default account currency", + "type": "string" + }, + "name": { + "description": "Landing Company legal name", + "type": "string" + }, + "requirements": { + "description": "Legal requirements for the Landing Company", + "type": "object", + "additionalProperties": false, + "properties": { + "after_first_deposit": { + "description": "After first deposit requirements", + "type": "object", + "additionalProperties": false, + "properties": { + "financial_assessment": { + "description": "Financial assessment requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["financial_information", "trading_experience"] + } + } + } + }, + "compliance": { + "description": "Compliance requirements", + "type": "object", + "additionalProperties": false, + "properties": { + "mt5": { + "description": "Compliance MT5 requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["expiration_check", "fully_authenticated"] + } + }, + "tax_information": { + "description": "Compliance tax information requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["tax_identification_number", "tax_residence"] + } + } + } + }, + "signup": { + "description": "Sign up requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["first_name", "residence", "salutation"] + } + }, + "withdrawal": { + "description": "Withdrawal requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["address_city", "address_line_1"] + } + } + } + }, + "shortcode": { + "description": "Landing Company short code", + "type": "string" + }, + "support_professional_client": { + "description": "Flag that indicates whether the landing company supports professional accounts or not", + "type": "integer", + "enum": [0, 1] + }, + "tin_not_mandatory": { + "description": "Flag that indicates whether tax identifier number is not mandatory for the current country and landing company.", + "type": "integer", + "enum": [0, 1] + } + } + }, + "id": { + "description": "Country code", + "type": "string" + }, + "is_idv_supported": { + "description": "Flag to indicate if idv is supported or not", + "type": "integer", + "enum": [1, 0] + }, + "lc_to_open_mf_account": { + "description": "Open mf account lc details.", + "type": "string" + }, + "minimum_age": { + "description": "Minimum age", + "type": "integer" + }, + "mt5_age_verification": { + "description": "Flag to indicate if mt5 age verification detail.", + "type": "integer", + "enum": [1, 0] + }, + "mt_all_company": { + "description": "Landing Company for MT5 standard combined all Synthetic and financial, currently has Financial as subtype.", + "type": ["null", "object"], + "additionalProperties": false, + "properties": { + "swap_free": { + "description": "Landing Company for MT5 combined all Synthetic and financial", + "type": ["null", "object"], + "additionalProperties": false, + "properties": { + "address": { + "description": "Landing Company address", + "type": ["array", "null"], + "items": { + "type": "string" + } + }, + "changeable_fields": { + "description": "Special conditions for changing sensitive fields", + "type": "object" + }, + "country": { + "description": "Landing Company country of incorporation", + "type": "string" + }, + "currency_config": { + "title": "Currency Config Structure", + "description": "The configuration of each currency.", + "type": "object" + }, + "has_reality_check": { + "description": "Flag to indicate whether reality check is applicable for this Landing Company. `1`: applicable, `0`: not applicable. The Reality Check is a feature that gives a summary of the client's trades and account balances on a regular basis throughout his session, and is a regulatory requirement for certain Landing Companies.", + "type": "integer", + "enum": [0, 1] + }, + "legal_allowed_contract_categories": { + "description": "Allowed contract types", + "type": "array", + "items": { + "type": "string" + } + }, + "legal_allowed_currencies": { + "description": "Allowable currencies", + "type": "array", + "items": { + "type": "string" + } + }, + "legal_allowed_markets": { + "description": "Allowable markets", + "type": "array", + "items": { + "type": "string" + } + }, + "legal_default_currency": { + "description": "Default account currency", + "type": "string" + }, + "name": { + "description": "Landing Company legal name", + "type": "string" + }, + "requirements": { + "description": "Legal requirements for the Landing Company", + "type": "object", + "additionalProperties": false, + "properties": { + "after_first_deposit": { + "description": "After first deposit requirements", + "type": "object", + "additionalProperties": false, + "properties": { + "financial_assessment": { + "description": "Financial assessment requirements", + "type": "array", + "items": { "type": "string", - "pattern": "^[a-zA-Z0-9]{2,20}$" - }, - "name": { - "description": "Landing Company legal name", - "type": "string" - }, - "requirements": { - "description": "Legal requirements for the Landing Company", - "type": "object", - "additionalProperties": false, - "properties": { - "after_first_deposit": { - "description": "After first deposit requirements", - "type": "object", - "additionalProperties": false, - "properties": { - "financial_assessment": { - "description": "Financial assessment requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "financial_information", - "trading_experience" - ] - } - } - } - }, - "compliance": { - "description": "Compliance requirements", - "type": "object", - "additionalProperties": false, - "properties": { - "mt5": { - "description": "Compliance MT5 requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "expiration_check", - "fully_authenticated" - ] - } - }, - "tax_information": { - "description": "Compliance tax information requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "tax_identification_number", - "tax_residence" - ] - } - } - } - }, - "signup": { - "description": "Sign up requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "first_name", - "residence", - "salutation" - ] - } - }, - "withdrawal": { - "description": "Withdrawal requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "address_city", - "address_line_1" - ] - } - } - } - }, - "shortcode": { - "description": "Landing Company short code", - "type": "string" - }, - "support_professional_client": { - "description": "Flag that indicates whether the landing company supports professional accounts or not", - "type": "integer", - "enum": [ - 0, - 1 - ] + "examples": ["financial_information", "trading_experience"] + } + } + } + }, + "compliance": { + "description": "Compliance requirements", + "type": "object", + "additionalProperties": false, + "properties": { + "mt5": { + "description": "Compliance MT5 requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["expiration_check", "fully_authenticated"] + } }, - "tin_not_mandatory": { - "description": "Flag that indicates whether tax identifier number is not mandatory for the current country and landing company.", - "type": "integer", - "enum": [ - 0, - 1 - ] + "tax_information": { + "description": "Compliance tax information requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["tax_identification_number", "tax_residence"] + } } + } + }, + "signup": { + "description": "Sign up requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["first_name", "residence", "salutation"] + } + }, + "withdrawal": { + "description": "Withdrawal requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["address_city", "address_line_1"] + } } + } + }, + "shortcode": { + "description": "Landing Company short code", + "type": "string" }, - "forbidden_postcode_pattern": { - "description": "Forbidden postcode pattern", + "support_professional_client": { + "description": "Flag that indicates whether the landing company supports professional accounts or not", + "type": "integer", + "enum": [0, 1] + }, + "tin_not_mandatory": { + "description": "Flag that indicates whether tax identifier number is not mandatory for the current country and landing company.", + "type": "integer", + "enum": [0, 1] + } + } + } + } + }, + "mt_financial_company": { + "description": "Landing Company for MT5 financial contracts (all except Synthetic Indices), currently divided into Financial STP, Financial (standard) as subtypes.", + "type": ["null", "object"], + "additionalProperties": false, + "properties": { + "financial": { + "description": "Contain details for landing company for financial subtype. The Financial account is suitable for a wide range of traders, both new and experienced. It gives you mid-range leverage and variable spreads that give you a great deal of flexibility for whatever position you wish to take in the market.", + "type": ["null", "object"], + "additionalProperties": false, + "properties": { + "address": { + "description": "Landing Company address", + "type": ["array", "null"], + "items": { "type": "string" + } }, - "gaming_company": { - "description": "Landing Company for gaming contracts (Synthetic Indices)", - "type": [ - "null", - "object" - ], - "additionalProperties": false, - "properties": { - "address": { - "description": "Landing Company address", - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - }, - "changeable_fields": { - "description": "Special conditions for changing sensitive fields", - "type": "object" - }, - "country": { - "description": "Landing Company country of incorporation", - "type": "string" - }, - "currency_config": { - "title": "Currency Config Structure", - "description": "The configuration of each currency.", - "type": "object" - }, - "has_reality_check": { - "description": "Flag to indicate whether reality check is applicable for this Landing Company. `1`: applicable, `0`: not applicable. The Reality Check is a feature that gives a summary of the client's trades and account balances on a regular basis throughout his session, and is a regulatory requirement for certain Landing Companies.", - "type": "integer", - "enum": [ - 0, - 1 - ] - }, - "legal_allowed_contract_categories": { - "description": "Allowed contract types", - "type": "array", - "items": { - "type": "string" - } - }, - "legal_allowed_currencies": { - "description": "Allowable currencies", - "type": "array", - "items": { - "type": "string" - } - }, - "legal_allowed_markets": { - "description": "Allowable markets", - "type": "array", - "items": { - "type": "string" - } - }, - "legal_default_currency": { - "description": "Default account currency", - "type": "string" - }, - "name": { - "description": "Landing Company legal name", - "type": "string" - }, - "requirements": { - "description": "Legal requirements for the Landing Company", - "type": "object", - "additionalProperties": false, - "properties": { - "after_first_deposit": { - "description": "After first deposit requirements", - "type": "object", - "additionalProperties": false, - "properties": { - "financial_assessment": { - "description": "Financial assessment requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "financial_information", - "trading_experience" - ] - } - } - } - }, - "compliance": { - "description": "Compliance requirements", - "type": "object", - "additionalProperties": false, - "properties": { - "mt5": { - "description": "Compliance MT5 requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "expiration_check", - "fully_authenticated" - ] - } - }, - "tax_information": { - "description": "Compliance tax information requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "tax_identification_number", - "tax_residence" - ] - } - } - } - }, - "signup": { - "description": "Sign up requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "first_name", - "residence", - "salutation" - ] - } - }, - "withdrawal": { - "description": "Withdrawal requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "address_city", - "address_line_1" - ] - } - } - } - }, - "shortcode": { - "description": "Landing Company short code", - "type": "string" - }, - "support_professional_client": { - "description": "Flag that indicates whether the landing company supports professional accounts or not", - "type": "integer", - "enum": [ - 0, - 1 - ] + "changeable_fields": { + "description": "Special conditions for changing sensitive fields", + "type": "object" + }, + "country": { + "description": "Landing Company country of incorporation", + "type": "string" + }, + "currency_config": { + "title": "Currency Config Structure", + "description": "The configuration of each currency.", + "type": "object" + }, + "has_reality_check": { + "description": "Flag to indicate whether reality check is applicable for this Landing Company. `1`: applicable, `0`: not applicable. The Reality Check is a feature that gives a summary of the client's trades and account balances on a regular basis throughout his session, and is a regulatory requirement for certain Landing Companies.", + "type": "integer", + "enum": [0, 1] + }, + "legal_allowed_contract_categories": { + "description": "Allowed contract types for this Landing Company", + "type": "array", + "items": { + "type": "string" + } + }, + "legal_allowed_currencies": { + "description": "Allowed account currencies for this Landing Company", + "type": "array", + "items": { + "type": "string" + } + }, + "legal_allowed_markets": { + "description": "Allowed markets for this Landing Company", + "type": "array", + "items": { + "type": "string" + } + }, + "legal_default_currency": { + "description": "Default account currency", + "type": "string" + }, + "name": { + "description": "Landing Company legal name", + "type": "string" + }, + "requirements": { + "description": "Legal requirements for the Landing Company", + "type": "object", + "additionalProperties": false, + "properties": { + "after_first_deposit": { + "description": "After first deposit requirements", + "type": "object", + "additionalProperties": false, + "properties": { + "financial_assessment": { + "description": "Financial assessment requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["financial_information", "trading_experience"] + } + } + } + }, + "compliance": { + "description": "Compliance requirements", + "type": "object", + "additionalProperties": false, + "properties": { + "mt5": { + "description": "Compliance MT5 requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["expiration_check", "fully_authenticated"] + } }, - "tin_not_mandatory": { - "description": "Flag that indicates whether tax identifier number is not mandatory for the current country and landing company.", - "type": "integer", - "enum": [ - 0, - 1 - ] + "tax_information": { + "description": "Compliance tax information requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["tax_identification_number", "tax_residence"] + } } + } + }, + "signup": { + "description": "Sign up requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["first_name", "residence", "salutation"] + } + }, + "withdrawal": { + "description": "Withdrawal requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["address_city", "address_line_1"] + } } + } + }, + "shortcode": { + "description": "Landing Company short code", + "type": "string" + }, + "support_professional_client": { + "description": "Flag that indicates whether the landing company supports professional accounts or not", + "type": "integer", + "enum": [0, 1] + }, + "tin_not_mandatory": { + "description": "Flag that indicates whether tax identifier number is not mandatory for the current country and landing company.", + "type": "integer", + "enum": [0, 1] + } + } + }, + "financial_stp": { + "description": "Contain details for landing company for Financial STP subtype. The Financial STP account provides you with tight spreads, higher ticket size and offers a variety of FX pairs from majors to exotics. It is a straight through processing (STP) account with direct access to FX liquidity from various providers.", + "type": ["null", "object"], + "additionalProperties": false, + "properties": { + "address": { + "description": "Landing Company address", + "type": ["array", "null"], + "items": { + "type": "string" + } }, - "id": { - "description": "Country code", + "changeable_fields": { + "description": "Special conditions for changing sensitive fields", + "type": "object" + }, + "country": { + "description": "Landing Company country of incorporation", + "type": "string" + }, + "currency_config": { + "title": "Currency Config Structure", + "description": "The configuration of each currency.", + "type": "object" + }, + "has_reality_check": { + "description": "Flag to indicate whether reality check is applicable for this Landing Company. `1`: applicable, `0`: not applicable. The Reality Check is a feature that gives a summary of the client's trades and account balances on a regular basis throughout his session, and is a regulatory requirement for certain Landing Companies.", + "type": "integer", + "enum": [0, 1] + }, + "legal_allowed_contract_categories": { + "description": "Allowed contract types for this Landing Company", + "type": "array", + "items": { "type": "string" + } }, - "is_idv_supported": { - "description": "Flag to indicate if idv is supported or not", - "type": "integer", - "enum": [ - 1, - 0 - ] + "legal_allowed_currencies": { + "description": "Allowed account currencies for this Landing Company", + "type": "array", + "items": { + "type": "string" + } }, - "lc_to_open_mf_account": { - "description": "Open mf account lc details.", + "legal_allowed_markets": { + "description": "Allowed markets for this Landing Company", + "type": "array", + "items": { "type": "string" + } }, - "minimum_age": { - "description": "Minimum age", - "type": "integer" - }, - "mt5_age_verification": { - "description": "Flag to indicate if mt5 age verification detail.", - "type": "integer", - "enum": [ - 1, - 0 - ] - }, - "mt_all_company": { - "description": "Landing Company for MT5 standard combined all Synthetic and financial, currently has Financial as subtype.", - "type": [ - "null", - "object" - ], - "additionalProperties": false, - "properties": { - "swap_free": { - "description": "Landing Company for MT5 combined all Synthetic and financial", - "type": [ - "null", - "object" - ], - "additionalProperties": false, - "properties": { - "address": { - "description": "Landing Company address", - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - }, - "changeable_fields": { - "description": "Special conditions for changing sensitive fields", - "type": "object" - }, - "country": { - "description": "Landing Company country of incorporation", - "type": "string" - }, - "currency_config": { - "title": "Currency Config Structure", - "description": "The configuration of each currency.", - "type": "object" - }, - "has_reality_check": { - "description": "Flag to indicate whether reality check is applicable for this Landing Company. `1`: applicable, `0`: not applicable. The Reality Check is a feature that gives a summary of the client's trades and account balances on a regular basis throughout his session, and is a regulatory requirement for certain Landing Companies.", - "type": "integer", - "enum": [ - 0, - 1 - ] - }, - "legal_allowed_contract_categories": { - "description": "Allowed contract types", - "type": "array", - "items": { - "type": "string" - } - }, - "legal_allowed_currencies": { - "description": "Allowable currencies", - "type": "array", - "items": { - "type": "string" - } - }, - "legal_allowed_markets": { - "description": "Allowable markets", - "type": "array", - "items": { - "type": "string" - } - }, - "legal_default_currency": { - "description": "Default account currency", - "type": "string" - }, - "name": { - "description": "Landing Company legal name", - "type": "string" - }, - "requirements": { - "description": "Legal requirements for the Landing Company", - "type": "object", - "additionalProperties": false, - "properties": { - "after_first_deposit": { - "description": "After first deposit requirements", - "type": "object", - "additionalProperties": false, - "properties": { - "financial_assessment": { - "description": "Financial assessment requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "financial_information", - "trading_experience" - ] - } - } - } - }, - "compliance": { - "description": "Compliance requirements", - "type": "object", - "additionalProperties": false, - "properties": { - "mt5": { - "description": "Compliance MT5 requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "expiration_check", - "fully_authenticated" - ] - } - }, - "tax_information": { - "description": "Compliance tax information requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "tax_identification_number", - "tax_residence" - ] - } - } - } - }, - "signup": { - "description": "Sign up requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "first_name", - "residence", - "salutation" - ] - } - }, - "withdrawal": { - "description": "Withdrawal requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "address_city", - "address_line_1" - ] - } - } - } - }, - "shortcode": { - "description": "Landing Company short code", - "type": "string" - }, - "support_professional_client": { - "description": "Flag that indicates whether the landing company supports professional accounts or not", - "type": "integer", - "enum": [ - 0, - 1 - ] - }, - "tin_not_mandatory": { - "description": "Flag that indicates whether tax identifier number is not mandatory for the current country and landing company.", - "type": "integer", - "enum": [ - 0, - 1 - ] - } - } - } - } + "legal_default_currency": { + "description": "Default account currency", + "type": "string" }, - "mt_financial_company": { - "description": "Landing Company for MT5 financial contracts (all except Synthetic Indices), currently divided into Financial STP, Financial (standard) as subtypes.", - "type": [ - "null", - "object" - ], - "additionalProperties": false, - "properties": { - "financial": { - "description": "Contain details for landing company for financial subtype. The Financial account is suitable for a wide range of traders, both new and experienced. It gives you mid-range leverage and variable spreads that give you a great deal of flexibility for whatever position you wish to take in the market.", - "type": [ - "null", - "object" - ], - "additionalProperties": false, - "properties": { - "address": { - "description": "Landing Company address", - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - }, - "changeable_fields": { - "description": "Special conditions for changing sensitive fields", - "type": "object" - }, - "country": { - "description": "Landing Company country of incorporation", - "type": "string" - }, - "currency_config": { - "title": "Currency Config Structure", - "description": "The configuration of each currency.", - "type": "object" - }, - "has_reality_check": { - "description": "Flag to indicate whether reality check is applicable for this Landing Company. `1`: applicable, `0`: not applicable. The Reality Check is a feature that gives a summary of the client's trades and account balances on a regular basis throughout his session, and is a regulatory requirement for certain Landing Companies.", - "type": "integer", - "enum": [ - 0, - 1 - ] - }, - "legal_allowed_contract_categories": { - "description": "Allowed contract types for this Landing Company", - "type": "array", - "items": { - "type": "string" - } - }, - "legal_allowed_currencies": { - "description": "Allowed account currencies for this Landing Company", - "type": "array", - "items": { - "type": "string" - } - }, - "legal_allowed_markets": { - "description": "Allowed markets for this Landing Company", - "type": "array", - "items": { - "type": "string" - } - }, - "legal_default_currency": { - "description": "Default account currency", - "type": "string" - }, - "name": { - "description": "Landing Company legal name", - "type": "string" - }, - "requirements": { - "description": "Legal requirements for the Landing Company", - "type": "object", - "additionalProperties": false, - "properties": { - "after_first_deposit": { - "description": "After first deposit requirements", - "type": "object", - "additionalProperties": false, - "properties": { - "financial_assessment": { - "description": "Financial assessment requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "financial_information", - "trading_experience" - ] - } - } - } - }, - "compliance": { - "description": "Compliance requirements", - "type": "object", - "additionalProperties": false, - "properties": { - "mt5": { - "description": "Compliance MT5 requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "expiration_check", - "fully_authenticated" - ] - } - }, - "tax_information": { - "description": "Compliance tax information requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "tax_identification_number", - "tax_residence" - ] - } - } - } - }, - "signup": { - "description": "Sign up requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "first_name", - "residence", - "salutation" - ] - } - }, - "withdrawal": { - "description": "Withdrawal requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "address_city", - "address_line_1" - ] - } - } - } - }, - "shortcode": { - "description": "Landing Company short code", - "type": "string" - }, - "support_professional_client": { - "description": "Flag that indicates whether the landing company supports professional accounts or not", - "type": "integer", - "enum": [ - 0, - 1 - ] - }, - "tin_not_mandatory": { - "description": "Flag that indicates whether tax identifier number is not mandatory for the current country and landing company.", - "type": "integer", - "enum": [ - 0, - 1 - ] - } - } + "name": { + "description": "Landing Company legal name", + "type": "string" + }, + "requirements": { + "description": "Legal requirements for the Landing Company", + "type": "object", + "additionalProperties": false, + "properties": { + "after_first_deposit": { + "description": "After first deposit requirements", + "type": "object", + "additionalProperties": false, + "properties": { + "financial_assessment": { + "description": "Financial assessment requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["financial_information", "trading_experience"] + } + } + } + }, + "compliance": { + "description": "Compliance requirements", + "type": "object", + "additionalProperties": false, + "properties": { + "mt5": { + "description": "Compliance MT5 requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["expiration_check", "fully_authenticated"] + } }, - "financial_stp": { - "description": "Contain details for landing company for Financial STP subtype. The Financial STP account provides you with tight spreads, higher ticket size and offers a variety of FX pairs from majors to exotics. It is a straight through processing (STP) account with direct access to FX liquidity from various providers.", - "type": [ - "null", - "object" - ], - "additionalProperties": false, - "properties": { - "address": { - "description": "Landing Company address", - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - }, - "changeable_fields": { - "description": "Special conditions for changing sensitive fields", - "type": "object" - }, - "country": { - "description": "Landing Company country of incorporation", - "type": "string" - }, - "currency_config": { - "title": "Currency Config Structure", - "description": "The configuration of each currency.", - "type": "object" - }, - "has_reality_check": { - "description": "Flag to indicate whether reality check is applicable for this Landing Company. `1`: applicable, `0`: not applicable. The Reality Check is a feature that gives a summary of the client's trades and account balances on a regular basis throughout his session, and is a regulatory requirement for certain Landing Companies.", - "type": "integer", - "enum": [ - 0, - 1 - ] - }, - "legal_allowed_contract_categories": { - "description": "Allowed contract types for this Landing Company", - "type": "array", - "items": { - "type": "string" - } - }, - "legal_allowed_currencies": { - "description": "Allowed account currencies for this Landing Company", - "type": "array", - "items": { - "type": "string" - } - }, - "legal_allowed_markets": { - "description": "Allowed markets for this Landing Company", - "type": "array", - "items": { - "type": "string" - } - }, - "legal_default_currency": { - "description": "Default account currency", - "type": "string" - }, - "name": { - "description": "Landing Company legal name", - "type": "string" - }, - "requirements": { - "description": "Legal requirements for the Landing Company", - "type": "object", - "additionalProperties": false, - "properties": { - "after_first_deposit": { - "description": "After first deposit requirements", - "type": "object", - "additionalProperties": false, - "properties": { - "financial_assessment": { - "description": "Financial assessment requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "financial_information", - "trading_experience" - ] - } - } - } - }, - "compliance": { - "description": "Compliance requirements", - "type": "object", - "additionalProperties": false, - "properties": { - "mt5": { - "description": "Compliance MT5 requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "expiration_check", - "fully_authenticated" - ] - } - }, - "tax_information": { - "description": "Compliance tax information requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "tax_identification_number", - "tax_residence" - ] - } - } - } - }, - "signup": { - "description": "Sign up requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "first_name", - "residence", - "salutation" - ] - } - }, - "withdrawal": { - "description": "Withdrawal requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "address_city", - "address_line_1" - ] - } - } - } - }, - "shortcode": { - "description": "Landing Company short code", - "type": "string" - }, - "support_professional_client": { - "description": "Flag that indicates whether the landing company supports professional accounts or not", - "type": "integer", - "enum": [ - 0, - 1 - ] - }, - "tin_not_mandatory": { - "description": "Flag that indicates whether tax identifier number is not mandatory for the current country and landing company.", - "type": "integer", - "enum": [ - 0, - 1 - ] - } - } + "tax_information": { + "description": "Compliance tax information requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["tax_identification_number", "tax_residence"] + } } + } + }, + "signup": { + "description": "Sign up requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["first_name", "residence", "salutation"] + } + }, + "withdrawal": { + "description": "Withdrawal requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["address_city", "address_line_1"] + } } + } }, - "mt_gaming_company": { - "description": "Landing Company for MT5 standard gaming contracts (Synthetic Indices), currently has Financial as subtype.", - "type": [ - "null", - "object" - ], - "additionalProperties": false, - "properties": { - "financial": { - "description": "Landing Company for MT5 gaming contracts (Synthetic Indices)", - "type": [ - "null", - "object" - ], - "additionalProperties": false, - "properties": { - "address": { - "description": "Landing Company address", - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - }, - "changeable_fields": { - "description": "Special conditions for changing sensitive fields", - "type": "object" - }, - "country": { - "description": "Landing Company country of incorporation", - "type": "string" - }, - "currency_config": { - "title": "Currency Config Structure", - "description": "The configuration of each currency.", - "type": "object" - }, - "has_reality_check": { - "description": "Flag to indicate whether reality check is applicable for this Landing Company. `1`: applicable, `0`: not applicable. The Reality Check is a feature that gives a summary of the client's trades and account balances on a regular basis throughout his session, and is a regulatory requirement for certain Landing Companies.", - "type": "integer", - "enum": [ - 0, - 1 - ] - }, - "legal_allowed_contract_categories": { - "description": "Allowed contract types", - "type": "array", - "items": { - "type": "string" - } - }, - "legal_allowed_currencies": { - "description": "Allowable currencies", - "type": "array", - "items": { - "type": "string" - } - }, - "legal_allowed_markets": { - "description": "Allowable markets", - "type": "array", - "items": { - "type": "string" - } - }, - "legal_default_currency": { - "description": "Default account currency", - "type": "string" - }, - "name": { - "description": "Landing Company legal name", - "type": "string" - }, - "requirements": { - "description": "Legal requirements for the Landing Company", - "type": "object", - "additionalProperties": false, - "properties": { - "after_first_deposit": { - "description": "After first deposit requirements", - "type": "object", - "additionalProperties": false, - "properties": { - "financial_assessment": { - "description": "Financial assessment requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "financial_information", - "trading_experience" - ] - } - } - } - }, - "compliance": { - "description": "Compliance requirements", - "type": "object", - "additionalProperties": false, - "properties": { - "mt5": { - "description": "Compliance MT5 requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "expiration_check", - "fully_authenticated" - ] - } - }, - "tax_information": { - "description": "Compliance tax information requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "tax_identification_number", - "tax_residence" - ] - } - } - } - }, - "signup": { - "description": "Sign up requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "first_name", - "residence", - "salutation" - ] - } - }, - "withdrawal": { - "description": "Withdrawal requirements", - "type": "array", - "items": { - "type": "string", - "examples": [ - "address_city", - "address_line_1" - ] - } - } - } - }, - "shortcode": { - "description": "Landing Company short code", - "type": "string" - }, - "support_professional_client": { - "description": "Flag that indicates whether the landing company supports professional accounts or not", - "type": "integer", - "enum": [ - 0, - 1 - ] - }, - "tin_not_mandatory": { - "description": "Flag that indicates whether tax identifier number is not mandatory for the current country and landing company.", - "type": "integer", - "enum": [ - 0, - 1 - ] - } - } - } - } + "shortcode": { + "description": "Landing Company short code", + "type": "string" }, - "name": { - "description": "Country name", + "support_professional_client": { + "description": "Flag that indicates whether the landing company supports professional accounts or not", + "type": "integer", + "enum": [0, 1] + }, + "tin_not_mandatory": { + "description": "Flag that indicates whether tax identifier number is not mandatory for the current country and landing company.", + "type": "integer", + "enum": [0, 1] + } + } + } + } + }, + "mt_gaming_company": { + "description": "Landing Company for MT5 standard derived contracts (Synthetic Indices), currently has Financial as subtype.", + "type": ["null", "object"], + "additionalProperties": false, + "properties": { + "financial": { + "description": "Landing Company for MT5 derived contracts (Synthetic Indices)", + "type": ["null", "object"], + "additionalProperties": false, + "properties": { + "address": { + "description": "Landing Company address", + "type": ["array", "null"], + "items": { + "type": "string" + } + }, + "changeable_fields": { + "description": "Special conditions for changing sensitive fields", + "type": "object" + }, + "country": { + "description": "Landing Company country of incorporation", + "type": "string" + }, + "currency_config": { + "title": "Currency Config Structure", + "description": "The configuration of each currency.", + "type": "object" + }, + "has_reality_check": { + "description": "Flag to indicate whether reality check is applicable for this Landing Company. `1`: applicable, `0`: not applicable. The Reality Check is a feature that gives a summary of the client's trades and account balances on a regular basis throughout his session, and is a regulatory requirement for certain Landing Companies.", + "type": "integer", + "enum": [0, 1] + }, + "legal_allowed_contract_categories": { + "description": "Allowed contract types", + "type": "array", + "items": { + "type": "string" + } + }, + "legal_allowed_currencies": { + "description": "Allowable currencies", + "type": "array", + "items": { "type": "string" + } }, - "need_set_max_turnover_limit": { - "description": "Flag to indicate whether max turnover limit settings.", - "type": "integer", - "enum": [ - 0, - 1 - ] - }, - "no_province": { - "description": "Flag to indicate province settings.", - "type": "integer", - "enum": [ - 0, - 1 - ] - }, - "require_address_postcode": { - "description": "Flag to indicate whether address postcode is required or not.", - "type": "integer", - "enum": [ - 0, - 1 - ] - }, - "require_age_verified_for_synthetic": { - "description": "Flag to indicate whether age verification required ofr synthetic or not.", - "type": "integer", - "enum": [ - 0, - 1 - ] - }, - "require_poi": { - "description": "Flag to indicate whether poi is required.", - "type": "integer", - "enum": [ - 0, - 1 - ] - }, - "require_verification_when_not_age_verified": { - "description": "Flag to indicate whether verification required if age not verified.", - "type": "integer", - "enum": [ - 0, - 1 - ] - }, - "skip_deposit_verification": { - "description": "Flag to indicate whether to skip deposit verifcation or not.", - "type": "integer", - "enum": [ - 0, - 1 - ] - }, - "ukgc_funds_protection": { - "description": "Flag to indicate ukgc funds protection setting.", - "type": "integer", - "enum": [ - 0, - 1 - ] - }, - "virtual_company": { - "description": "Virtual Company", + "legal_allowed_markets": { + "description": "Allowable markets", + "type": "array", + "items": { "type": "string" + } + }, + "legal_default_currency": { + "description": "Default account currency", + "type": "string" + }, + "name": { + "description": "Landing Company legal name", + "type": "string" + }, + "requirements": { + "description": "Legal requirements for the Landing Company", + "type": "object", + "additionalProperties": false, + "properties": { + "after_first_deposit": { + "description": "After first deposit requirements", + "type": "object", + "additionalProperties": false, + "properties": { + "financial_assessment": { + "description": "Financial assessment requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["financial_information", "trading_experience"] + } + } + } + }, + "compliance": { + "description": "Compliance requirements", + "type": "object", + "additionalProperties": false, + "properties": { + "mt5": { + "description": "Compliance MT5 requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["expiration_check", "fully_authenticated"] + } + }, + "tax_information": { + "description": "Compliance tax information requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["tax_identification_number", "tax_residence"] + } + } + } + }, + "signup": { + "description": "Sign up requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["first_name", "residence", "salutation"] + } + }, + "withdrawal": { + "description": "Withdrawal requirements", + "type": "array", + "items": { + "type": "string", + "examples": ["address_city", "address_line_1"] + } + } + } + }, + "shortcode": { + "description": "Landing Company short code", + "type": "string" + }, + "support_professional_client": { + "description": "Flag that indicates whether the landing company supports professional accounts or not", + "type": "integer", + "enum": [0, 1] + }, + "tin_not_mandatory": { + "description": "Flag that indicates whether tax identifier number is not mandatory for the current country and landing company.", + "type": "integer", + "enum": [0, 1] } + } } + } + }, + "name": { + "description": "Country name", + "type": "string" + }, + "need_set_max_turnover_limit": { + "description": "Flag to indicate whether max turnover limit settings.", + "type": "integer", + "enum": [0, 1] + }, + "no_province": { + "description": "Flag to indicate province settings.", + "type": "integer", + "enum": [0, 1] + }, + "require_address_postcode": { + "description": "Flag to indicate whether address postcode is required or not.", + "type": "integer", + "enum": [0, 1] + }, + "require_age_verified_for_synthetic": { + "description": "Flag to indicate whether age verification required ofr synthetic or not.", + "type": "integer", + "enum": [0, 1] + }, + "require_poi": { + "description": "Flag to indicate whether poi is required.", + "type": "integer", + "enum": [0, 1] + }, + "require_verification_when_not_age_verified": { + "description": "Flag to indicate whether verification required if age not verified.", + "type": "integer", + "enum": [0, 1] }, - "echo_req": { - "description": "Echo of the request made.", - "type": "object" + "skip_deposit_verification": { + "description": "Flag to indicate whether to skip deposit verifcation or not.", + "type": "integer", + "enum": [0, 1] }, - "msg_type": { - "description": "Action name of the request made.", - "type": "string", - "enum": [ - "landing_company" - ] + "ukgc_funds_protection": { + "description": "Flag to indicate ukgc funds protection setting.", + "type": "integer", + "enum": [0, 1] }, - "req_id": { - "description": "Optional field sent in request to map to response, present only when request contains `req_id`.", - "type": "integer" + "virtual_company": { + "description": "Virtual Company", + "type": "string" } + } + }, + "echo_req": { + "description": "Echo of the request made.", + "type": "object" + }, + "msg_type": { + "description": "Action name of the request made.", + "type": "string", + "enum": ["landing_company"] + }, + "req_id": { + "description": "Optional field sent in request to map to response, present only when request contains `req_id`.", + "type": "integer" } + } } diff --git a/config/v3/landing_company/send.json b/config/v3/landing_company/send.json index 47248985e..fd472000e 100644 --- a/config/v3/landing_company/send.json +++ b/config/v3/landing_company/send.json @@ -1,28 +1,26 @@ { - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Landing Company (request)", - "description": "The company has a number of licensed subsidiaries in various jurisdictions, which are called Landing Companies. This call will return the appropriate Landing Company for clients of a given country. The landing company may differ for Gaming contracts (Synthetic Indices) and Financial contracts (Forex, Stock Indices, Commodities).", - "type": "object", - "auth_required": 0, - "additionalProperties": false, - "required": [ - "landing_company" - ], - "properties": { - "landing_company": { - "title": "Landing Company", - "description": "Client's 2-letter country code (obtained from `residence_list` call).", - "type": "string", - "pattern": "^\\w\\w$" - }, - "passthrough": { - "description": "[Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field. Maximum size is 3500 bytes.", - "type": "object", - "maxSize": 3500 - }, - "req_id": { - "description": "[Optional] Used to map request to response.", - "type": "integer" - } + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Landing Company (request)", + "description": "The company has a number of licensed subsidiaries in various jurisdictions, which are called Landing Companies. This call will return the appropriate Landing Company for clients of a given country. The landing company may differ for derived contracts (Synthetic Indices) and Financial contracts (Forex, Stock Indices, Commodities).", + "type": "object", + "auth_required": 0, + "additionalProperties": false, + "required": ["landing_company"], + "properties": { + "landing_company": { + "title": "Landing Company", + "description": "Client's 2-letter country code (obtained from `residence_list` call).", + "type": "string", + "pattern": "^\\w\\w$" + }, + "passthrough": { + "description": "[Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field. Maximum size is 3500 bytes.", + "type": "object", + "maxSize": 3500 + }, + "req_id": { + "description": "[Optional] Used to map request to response.", + "type": "integer" } + } }