How-to Articles

Managing Clients

See also

Clients

How to Create a Client

  1. Navigate to Clients > General in the menu.

  2. Click +Add.

  3. Set client E-mail, First Name, and Last Name. The set of fields may vary depending on the registration wizard settings.

Upon successful registration, an e-mail notification on successful registration will be sent to the user. Note that a password is not set: the user must reset password at first log in. You can also set the password for the user and send it also by the e-mail.

You can add detailed information about the client: click the client in the clients list and fill out the form.

Note

Admin Allowed Client Tags are assigned by default to the created client.

How to Change a Client Password

  1. Navigate to Clients > General in the menu.

  2. Select the client from the list, then click edit button.

  3. Click Actions in the upper-right corner, then select Change password.

  4. Type a new password or generate a random one by clicking the arrows icon.

  5. Set Send mail to Yes to send the new password to the client by e-mail.

  6. Click Save to apply changes.

How to Disable 2FA

  1. Navigate to Clients > General in the menu.

  2. Select the client from the list, then click edit button.

  3. Go to the Settings tab.

  4. Set Google Authenticator to Disable.

  5. Click Save to apply changes.

How to Upload a File

  1. Navigate to Clients > General in the menu.

  2. Select the client from the list, then click edit button.

  3. Go to the Files tab.

  4. Click +Add.

  5. Set Caption for the file. This caption will be displayed in the files list.

  6. Select the file(s) to upload. Note that the uploaded file(s) must meet the following requirements:

  • Supported formats: DOC, DOCX, XLSX, CSV, PDF, JPG, PNG, PAGES, NUMBERS, ZIP

  • File size: up to 3 MB

  1. Click Save to upload file.

Request Resolution

Some actions performed by your clients require a resolution (approve or reject). A list of pending requests is accessible by clicking on the shield icon or from the menu (for quick and convenient search):

  1. Navigate to Clients > Requests in the menu.

  2. Select the request. You can use filters by client’s email, request type or any other for quick search.

  3. Click the edit button to view request details. Note that for some providers it is also possible to edit the deposit or payout amount directly in the request.

  4. Add comment if required — this comment will be displayed only in the Back Office. Your client will not get any notification on it.

  5. Use the Options button to set the color of the request in the list.

  6. Click Audit to check the transaction. The system will summarize all incoming transactions on the account and show a notification if there is a significant discrepancy in the balance. This step requires ‘Update requests’ permission.

  7. Click Approve or Reject to resolve the request.

If rejected:

  1. Select Resolution type and Resolution. Type and resolution must be preliminary created in the system, ref. to How to Create a Request Resolution Type, How to Create a Request Resolution.

  2. Confirm the rejection by solving a simple math problem and provide the result in the Verification code field.

  3. Click Ok to save changes.

After that an e-mail notification on request resolution will be sent to the client.

Managing Finance

See also

Finance

How to Create a Deposit

Before creating a manual deposit via the Back Office:

  1. Navigate to System > Deposit system > Deposit methods.

  2. Check if deposit method manual is created and enabled (Enabled field set to Yes).

If the method is not in the list, follow these steps to create it:

  1. Click Create.

  2. Fill out the form:

  • Set Name: manual.

  • Set Caption: Manual Deposit.

  • Select Provider: manual.

  • Select Currency: you can add more currencies later on the TR Currencies tab of method details.

  1. Click Save to create the method. Created method is enabled by default.

When the method is created and enabled, you can use any of the methods described below to create a deposit.

Method 1

  1. Navigate to Clients > General in the menu.

  2. Select the client to whose account you want to create a deposit.

Note

You can use filters by name or email for quick search.

  1. Click the client name to go to details.

  2. Click the Transactions tab, then select Deposit.

  3. Click Create.

  4. Select a client account to which you want to deposit, then click Select.

  5. Fill out the form:

  • Check that Method is set to manual. Check account number and currency.

  • Set deposit Amount.

  • Set commissions.

  • Сheck Don’t send email if you do not want to send the client an email notification of the deposit.

  • Confirm the operation by solving a simple math problem and provide the result in Verification code.

  • Add the Internal comment if needed. It will be displayed only in the Back Office.

  1. Click Save to create the deposit.

Method 2

  1. Navigate to Clients > General in the menu.

  2. Select the client to whose account you want to create a deposit.

Note

You can use filters by name or email for quick search.

  1. Click the client name to go to details.

  2. Click the Accounts tab.

  3. Select a client account to which you want to deposit, then click the edit button.

  4. Click the Transactions tab, then select Deposit.

  5. Click Create.

  6. Fill out the form:

  • Check that Method is set to manual. Check account number and currency.

  • Set deposit Amount.

  • Set commissions.

  • Сheck Don’t send email if you do not want to send the client an email notification of the deposit.

  • Confirm the operation by solving a simple math problem and provide the result in Verification code.

  • Add the Internal comment if needed. It will be displayed only in the Back Office.

  1. Click Save to create the deposit.

Method 3

  1. Navigate to Finance > Deposits in the menu.

  2. Click Create.

  3. Select a client account to which you want to deposit, then click Select.

Note

You can use filters by account number or email for quick search.

  1. Fill out the form:

  • Check that Method is set to manual. Check account number and currency.

  • Set deposit Amount.

  • Set commissions.

  • Сheck Don’t send email if you do not want to send the client an email notification of the deposit.

  • Confirm the operation by solving a simple math problem and provide the result in Verification code.

  • Add the Internal comment if needed. It will be displayed only in the Back Office.

  1. Click Save to create the deposit.

How to Create a Payout

Before creating a manual payout via the Back Office:

  1. Navigate to System > Payout system > Payout methods.

  2. Check if payout method manual is created and enabled (Enabled field set to Yes).

If the method is not in the list, follow these steps to create it:

  1. Click Create.

  2. Fill out the form:

  • Set Name: manual.

  • Set Caption: Manual Deposit.

  • Select Provider: manual.

  • Select Currency: you can add more currencies later on the Currencies tab of method details.

  1. Click Save to create the method. Created method is enabled by default.

When the method is created and enabled, you can use any of the methods described below to create a payout.

Method 1

  1. Navigate to Clients > General in the menu.

  2. Select the client from whose account you want to create a payout.

Note

You can use filters by name or email for quick search.

  1. Click the client name to go to details.

  2. Click the Transactions tab, then select Payout.

  3. Click Create.

  4. Select a client account from which you want to create a payout, then click Select.

  5. Fill out the form:

  • Check that Method is set to manual. Check account number and currency.

  • Set payout Amount.

  • Set commissions.

  • Сheck Don’t send email if you do not want to send the client an email notification of the payout.

  • Confirm the operation by solving a simple math problem and provide the result in Verification code.

  • Add the Internal comment if needed. It will be displayed only in the Back Office.

  1. Click Save to create the payout.

Method 2

  1. Navigate to Clients > General in the menu.

  2. Select the client from whose account you want to create a payout.

Note

You can use filters by name or email for quick search.

  1. Click the client name to go to details.

  2. Click the Accounts tab.

  3. Select a client account from which you want to create a payout, then click the edit button.

  4. Click the Transactions tab, then select Payout.

  5. Click Create.

  6. Fill out the form:

  • Check that Method is set to manual. Check account number and currency.

  • Set payout Amount.

  • Set commissions.

  • Сheck Don’t send email if you do not want to send the client an email notification of the payout.

  • Confirm the operation by solving a simple math problem and provide the result in Verification code.

  • Add the Internal comment if needed. It will be displayed only in the Back Office.

  1. Click Save to create the payout.

Method 3

  1. Navigate to Finance > Payouts in the menu.

  2. Click Create.

  3. Select a client account from which you want to create a payout, then click Select.

Note

You can use filters by account number or email for quick search.

  1. Fill out the form:

  • Check that Method is set to manual. Check account number and currency.

  • Set payout Amount.

  • Set commissions.

  • Сheck Don’t send email if you do not want to send the client an email notification of the payout.

  • Confirm the operation by solving a simple math problem and provide the result in Verification code.

  • Add the Internal comment if needed. It will be displayed only in the Back Office.

  1. Click Save to create the payout.

How to Create a Transfer

To create a transfer between account in the Back Office, you can use any of the methods described below.

Method 1

  1. Navigate to Clients > General in the menu.

  2. Select the client between whose accounts you want to create a transfer.

Note

You can use filters by name or email for quick search.

  1. Click the client name to go to details.

  2. Click the Transactions tab, then select Transfer.

  3. Click Create.

  4. Fill out the form:

  • Select debiting account in the From account field.

  • Select destination account in the To account field.

  • Set transfer Amount.

  • Confirm the operation by solving a simple math problem and provide the result in Verification code.

  1. Click Save to create the transfer.

Method 2

  1. Navigate to Clients > General in the menu.

  2. Select the client between whose accounts you want to create a transfer.

Note

You can use filters by name or email for quick search.

  1. Click the client name to go to details.

  2. Click the Accounts tab.

  3. Select a client account from which you want to create a transfer, then click the edit button.

  4. Click the Transactions tab, then select Transfer.

  5. Click Create.

  6. Fill out the form:

  • Select destination account in the To account field.

  • Set transfer Amount.

  • Confirm the operation by solving a simple math problem and provide the result in Verification code.

  1. Click Save to create the transfer.

Method 3

  1. Navigate to Finance > Transfers in the menu.

  2. Click Create.

  3. Select the client between whose accounts you want to create a transfer, then click Select.

Note

You can use filters by name or email for quick search.

  1. Fill out the form:

  • Select debiting account in the From account field.

  • Select destination account in the To account field.

  • Set transfer Amount.

  • Confirm the operation by solving a simple math problem and provide the result in Verification code.

  1. Click Save to create the transfer.

How to Create an Exchange

To create a currency exchange in the Back Office, you can use any of the methods described below.

Method 1

  1. Navigate to Clients > General in the menu.

  2. Select the client between whose accounts you want to create an exchange.

Note

You can use filters by name or email for quick search.

  1. Click the client name to go to details.

  2. Click the Transactions tab, then select Exchange.

  3. Click Create.

  4. Fill out the form:

  • Select debiting account in the From account field.

  • Select destination account in the To account field.

  • Select Exchange type:

    • Source & Rate (Sell) — for selling, destination amount cannot be set,

    • Destination & Rate (Buy) — for buying, source amount cannot be set,

    • Source & Destination (Direct) — for direct transfer, rates cannot be set.

  • Set exchange amounts and rates depending on selected exchange type.

  • Confirm the operation by solving a simple math problem and provide the result in Verification code.

  1. Click Save to create the exchange.

Method 2

  1. Navigate to Clients > General in the menu.

  2. Select the client between whose accounts you want to create an exchange.

Note

You can use filters by name or email for quick search.

  1. Click the client name to go to details.

  2. Click the Accounts tab.

  3. Select a client account from which you want to create an exchange, then click the edit button.

  4. Click the Transactions tab, then select Exchange.

  5. Click Create.

  6. Fill out the form:

  • Select destination account in the To account field.

  • Select Exchange type:

    • Source & Rate (Sell) — for selling, destination amount cannot be set,

    • Destination & Rate (Buy) — for buying, source amount cannot be set,

    • Source & Destination (Direct) — for direct transfer, rates cannot be set.

  • Set exchange amounts and rates depending on selected exchange type.

  • Confirm the operation by solving a simple math problem and provide the result in Verification code.

  1. Click Save to create the exchange.

Method 3

  1. Navigate to Finance > Exchange in the menu.

  2. Click Create.

  3. Select the client between whose accounts you want to create an exchange, then click Select.

Note

You can use filters by name or email for quick search.

  1. Fill out the form:

  • Select debiting account in the From account field.

  • Select destination account in the To account field.

  • Select Exchange type:

    • Source & Rate (Sell) — for selling, destination amount cannot be set,

    • Destination & Rate (Buy) — for buying, source amount cannot be set,

    • Source & Destination (Direct) — for direct transfer, rates cannot be set.

  • Set exchange amounts and rates depending on selected exchange type.

  • Confirm the operation by solving a simple math problem and provide the result in Verification code.

  1. Click Save to create the exchange.

How to Create a Report

  1. Navigate to Finance > Reports in the menu.

  2. Click the Create.

  3. Fill out the form:

  • Interval — schedule the report:

    • Daily — the report is sent every day,

    • Weekly — the report is sent once a week,

    • Monthly — the report is sent once a month,

  • Data slice — select data period to be sent (specified time is server time):

    • Day — previous day from 00:00 to 23:59,

    • Week — previous week from Monday 00:00 to Sunday 23:59,

    • Month — previous month from the first day of the month 00:00 to the last day 23:59,

    • Curweek — previous 7 days from the first day 00:00 to yesterday 23:59,

    • Overall — from the very beginning to yesterday 23:59,

    • Curmonth — from the first day of the current month 00:00 to yesterday 23:59,

  • File format — select one of: HTML, XLSX, CSV,

  • Active — default value is Active — the report is sent. To stop reporting, set to Inactive,

  • Name — type the report name to be displayed in the list,

  • Class — select report class from the list,

  • Mail to — type the e-mail address to which the report should be sent,

  • Start hour — type the hour for reporting in range of 0 to 23,

  • GMT offset — select your GMT offset to be sure the report is sent at the required time.

  1. Click Save.

Note

Please, note that server time may differ from you GMT offset. You can see current server date-time in the topbar.

Managing Bonuses

See also

Bonuses

How to Create a Bonus Preset

  1. Navigate to Bonuses > Bonus Presets.

  2. Click Create, then select the platform.

  3. Fill out the form:

  • Name — displayed name of the preset

  • Default — if Yes, the bonus is default for all clients

  • Lifetime — the number of days after which the activated bonus expires

  • Lot per unit — the required amount of traded volume for bonus crediting. Must be greater than 0

  • Set credit immediately — if Enabled, the bonus is credited immediately

  • Ignored open/close interval — the minimum time interval during which a position must be opened for the bonus to be credited

  • Autoenable trading if balance > 0 — if Enabled, trading with bonus funds is available only with a positive account balance. The system checks balances once an hour and deactivates bonuses for zero or negative balances

  • Ignored symbol groups — currency pairs for which this bonus is not credited. Multiple select available

  1. Click Save.

How to a Bonus from Deposit

You can create a bonus that will be automatically credited to all clients who deposit into their trading account.

  1. Navigate to System > Settings.

  2. In the Bonuses block:

  • Set Аutocreate from deposit to Enabled

  • In the Autocreated bonus percent field, specify the percentage of the deposit which you want to pay as a bonus

  • Set Burn if balance < 0 to Enabled, so that this bonus will automatically revoked if the balance of the client’s trading account becomes lass than 0

  1. Click Save to activate the bonus.

Managing Products

See also

Products

How to Create a Wallet

  1. Navigate to Products > Products in the menu.

  2. Click Create, then select eWallet from the drop-down list.

  3. Fill out the form:

  • Platform — set by default,

  • Platform Group — select eWallet,

  • Currency — select the wallet currency,

  • Name — set the wallet name which will be displayed in the Products List,

  • Group — select a group, the wallet will be displayed in the selected group in the Trader’s Room interface,

  • Factory — set 100 for cent account or keep the default value,

  • Type — select Personal.

  1. Click Save.

  2. Fill out details:

  • Set the Caption, which will be displayed in the Trader’s Room interface. Set localizations if needed.

  • Set Status to Enabled.

  • Set Group rights to eWallet or select the Rights if group rights were not configured.

  • Set Max accounts to 1.

  • Set external Link to currency or other information. This link will be displayed in the Trader’s Room interface as i icon.

  • Set Autocreation on login to Yes if you want this wallet will be added to each client upon initial log in to the Trader’s Room.

  1. Click Save to apply changes.

Managing Promotion

See also

Promotion

How to Create a Banner

  1. Navigate to Promotion > Banners in the menu.

  2. Click Create.

  3. Fill out the form:

  • Set Caption of the banner — title which will be displayed in the Trader’s Room,

  • Set Banner URL — a tail of the page URL on which you want the banner to be displayed, e. g. /dashboard, /wallets,

  • Set Priority of the banner — if there are more than one banner, you can specify the order in which they will be displayed.

  1. Click Save. The banner is disabled by default so that you can configure it.

  2. Select the created banner from the list and click the edit button.

  3. On the Banner tab, specify Button URL if needed. If this value is specified, by clicking on the button, the client will be redirected to the specified URL.

  4. In the banner details navigate to Light/Dark tabs to configure the banner for light and dark theme of the Trader’s Room interface:

  • Check Caption. Set localizations if needed.

  • In the Button field you can specify an HTML link which will be displayed as a button on the banner, for example: <a href="https://your-source-link">View details</a>. Set localizations if needed.

  • Type Text of the banner. Set localizations if needed.

  • Specify the link to background image in the Banner Background field.

  1. On the Banner tab set Enable to Yes.

  2. Click Save to activate the banner.

How to Create an Announcement

  1. Navigate to Promotion > Announcements in the menu.

  2. Click Create.

  3. Select announcement Type:

  • Required — this announcement contains a button and blocks interactions with the Trader’s Room interface until the client clicks this button

  • Optional — this announcement does not require any actions and is visible as a notification

  1. Set announcement Title.

  2. Click Save. The announcement is disabled by default so that you can configure it.

  3. Select the created announcement from the list and click the edit button.

  4. In the announcement details:

  • Set localizations for Title if needed.

  • Set Enable to Yes.

  • Set Button Text — this field is available and required for required announcements only.

  • Enter Targeted Emails if you want to send the announcement only to specified clients. You can also upload emails list as a CSV file.

  • Type Text of the announcement. Set localizations if needed.

  • Specify Button URL if needed. If this value is specified, by clicking on the button, the client will be redirected to the specified URL.

  1. Click Save to activate the announcement.

Managing Mailing

See also

Mailing

How to Send an Email

You can create an email to send it immediately or at scheduled time, or to save your email as a template. This email can be sent to any email address(es).

  1. Navigate to Mailing > Send Email in the menu.

  2. Click Create.

  3. Fill out the form:

  • Select a Template or leave this field empty. Template must be preliminary created in the system, ref. to How to Create an Email Template.

  • Set a Subject — the global, or “message level”, subject of your email,

  • Set a Description — internal description of the email, will not be seen on the email,

  • Set date and time in Send at or leave this field empty to send email immediately after saving.

  • Set target addresses in Send to. Click Send to all clients to send this email to all registered clients in the system. You can also upload a CSV file with email addresses. In the same way, you can specify the recipients of carbon copy (Cc to) and blind carbon copy (Bcc to).

  • Select Platform,

  • HTML text is a body of your email. You can preview the email by clicking Refresh preview. Plain text is also supported.

  • Click Choose Files to upload attachments to your email.

  1. Click Save to create the email or Save as template to create a template.

How to Create an Email Template

  1. Navigate to Mailing > Send Email in the menu.

  2. Click Create.

  3. Fill out the form:

  • Set Caption — a template name that will be displayed in the template drop-down list,

  • Set a Subject — the global, or “message level”, subject of your email,

  • Set a Description — internal description of the email, will not be seen on the email,

  • Select Platform,

  • HTML text is a body of the email. You can preview the email by clicking Refresh preview. Plain text is also supported.

  1. Click Save to create the template.

You can also save your email as a template. In that case, ref. to How to Send an Email, perform the steps, then click Save as template.

How to Configure SendGrid

First, register on the SendGrid platform to get API keys.

  1. Go to SendGrid website and register in the system.

  2. After the registration navigate to Settings > API Keys.

  3. Click Create API Key.

  4. Click on the generated API key and make sure the Full Access option is checked.

  5. Copy the API key.

Then, configure SendGrid in the Trader’s Room Back Office.

  1. Navigate to Mailing > Configuration.

  2. Click Create.

  3. Fill out the form:

  • Caption — enter any name you like

  • Platform — select SendGrid from the dropdown list

  1. Click Save.

  2. Paste the copied API key to the API key field.

  3. Enter Sender address and Sender name.

  4. Switch Status to enabled.

  5. Click Save.

Finally, set up webhook on the SendGrid platform.

  1. Go to SendGrid website.

  2. Navigate to Settings > Mail settings.

  3. In the Event Settings section switch the Status option to enabled.

  4. Click Event Webhook and fill out the form:

  • Authorization Method — select None

  • Host URL — enter URL specified in the Webhook URL field in the Mailing > Configuration section of the Trader’s Room Interface

  • Deliverability Data — check all the available checkboxes

  • Event Webhook Status — must be switched to enabled

  1. Click Save.

KYC Constructor

Before you begin to configure KYC constructor, you must define:

  • how many verification levels you want to support,

  • which restrictions and limits you want to set for each level,

  • which documents your client must provide for each level.

Following the steps below, you will create and set up the necessary levels and documents in the Back Office, as well as configure their display in the Trader’s Room interface.

First, create the document groups. To create a group:

  1. Navigate to Verification > Document Groups in the menu.

  2. Click Create.

  3. Fill out the form:

  • Set Name of the group. This name will be displayed in the Back Office only.

  • Set Type to One.

  • Set Caption — name of the document group in the Trader’s Room interface. Set localizations if needed.

  • Set Description — in this field you can provide any hints to your clients about the documents procedure. We support HTML in this field. Set localizations if needed.

  • Set Enabled to Yes.

Then, create the required documents. To create a document:

  1. Navigate to Verification > Document Types in the menu.

  2. Click Create.

  3. Fill out the form:

  • Set Name of the document. This name will be displayed in the Back Office only.

  • Set Caption name of the document in the Trader’s Room interface. Set localizations if needed.

  • Set Description — we support HTML in this field. Set localizations if needed.

  • Set Status to Enabled.

  • Set Group of the document — one of those created in the previous step.

  • Set Max files — how many documents of this type your client can upload.

Finally, create the required verification levels. On each instance of the Trader’s Room level 0 is already set up and is default. To create a new level:

  1. Navigate to Verification > Levels in the menu.

  2. Click Create.

  3. Fill out the form:

  • Set Index of the new level, different from 0.

  • Set Wizard: B2B\TCA\Verification\Wizards\DocumentsWizard. This is a required value.

  • Set Caption — name of the level in the Trader’s Room interface. Set localizations if needed.

  • Set Description — for example, a list of permissions for this level, this will be displayed in the Trader’s Room interface in level details. We support HTML in this field. Set localizations if needed.

  • Set Visible to Yes.

  • Set Default to No (as default level is always level 0).

  • Select Assigned Client Right (ref. to Client Rights for details).

  • Select Document Groups (of those created in the step 1), which prove this level of verification. Multiple select available.

SumSub Constructor

First, set up and configure SumSub connection.

  1. Navigate to System > External Connections.

  2. Click Create.

  3. Fill out the form:

  • Set the Name of the connected system

  • Set connection Caption for the Back Office

  • Select Provider: SumSubstance

  1. Click Save. Created connection will be added to the list.

  2. Select SumSub connection from the list and click the edit button.

  3. Fill out the form:

  • Set Service location: https://api.sumsub.com/

  • Set Client ID which is the Account name in Settings > Account Details in the SumSub interface

  • Set Webhook Secret Key: you need to create preliminary 2 webhooks in Dev space > Webhooks in the SumSub interface. Required webhooks configuration is given below

  • Leave fields Login and Password blank

  • Input Token and Token secret: you can generate your token and secret key in Dev space > App Tokens in the SumSub interface

  • If you want to use separate verification flows for individual and corporate clients, enable Client Resetting Mode

Important

Enabled Client Resetting Mode means that changing client’s type from individual to corporate and vice versa will require re-verification:

  • client’s verification level will be reset to 0

  • all client’s requests with the PENDING status and the Verification type will be automatically rejected

  • the applicant in the SNS system will be reset to the initial level and all previously uploaded documents will be invalidated

All previously uploaded files and documents in the Back Office will be stored.

  1. Click Save.

Then, create the verification levels in the Back Office. On each instance of the Trader’s Room Back level 0 is already set up and is default. To create a new level:

  1. Navigate to Verification > Levels in the menu.

  2. Click Create.

  3. Fill out the form:

  • Set Index of the new level, different from 0

  • Set Wizard: B2B\TCA\SumSubstance\Wizards\SnsWizardsSDK. This is a required value

  • Set Caption — name of the level in the Trader’s Room interface. Set localizations if needed

  • Set Description — for example, a list of permissions for this level, this will be displayed in the Trader’s Room interface in level details. We support HTML in this field. Set localizations if needed

  • Set Visible to Yes

  • Set Default to No (as default level is always level 0)

  • Select Assigned Client Right (ref. to Client Rights for details)

Then, create document types for SumSub verification.

  1. Navigate to Verification > Document Types.

  2. Click Create.

  3. Fill out the form. Note that Name of the type must comply with SumSub supported document types.

  4. Click Save.

Finally, create levels and flows in the SumSub interface.

On the side of the Back Office, we support two client types: individual and corporate. SumSub provides opportunity to set up two different flows of verification for these types. To use this option, make sure that you enabled Client Resetting Mode when configuring SumSub connection (see the first part of this article about configuring SumSub connection).

To add a new level:

  1. In the SumSub interface, navigate to Integrations > Applicant Levels.

  2. Click Add new level.

  3. Select required steps.

Important

The name of the level must comply with the following format:

  • level1, level2, etc. — for individual clients

  • level1corporate, level2corporate, etc. — for corporate clients

To add a new flow:

  1. In the SumSub interface, navigate to Integrations > Verification Flow.

  2. Click Add new.

  3. Select options. For each flow select compatible level.

SumSub Webhooks Configuration

Pending

  • Name: PENDING

  • Receiver: HTTP Endpoint

  • Target: https://{your domain}/api/v1/verification-sns/handle

  • Type: Applicant pending (applicantPending)

  • Secret key: same as for Reviewed

Reviewed

  • Name: REVIEWED

  • Receiver: HTTP Endpoint

  • Target: https://{your domain}/api/v1/verification-sns/handle

  • Type: Applicant reviewed (applicantReviewed)

  • Secret key: same as for Pending

Managing System

See also

System

How to Change Wizard Workflow

  1. Navigate to System > Wizards in the menu.

  2. Select the wizard you want to change and click the edit button.

  3. Go to the Workflow tab:

  • To change steps priority, use drag-and-drop

  • To add a new step, click the Add button, then select the type. Note that not all wizards support additional steps. For more information about default and available steps ref. to Wizards

  1. Click Save to apply changes.

How to Configure Registration Wizard

How to Add a Phone Number

  1. Navigate to System > Wizards in the menu.

  2. Select the Registration wizard and click the edit button. You can use filters by name or type for quick search.

  3. Go to the Workflow tab.

  4. Select the Basic Information step and click the edit button.

  5. Go to the Custom Fields tab.

  6. Click Add.

  7. In the Main field settings select the type: group.

  8. In the Field attributes set Name: phones. Then select Rules: required and array.

  9. Click Save.

  10. Find the created phones field in the list and click the edit button.

  11. In the Sub fields section click Add.

  12. In the Main field settings select the type: group.

  13. In the Field attributes set Name: 0.

  14. Find the created subfield 0 in the table and click the edit button.

  15. Click Add.

  16. In the Main field settings select the type: input.

  17. In the Field attributes set the following values:

  • Label: Phone number

  • Rules: required, distinct, and phone:AUTO

  • Name: phone

  • Mask key: phone

  1. Click Save.

How to Add First and Last Names

  1. Navigate to System > Wizards in the menu.

  2. Select the Registration wizard and click the edit button. You can use filters by name or type for quick search.

  3. Go to the Workflow tab.

  4. Select the Basic Information step and click the edit button.

  5. Go to the Custom Fields tab.

  6. Click Add.

  7. In the Main field settings select the type: group.

  8. In the Field attributes set Name: info.

  9. Click Save.

  10. Find the created info field in the list and click the edit button.

  11. In the Sub fields section click Add.

  12. In the Main field settings select the type: input.

  13. In the Field attributes set the following values:

  • Label: First name

  • Name: givenName

  • Rules: required, string, min:1, max:30, info_name

  1. Click Save.

  2. Select the created info field in the list again and click the edit button.

  3. In the Sub fields section click Add.

  4. In the Main field settings select the type: input.

  5. In the Field attributes set the following values:

  • Label: Last name

  • Name: familyName

  • Rules: required, string, min:1, max:30, info_name

  1. Click Save.

How to Add Google ReCaptcha

Note

To add Google ReCaptcha to registration and login pages of the Trader’s Room you need ReCaptcha key and secret.

  1. Navigate to System in the menu.

  2. In the Google ReCaptha section:

  • Set Disable/Enable ReCaptcha to Enabled.

  • Fill out the ReCaptcha key and secret.

  1. Click Save to add ReCaptcha.

How to Add/Remove a Language

To enable/disable language of the Trader’s Room interface:

  1. Navigate to System > Localizations.

  2. Select the language from the list and click the edit button.

  3. To switch on the language, set Enabled to Yes. To switch off the language, set Enabled to No.

  4. Click Save to apply changes.

How to Create a Request Resolution Type

  1. Navigate to System > Requests > Resolutions Types in the menu.

  2. Click Create.

  3. Fill out the form:

  • Set Name of the type (e. g. financial).

  • Set Caption — title of the type which will be displayed in the resolution types drop-down list (e. g. Financial Rejection).

  • Set Enabled to Yes.

  1. Click Save to create the type.

How to Create a Request Resolution

  1. Navigate to System > Requests > Resolutions in the menu.

  2. Click Create.

  3. Fill out the form:

  • Set Name of the resolution (e. g. suspicious).

  • Set Caption — title of the resolution which will be displayed in the resolutions drop-down list (e. g. Suspicious Transaction).

  • Set Enabled to Yes.

  • Select Resolution type from the list. Resolution type must be preliminary created in the system, ref. to How to Create a Request Resolution Type.

  1. Click Save to create the resolution.

How to Add an Admin User

  1. Navigate to System > Users.

  2. Click Create.

  3. Fill out the form:

  • Type an Email.

  • Type a Password or generate a random one by clicking the arrows icon.

  • Check that Status is set to Enabled.

  • Select user groups to which the user must be included.

  • Check the box Send to email to send credentials.

  1. Click Save to create the user.

How to Grant Permissions

  1. Navigate to System > Groups.

  2. Select a user group to grant access rights.

  3. Select a permission tab. The tabs correspond to menu items, but in alphabetical order.

  4. Select the required permissions. You can use Check to quickly select a group of rights (All/View/Create/Update/Delete). Use Uncheck all to quickly uncheck all selected rights.

  5. Click Save to apply changes.