Account APIs
Account APIs are designed to manage user accounts, settings, and security. They provide functionalities for authorising sessions, managing API tokens, retrieving and updating account information, handling KYC (Know Your Customer) processes, and setting trading and self-exclusion limits.
These APIs ensure secure, compliant, and personalised interactions on the Deriv platforms, empowering users to effectively manage their accounts and trading activities.
| # | API Name | Description | Send | Subscribe | Scope |
|---|---|---|---|---|---|
| 1 | API Token | This call manages API tokens. | ✔ | ✘ | Admin |
| 2 | Authorize | Authorises the current WebSocket session using a token. This must precede requests that require access to the client account, such as purchasing or selling contracts. | ✔ | ✘ | NA |
| 3 | Balance | Retrieves the user account balance. | ✔ | ✔ | Read |
| 4 | Document Upload | Requests and uploads KYC documents from the client. | ✔ | ✘ | Admin |
| 5 | Account Status | Retrieves the current status of the user account. | ✔ | ✘ | Read |
| 6 | Login History | Retrieves a summary of the user’s login history. | ✔ | ✘ | Read |
| 7 | Log Out | Logs the user out of the current session. | ✔ | ✘ | NA |
| 8 | Account Limits | Retrieves the user's trading and withdrawal limits. | ✔ | ✘ | Read |
| 9 | Get Self-Exclusion | Allows users to exclude themselves from the website or set limits on their trading activities. | ✔ | ✘ | Read |
| 10 | Get Account Settings | Retrieves the user’s account settings, such as email, date of birth, and address. | ✔ | ✘ | Read |
| 11 | Identity Verification Add Document | Adds documents required for identity verification, including country of issuance and document type. | ✔ | ✘ | Admin |
| 12 | New Real-Money Account: Deriv Investment (Europe) Ltd | Opens a new real-money account with the Maltainvest Landing Company. | ✔ | ✘ | Admin |
| 13 | New Real-Money Account: Default Landing Company | Opens a new real-money account. | ✔ | ✘ | Admin |
| 14 | New Virtual-Money Account | Creates a demo account. | ✔ | ✘ | NA |
| 15 | OAuth Applications | Lists all used OAuth applications. | ✔ | ✘ | Read |
| 16 | Verify Email | Verifies the user’s email address for various purposes. | ✔ | ✘ | NA |
| 17 | Get Financial Assessment | Retrieves the client’s financial assessment details, which are required for compliance with regulatory and KYC requirements. | ✔ | ✘ | Read |
| 18 | Top Up Virtual-Money Account | Tops up the demo account when the balance is low. | ✔ | ✘ | Trade |
| 19 | Terms and Conditions Approval | Approves the latest version of Deriv's terms and conditions. | ✔ | ✘ | Admin |
| 20 | Trading Platform: Investor Password Reset | Resets the investor password of the trading platform account. | ✔ | ✘ | Admin |
| 21 | Trading Platform: Password Reset | Resets the password of the trading platform account. | ✔ | ✘ | Admin |
| 22 | Set Financial Assessment | Updates the financial assessment based on the client’s knowledge and experience with options trading. | ✔ | ✘ | Admin |
| 23 | Set Self-Exclusion | Sets self-exclusion limits (in conjunction with the get_self_exclusion function). | ✔ | ✘ | Admin |
| 24 | Set Account Settings | Updates the user’s account settings (in conjunction with get_account_settings). | ✔ | ✘ | Admin |
Updated 10 days ago