Help Center
Our products knowledge base for customers
Sumsub
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.
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.
After saving the token will be displayed in the general list of available tokens:
2. Settings ➝ Connections (Platform)
Under KYC ➝ Settings ➝ Sumsub
, click Create connection to create a connection to Sumsub in the system.
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.
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.
To create a webhook go to Dev space ➝ Webhooks ➝ Webhook manager
section in the Sumsub system.
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.
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
.
Click Create webhook to save the webhook.
Click SAVE CHANGES to save the changes of the edited webhook.
You can also test the webhook by clicking the Test webhook button.
If it is configured correctly, you will see the following notification in the upper right corner of the screen:
Check the webhook connection logs you can in the Dev space ➝ Webhooks ➝ Webhook logs
section.
4. Sumsub ➝ KYC levels
Here you can configure different KYC levels for users.
Click Create level to create a new KYC level.
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.
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
.
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.
In the Required Steps
subsection, you can set the information required from the user for verification.
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 ➝ Steps
, 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.
Click CREATE to save the level with the preset settings.
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.
The applicant's data will be sent to Sumsub as the fields are filled in.
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.
If the verification is passed, in the relevant subsections KYC ➝ Applicants
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
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.
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
.
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.
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
.