Link to plugin page: https://zeroqode-demo-29.bubbleapps.io/sumsub_identity_verification

Demo to preview the plugin:

🔗

Live Demo: https://zeroqode-demo-29.bubbleapps.io/sumsub_identity_verification

🔗

Bubble Editor: https://bubble.io/page?version=live&type=page&name=sumsub_identity_verification&id=zeroqode-demo-29&ttab=tabs-1&tab=tabs-1

Introduction

Samsung is a leading provider of identity verification and compliance solutions. Their platform helps businesses verify user identities, comply with regulations, and mitigate fraud risks. They offer a range of verification methods, including document verification and facial recognition, combined with AI algorithms and human expertise. Sumsub's solutions are used across various industries and provide secure and scalable options for businesses of all sizes.

Prerequisites

You must have an account with sumsub.com to interact with the API. Create your development account at: https://sumsub.com

Actions

API Health

You can check the operational status of the service using the request below. HTTP status 200 in response which confirms the availability of our API.

Creating an applicant

An applicant is an entity representing one physical person. It may have several ID documents attached, like an ID card or a passport. Many additional photos of different documents can be attached to the same applicant.

⚠️

Please note that the level Name is case-sensitive and must be created in the same environment.

Fields

Field Name	Required	Description	Type
Level Name	Yes	A name of the user verification steps configuration that you should set up on the dashboard.	Text
External User ID	Yes	An applicant ID on the client side should be unique.	Text
Email	No	Applicant email.	Text
Country	No	Alpha-3 country code (e.g. DEU or GBR)	Text
Phone	No	Applicant phone number.	Text
First Name	No	Applicant's First name.	Text
Last Name	No	Applicant Last Name.	Text
Gender	No	Sex of a person (M or F).	Text
Date of Birth	No	Date of birth (format YYYY-MM-DD, e.g. 2001-09-25).	Text

States

Name	Type
Applicant ID	Text
Created At	Text
Client ID	Text
Inspection ID	Text
External User ID	Text
Place Of Birth	Text
Country	Text
Email	Text
Phone	text
Excluded Countries	Text (list)
Doc Sets	Text
Reprocessing	yes/no
Create Date	Text
Review Status	Text
Type	Text

Adding ID Document

If a document is double-sided submit two images and set up ID Doc Sub Type properly (FRONT_SIDE and BACK_SIDE)

Make sure to send BACK_SIDE if FRONT_SIDE was already sent otherwise verification step won't be completed, and you won't be able to initiate a check.

Fields

Field Name	Required	Description	Type
Applicant ID	Yes	Applicant ID	Text
File Url	Yes	File Url of photo of a document	Text
ID Doc Type	Yes	Example: ID_CARD, PASSPORT, DRIVERS, RESIDENCE_PERMIT, UTILITY_BILL, SELFIE, VIDEO_SELFIE, PROFILE_IMAGE, ID_DOC_PHOTO, AGREEMENT, CONTRACT, DRIVERS_TRANSLATION, INVESTOR_DOC, VEHICLE_REGISTRATION_CERTIFICATE, PAYMENT_METHOD, BANK_CARD, COVID_VACCINATION_FORM, OTHER	Text
Country	Yes	3-letter country code	Text
ID Doc Sub Type	No	Example: FRONT_SIDE, BACK_SIDE	Text
First Name	No	First name	Text
Last Name	No	Last Name	Text
Date of birth	No	Date of birth	text

State

Name	Type
Response	yes/no
ID	Text
Error message	Text

Getting applicant data

Note that particular data is shown only if it was recognized from the document or provided by user.

Fields

Name	Required	Description	Type
Applicant ID	Yes	Applicant ID	Text

States

Name	Type
Applicant ID	Text
Created At	Text
Key	Text
Client ID	Text
Inspection ID	Text
External User ID	Text
First Name	Text
First Name En	Text
Last Name	Text
Last Name En	Text
Date of Birthday	Text
Email	Text
Phone	Text
Required ID Docs	Text
Review ID	Text
Attempt ID	Text
Attempt Cnt	Number
Level Name	Text
Create Date	Text
Review Status	Text
Priority	Number
Type	Text

Changing Provided Info

If you'd like to alter the data that you've provided us to cross-check it with documents, this method patches the fields in the fixedInfo key of the applicant.

Fields

Name	Required	Description	Type
Applicant ID	Yes	Applicant ID	Text
First Name	No	First Name	Text
Last Name	No	Last Name	Text
Middle Name	No	Middle Name	Text
First Name En	No	Automatic transliteration of the first name.	Text
Last Name En	No	Automatic transliteration of the last name.	Text
Middle Name En	No	Automatic transliteration of the middle name.	Text
Legal Name	No	Legal Name	Text
Gender	No	Sex of a person (M or F).	Text
Date of Birthday	No	Date of birth (format YYYY-mm-dd, e.g. 2001-09-25).	Text
Place Of Birth	No	Place of birth.	Text
State Of Birth	No	State Of Birth	Text
Country	No	Alpha-3 country code (e.g. DEU or GBR)	Text
Nationality	No	Alpha-3 country code	Text
Tin	No	Tax Identification Number.	Text

States

States	Type
First Name	Text
Last Name	Text
Middle Name	Text
First Name En	Text
Last Name En	Text
Middle Name En	Text
Legal Name	Text
Gender	Text
Date of Birthday	Text
Place Of Birth	Text
Country Of Birth	Text
Country	Text
Nationality	Text
Tin	Text
State Of Birth	Text

Getting Applicant Status

Fields

Name	Required	Description	Type
Applicant ID	Yes	Applicant ID	Text

State

Name	Type
SELFIE	Text
IDENTITY	Text

Clarifying The Reason for Rejection

Fields

Name	Required	Description	Type
Applicant ID	Yes	Applicant ID	Text

State

Name	Type
Result	Test(list)

Requesting an Applicant Check

You can programmatically ask us to re-check an applicant in cases where you or your user believe that our system made a mistake, or you're sending us documents via API and would like us to perform a check. To initiate a re-check, simply move the applicant to the pending state by performing the following request.

Fields

Name	Required	Description	Type
Applicant ID	Yes	Applicant ID	Text

States

Name	Type
Respons	yes/no
Error message	Text

Getting Document Images

If you are interested in receiving images that were a part of the final verification, you should use this method.

Since a user may re-upload images several times and, for example, also change a passport photo to an ID card, it might be tricky for you to understand which ones actually made the applicant pass or fail.

Fields

Name	Required	Description	Type
Inspection ID	Yes	Inspection ID (it's part of an applicant)	Text
Image ID	Yes	Image ID	text

State

Name	Type
Response	text
Error message	text

Adding an Applicant to Blocklist

If for some reason you need to add an applicant to the blocklist, you can use this endpoint. It is necessary to add the reason for adding the applicant to the blocklist.

Fields

Name	Required	Description	Type
Applicant ID	Yes	Applicant ID	Text
Note	Yes	Reason or note for the applicant added to the blocklist	Text

State

Name	Type
Applicant ID	Text
Created At	Text
Key	Text
Client ID	Text
Inspection ID	Text
External User ID	Text
First Name	Text
Last Name	Text
Date of Birthday	Text
Gender	Text
Country	Text
Phone	Text
Email	Text
Applicant Platform	Text
Doc Sets	Text
Review ID	Text
Attempt ID	Text
Attempt Cnt	Number
Elapsed Since Pending Ms	Number
Elapsed Since Queued Ms	Number
Level Name	Text
Create Date	Text
Review Date	Text
Reject Labels	Text (list)
Review Answer	Text
Review Reject Type	Text
Review Status	Text
Type	Text
Error Message	Text

Resetting an Applicant

In very rare cases, it is required to change the status of the applicant to init. For example, if a user has contacted support with a request to re-pass verification from scratch with new documents.

Fields

Name	Required	Description	Type
Applicant ID	Yes	Applicant ID	Text

State

Name	Type
Result	Yes/No

Changing top-level Info

This method patches top-level applicant info like email, externalUserId, sourceKey, type for specified applicantId. The body must contain only those fields that you intend to change. Null fields will be ignored.

Fields

Name	Required	Description	Type
Applicant ID	Yes	Applicant ID	Text
External User ID	No	New External ID for an applicant	Text
Email	No	New email	Text
Phone	No	New phone number	Text
Source Key	No	New sourceKey	Text
Lang	No	The language in which the applicant should see the result of the verification.	Text

State

Name	Type
Applicant ID	Text
Created At	Text
Key	Text
Client ID	Text
Inspection ID	Text
External User ID	Text
Source Key	Text
Info First Name	Text
Info First Name En	Text
Info Middle Name	Text
Info Middle Name En	Text
Info Last Name	Text
Info Last Name En	Text
Info Date of Birthday	Text
Info Gender	Text
Info Place Of Birth	Text
Info Place Of Birth En	Text
Info Country	Text
Info Nationality	Text
Info Country Of Birth	Text
Info State Of Birth	Text
Info Phone	Text
Info Addresses	Text
Info Tin	Text
Info ID Docs	Text
Info Legal Name	Text
Fixed Info First Name	Text
Fixed Info Last Name	Text
Fixed Info Dob	Text
Fixed Info Country	Text
Email	Text
Phone	Text
Applicant Platform	Text
Required ID Docs - Doc Sets	Text
Review Review ID	Text
Review Attempt ID	Text
Review Attempt Cnt	Number
Review Level Name	Text
Review Create Date	Text
Review Review Status	Text
Lang	Text
Type	Text
Tags	Text(list)

Marking Image as Inactive

Fields

Name	Required	Description	Type
Inspection ID	Yes	Inspection id	Text
Image ID	Yes	Image ID	Text

State

Name	Type
Result	Yes/No
Error message	Text

Set Risk Level For The Applicant

This method allows you to set a risk level for your applicant by your own criteria.

Fields

Name	Required	Description	Type
Applicant ID	Yes	Applicant ID	Text
Comment	Yes	Any string	Text
Risk Level	Yes	Valid values are: unknown/low/medium/high	Text

States

Name	Type
Result	Text
Risk Level	Text
Error Message	Text

Adding Custom Applicant Tags

Use this method to assign custom tags to applicant profiles. Also, create new tags in the Global settings section of the dashboard

Fields

Name	Required	Description	Type
Applicant ID	Yes	Applicant ID	Text
Tags	Yes	List of custom tag strings: Approved Sanctions, Approved PEP, 821	Text

State

Name	Type
Result	Yes/No
Error Message	Text

Sumsub Identity Verification

Demo to preview the plugin:

Introduction

Prerequisites

Actions

API Health

Creating an applicant

Adding ID Document

Getting applicant data

Changing Provided Info

Getting Applicant Status

Clarifying The Reason for Rejection

Requesting an Applicant Check

Getting Document Images

Adding an Applicant to Blocklist

Resetting an Applicant

Changing top-level Info

Marking Image as Inactive

Set Risk Level For The Applicant

Adding Custom Applicant Tags

Changelogs