How to use SumSubstance

See also

Verification

This article provides instructions on how to configure B2Core to use an automatic KYC provider, SumSubstance (SumSub).

How to configure a connection to the SumSub system

  1. Navigate to System > External Connections, and click +Create in the upper-right corner of the screen.

  2. In the invoked Create connection window, fill in the following fields:

  • In the Name field, type a name that you want to use for the connection.

  • In the Caption field, type a caption that will be applied to the connection in the B2Core Back Office.

  • From the Provider drop-down list, select SumSubstance.

  1. Click Save to create the connection.

  2. From a connections list, select the SumSub connection that you created and click Edit.

  3. On the Edit connection screen, specify the following settings:

  • In the Service Location field, type https://api.sumsub.com/.

  • In the Client ID field, type your SumSub account name. To view your account name, in the SumSub interface, go to Settings > Account Details.

  • In the Webhook Secret Key field, type a webhook secret. You should generate two webhooks via the SumSub interface. To generate webhooks, in the SumSub interface, go to in Dev space > Webhooks. The required webhook configurations are provided in SumSub webhook configurations.

  • Leave the Login and Password fields empty.

  • In the Token and Token Secret fields, type a token and a secret key value generated via the SumSub interface. To generate a token and a secret key value, in the SumSub interface, go to Dev space > App Tokens.

  • To apply different verification flows to individual and corporate clients, select Enabled from the Client Resetting Mode drop-down list.

Important

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 the other way around. After changing a type, the following happens:

  • In the B2Core Back Office, a client’s verification level resets to 0.

  • All pending client’s requests to improve their 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.

  1. Optionally, you can enable transaction monitoring for currencies if it is not enabled in the SumSub system. To enable the transaction monitoring service, select Yes in the Enabled drop-down list, and select one or more currencies that you want to monitor from the Currency Filter drop-down list.

  2. Click Save.

How to create verification levels for SumSub

Level 0 is a verification level that is created and assigned to each B2Core instance by default.

To create a new verification level, do the following:

  1. Navigate to Verification > Levels, and click +Create in the upper-right corner of the Levels screen.

  2. On the Create verification level screen, fill in the following fields:

  • In the Index field, specify a non-zero integer value.

  • In the Wizard filed, type B2B\TCA\DocumentsSNS\Wizards\SnsWizardSDK. This is a required path.

  • In the Caption field, type a level name that will be displayed in the B2Core UI. If required, specify the localization properties for this field by clicking the button located on the right side of the field.

  • In the Description field, enter a description for the new level. For example, you may enter a list of permissions granted to a client upon reaching this verification level. The level description will be displayed in the B2Core UI. The description can be specified in the HTML format. If required, specify the localization properties for this field by clicking the button located on the right side of the field.

  • From the Visible drop-down list, select Yes.

  • From the Default drop-down list, select No. (Level 0 is the default verification level).

  • From the Assigned Client Right drop-down list, select an appropriate access level (refer to Client rights for details).

  1. Click Save.

How to create document types for SumSub verification via the B2Core Back Office

  1. Navigate to Verification > Document Types, and click +Create in the upper-right corner of the Document types screen.

  2. Fill in the fields displayed on the Create document type screen (for details, refer to Document types).

Note

A document type name specified in the Name field must comply with the document types supported by the SumSub system.

  1. Click Save to create a document type.

How to create levels and flows via 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 the SumSub system.

To add a new level, do the following:

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

  2. Click Add new level.

  3. Select the required steps.

Important

Level names must be specified in the following formats:

  • For individual clients: level1, level2 and so on.

  • For corporate clients: level1corporate, level2corporate and so on.

To add a new flow, do the following:

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

  2. Click Add new.

  3. Select the required options. For each flow, select a compatible level.

SumSub webhook configurations

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