Release notes
Integrations
Back Office guide
How-to articles
B2Core API
Release notes
January 31, 2023
January 19, 2023
December 20, 2022
December 6, 2022
November 24, 2022
November 8, 2022
October 25, 2022
October 11, 2022
September 27, 2022
September 13, 2022
August 30, 2022
August 16, 2022
August 2, 2022
July 19, 2022
July 5, 2022
June 21, 2022
June 7, 2022
May 24, 2022
April 26, 2022
April 12, 2022
March 29, 2022
March 15, 2022
March 1, 2022
February 15, 2022
February 1, 2022
January 18, 2022
December 21, 2021
December 7, 2021
November 24, 2021
November 9, 2021
October 26, 2021
October 12, 2021
September 28, 2021
September 14, 2021
August 31, 2021
August 3, 2021
July 20, 2021
July 6, 2021
June 22, 2021
June 8, 2021
May 26, 2021
April 27, 2021
April 13, 2021
March 30, 2021
March 16, 2021
March 2, 2021
February 16, 2021
February 2, 2021
Integrations
Trading platforms
Payment systems
KYC providers
Communication platforms
Other systems
Back Office guide
Get started
Authorization and permissions
General interface options
The top bar options
Common options
Filtering and sorting
Pagination
Visibility
Data export
Clients
General
The Client tab
The Contacts tab
The Event log tab
The Accounts tab
The Transactions tab
The Finance tab
The History tab
The MT Accounts tab
The Trades tab
The B2Margin Accounts tab
The Introducing brokers tab
The Services tab
The Files tab
The Settings tab
The Advanced tab
The Compliances tab
The Devices tab
The Documents tab
The Mailing Log tab
Services
Clients
List
Parameters
Categories
Groups
Saved presets
Requests
Accounts
Managers
Types
Events log
List
Categories
Introducing brokers
MT accounts
MT4 accounts
MT5 accounts
Finance
Deposits
Payouts
Deposit wallets
Transfers
Exchange
Transactions
Reports
Currencies
Currencies
Rates
Currency pairs
Bonuses
Bonus presets
Bonus distribution
Temporary bonuses
Products
Products
Groups
Rights
Platforms
Commission cashback
Commission plans
Trading data
Processing log
Distribution log
PAMM
Links
Promotion
Banners
Announcements
Dashboard
Menu
Mailing
Marketing
Configuration
Send email
Email templates
System
Providers
Queue
Log
Ticket feedback
Verification
Levels
Documents
Document types
Document groups
Client tests
B2BinPay
Wallets
Withdrawals
System
Key storage
Key storage values
Key storage tags
Deposit system
Deposit methods
Deposit groups
Payout system
Payout methods
Payout groups
Wizards
Registration
Password Recovery
Password change
Client type change
Profile change
Phone change
Address change
Authorization
2FA change
Whitelist creation
Whitelist delete
Whitelist change
Withdrawals
Wizards
Bulk actions
Event calendar
Operation types
Countries
External connections
Filesystems
Localizations
Requests
Resolutions
Resolution types
Templates
Template types
Templates
SMS
Providers
SMS templates
Settings
Event notifications
Users
Users
Groups
Client Tags
Events
Successful registration
Transfers
Account created
Transaction verifying
Hedging failed
Request receiving
Client rights
Client folders
Backend images
Import data
Antifraud
Antifraud notifications
Antifraud settings
Antifraud procedures
Security
Search by IP
Blocked clients
Black lists
White lists
Transaction monitoring
Address whitelist
References
Client statuses
Client request statuses
Transaction statuses
Supported currencies
Fiat
Crypto
Block explorer list
Coins
Stablecoins
How-to articles
Manage clients
How to create a client profile
How to change a client password
How to prompt a password reset
How to disable 2FA for a client
How to enable internal transfers for a client
How to view deposit or withdrawal addresses
How to upload a file
How to assign tags to clients
How to resolve client requests
How to create categories for the Event log
Manage finances
How to add, edit or delete deposit or withdrawal methods
How to add a manual deposit or withdrawal method
How to configure commissions for a deposit or withdrawal method
How to restrict the use of a deposit or withdrawal method
How to create a deposit
How to create a payout
How to create a transfer
How to exchange funds
How to create a report
How to set a cashback
How to configure cashback settings
How to create a method for depositing cashback rewards
How to identify clients that received cashback rewards
Manage currencies
How to add a currency
How to configure currency exchange rates
How to add an exchange currency pair
How to set priorities for exchange rate providers
Manage bonuses
How to create a bonus preset
How to automatically credit bonuses to clients upon deposits
Manage products
How to create a wallet
How to restrict the use of a product
Manage commission cashback options
How to configure a commission cashback plan
How to modify or remove a commission cashback plan
Manage advertising options
How to create a banner
How to create a desktop banner
How to create a banner for the mobile app
How to create an announcement
How to configure the default Dashboard
How to add Ticker Widget symbols to the Dashboard
How to configure a menu in the B2Core UI
Manage mailing options
How to send an email
How to create an email template
How to configure SMTP
How to sign up with an SMTP service provider
How to configure an SMTP service connection via the B2Core Back Office
How to configure SendGrid
How to determine why clients fail to receive email notifications
Manage verification options
How to use the KYC constructor
How to create document groups
How to create documents
How to create verification levels
How to create permission levels
How to set up deposit, withdrawal and transfer limits by verification levels
How to use SumSubstance
How to configure a connection to the SumSub system
How to create verification levels for SumSub
How to create document types for SumSub verification via the B2Core Back Office
How to create levels and flows via the SumSub interface
SumSub webhook configurations
How to use ShuftiPro
How to configure a connection to ShuftiPro
How to create document groups for ShuftiPro verification
How to create document types for ShuftiPro verification
How to create verification levels for ShuftiPro
How to create a client accreditation test
Manage system settings
How to change the wizard workflow
How to configure the registration wizard
How to add a phone number
How to add a phone number confirmation step
How to add first and last names
How to block registration for a country
How to add Google ReCaptcha
How to add a B2BinPay API key to the B2Core Back Office
How to add or remove a language
How to create a request resolution type
How to create a request resolution
How to set up event notifications
How to add a user group and grant permissions
How to add an admin user
How to make an admin user see only specific clients
How to create a bulk action
How to export a CSV file with email addresses
How to manage calendar events
How to create an event
How to update or remove an event
How to change Back Office images
How to set up a Slack bot
How to configure Twilio
How to sign up with Twilio
How to configure Twilio as a 2FA SMS provider
How to configure Twilio as a phone service provider
How to test the Twilio phone service operation
How to set up 2FA
How to set up 2FA with SMS
How to create a template for delivering 2FA codes via SMS
How to check configuration of the wizards related to 2FA with SMS
How to test operation of 2FA with SMS
How to import client-related data
How to import data related to Back Office user groups
Manage trading platforms
How to integrate B2Trader
How to create a platform for B2Trader
How to create a product group for B2Trader
How to create a product for B2Trader
How to integrate Match-Trader
How to create a platform for Match-Trader
How to create a product for Match-Trader
How to create Match-Trader accounts for clients
How to archive Match-Trader accounts
How to integrate OneZero and PrimeXM
How to create a platform for OneZero
How to create a platform for PrimeXM
How to create products for OneZero and PrimeXM
How to create OneZero and PrimeXM accounts for clients
B2Core API
REST API
Overview
HTTP headers
HTTP methods
HTTP response codes
Query parameters
Date and time formats
The Back Office API
Authentication
Sign in to the Back Office
Confirm a 2FA verification code
Refresh the access token
Sign out of the Back Office
Two-factor authentication
Check 2FA status
Get 2FA method details
Disable 2FA
Get 2FA change history
Get 2FA change details
Authorization history
Get authorization history
Get authorization details
Accounts
Get an account list
Get account details
Create a new account
Update an account
Get account preferences
Get account balance
Change account balance
Archive an account
Addresses
Get a list of client addresses
Get client address details
Add a client address
Update a client address
Delete a client address
Banners
Get a list of banners
Get banner details
Create a new banner
Update a banner
Delete a banner
Black and White lists
Get a list of security policies
Get security policy details
Create a new security policy
Update a security policy
Delete a security policy
Blocked clients
Get a list of blocked clients
Get blocked client details
Unblock a client
Clients
Get a client list
Get client details
Create a client profile
Client tags
Get a list of tags
Get tag details
Add a new tag
Update a tag
Delete a tag
Client types
Get a list of client types
Get client type details
Create a client type
Update a client type
Delete a client type
Countries
Get a list of countries
Get country details
Update a country
Currencies
Get a list of currencies
Get currency details
Add a currency
Update a currency
Delete a currency
Currency aliases
Get a list of currency aliases
Get currency alias details
Add a currency alias
Update a currency alias
Delete a currency alias
Currency pairs
Get a list of currency pairs
Get currency pair details
Add a currency pair
Update a currency pair
Delete a currency pair
Deposits
Make a deposit
Devices
Get a list of devices
Get device details
Delete a device
Documents
Get a list of documents
Get document details
Add a new document
Delete a document
Document types
Get a list of document types
Get document type details
Create a new document type
Update a document type
Delete a document type
Document groups
Get a list of document groups
Get document group details
Create a new document group
Update a document group
Delete a document group
Exchanges
Exchange currencies
Localizations
Get a list of localization options
Get localization option details
Update a localization option
Menu items
Get a menu tree
Get menu item details
Update a menu item
Passwords
Change a client password
Get a password change history
Get password change details
Prompt all clients to reset their passwords
Prompt a specific client to reset their password
Phone numbers
Get a list of phone numbers
Get phone number details
Add a new phone number
Update a phone number
Delete a phone number
Products
Get a list of products
Get product details
Create a new product
Update a product
Delete a product
Get a list of product groups
Get product group details
Create a new product group
Update a product group
Delete a product group
Get a list of product currencies
Get product currency details
Add a new product currency
Update a product currency
Delete a product currency
Profile changes
Get a profile change history
Get profile change details
Profile photos
Get a client profile photo
Upload a client profile photo
Delete a client profile photo
Rates
Get an exchange rate for a currency pair
Requests
Get a list of requests
Get request details
Update a request
Audit a request
Approve a request
Reject a request
Get request notifications
Resolutions
Get a list of resolutions
Get resolution details
Add a new resolution
Update a resolution
Delete a resolution
Get a list of resolution types
Get resolution type details
Add a new resolution type
Update a resolution type
Delete a resolution type
Transactions
Get a list of transactions
Get transaction details
Update a transaction
Get a list of transaction types
Get transaction type details
Update a transaction type
Submit a transaction monitoring request
Get a list of transaction monitoring results
Get transaction monitoring details
Transfers
Transfer funds between accounts
Users
Get a list of users
Get user details
Create a new user
Update user information
Delete a user
User groups
Get a list of user groups
Get user group details
Create a new user group
Update a user group
Delete a user group
Verification history
Get verification history
Get verification details
Verification levels
Get a list of verification levels
Get verification level details
Create a new verification level
Update a verification level
Delete a verification level
Widgets
Get a list of widgets
Get widget details
Update a widget
Get a list of tickers
Get ticker details
Get a list of ticker symbols
Get ticker symbol details
Add a new ticker symbol
Delete a ticker symbol
Withdrawals
Make a withdrawal
Withdrawal templates
Get a list of withdrawal templates
Get withdrawal template details
Back Office API objects
The Account object (Back Office)
The Address object (Back Office)
The Authorization Record object (Back Office)
The Banner object (Back Office)
The Client object (Back Office)
The Profile Change object (Back Office)
The Client Type object (Back Office)
The Country object (Back Office)
The Currency object (Back Office)
The Currency Alias object (Back Office)
The Currency Pair object (Back Office)
The Device object (Back Office)
The Document object (Back Office)
The Document Type object (Back Office)
The Document Group object (Back Office)
The Localization object (Back Office)
The Menu Item object (Back Office)
The Phone Number object (Back Office)
The Product object (Back Office)
The Product Currency object (Back Office)
The Product Group object (Back Office)
The Request object (Back Office)
The Resolution object (Back Office)
The Resolution Type object (Back Office)
The Security Policy object (Back Office)
The Transaction object (Back Office)
The Transaction Type (Back Office)
The Transaction Monitoring object (Back Office)
The User object (Back Office)
The User Group object (Back Office)
The Statement object (Back Office)
The Tag object (Back Office)
The Verification Level object (Back Office)
The Widget object (Back Office)
The Withdrawal Template object (Back Office)
The Front Office API
Get started
Obtain a device fingerprint
Registration
Initialize the Sign Up Wizard
Sign up to the B2Core UI
Authentication
Initialize the Sign In Wizard
Sign in to the B2Core UI
Refresh the access token
Sign out of the B2Core UI
Two-factor authentication
Choose a 2FA method
Use Google Authenticator to secure access to the B2Core UI
Use an SMS code to secure access to the B2Core UI
Initiate a 2FA procedure
Complete the initiated 2FA procedure
Check 2FA status
Get 2FA method details
Initialize a wizard for enabling 2FA
Initialize a wizard for disabling 2FA
Enable or disable 2FA
Enable 2FA with Google Authenticator
Enable 2FA with SMS
Disable 2FA
Get 2FA change history
Get 2FA change details
Accounts
Get a list of client accounts
Get client account details
Create a new account
Update an account
Archive an account
Apple device tokens
Add an Apple device token
Delete an Apple device token
Authorization history
Get authorization history
Get authorization details
Banners
Get a list of banners
Get banner details
Client profiles
Get client profile data
Update client profile data
Client types
Get a list of client types
Get client type details
Countries
Get a list of countries
Get country details
Currencies
Get currency rates
Get an exchange rate for a currency pair
Exchange currencies
Deposits
Make a synchronous deposit
Make an asynchronous deposit
Deposit methods
Get a list of deposit methods
Get deposit method details
Get a list of deposit groups
Get a list of currencies added to deposit methods
Devices
Get a list of devices
Get device details
Delete a device
Documents
Get a list of documents
Get document details
Add a new document
Delete a document
Localizations
Get a list of localization options
Get localization option details
Menu items
Get a menu tree
Get menu item details
Passwords
Change a client password
Get a password change history
Get password change details
Product currencies
Get a list of product currencies
Get product currency details
Product groups
Get a list of product groups
Get product group details
Profile photos
Get a client profile photo
Upload a client profile photo
Delete a client profile photo
The mobile app settings
Get the mobile app settings
Transactions
Get a list of client transactions
Get transaction details
Transfers
Transfer funds between accounts
Verification procedures
Get verification history
Get verification details
Initialize a wizard for running a verification procedure
Run a verification procedure
Verification levels
Get a list of verification levels
Get verification level details
Widgets
Get a list of widgets
Get widget details
Withdrawals
Initialize a wizard for withdrawing funds
Make a withdrawal
Confirm a withdrawal
Withdrawal methods
Get a list of withdrawal methods
Get withdrawal method details
Get a list of withdrawal groups
Get a list of currencies added to withdrawal methods
Withdrawal templates
Get a list of withdrawal templates
Get withdrawal template details
Create a withdrawal template
Update a withdrawal template
Delete a withdrawal template
Front Office API objects
The Account object (Front Office)
The Authorization Record object (Front Office)
The Banner object (Front Office)
The Client Profile (Front Office)
The Client Type object (Front Office)
The Country object (Front Office)
The Currency object (Front Office)
The Deposit Group object (Front Office)
The Deposit Method object (Front Office)
The Device object (Front Office)
The Document object (Front Office)
The Localization object (Front Office)
The Menu Item object (Front Office)
The Product Currency object (Front Office)
The Product Group (Front Office)
The Statement object (Front Office)
The Transaction object (Front Office)
The Verification Level object (Front Office)
The Widget object (Front Office)
The Withdrawal Group object (Front Office)
The Withdrawal Method object (Front Office)
The Withdrawal Template object (Front Office)
WebSocket API
Connect to a WebSocket server
Subscribe to the user events channel
B2Core API
B2Core API
This document provides comprehensive information about the B2Core API:
REST API
WebSocket API