Help Center

Our products knowledge base for customers

KYC

KYC

In this section, the broker has the opportunity to create and flexibly customize questionnaires for its clients. In order to verify his profile, the platform user must fill out a questionnaire created by the broker's administrator.

Applicants

The subsection contains a list of profiles for which the current verification statuses are specified:

kyc_1.png

The following columns are available for each record in the table:

NameDescription
IDID of applicant in the system
Profile IDProfile ID and it's name in the system
StepStep of the questionnaire, where the profile is situated (for unverified and manually verified profiles a dash is displayed)
StatusCurrent status of the profile
CreatedDate and time the application was created
UpdatedDate and time the application request was updated

Filtering of records by profiles and statuses is available in the table.

Please note! When navigating to other sections of the system, the filter configuration is preserved.

The button with three vertical bars allows to specify visible fields of the table. The button with a back arrow allows setting up default visibility settings.

The Save to XLS button allows downloading the applicants table.

List of possible statuses:

NameDescription
UndefinedClient has created an account/profile, no confirmation is required at this stage
Profile verification is requiredClient has created an account/profile
Profile under reviewClient sent all the steps for verification
An update is requiredDisplayed if there are steps to be corrected
Profile is verifiedThe reviewer has set the status to Verified
Profile verification is rejectedThe reviewer has set the status to Rejected
Profile verification is expiredProfile data is out of date. The client needs to update the data/re-verify
Re-verification is requiredProfile correction in process (not completed). The client have to complete the data update to send for re-verification
Profile under re-reviewUpdated profile information has been sent for verification
A re-update is requiredDisplayed if there are steps that need to be corrected as part of the profile update

Applicant card

Clicking on ID will open the applicant card. The applicant card allows the reviewer to verify the user's profile. The data sent by the user for verification is displayed here. The current profile status is displayed in the upper right corner. The Verify manually button is also available there, which allows to verify the profile at once, ignoring all verification steps.

kyc_2.png

The following information is provided on the applicant's card:

NameDescription
IDApplicant ID
ProfileProfile ID
Createddate of application creation
Updateddate of application update
Expires onquestionnaire expiration date (if specified)
Please note! Fields set as mandatory are marked with an asterisk.

Questionnaire statuses are assigned manually by the reviewers:

NameDescription
DraftThe questionnaire is partially filled out by the user.
SubmittedThe questionnaire has been sent by the user for verification.
ReviewThis status is assigned to the questionnaire after the first clicking Mark wrong in one of the fields of the questionnaire, checking the Correct data checkbox or manually changing the status of the questionnaire in the applicant's card.
HoldThis status is assigned to the applicant's application form to indicate that the application form is being held for review.
Additional info requiredThe reviewer assigns this status if the user has to make clarifications/corrections to the questionnaire at one of the steps.
RejectedThe applicant's questionnaire is rejected. The user sees the status, but cannot make changes to the questionnaire.
Level expiredset automatically if the expiry date of the questionnaire has come
Verification completedVerification of the applicant's profile has been successfully completed, the profile has been verified. The user sees this status and at this stage gets access to trading on the platform.

When the application is moved to one of the following statuses, the client will receive an email notification:

  • Submitted
  • On hold
  • Rejected
  • Level verified
  • Level expired
  • Additional info required
Please note! When changing the status to Verified, the reviewer can also set its expiry period in the Expires in field - 1, 2, 3 years or specify own option. After this period expires, the client will have to go through the verification level again. Without verification period option allows to not to specify a verification period.

kyc_22.png

The Mark wrong field allows the reviewer to enter a comment that the applicant will see if the questionnaire is returned to him after the review.

The Correct data checkbox allows the reviewer to mark that the data in the field is correct.

Settings

The subsection allows the broker administrator to customize the questionnaires. In this section you can see information about the identification and verification of each client. We strongly recommend you to carry out a questionnaire for each of your clients before they are granted access to financial transactions.

Steps

Each step in the platform can be created by linking an existing questionnaire to it.

kyc_3.png

The steps in the table are represented by records containing the following fields:

NameDescription
IDUnique identifier of the step in the platform
NameStep name
Step typeStep type (Internal - a questionnaire created inside the platform, Sumsub - a questionnaire created in the Sumsub service)
Step contentStep content displays the name of the questionnaire it contains.
Please note! The steps in the table are always sorted in ascending order of ID.

The Edit profile forms button allows you to select the forms that will be displayed in the administrative profiles and in the profile settings of the client terminal:

kyc_4.png

NameDescription
Personal formsdisplaying questionnaires for personal profiles in the profile settings of the client terminal profile
Corporate formsdisplay questionnaires for corporate profiles in the client terminal profile settings
Admin personal formsdisplay questionnaires for personal profiles in administrator terminal profiles
Admin corporate formsdisplaying questionnaires for corporate profiles in the administrator terminal profiles

Editing the steps order

The Edit steps order button allows you to edit the steps order individually for each of the profile types: For personal profiles and For corporate profiles.

kyc_5.png

Each created step gets into the list of Available steps. In order for a step to be available to the profile during KYC procedure, it must be moved to the Active steps list.

The + button allows you to add a step to the active steps list. The - button allows you to remove a step from the active steps list. Steps can be moved while editing by holding down the left mouse button on the six points next to the field. When you click Save, the changes to the step order will be saved.

Creating a new step

The Create step button allows you to open the sidepage of creating a new step.

To create a step, select the provider - Internal or Sumsub (if integration is connected), set its name for different locales and link an existing questionnaire to it. Once the Create button is clicked, the new step will be available for use.

kyc_6.png

Please note! Each created questionnaire can only be used in one step.

The OTP Required checkbox in the step settings allows to enable signing of the questionnaire by SMS message. In this case, when sending the questionnaire for verification, the client will have to enter the code from the SMS message sent to his phone number.

Please note! The function of signing the page by SMS message works if only the method of authorization by phone number is enabled in the broker settings (Brokers ➝ Broker ➝ Authorization).

Creating a step containing a document

Please note! To create such a step, document templates must first be created in the Documents section. Document templates that will be displayed on the questionnaire page are specified in the Document template field. {.is-info}

kyc_6_1.png

Fields to fill:

NameDescription
NameThe name of the document
Document titleThe title displayed in the document window
Document descriptionA description of the document
Document footerThe text displayed to the client in the footer of the document
Document templateThe selected document templates from the Documents section
Provider levelIn the current implementation, this is an arbitrary value
Expires inThe expiration period for the document before it needs to be re-uploaded by the client
OTP requiredWhen enabled, the client must verify the form using an OTP code
Please note! If an expiration date is set for a step, this field will be locked for editing during verification.

Editing a step

The Edit button allows you to edit an existing step. The name and questionnaire can be changed in any of the steps. Similar localization content can also be changed. Once you click Update, the changes will be applied.

kyc_7.png

Questionnaires

The tab is intended for viewing the list of existing and adding new questionnaires. Any questionnaire can be bound to a specific step.

Please note: One questionnaire can only be linked to one step.

kyc_8.png

The Preview button allows you to display an existing questionnaire as the user will see it:

kyc_9.png

Clicking on an existing questionnaire will open a page to edit it. To create a new questionnaire, click Add questionnaire.

Creating and editing the questionnaire

kyc_10.png

For each questionnaire, a title must be entered in the Questionnaire title field.

Pages serve as logical units within the questionnaire. Click Add page to create a new page.

Important! A page or fields used in it cannot be moved or deleted if they form dependencies with subsequent pages or fields. The platform will block such an action and display a corresponding warning. kyc_11.png
General page settings

For each page you need to add a title - Page title. You can add a description and help text in different languages (Help text) for the page.

kyc_12.png

By default, the created page is displayed within the questionnaire without preconditions - Always visible. To set display conditions, it is necessary to change this value to Show if.

When setting the Show if parameter, you must specify a field in the second cell which value selection will affect the page display. The third cell sets the value of equality (Is) or inequality (Is not). The fourth cell specifies the value, when selected, that will or will not make the page visible to the user.

Visibility condition setting example: kyc_13.png Show page if Field 1 is 1 - that is, the page will be displayed only if 1 was selected in the previously filled Field 1.

Use the Add rule button to specify additional (AND) or alternate (OR) page display condition statements.

Please note! Only one of the operators can be used per page.

After customizing the page and its fields, you must click Save to apply the changes to the questionnaire. You can also roll back the questionnaire view to the previous save by clicking the Undo changes to last save button.

Customizing page fields

kyc_14.png

The Field list block specifies the fields to be displayed on the page. You can change the order in which the fields are displayed on the page - you can move them by left-clicking on the six points next to any of them.

Note! A field cannot be moved if the previously defined logic of visibility conditions is violated.

Any field on the page can be deleted by clicking on the trash can button. You can edit the field by clicking on the pencil button. The arrow button will allow you to move the field to another page. The Add rule button allows you to add display conditions for the field. The display conditions are customizable similarly to the display conditions for pages described in General page settings of this help section. Fields that are expected to be filled in can be made mandatory by enabling the Required field checkbox.

Must be taken into concideration! If filling in a field is a prerequisite for subsequent actions, it cannot be moved or deleted.

The Add item button allows you to add a new item to the page. Several types of items are available - Text, Field, Group divider, Image:

  • Text on the page can be added in one of the available styles - header, text or description.

kyc_15.png

  • Field allows you to select one of the previously configured fields to add to the page. When adding this type of field, you can search and filter by field type:

kyc_16.png

  • Group divider allows you to add a divider to logically separate groups of fields on a page:

kyc_17.png

  • Image allows you to upload an image to the page. Once the image has been uploaded, the Save button should be clicked to save the image in the item:

kyc_18.png

Please note! The recommended image size is no larger than 660x660 pixels. Images with a larger resolution will be compressed horizontally and vertically to the maximum possible values.

Fields

The tab is intended for customization of fields. Fields are the main used units for questionnaire compilation and allow you to customize them flexibly.

kyc_19.png

The field table consists of the following columns:

NameDescription
Field IDUnique identifier of the field in the platform
Field typeField type
CodeThe code assigned to a field will be displayed in the Documents section and can be used in the document template shown to the user during the KYC process.
CommentInternal comment for administrators (displayed when editing questionnaires)
TitleField title
ValidationField validation condition
UpdatedDate and time of the last field setting change

The Create field button is used to create a new field. When you click on the button, a sidepage opens with the possibility to configure the field. Any field can be edited by clicking on Edit next to it:

kyc_20.png

After clicking the button Create/Update in the sidepage, the changes will be applied to the field.

Field types

When creating or editing a field, you can set its type - Type field. Depending on the field type, the composition of its settings will vary.

Settings that are common to all field types:

NameDescription
LocalizationField composition in the selected language. Applies to the language selected by the user in the settings.
TitleTitle of the field.
CodeField code. Used to substitute the field in documents.
CommentField comment (visible only to administrators).
Help textHelp text that appears when hovering over the question mark icon next to the field.

Fields and individual settings for them:

The Input field type allows you to enter a value based on its validation type: The Validation setting is mandatory and allows you to select the type of input values accepted by the field. The following validation types are available:

  • Phone - the setting accepts only phone numbers as input.

  • Number - the field accepts only numeric values. If you select this type of validation, you will be able to select the minimum (Min value) and maximum (Max value) values in the sidepage.

  • Date - the field accepts only date values. When entered, a calendar is displayed to the user with the ability to select a date from it. Subtype values can be selected for such a field:

    • Any date - any date.
    • Today or future - Today or any date in the future.
    • Today at the latest - Today or any date in the past.
    • Yesterday at the latest - Yesterday or any date in the past.
    • At least X years before today - At least X years before today.
    • At least X years from today - At least X years from today.
    • At least X months before today - At least X months before today.
    • At least X months from today - At least X months after today.
    • At least X days before today - At least X days before today.
    • At least X days from today - At least X days after today.
  • Text - any values are available. When selecting this type of validation, the platform offers to set the maximum length of the message in the field - String length.

  • Email - The field only accepts email input.

  • Regular expression – allows you to enter a regular expression that will be used to validate the field input. When selecting this type, you can also add an Error text, which will be displayed to the user in case of incorrect input.

Please note! If you select options with X time, the X (years/month/days) field becomes available to specify the number of days/months/years respectively.

Field type Text area - is intended for text input:

The String length setting allows you to specify the maximum length of the message in the field.


The Select and Radio field types are selectors with the ability to select one of several response options:

The Add item button allows you to add multiple answer choices with the option to select one of them.

The Allow custom option checkbox adds an empty field to the selector where the user can specify their own value.

For this type of Select field, the Help text section is not displayed.

The Multi Select and Checkbox group field types are multiple-choice selectors:

The Add item button allows you to add multiple answer choices with the option to select one of them.

The Allow custom option checkbox adds an empty field to the selector where the user can specify their own value.


The Files field type provides the ability to upload a file to the questionnaire.


The Checkbox field type adds a checkbox to the questionnaire: The Default value field allows you to set whether the checkbox will be enabled by default.

Sumsub

1. Sumsub ➝ AppToken

Primarily, you need to create a token in Sumsub. Once the token is created, a secret key will be automatically generated. These entities will be needed for the further creation of a connection to the platform.

sumsub_1.png

In the Dev space ➝ App Token subsection, click Generate app token to open the token creation form. Specify a name for the token in the Name field and configure the necessary permissions in the Permissions field. Click SAVE to save the token.

List of required permissions:

  • See applicant’s personal data
  • See check results
  • Change applicant’s personal data
  • Moderate Applicants
  • Manage dashboard users
  • Manage company settings
  • See statistics and analytics
  • See costs of checks
  • Manage applicant notes
  • Use moderation buttons
  • Manage check results
  • Manage KYT settings
  • See KYT transactions
  • Manage KYT transactions
  • Manage KYT rules
  • See customizable lists
  • Manage customizable lists
  • Manage KYT settings
  • See KYT transactions
  • Manage KYT transactions
  • Manage KYT rules
  • See AML cases
  • Manage AML cases
  • Manage workflows
  • Blocklist applicants
  • Reset applicants
  • Manage applicant tags
  • Download bulk applicant report
  • Change applicant level
  • See list of applicants
  • Deactivate applicants
IMPORTANT! After saving the token, a warning will be displayed that you need to save the token and secret key. After confirming that the data has been saved and clicking button All is saved, the secret key data will not be displayed anywhere else. When you refresh the page, the secret key will also not be displayed.

sumsub_2.png

After saving the token will be displayed in the general list of available tokens:

sumsub_3.png

2. Settings ➝ Connections (Platform)

Under KYC ➝ Settings ➝ Connections, click Create connection to create a connection to Sumsub in the system.

sumsub_4.png

To create a new connection, you must fill in the following fields: In the Provider field specify Sumsub. Name - fill with the name of the connection. Token - in this field you should specify the token that was generated in Sumsub at the previous step. Secret key - in this field specify the secret key that was generated in Sumsub at the previous step.

Once the connection is created, a webhook will be generated in the platform to be used for Sumsub (see next step).

When initialising the WebSDK or MobileSDK, access token authentication must be used. The TOKEN TTL field specifies the duration of time that this token will exist in the platform. After this time expires, a new token will be generated. The default value is 10 minutes.

sumsub_5.png

After completing the fields, click SAVE to save your connection. It will be displayed in the general list of connections.

3. Sumsub ➝ Webhooks

In the line of the connection created in the platform, click Config to see the Webhook URL and Secret key of the connection. These will be needed to create a webhook with Sumsub.

sumsub_6.png

sumsub_7.png

To create a webhook go to Dev space ➝ Webhooks ➝ Webhook manager section in the Sumsub system.

sumsub_8_1.png

Click Create webhook and fill the following fields:

The Name is the name of your webhook in Sumsub. In the Webhook receiver field you should select HTTP Address. In the Target field you have to specify the Webhook URL of the connection previously created in the platform under Connections. In the Webhook types field, specify the webhooks types to be sent from Sumsub (For example, Applicant created, Applicant pending, etc.). In the Applicant types field, specify the type of applicants which will use this webhook - Individual or Company. If this field is left blank, it will include both types of applicants. However, most cases are covered by the Individual type.

sumsub_8_2.png

In the Secret key field, specify the Secret key of the connection created in the previous step. In the Signature algorithm field, choose the encryption type between ones supported by platform - SHA512 or SHA256.

sumsub_8_3.png

Click Create webhook to save the webhook.

sumsub_8_6.png

Click SAVE CHANGES to save the changes of the edited webhook.

sumsub_8_7.png

You can also test the webhook by clicking the Test webhook button.

sumsub_8_8.png

If it is configured correctly, you will see the following notification in the upper right corner of the screen:

sumsub_webhook_check.png

Check the webhook connection logs you can in the Dev space ➝ Webhooks ➝ Webhook logs section.

sumsub_8_5.png

4. Sumsub ➝ KYC levels

Here you can configure different KYC levels for users.

Click Create level to create a new KYC level.

sumsub_levels_1.png

The following fields will be available when creating or customising the level: Name - The name of the level in Sumsub.

Note! This field is filled in once. After the level is saved for the first time, the field will become uneditable.

The Type field specifies the type of verification - standard or with additional checks, which you can specify further.

sumsub_levels_2.png

In the More options section you can specify a few of additional settings. These include a setting that allows you to send emails to users about verification statuses during the verification process - Send emails about verification statuses.

sumsub_levels_3.png

Click SAVE to save the level settings.

After saving the settings in the section, the links and QR code will be displayed to the applicant in the system before the verification. Since verification takes place directly in the platform, they are not required for operation.

sumsub_levels_4.png

In the Required Steps subsection, you can set the information required from the user for verification.

sumsub_levels_5.png

5. Platform ➝ KYC levels

After setting up the level in Sumsub, it needs to be added to the platform.

To do this, under KYC ➝ Settings ➝ Levels, click CREATE LEVEL and fill in the following fields: KYC connection - the connection you created in the Connections section. Name - the name of the level displayed in the platform. Provider level - name of the level created earlier in Sumsub.

PLEASE NOTE! The level name in Sumsub and the Provider name in the platform must be completely identical.

sumsub_levels_6.png

Click CREATE to save the level with the preset settings.

Note! After creating a level in the platform, you must click Set as default to use it as the default active level. The default level means that it is the one that will be used to connect clients to Sumsub for verification. An unlimited number of levels can be created, but only one can be active, i.e. used for verification at a given time.

sumsub_levels_7.png

6. Verification

User section:

When the user logs into the system - he will see a message about the necessity of verification. The user will be verified and all functionality will be available to him after he passes the verification defined earlier in the level settings.

verification_1.png

The applicant's data will be sent to Sumsub as the fields are filled in.

verification_2.png

After successfully completing the data required for verification, the applicant will see a notification indicating the status of his application. To find out what stage of verification their application is in, the applicant should click Verify now at the top of the screen.

verification_4.png

verification_3.png

If the verification is passed, in the relevant subsections KYC ➝ Applicants | Profiles verification and in the section Access ➝ Profiles the profile will be in the status Verified. In this status, the user's functionality is no longer limited.

Also, the plug with a message to the user about the necessity of verification will disappear and the profile will have access to all the functionality of the platform.

If the user does not have all the data filled in correctly - he can be sent for additional verification. In the platform by clicking on Verify now he will see a notification indicating the documents that need to be filled in or edited.

Administrative section:

In the KYC ➝ Settings ➝ Profiles Verification subsection, there is an option to force user verification, bypassing all verification steps in Sumsub. To do this, simply click the Verify Manually button and specify the desired verification level for the profile.

verifymanually1.png

After successful verification, in the Applicants and Profile verifications sections, the profile will be assigned a Verified status. In Sumsub the status will be changed to Approved.

verification_5.png

If the user has filled in the data, but has not passed all the verification steps - the user profile in the platform is assigned the Not verified status. In the Sumsub applicants list, the applicant's profile will be displayed in the Documents requested status until the applicant fills in all required fields.

When the user has filled in all the data and sent it for review - the user's profile is assigned the Pending status. In the same status it will be in the list of applicants in Sumsub.

verification_6.png

The status in Sumsub will be changed to Requires action once the verification has started.

If the applicant has not filled in all the data correctly - it can be sent for additional verification, in the platform's admin section it will be assigned Expired status. In Sumsub it will be assigned the status Resubmission required.

If there is a need to request additional data from an already verified applicant - in the platform it will be given a Additional info requested status (An update is required for the profile status), in Sumsub it will be given a Resubmission required status.

If the check is not passed - in the platform the status will be changed to Denied. In the list of applicants in Sumsub the application status will be changed to Rejected.

Questionnaires

The following characteristics of KYC Questionnaire are available in the table:

NameDescription
IDa questionnaire identifier
Profileprofile that is undergoing a questionnaire
Brokerthe broker on which a questionnaire is taking place
Statusa questionnaire status
Createdwhen a questionnaire was created
Updatedwhen a questionnaire was updated

Click Add questionnaire to add new a questionnaire. In the side page that opens, select a profile and click Add.

Click View to open the questionnaire. Inside the questionnaire there are the following tabs:

  • Customer information - information about the customer completing the questionnaire;
  • CRS self-certification - provide the Taxpayer Identification Number (“TIN”) or Functional Equivalent issued by your country(ies) of tax residence. If a TIN or Functional Equivalent is not issued by the country(ies) of residence for tax purposes, please provide the appropriate reason;
  • FATCA self-certification - The Foreign Account Tax Compliance Act (FATCA) is a US Tax regulation enacted in 2010 in an effort to combat tax evasion by US investors, with offshore accounts and assets. The main objective of FATCA is to require non-US Financial Institutions (FFIs) to identify any US account holders and any US entities under US control and to inform the Internal Revenue Service (IRS) of their assets, income payments and trade flow during a financial year;
  • Politically exposed persons - here customers should confirm that they are not politically exposed persons (or a family member or person known to be a close associate of a politically exposed person);
  • Education and occupation - information about the customer's education and occupation,
  • Investment profile - information about the customer's investment profile;
  • Knowledge and experience - information about the customer's knowledge and experience;
  • Payment details - customer's payment details;
  • Explicit declarations and documents - here the customer is advised to carefully review all documents in this section and check all boxes to indicate that they have read them and agree to the terms.

kyc-questionnaire.png

Didn't find what you were looking for? Contact to support@unity.finance. We will be happy to help 24/7