How to use SumSubstance
This article provides instructions on how to configure B2CORE to use the KYC provider, SumSubstance (SumSub).
Before proceeding with the instructions, you must have signed up for SumSub and have an active account.
How to configure a connection to SumSub
Only admins who are assigned the permissions to manage external connections can set up a connection to SumSub.
To set up a connection:
In the B2CORE Back Office, navigate to System > External connections.
Click +Create in the upper-right page corner.
On the Create connection page, fill in the following fields:
In the Name field, enter a name that you want to use for the connection.
In the Caption field, enter a caption that will be applied to the connection in the Back Office.
In the Provider dropdown, select SumSubstance.
Click Save to create the connection.
In the connections list, find the SumSub connection that you've created and click Edit to enter the connection details.
On the Edit connection page, specify the following settings:
In the Service Location field, specify
https://api.sumsub.com/.In the Client ID field, specify your SumSub account name. To view your account name, in the SumSub interface, go to Settings > Account Details.
In the Webhook Secret Key field, specify a webhook secret. You should generate two webhooks in the SumSub interface. To do this, in the SumSub interface, go to Dev space > Webhooks (for the required webhook configurations, refer to SumSub webhook configurations).
Leave the Login and Password fields empty.
In the Token and Token Secret fields, specify a token and a secret key value generated in the SumSub interface. To generate them, in the SumSub interface, go to Dev space > App Tokens.
To apply different verification flows to individual and corporate clients, select Enabled in the Client Resetting Mode dropdown.
When the Client Resetting Mode option is enabled, this means that repeated verification is required for clients whose type has been changed from individual to corporate, or vice versa. After changing a type, the following happens:
In the B2CORE Back Office, a client’s verification level resets to
Level 0, which is the default verification level.All pending client’s requests to obtain a higher verification level are automatically rejected.
In the SumSub system, an applicant is set back to the initial level, and all documents that have been previously uploaded for this applicant are invalidated.
All files and documents that have been previously uploaded for this client in the B2CORE Back Office will still be available.
Optionally, you can enable transaction monitoring for currencies if it’s not enabled in the SumSub system. To enable the transaction monitoring service, select Yes in the Enabled dropdown, and select one or more currencies that you want to monitor in the Currency Filter dropdown.
Click Save to apply the settings.
How to create document groups for SumSub verification
Create document groups to enable clients to submit various documents supported by SumSub for verification. For each document (such as an ID card, passport, driver’s license, and others) that you want to make available for verification, create a separate document group with the appropriate name.
To create a document group:
In the B2CORE Back Office, navigate to Verification > Document groups.
Click +Create in the upper-right page corner.
On the Create document group page, fill in the following fields:
In the Name field, specify the name of a document group.
Ensure to specify document group names exactly as the names of document types supported by SumSub, such as ID_CARD, PASSPORT, DRIVERS, RESIDENCE_PERMIT, and so on.
For example, if you want your clients to submit their ID cards for document verification, create a document group with the name ID_CARD.
In the Caption field, specify a document group caption that will be displayed in the B2CORE UI.
In the Type dropdown, select One.
In the Description field, specify a description for the document group that is used in the Back Office.
Make sure that Yes is selected in the Enabled dropdown.
Click Save to create the document group.
How to create document types for SumSub verification
For each document group that you've created, create a document type.
To create a document type:
In the B2CORE Back Office, navigate to Verification > Document Types.
Click +Create in the upper-right page corner.
On the Create document type page, fill in the following fields:
In the Name field, specify the name of a document type.
Document type names must be the same as the names of the previously created document groups. For example, ID_CARD, PASSPORT, DRIVERS, RESIDENCE_PERMIT, and so on.
In the Caption field, specify a document type caption that will be displayed in the B2CORE UI.
In the Description field, specify a description for the document type that will be displayed in the B2CORE UI.
In the Group dropdown, select a document group with which this document type must be associated.
In the Max files field, specify the maximum number of files that clients can upload for this document type.
In the Status dropdown, select Enabled.
Click Save to create the document type.
How to create verification levels for SumSub in the B2CORE Back Office
You can create verification levels or modify the existing levels to use SumSub for verification.
To create a verification level:
In the B2CORE Back Office, navigate to Verification > Levels.
Click +Create in the upper-right page corner.
On the Create verification level page, fill in the following fields:
In the Index field, specify a non-zero integer value.
The zero (
0) index is always assigned to the default verification level. For other verification levels, the index must be greater than zero, such as1for Level 1,2for Level 2 and so on.In the Wizard dropdown, select
SnsWizardSDK.In the Caption field, specify a level name that will be displayed in the B2CORE UI and mobile app, such as
Level 1. If required, specify the localization properties for this field by clicking the button located on the right side of the field.In the Desktop Description field, specify a description of the level to be displayed in the B2CORE UI. This description can include the permissions granted to clients once they obtain this level.
The description for the B2CORE UI can be specified in the HTML format. If required, specify the localization properties for this field.
In the Mobile Description field, specify a level description to be displayed in the mobile app.
The description for the mobile app can be specified in the JSON format. If required, specify the localization properties for this field.
In the Visible dropdown, select Yes.
In the Default dropdown, select No. (
Level 0is always the default verification level).In the Assigned Client Right dropdown, select a permission level defining the set of permissions that you want to grant to your clients after obtaining this verification level (for details, refer to Client rights).
In the Document groups dropdown, select one or more required document groups. For example, you can select
ID_CARDandRESIDENCE_PERMITif you want your clients to submit their ID cards and residence permits for verification to receive this level.In the Client tests dropdown, optionally select one or more accreditation tests if you want to force your clients to pass these tests before they can submit their documents for verification. The list of available tests includes all the tests with visibility set to Yes, which are displayed on the Client tests page.
Click Save to create the level.
How to create levels and flows in the SumSub interface
The B2CORE Back Office supports two types of clients: individual and corporate. The SumSub system provides the capability to set up a separate verification flow for each of the types. To use this option, make sure that you enabled the Client Resetting Mode when configuring a connection to SumSub.
To add a new level:
In the SumSub interface, navigate to Integrations > Applicant Levels.
Click Add new level.
Select the required steps.
Level names must be specified in the following formats:
For individual clients:
level1,level2, and so on.For corporate clients:
level3corporate,level4corporate, and so on.
These formats ensure correct mapping between levels in SumSub and B2CORE. The mapping is based on the Index assigned to each verification level in B2CORE. You can find indexes in the respective column on the Verification > Levels page of the B2CORE Back Office and use them in the level names for SumSub. For example:
level1in SumSub maps to the level with Index = 1 in B2CORElevel2in SumSub maps to the level with Index = 2 in B2CORElevel3corporatein SumSub maps to the level with Index = 3 in B2CORElevel4corporatein SumSub maps to the level with Index = 4 in B2CORE and so on.
To add a new flow:
In the SumSub interface, navigate to Integrations > Verification Flow.
Click Add new.
Select the required options. For each flow, select a compatible level.
SumSub webhook configurations
Pending
Name:
PENDINGReceiver:
HTTP EndpointTarget:
https://{your-Back-Office-URL}/api/v1/verification-sns/handleType:
Applicant pending (applicantPending)Secret key: the same for both webhooks
Reviewed
Name:
REVIEWEDReceiver:
HTTP EndpointTarget:
https://{your-Back-Office-URL}/api/v1/verification-sns/handleType:
Applicant reviewed (applicantReviewed)Secret key: the same for both webhooks
Make sure to replace {your-Back-Office-URL} with the domain of your B2CORE Back Office, not the B2CORE UI. For example, the target for webhooks may look like this: https://example.com/api/v1/verification-sns/handle.
Last updated
Was this helpful?