# V6.5.0 - SumSub Integration
**Released Date - 23 May 2023**
We're thrilled to share that our latest release includes full integration with SumSub, an all-in-one KYC verification platform that can help catch fraudsters and ensure your business meets compliance regulations worldwide. With this new integration, you can enhance your KYC and due diligence checks on clients, giving you peace of mind that your business is secure.
## Summary
1. [SumSub Integration](#sumsub-integration)
* **Streamlined KYC/KYB/AML Processes:** \
Sumsub provides an all-in-one toolkit that simplifies and automates the customer onboarding and verification procedures, reducing manual effort and accelerating the process.
* **Compliance with Regulatory Requirements:** \
By utilizing Sumsub's platform, businesses can ensure they meet the necessary KYC, KYB, and AML regulations, reducing the risk of non-compliance and associated penalties.
* **Enhanced Security:** \
Sumsub's integration helps detect and prevent digital fraud, improving the overall security of the CRM system and protecting against potential risks.
* **Improved Customer Experience:** \
With faster verification processes, customers experience a smoother onboarding journey, resulting in higher conversion rates and increased customer satisfaction.
## Sumsub Integration
### 1) Marketplace Installation
Install SumSub on your CRM by following the steps below:
{% tabs %}
{% tab title="Step 1" %}
1. Go to marketplace and look for SumSub.
2. Click "Obtain".\
{% endtab %}
{% tab title="Step 2" %}
You will be redirected to a page providing you with a brief background SumSub. Click "Obtain" to proceed with the installation.
{% endtab %}
{% endtabs %}
### 2) Roles and Permissions
Upon installation of SumSub, you will need to ensure the respective permissions are enabled.
1. KYC Verification - this permission allows users to view the SumSub verification results on the client detail page and request page.
2. Update Sumsub Status - this permission allows users to update SumSub's verification status.
3. Read Sumsub Settings - this permission allows users to view SumSub settings
4. Update Sumsub Settings - this permission allows users to edit SumSub settings
### 3) Register SumSub Account
To register and setup your SumSub account, follow the steps below:
{% tabs %}
{% tab title="Step 1" %}
1. Go to SumSub website and click "Sign Up".
2. Fill in the necessary fields and click "Sign Up". \
3. Key in the email OTP sent to your email address. \
4. Set the password to your Sumsub account and click "Complete". \
5. Click "Go to Login".\
6. Key in your username and password and login. \
7. On the first login, you will need to setup Two-Factor-Authentication (2FA). \
8. Once 2FA is setup, you will successful login to your SumSub account.
{% endtab %}
{% tab title="Step 2" %}
1. Navigate to "Billing" and select your plan by clicking "Choose your plan". By default, SumSub has a 14 day free trial (subject to changes).
2. Select your preferred plan and fill in your payment details.
3. Once you have selected your plan and filled in your payment details, you will be switched to "Production" environment.
{% endtab %}
{% endtabs %}
### 4) Configure KYC Levels on SumSub
You will need to configure the various KYC Levels on SumSub. Different KYC Levels will have different requirements and verifications that your clients will need to complete.
{% tabs %}
{% tab title="Step 1" %}
1. Navigate to "Integration" > "Individuals" and click "Create Level".
2. Fill in "Level" Name. \
\
{% endtab %}
{% tab title="Step 2" %}
It is recommended to create 2 separate "Levels":
* Document Verification
* Face Liveness Check
Scroll down and under "Verification steps":
1. By default, there will be 2 steps: Identity Document and Selfie
2. Delete the respective verification step
1. If you are configuring the "Level" for Document Verification, click the "Delete" icon beside "Selfie".
2. If you are configuring the "Level for Face Liveness Check, click the "Delete" icon beside "Identity document".
{% endtab %}
{% tab title="Step 3" %}
For "Identity document":
1. Select "File upload".
2. Select the supported documents.
3. Click "Create Level".
For "Selfie":
1. Select "Advanced liveness check".
2. Click "Create Level".
{% endtab %}
{% endtabs %}
### 5) Obtaining SumSub Token & Secret Key
The SumSub Token & Secret Key is required in order for you to connect your SumSub account to the CRM. You can obtain them by following the steps below:
{% tabs %}
{% tab title="Step 1" %}
1. Navigate to "Dev space" > "App tokens".
2. Click "Generate app token".
{% endtab %}
{% tab title="Step 2" %}
1. Fill in the "Name".
2. Click "Generate app token".
{% endtab %}
{% tab title="Step 3" %}
1. The token and secret key will be generated.
2. Please save the Token and Secret Key separately and click "I've saved app token and key securely". \
\
3. You will no longer be able to view the data for security reasons.
{% endtab %}
{% endtabs %}
### 6) Create Webhook on SumSub
You will need to create a webhook on Sumsub. To do so, follow these steps:
{% tabs %}
{% tab title="Step 1" %}
1. Go to "Dev space" > "Webhook manager".
2. Click "Create webhook".
{% endtab %}
{% tab title="Step 2" %}
1. Fill in the name of your webhook.
2. You will also need to fill in the "Target". \
\&#xNAN;*"Target" = **Host**/api/v1/file/sumsub/webhooks*\
\
3. To retrieve the **Host**, on the CRM, navigate to "Dev Space" > "Open API Keys". You will see the **Host** displayed here.
4. Fill in the "Target".
5. Select "applicantCreated" and "applicantReviewed" under "Webhook types". \
\
{% endtab %}
{% tab title="Step 3" %}
1. Under "HTTP Headers", click "Add key value pair". \
\
2. For "Key", fill in "id".
3. For "Value", fill in your CRM ID. \
\
4. To retrieve your CRM ID, navigate to "Back Office" > "Brand Settings". Your CRM ID will be displayed here.
5. Fill in on SumSub and click "Create webhook".
{% endtab %}
{% endtabs %}
### 7) Connecting SumSub to CRM
SumSub on CRM is categorized into 2 different sections:
1. Document Verification - this involves verifying the authenticity and integrity of the documents uploaded by clients, which allows brokers to ensure that the documents are not tampered with.
2. Authentication - this refers to any other verification steps setup on SumSub such as face recognition, phone verification or risk assessment questionnaires.
#### A) Document Verification Setup
{% tabs %}
{% tab title="Step 1" %}
1. Navigate to KYC > SumSub Settings on the CRM.
{% endtab %}
{% tab title="Step 2" %}
1. Click the "Edit" icon.
2. Turn on "File Verification".
3. Key in the following:
* Token
* Secret Key
* Level Name - please ensure this corresponds to the level name on SumSub
{% endtab %}
{% tab title="Step 3" %}
1. Complete the File Validation Configuration.
2. You will need to correlate the Sumsub file fields with the KYC file fields one by one to ensure that the file uploaded to Sumsub for verification is referenced to the correct document uploaded by clients.
3. Sumsub Field & KYC Form - Group
* By default, the CRM will list out all the KYC forms you have setup.
* You will need to configure the File Validation Configuration for all KYC forms.
* For each KYC form, you will need to select the KYC form fields group.
4. Sumsub File Type
* By default, all the selected file types on SumSub will be reflected here.
* You can click the dropdown list to select your preferred file types.
5. Front and Back
* You will need to select which KYC field the file type corresponds to.
6. You can add or delete file types by clicking on the respective icons.
7. Click "Save".
{% endtab %}
{% endtabs %}
#### B) Authentication Setup
{% tabs %}
{% tab title="Step 1" %}
Navigate to KYC > SumSub Settings on the CRM.
{% endtab %}
{% tab title="Step 2" %}
1. Click the "Edit" icon. Turn on "Authentication".
2. Key in the following:
* Token
* Secret Key
* Level Name - please ensure this corresponds to the level name on SumSub
{% endtab %}
{% tab title="Step 3" %}
Brokers will need to set the Authentication reminder policy. \
The available options are:
1. Do not remind
* This means that clients will not be reminded to complete their authentication
* This is the default selection
2. Remind each time you log in
* This means that clients will be reminded to complete their authentication each time they login to the CRM.
* A popup will appear when clients login. Clients can click "Authenticate Now" to complete the authentication or "Cancel" to close the popup.
3. Mandatory verification
* Brokers will be able to select which functions will be disabled if client have yet to complete the authentication. \
* If authentication is not completed and client attempts to perform any of the selected functions, a popup notice will appear to inform clients to complete authentication first.\
Click "Save".
{% endtab %}
{% endtabs %}
### **8) Document Verification**
#### **A) For New Clients**
Brokers will be able to verify the documents of new clients when they submit the following requests:
1. KYC
2. Trader Registration - if KYC is required upon registration
{% tabs %}
{% tab title="Step 1" %}
When brokers are reviewing KYC or Trader Registration requests, they will be able to see the following:
* SumSub Verification Results
* Document Verification
{% endtab %}
{% tab title="Step 2" %}
Before document verification, when brokers click onto "Sumsub Verification Results", there will be no data available.
{% endtab %}
{% tab title="Step 3" %}
1. To proceed with the document verification, click "Document Verification".
2. Fill in the Country, File Type and click "Verify".\
3. The document will be submitted to SumSub for verification.
{% endtab %}
{% tab title="Step 4" %}
1. Sumsub Verification Link will display the SumSub ID and the timestamp of when the verification was submittted to SumSub.
2. Clicking onto the SumSub ID will open a tab showing the SumSub verification details.
3. Once document has been verified, broker can proceed to approve or reject the client's request.
{% endtab %}
{% endtabs %}
#### B) For Existing Clients
1. Brokers are able to conduct document verification on existing clients as well.
2. Brokers can do so via the following ways:
* Document Verification on Client Details Page
* Document Verification on Deposit or Withdrawal Request Page
**Document Verification on Client Details Page**
{% tabs %}
{% tab title="Step 1" %}
1. On the Client Details Page, navitage to "KYC".
2. You will be able to see a new section on the top for document verification.
{% endtab %}
{% tab title="Step 2" %}
1. Brokers will be able to see the "Status" of the document verification. The different statuses are:
* Unverified
* Verified
* Failed to Verify
2. Click "Document Verification" to proceed with the verification.
3. Fill in Country, File Type and click "Verify".\
4. The document will be submitted to SumSub for verification.
{% endtab %}
{% tab title="Step 3" %}
1. You will be able to see the updated status, validation results and last verified time.
2. You can click onto the "Validation Results" and a tab will be opened showing the SumSub verification results.
{% endtab %}
{% endtabs %}
**Document Verification on Deposit / Withdrawal Request Page**
{% tabs %}
{% tab title="Step 1" %}
When brokers are reviewing deposit or withdrawal requests, they will be able to see the following:
* SumSub Verification Results
* Document Verification
{% endtab %}
{% tab title="Step 2" %}
1. Brokers can view the status of the document verification by clicking "SumSub Verification Results".
2. If document has not been verified, no data will be available.
{% endtab %}
{% tab title="Step 3" %}
1. If document verification has not been completed, brokers can proceed to click "Document Verification".
2. Fill in the country, file type and click "Verify". \
3. The document will be submitted to SumSub for verification.
4. Once document has been verified, brokers can proceed to approve / reject client's request.
{% endtab %}
{% endtabs %}
### **9) Authentication**
The process will be as the following:
{% tabs %}
{% tab title="Step 1" %}
1. On the client portal "Settings" page, clients will be able to see their authentication status as "Unverified".
2. To proceed to authenticate their account, click "Authenticate Now".
{% endtab %}
{% tab title="Step 2" %}
1. Sumsub popup will appear. Agree to the terms and click "Next". \
2. Clients will be able to view the instructions and click "I'm Ready". \
3. Clients can also opt to continue the verification on their mobile phones by clicking "Continue on phone". A link and QR code will be provided for the client to continue the process on their phones. \
4. Follow the instructions and complete the selfie check. You will need to have a device with front facing camera to complete this.
5. Once completed, clients will be able to see an overview of the steps done. Click "Next" to proceed. \
6. Once completed, clients will be notified that their data is being processed and the status of the authentication will be updated once completed. \
{% endtab %}
{% tab title="Step 3" %}
Once authentication is completed, clients will be able to view the results:
1. If approved, the status will indicate "Verified".
2. If rejected, the status will indicate "Authentication Failed".
* Clients can click the "View" icon to view the rejection reason.
* Depending on the reason of rejection, clients can redo the Authentication by clicking "Reauthentication".
* If the authentication was rejected but manually approved by the broker on SumSub, the authentication status will be updated to show "Verified".
{% endtab %}
{% tab title="Step 4" %}
Brokers will be able to view the Authentication status via the CRM Backoffice Portal.
1. On the Client Details Page, navigate to "Authentication".
2. You will be able to see the following details:
* Status
* Validation Results - you can click onto it to view the details on SumSub.
* Last Verified Time
{% endtab %}
{% endtabs %}
