Help Center
Our products knowledge base for customers
Sumsub
Sumsub
1. Sumsub ➝ AppToken
В первую очередь необходимо создать токен в Sumsub. После создания токена будет автоматически сгенерирован секретный ключ. Данные сущности понадобятся для последующего создания соединения с платформой.
В подразделе Dev space ➝ App Token
нажмите Generate app token, чтобы открыть форму создания токена. Укажите название для токена в поле Name
и настройте необходимые разрешения в поле Permissions
. Нажмите SAVE, чтобы сохранить токен.
Спикок возможых разрешений:
- See applicant’s personal data
- See check results
- Change applicant’s personal data
- Moderate Applicants
- Manage dashboard users
- Manage company settings
- See statistics and analytics
- See costs of checks
- Manage applicant notes
- Use moderation buttons
- Manage check results
- Manage KYT settings
- See KYT transactions
- Manage KYT transactions
- Manage KYT rules
- See customizable lists
- Manage customizable lists
- Manage KYT settings
- See KYT transactions
- Manage KYT transactions
- Manage KYT rules
- See AML cases
- Manage AML cases
- Manage workflows
- Blocklist applicants
- Reset applicants
- Manage applicant tags
- Download bulk applicant report
- Change applicant level
- See list of applicants
- Deactivate applicants
ВАЖНО! После сохранения токена, отобразится предупреждение о том, что необходимо сохранить токен и секретный ключ. После подтверждения того, что данные сохранены и нажатия кнопки All is saved данные о секретном ключе больше нигде отображаться не будут. При обновлении страницы секретный ключ также не будет отображаться.
После сохранения токена, он будет отображаться в общем списке доступных токенов:
2. Настройки ➝ Sumsub (Платформа)
В разделе KYC ➝ Настройки ➝ Sumsub
нажмите Создать соединение для создания соединения с Sumsub в системе.
Для создания нового соединения необходимо заполнить следующие поля:
В поле Провайдер
указать Sumsub
.
Название
- указать название соединения.
Токен
- в данном поле следует указать токен, который был сгенерирован в Sumsub на предыдущем шаге.
Секретный ключ
- в данном поле следует указать секретный ключ, который был сгенерирован в Sumsub на предыдущем шаге.
После создания соединения, в платформе сгенерируется вебхук, который будет использоваться для Sumsub (см. следующий шаг).
При инициализации WebSDK или MobileSDK необходимо использовать аутентификацию с помощью токена доступа. В поле Время жизни токена
задается время, которое этот токен в платформе будет существовать. По истечению данного времени, будет сгенерирован новый токен. Значение по умолчанию равно 10 минутам.
После заполнения указанных полей нажмите СОЗДАТЬ для сохранения вашего соединения. Оно будет отображаться в общем списке соединений.
3. Sumsub ➝ Webhooks
Напротив созданного в платформе соединения нажмите на Конфигурация
для того, чтобы увидеть URL веб-хука
и Секретный ключ
соединения. Они понадобятся для создания вебхука с Sumsub.
Для создания вебхука c платформой, в системе Sumsub перейдите в раздел Dev space ➝ Webhooks ➝ Webhook manager
.
Нажмите Create webhook и заполните следующие поля:
Name
- название вашего вебхука в Sumsub.
В поле Receiver
необходимо выбрать HTTP Address
В поле Target
необходимо указать Webhook URL
соединения, ранее созданного в платформе, в разделе Connections
.
В поле Webhook types
укажите типы вебхуков, которые будут отправляться из Sumsub (Например, Applicant created, Applicant pending и т.д.).
В поле Applicant types
укажите тип аппликантов, который будет использовать данный вебхук - Individual
, Company
или оба. Если оставить данное поле пустым, оно будет включать в себя оба типа аппликантов. Тем не менее, большинство случаев покрывается типом Individual
.
В поле Secret key
необходимо указать Secret key
соединения, созданного на предыдущем шаге.
В поле Signature algorithm
укажите тип шифрования, поддерживаемый платформой - SHA512
или SHA256
.
Нажмите Create webhook для сохранения созданного вебхука.
Нажмите SAVE CHANGES, чтобы сохранить изменения в редактируемом вебхуке.
Вы также можете проверить работу вебхука, нажав кнопку Test webhook.
При корректной настройке, в правом верхнем углу экрана вы увидите следующее уведомление:
Проверить логи соединения вебхука можно в разделе Dev space ➝ Webhooks ➝ Webhook logs
:
4. Sumsub ➝ KYC levels
Здесь вы можете настроить различные уровни KYC для пользователей.
Нажмите Create level для создания нового уровня KYC.
При создании или настройке уровня вам будут доступны следующие поля:
Name
- Название уровня в Sumsub.
Обратите внимание! Данное поле заполняется один раз. После первичного сохранения уровня, поле станет нередактируемым.
В поле Type
задается тип верификации - стандартная или с дополнительными проверками, которые вы можете задать в дальнейшем.
В разделе More options
вы можете задать ряд дополнительных настроек. В их числе настройка, которая позволяет отправлять пользователям сообщения о статусах в процессе их верификации - Send emails about verification statuses
.
Нажмите SAVE, чтобы сохранить настройки уровня.
После сохранения настроек в разделе, отобразятся ссылки и QR-код, которые будут отображены аппликанту в системе до верификации. Так как верификация происходит непосредственно в платформе, они для работы не требуются.
В подразделе Required Steps
вы можете задать информацию, требуемую от пользователя для верификации.
5. Платформа ➝ Шаги KYC
После настройки уровня в Sumsub, его необходимо добавить в платформу.
Для этого в разделе KYC ➝ Настройки ➝ Шаги
нажмите СОЗДАТЬ и заполните следующие поля:
Связь KYC
- соединение, созданное вами в разделе Sumsub
.
Название
- название уровня, отображаемое в платформе.
Уровень SumSub
- название уровня, созданного ранее в Sumsub.
Нажмите СОЗДАТЬ для сохранения уровня с заданными настройками.
6. Verification
Пользовательская часть:
Когда пользователь зайдет в систему - он увидит сообщение о необходимости верификации. Пользователь будет верифицирован и ему станет доступен весь функционал, когда он пройдет верификацию, определенную ранее в настройках уровней.
Данные аппликанта по мере заполнения полей будут направляться в Sumsub.
После успешного заполнения данных, необходимых для верификации, аппликант увидит уведомление, в котором будет указан статус его заявки. Чтобы узнать, на каком этапе проверки находится его заявка, аппликант должен нажать Подтвердить сейчас
в верхней части экрана.
Если верификация пройдена - в соответствующих подразделах KYC ➝ Кандидаты
и в разделе Доступ ➝ Профили
профиль будет в статусе Профиль подтвержден
.
В этом статусе функционал пользователя более не ограничен.
Также заглушка с сообщением пользователю о необходимости верификации исчезнет и профилю станет доступен весь функционал платформы.
Если у пользователя не все данные заполнены корректно - он может быть отправлен на дополнительную проверку, в платформе по клику на Пройти верификацию
он увидит уведомление с указанием документов, которые необходимо заполнить, отредактировать.
Административная часть:
В подразделе KYC ➝ Настройки
есть возможность принудительной верификации пользователей, минуя все этапы верификации в Sumsub. Для этого достаточно выбрать карточку кандидата, в ней нажать кнопку Изменить статус и указать нужный уровень верификации для профиля.
После успешной верификации в разделах Кандидаты
и Профили
профилю будет присвоен статус Профиль подтвержден
.
В Sumsub статус будет изменен на Approved
.
Если пользователь заполнил данные, но они прошли не все этапы проверки - профилю пользователя присваивается статус Необходимо подтверждение профиля
.
В списке аппликантов Sumsub, профиль аппликанта будет отображен в статусе Documents requested
, пока аппликант не заполнит все необходимые поля.
Когда пользователь заполнил все данные и отправил их на рассмотрение - профилю пользователя присваивается статус Pending
. В таком же статусе он находится списке аппликантов в Sumsub.
После начала проверки статус в Sumsub будет изменен на Requires action
.
Если у аппликанта не все данные заполнены корректно - он может быть отправлен на дополнительную проверку, в административной части платформы ему будет присвоен статус Данные профиля устарели
.
В Sumsub ему будет присвоен статус Resubmission required
.
Если возникает необходимость запросить дополнительные данные у уже верифицированного аппликанта - в платформе ему будет присвоен статус Требуется обновление информации
(Необходимо подтверждение профиля
для профиля), в Sumsub - Resubmission required
Если проверка не пройдена - в платформе статус будет изменен на Подтверждение профиля отклонено
.
В списке аппликантов в Sumsub заявке аппликанта будет присвоен статус Rejected
.