Skip to content

Commit

Permalink
JSON Schema Update
Browse files Browse the repository at this point in the history
  • Loading branch information
Github Workflow committed Jun 22, 2024
1 parent 907dcd4 commit 3c3f77b
Show file tree
Hide file tree
Showing 5 changed files with 174 additions and 235 deletions.
359 changes: 165 additions & 194 deletions config/v3/landing_company/receive.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -970,12 +970,171 @@
"additionalProperties": false,
"properties": {
"swap_free": {
"$ref": "#/$defs/landingCompanyDetails",
"description": "Landing Company for MT5 combined all Synthetic and financial"
},
"zero_spread": {
"$ref": "#/$defs/landingCompanyDetails",
"description": "Contain details for landing company for zero_spread sub account type."
"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
]
}
}
}
}
},
Expand Down Expand Up @@ -1589,193 +1748,5 @@
"description": "Optional field sent in request to map to response, present only when request contains `req_id`.",
"type": "integer"
}
},
"$defs": {
"afterFirstDepositRequirements": {
"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"
]
}
}
}
},
"complianceRequirements": {
"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"
]
}
}
}
},
"landingCompanyDetails": {
"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": {
"$ref": "#/$defs/legalRequirements",
"description": "Legal requirements for the Landing Company"
},
"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
]
}
}
},
"legalRequirements": {
"description": "Legal requirements for the Landing Company",
"type": "object",
"additionalProperties": false,
"properties": {
"after_first_deposit": {
"$ref": "#/$defs/afterFirstDepositRequirements",
"description": "After first deposit requirements"
},
"compliance": {
"$ref": "#/$defs/complianceRequirements",
"description": "Compliance requirements"
},
"signup": {
"$ref": "#/$defs/signUpRequirements",
"description": "Sign up requirements"
},
"withdrawal": {
"$ref": "#/$defs/withdrawalRequirements",
"description": "Withdrawal requirements"
}
}
},
"signUpRequirements": {
"description": "Sign up requirements",
"type": "array",
"items": {
"type": "string",
"examples": [
"first_name",
"residence",
"salutation"
]
}
},
"withdrawalRequirements": {
"description": "Withdrawal requirements",
"type": "array",
"items": {
"type": "string",
"examples": [
"address_city",
"address_line_1"
]
}
}
}
}
Loading

0 comments on commit 3c3f77b

Please sign in to comment.