B2Core API
B2Core API
This document provides comprehensive information about the B2Core API:
- Release notes
- August 9, 2023
- May 29, 2023
- April 18, 2023
- April 4, 2023
- March 21, 2023
- February 28, 2023
- February 14, 2023
- 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
- Back Office guide
- Get started
- Clients
- Introducing brokers
- MT accounts
- Finance
- Bonuses
- Currencies
- Cashback
- Products
- PAMM
- Promotion
- Mailing
- Ticket feedback
- Verification
- B2BinPay
- System
- Antifraud
- Security
- References
- 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 create a deposit
- How to create a payout
- How to create a transfer
- How to exchange funds
- How to create a report
- Manage currencies
- Manage bonuses
- Manage products
- Manage cashback options
- Manage advertising options
- Manage mailing options
- Manage verification options
- Manage system settings
- How to change the wizard workflow
- How to add and configure the registration wizard
- 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 set up Apple push 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 change Back Office images
- How to set up 2FA
- How to import client-related data
- How to import data related to Back Office user groups
- Manage trading platforms
- Manage communication platforms
- Manage Acrobat Sign templates
- Manage clients
- B2Core API
- REST API
- Overview
- The Back Office API
- Authentication
- Two-factor authentication
- Authorization history
- Accounts
- Addresses
- Antifraud procedures
- Banners
- Black and White lists
- Blocked clients
- Bonuses
- Get a list of bonuses
- Get bonus details
- Create a bonus
- Update a bonus
- Delete a bonus
- Extend a bonus
- Hold a bonus
- Reactivate a bonus
- Revoke a bonus
- Get a list of bonus presets
- Get bonus preset details
- Create a bonus preset
- Update a bonus preset
- Delete a bonus preset
- Get a list of temporary bonuses
- Get temporary bonus details
- Create a temporary bonus
- Update a temporary bonus
- Delete a temporary bonus
- Calendar events
- Clients
- Client files
- Client folders
- Client managers
- Client permissions
- Client settings
- Client tags
- Client tests
- Get a list of client tests
- Get client test details
- Create a client test
- Update a client test
- Delete a client test
- Get a list of test’s questions
- Get test’s question details
- Add a question to a client test
- Update a test’s question
- Delete a test’s question
- Get a list of answer options
- Get answer option details
- Add an answer option
- Update an answer option
- Delete an answer option
- Get a list of completed tests
- Get completed test details
- Client types
- Confirmations
- Get a list of SMS providers
- Get SMS provider details
- Get a list of SMS provider names
- Get the configuration settings of an SMS provider
- Add an SMS provider
- Update an SMS provider
- Delete an SMS provider
- Get a list of confirmation templates
- Get confirmation template details
- Create a confirmation template
- Update a confirmation template
- Delete a confirmation template
- Countries
- Currencies
- Currency aliases
- Currency pairs
- Deposits
- Deposit methods
- Get a list of deposit groups
- Get deposit group details
- Create a deposit group
- Update a deposit group
- Delete a deposit group
- Get a list of deposit methods
- Get deposit method details
- Create a deposit method
- Update a deposit method
- Delete a deposit method
- Get a list of deposit commissions
- Get Deposit commission details
- Add a deposit commission
- Update a deposit commission
- Delete a deposit commission
- Get a list of deposit currencies
- Get Deposit currency details
- Add a deposit currency
- Update a deposit currency
- Delete a deposit currency
- Get a list of deposit method attributes
- Get deposit method attribute details
- Add a deposit method attribute
- Delete a deposit method attribute
- Get a list of deposit method restrictions
- Get deposit method restriction details
- Add a new deposit method restriction
- Update a deposit method restriction
- Delete a deposit method restriction
- Devices
- Documents
- Document types
- Document groups
- Emails
- Get a list of email delivery services
- Get email delivery service details
- Add an email delivery service
- Update an email delivery service configuration
- Delete an email delivery service configuration
- Get a list of email templates
- Get email template details
- Create an email template
- Update an email template
- Delete an email template
- Get a list of sent emails
- Get sent email details
- Send an email
- Delete a sent email
- Email notification templates
- Get a list of email notification templates
- Get email notification template details
- Create a new email notification template
- Update an email notification template
- Delete an email notification template
- Get a list of notification types
- Get notification type details
- Create a new notification type
- Update a notification type
- Delete a notification type
- Event notifications
- Get a list of events types
- Get a list of event notifications
- Get event notification details
- Create a new event notification
- Update an event notification
- Delete an event notification
- Get a list of event listeners
- Get event listener details
- Add a new event listener
- Update an event listener
- Delete an event listener
- Get an event types list
- Get a list of event handlers
- Get a list of event handler workflows
- Exchange rate providers
- Exchanges
- External connections
- File storage
- Key-value storage
- Localizations
- Menu items
- Paid services
- Get a list of subscriptions
- Get subscription details
- Create a subscription
- Update a subscription
- Delete a subscription
- Get a list of paid-service groups
- Get paid-service group details
- Create a paid-service group
- Update a paid-service group
- Delete a paid-service group
- Get a list of paid-service parameters
- Get paid-service parameter details
- Add a paid-service parameter
- Update a paid-service parameter
- Delete a paid-service parameter
- Get a list of parameter presets
- Get parameter preset details
- Create a parameter preset
- Update a parameter preset
- Delete a parameter preset
- Get a list of paid services
- Get paid service details
- Add a paid service
- Update a paid service
- Delete a paid service
- Passwords
- Phone numbers
- 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
- Get a list of product notes
- Get product note details
- Add a new product note
- Update a product note
- Delete a product note
- Get a list of product restrictions
- Get product restriction details
- Add a new product restriction
- Update a product restriction
- Delete a product restriction
- Product permission groups
- Profile changes
- Profile photos
- Requests
- Resolutions
- SMTP service providers
- System logs
- Transactions
- Transfers
- Twilio
- Users
- User groups
- Verification history
- 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
- Get a list of verification level restrictions
- Get verification level restriction details
- Add a verification level restriction
- Update a verification level restriction
- Delete a verification level restriction
- Whitelisted withdrawal addresses
- Widgets
- Withdrawals
- Withdrawal methods
- Get a list of withdrawal groups
- Get withdrawal group details
- Create a withdrawal group
- Update a withdrawal group
- Delete a withdrawal group
- Get a list of withdrawal methods
- Get withdrawal method details
- Create a withdrawal method
- Update a withdrawal method
- Delete a withdrawal method
- Get a list of withdrawal commissions
- Get withdrawal commission details
- Add a withdrawal commission
- Update a withdrawal commission
- Delete a withdrawal commission
- Get a list of withdrawal currencies
- Get withdrawal currency details
- Add a withdrawal currency
- Update a withdrawal currency
- Delete a withdrawal currency
- Get a list of withdrawal method attributes
- Get withdrawal method attribute details
- Add a withdrawal method attribute
- Delete a withdrawal method attribute
- Get a list of withdrawal method restrictions
- Get withdrawal method restriction details
- Add a withdrawal method restriction
- Update a withdrawal method restriction
- Delete a withdrawal method restriction
- Withdrawal templates
- Back Office API objects
- The Answer Option object (Back Office)
- The Account object (Back Office)
- The Address object (Back Office)
- The Antifraud Procedure object (Back Office)
- The Authorization Record object (Back Office)
- The Banner object (Back Office)
- The Bonus object (Back Office)
- The Bonus Preset object (Back Office)
- The Calendar Event object (Back Office)
- The Client object (Back Office)
- The Client Folder object (Back Office)
- The Client Limits object (Back Office)
- The Client Manager object (Back Office)
- The Client Settings object (Back Office)
- The Client Test object (Back Office)
- The Client Type object (Back Office)
- The Completed Test object (Back Office)
- The SMS Provider object (Back Office)
- The Confirmation Template 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 Deposit Commission (Back Office)
- The Deposit Currency object (Back Office)
- The Deposit Group object (Back Office)
- The Deposit Method object (Back Office)
- The Deposit Method Attribute object (Back Office)
- The Deposit Method Restriction object (Back Office)
- The File Storage object (Back Office)
- The Key-Value Pair object (Back Office)
- The Key-Value Tag 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 Email Delivery Service object (Back Office)
- The SMTP Service Provider object (Back Office)
- The Notification Type object (Back Office)
- The Email Notification Template object (Back Office)
- The Email Template object (Back Office)
- The Event Listener object (Back Office)
- The Event Notification object (Back Office)
- The Exchange Rate Provider object (Back Office)
- The External Connection object (Back Office)
- The Localization object (Back Office)
- The Menu Item object (Back Office)
- The Paid Service object (Back Office)
- The Paid-Service group object (Back Office)
- The Paid-Service parameter object (Back Office)
- The Parameter Preset object (Back Office)
- The Permission Level 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 Product Note object (Back Office)
- The Product Permission Group object (Back Office)
- The Product Restriction object (Back Office)
- The Profile Change 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 Sent Email object (Back Office)
- The Subscription object (Back Office)
- The System Log object (Back Office)
- The Test’s Question object (Back Office)
- The Temporary Bonus 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 Verification Level Restriction object (Back Office)
- The Whitelisted Address object (Back Office)
- The Widget object (Back Office)
- The Withdrawal Commission (Back Office)
- The Withdrawal Currency object (Back Office)
- The Withdrawal Group object (Back Office)
- The Withdrawal Method object (Back Office)
- The Withdrawal Method Attribute object (Back Office)
- The Withdrawal Method Restriction object (Back Office)
- The Withdrawal Template object (Back Office)
- The Front Office API
- Get started
- Obtain a device fingerprint
- Registration
- Authentication
- Initialize the Sign In Wizard
- Sign in to the B2Core UI
- Refresh the access token
- Sign out of the B2Core UI
- Reset a password from the Sign In page
- Set up a new password from the Sign In page
- Get a QR code sign-in channel
- Get an authorization token for signing in using a QR code
- Sign in using a QR code
- 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 for an authorized client
- Initiate a 2FA procedure for an unauthorized client
- 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
- Get 2FA change history
- Get 2FA change details
- Accounts
- Get a list of client accounts
- Get client account details
- Create a new account
- Archive an account
- Update an account
- Initialize the wizard for changing a trading account password
- Confirm a procedure of changing a trading account password
- Change a trading account password
- Restore a trading account password
- Announcements
- Anti-phishing codes
- Apple device tokens
- Authorization history
- Banners
- Bonuses
- Charts
- Client permissions
- Client profiles
- Client settings
- Client tests
- Client types
- Countries
- Currencies
- Help desk tickets
- Deposits
- Deposit methods
- Devices
- Documents
- Key-value storage
- Localizations
- Menu items
- Passwords
- Product currencies
- Product groups
- Product notes
- Profile photos
- The mobile app settings
- Trading platforms
- Transactions
- Transfers
- Verification procedures
- Verification levels
- Whitelisted withdrawal addresses
- Get a list of whitelisted withdrawal addresses
- Get whitelisted withdrawal address details
- Get a list of currencies for withdrawing funds to whitelisted withdrawal addresses
- Initialize the wizard for creating a withdrawal address whitelist
- Add a withdrawal address to a whitelist
- Initialize the wizard for removing a withdrawal address from a whitelist
- Remove a withdrawal address from a whitelist
- Enable the address management option
- Initialize the wizard for disabling the address management option
- Disable the address management option
- Confirm an initialized procedure
- Widgets
- Withdrawals
- Withdrawal methods
- Withdrawal templates
- Front Office API objects
- The Account object (Front Office)
- The Announcement object (Front Office)
- The Authorization Record object (Front Office)
- The Banner object (Front Office)
- The Bonus object (Front Office)
- The Client Profile (Front Office)
- The Client Settings object (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 Exchange Rate object (Front Office)
- The Key-Value Pair 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 Product Note object (Front Office)
- The Temporary Bonus object (Front Office)
- The Ticket object (Front Office)
- The Transaction object (Front Office)
- The Verification Level object (Front Office)
- The Whitelisted Address 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
- REST API
- B2Core Mobile
- Deploying your iOS app
- Step 1. Prepare the licenses for trading crypto
- Step 2. Create and configure a demo account in the B2Core UI
- Step 3. Enroll in the Apple Developer Program as an Organization
- Step 4. Grant the access and admin permissions to the B2Core team
- Step 5. Provide all necessary information to your Account Manager
- Step 6. Specify the pricing, availability and privacy options
- Step 7. Specify a demo account from which the Apple Review team will log in
- Deploying your Android app
- Deploying your iOS app