How to use ShuftiPro

This article provides instructions on how to configure B2Core to use the automatic KYC provider, ShuftiPro. With ShuftiPro, you can conduct document and face verification to validate the identity of individual clients, as well as address and location verification.

How to configure a connection to ShuftiPro

Only admins who are assigned the permissions to manage external connections can set up a connection to ShuftiPro.

Set up a connection as follows:

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

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

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

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

  • In the Provider dropdown, select ShuftiPro.

  1. Click Save.

  2. On the Edit connection page, specify the following settings:

  • In the API host field, specify a URL to the ShuftiPro API endpoint.

  • In the Client ID and Secret key fields, specify the client ID and secret key value to access ShuftiPro.

  • In the New signature (for secrets after March 2023) field, select either:

    • No — for clients who registered with ShuftiPro before March 15, 2023.

    • Yes — for clients who registered with ShuftiPro or updated their secret keys after March 15, 2023. This is needed to validate a key signature returned in ShuftiPro API responses (for details, refer to Response Signature in the ShuftiPro documentation).

  1. In the Enabled dropdown, select Yes.

  2. Click Save to create the connection.

How to create document groups for ShuftiPro verification

For document verification, create three document groups with the names passport, id_card, and driving_license. These groups enables you to request your clients to submit various documents, such as passports, national identity cards, and driving licenses, for identity verification.

For address and location verification, create four document groups with the names rent_agreement, bank_letter_receipt, employer_letter, and utility_bill. These groups enables you to request your clients to submit various documents, including rent agreements, bank letter receipts, employer letters, and utility bills to confirm their addresses and locations such as cities or countries.

For face verification, create a document group with the name selfie.

Create a document group as follows:

  1. Navigate to Verification > Document groups and click +Create in the upper-right page corner.

  2. On the Create document group page, fill in the following fields:

  • In the Name field, specify the name of a document group.

  • 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.

Important

Ensure to specify document group names exactly as provided above, in lower case. For example: passport, id_card, driving_license, selfie, rent_agreement, and so on.

  1. Make sure that Yes is selected in the Enabled dropdown.

  2. Click Save to create the document group.

How to create document types for ShuftiPro verification

Create a document type for each document group.

Create a document type as follows:

  1. Navigate to Verification > Document types and click +Create in the upper-right page corner.

  2. On the Create document type page, fill in the following fields:

  • In the Name field, specify the name of a document type.

  • 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 previously created 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.

Important

Document type names must be the same as the names of the previously created document groups. For example: passport, id_card, selfie, rent_agreement, and so on.

  1. In the Status dropdown, select Enabled.

  2. Click Save to create the document type.

How to create verification levels for ShuftiPro

You can create verification levels or modify the existing levels to use ShuftiPro for document, address, and face verification.

Create a verification level as follows:

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

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

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

  • In the Wizard dropdown, select either of the two options:

    • ShuftiProSDK to open the default ShuftiPro window in the B2Core UI so that clients can upload the documents required for verification.

    • ShuftiProDirect to open the window specifically designed for the B2Core UI so that clients can upload the documents required for verification.

  • In the Caption field, specify a level name that will be displayed in the B2Core UI and mobile app (for example, 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 level description to be displayed in the B2Core UI. For a level description, you can list the permissions granted to clients after obtaining 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 0 is the default verification level).

  • In the Assigned Client Right dropdown, select an appropriate access level (refer to Client rights for details).

  • In the Document groups dropdown, select one or more required document groups. For example, you can select passport and selfie if you want your clients to submit their passports and pass face verification to receive this level.

  1. Click Save to create the level.