Skip to content

Commit

Permalink
JSON Schema Update
Browse files Browse the repository at this point in the history
  • Loading branch information
nobody committed Apr 30, 2024
1 parent de40eaf commit 589e144
Show file tree
Hide file tree
Showing 25 changed files with 469 additions and 77 deletions.
2 changes: 2 additions & 0 deletions _data/v3.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,8 @@ groups:
title: P2P Advertiser Update
- name: p2p_chat_create
title: P2P Chat Create
- name: p2p_country_list
title: P2P Country List
- name: p2p_order_cancel
title: P2P Order Cancel
- name: p2p_order_confirm
Expand Down
4 changes: 4 additions & 0 deletions config/v3/authorize/receive.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@
"description": "Currency of specified account.",
"type": "string"
},
"currency_type": {
"description": "Currency type for the corresponding currency.",
"type": "string"
},
"excluded_until": {
"description": "Epoch of date till client has excluded him/herself from the website, only present if client is self excluded.",
"type": "integer"
Expand Down
105 changes: 104 additions & 1 deletion config/v3/get_account_status/receive.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,101 @@
"expired",
"suspected"
]
},
"verified_jurisdiction": {
"description": "This represents the current status of authentication for each mt5 jurisdiction.",
"type": "object",
"additionalProperties": false,
"properties": {
"bvi": {
"description": "This represents whether the client is allowed or not to create an account under this jurisdiction",
"type": "integer",
"enum": [
0,
1
]
},
"dsl": {
"description": "This represents whether the client is allowed or not to create an account under this jurisdiction",
"type": "integer",
"enum": [
0,
1
]
},
"iom": {
"description": "This represents whether the client is allowed or not to create an account under this jurisdiction",
"type": "integer",
"enum": [
0,
1
]
},
"labuan": {
"description": "This represents whether the client is allowed or not to create an account under this jurisdiction",
"type": "integer",
"enum": [
0,
1
]
},
"malta": {
"description": "This represents whether the client is allowed or not to create an account under this jurisdiction",
"type": "integer",
"enum": [
0,
1
]
},
"maltainvest": {
"description": "This represents whether the client is allowed or not to create an account under this jurisdiction",
"type": "integer",
"enum": [
0,
1
]
},
"samoa": {
"description": "This represents whether the client is allowed or not to create an account under this jurisdiction",
"type": "integer",
"enum": [
0,
1
]
},
"samoa-virtual": {
"description": "This represents whether the client is allowed or not to create an account under this jurisdiction",
"type": "integer",
"enum": [
0,
1
]
},
"svg": {
"description": "This represents whether the client is allowed or not to create an account under this jurisdiction",
"type": "integer",
"enum": [
0,
1
]
},
"vanuatu": {
"description": "This represents whether the client is allowed or not to create an account under this jurisdiction",
"type": "integer",
"enum": [
0,
1
]
},
"virtual": {
"description": "This represents whether the client is allowed or not to create an account under this jurisdiction",
"type": "integer",
"enum": [
0,
1
]
}
}
}
}
},
Expand Down Expand Up @@ -237,6 +332,14 @@
"type": "string"
}
},
"report_available": {
"description": "Indicate if the verification report was returned by the provider",
"type": "integer",
"enum": [
0,
1
]
},
"reported_properties": {
"description": "Shows the latest document properties detected and reported by IDVS",
"type": "object"
Expand Down Expand Up @@ -518,7 +621,7 @@
]
},
"status": {
"description": "Account status. Possible status: \n- `address_verified`: client's address is verified by third party services. \n- `allow_document_upload`: client is allowed to upload documents. \n- `age_verification`: client is age-verified. \n- `authenticated`: client is fully authenticated. \n- `cashier_locked`: cashier is locked. \n- `crs_tin_information`: client has updated tax related information. \n- `deposit_locked`: deposit is not allowed. \n- `disabled`: account is disabled. \n- `document_expired`: client's submitted proof-of-identity documents have expired. \n- `document_expiring_soon`: client's submitted proof-of-identity documents are expiring within a month. \n- `dxtrade_password_not_set`: Deriv X password is not set. \n- `financial_assessment_not_complete`: client should complete their financial assessment. \n- `financial_information_not_complete`: client has not completed financial assessment. \n- `financial_risk_approval`: client has accepted financial risk disclosure. \n- `max_turnover_limit_not_set`: client has not set financial limits on their account. Applies to UK and Malta clients. \n- `mt5_password_not_set`: MT5 password is not set. \n- `mt5_withdrawal_locked`: MT5 deposits allowed, but withdrawal is not allowed. \n- `needs_affiliate_coc_approval`: user must approve the Affiliate's Code of Conduct Agreement. \n- `no_trading`: trading is disabled. \n- `no_withdrawal_or_trading`: client cannot trade or withdraw but can deposit. \n- `p2p_blocked_for_pa`: p2p is blocked for the current payment agent client. \n- `pa_withdrawal_explicitly_allowed`: withdrawal through payment agent is allowed. \n- `password_reset_required`: this client must reset their password. \n- `professional`: this client has opted for a professional account. \n- `professional_requested`: this client has requested for a professional account. \n- `professional_rejected`: this client's request for a professional account has been rejected. \n- `social_signup`: this client is using social signup. \n- `trading_experience_not_complete`: client has not completed the trading experience questionnaire. \n- `ukgc_funds_protection`: client has acknowledged UKGC funds protection notice. \n- `unwelcome`: client cannot deposit or buy contracts, but can withdraw or sell contracts. \n- `withdrawal_locked`: deposits allowed but withdrawals are not allowed. \n- `deposit_attempt`: this prevent a client from changing the account currency after deposit attempt. \n- `poi_name_mismatch`: client POI documents name mismatch. \n- `allow_poa_resubmission`: the client can resubmit POA documents. \n- `allow_poi_resubmission`: the client can resubmit POI documents. \n- `shared_payment_method`: the client has been sharing payment methods. \n- `personal_details_locked`: client is not allowed to edit personal profile details. \n- `transfers_blocked`: it block any transfer between two accounts. \n- `df_deposit_requires_poi`: the DF deposit will be blocked until the client gets age verified. \n- `authenticated_with_idv_photoid`: the client has been fully authenticated by IDV. \n- `idv_revoked`: the client used to be fully authenticated by IDV but it was taken away due to compliance criteria. \n- `mt5_additional_kyc_required`: client tax information, place of birth and account opening reason is missing. \n- `poi_expiring_soon`: the POI documents of the client will get expired soon, allow them to reupload POI documents. \n- `poa_expiring_soon`: the POA documents of the client will get outdated soon, allow them to reupload POA documents.",
"description": "Account status. Possible status: \n- `address_verified`: client's address is verified by third party services. \n- `allow_document_upload`: client is allowed to upload documents. \n- `age_verification`: client is age-verified. \n- `authenticated`: client is fully authenticated. \n- `cashier_locked`: cashier is locked. \n- `crs_tin_information`: client has updated tax related information. \n- `deposit_locked`: deposit is not allowed. \n- `disabled`: account is disabled. \n- `document_expired`: client's submitted proof-of-identity documents have expired. \n- `document_expiring_soon`: client's submitted proof-of-identity documents are expiring within a month. \n- `dxtrade_password_not_set`: Deriv X password is not set. \n- `financial_assessment_not_complete`: client should complete their financial assessment. \n- `financial_information_not_complete`: client has not completed financial assessment. \n- `financial_risk_approval`: client has accepted financial risk disclosure. \n- `max_turnover_limit_not_set`: client has not set financial limits on their account. Applies to UK and Malta clients. \n- `mt5_password_not_set`: MT5 password is not set. \n- `mt5_withdrawal_locked`: MT5 deposits allowed, but withdrawal is not allowed. \n- `needs_affiliate_coc_approval`: user must approve the Affiliate's Code of Conduct Agreement. \n- `no_trading`: trading is disabled. \n- `no_withdrawal_or_trading`: client cannot trade or withdraw but can deposit. \n- `p2p_blocked_for_pa`: p2p is blocked for the current payment agent client. \n- `pa_withdrawal_explicitly_allowed`: withdrawal through payment agent is allowed. \n- `password_reset_required`: this client must reset their password. \n- `professional`: this client has opted for a professional account. \n- `professional_requested`: this client has requested for a professional account. \n- `professional_rejected`: this client's request for a professional account has been rejected. \n- `social_signup`: this client is using social signup. \n- `trading_experience_not_complete`: client has not completed the trading experience questionnaire. \n- `ukgc_funds_protection`: client has acknowledged UKGC funds protection notice. \n- `unwelcome`: client cannot deposit or buy contracts, but can withdraw or sell contracts. \n- `withdrawal_locked`: deposits allowed but withdrawals are not allowed. \n- `deposit_attempt`: this prevent a client from changing the account currency after deposit attempt. \n- `poi_name_mismatch`: client POI documents name mismatch. \n- `allow_poa_resubmission`: the client can resubmit POA documents. \n- `allow_poi_resubmission`: the client can resubmit POI documents. \n- `shared_payment_method`: the client has been sharing payment methods. \n- `personal_details_locked`: client is not allowed to edit personal profile details. \n- `transfers_blocked`: it block any transfer between two accounts. \n- `df_deposit_requires_poi`: the DF deposit will be blocked until the client gets age verified. \n- `authenticated_with_idv_photoid`: the client has been fully authenticated by IDV. \n- `idv_revoked`: the client used to be fully authenticated by IDV but it was taken away due to compliance criteria. \n- `mt5_additional_kyc_required`: client tax information, place of birth and account opening reason is missing. \n- `poi_expiring_soon`: the POI documents of the client will get expired soon, allow them to reupload POI documents. \n- `poa_expiring_soon`: the POA documents of the client will get outdated soon, allow them to reupload POA documents. \n- `tin_manually_approved`: the client's tax_identification_number has been manually approved as client is not applicable for tax_identification_number",
"type": "array",
"items": {
"type": "string"
Expand Down
22 changes: 22 additions & 0 deletions config/v3/get_settings/receive.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,28 @@
],
"sensitive": 1
},
"phone_number_verification": {
"description": "The status of the Phone Number Verification.",
"type": "object",
"additionalProperties": false,
"required": [
"verified"
],
"properties": {
"next_attempt": {
"description": "(Optional) Indicates the timestamp for the next verification attempt",
"type": "integer"
},
"verified": {
"description": "Indicates the verification status of the client's phone number.",
"type": "integer",
"enum": [
0,
1
]
}
}
},
"place_of_birth": {
"description": "Place of birth, 2-letter country code.",
"type": [
Expand Down
16 changes: 16 additions & 0 deletions config/v3/kyc_auth_status/receive.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,14 @@
"items": {
"type": "string"
}
},
"report_available": {
"description": "Indicate if the verification report was returned by the provider (IDV only).",
"type": "integer",
"enum": [
0,
1
]
}
}
},
Expand Down Expand Up @@ -200,6 +208,14 @@
"items": {
"type": "string"
}
},
"report_available": {
"description": "Indicate if the verification report was returned by the provider (IDV only).",
"type": "integer",
"enum": [
0,
1
]
}
}
},
Expand Down
Loading

0 comments on commit 589e144

Please sign in to comment.