KYC ПЛАТФОРМА

Концепции (заявитель/заявка)

Заявитель (Applicant)

Заявитель — это сущность, группирующая в себе учётные данные, заявки на проверку физического лица и их статусы.

Идентификатор заявителя

Для работы с заявителями в МТС KYC платформе используется external_id — идентификатор заявителя из основной системы клиента.

Этот идентификатор: – Генерируется пользователем API – Должен быть уникальным в рамках вашей системы – Используется для связи заявителя с вашим продуктом – Имеет ограничение: 0..255 символов

В API заявитель может обозначаться как externalId или applicantKey. Это внешний идентификатор, по которому система клиента связывает свои данные с объектом заявителя в KYC Platform.

Данные заявителя

При создании заявителя можно передать следующую информацию:

  • externalId (обязательно) — внешний идентификатор заявителя
  • email — электронная почта
  • phone — номер телефона в формате MSISDN
  • firstName — имя
  • surname — фамилия
  • middleName — отчество
  • birthdate — дата рождения (формат ISO 8601 DateOnly: ГГГГ-ММ-ДД)
  • passport — паспортные данные:
  • series — серия
  • number — номер
  • issuedDate — дата выдачи
  • issuedBy — кем выдан
  • divisionCode — код подразделения
  • driverId — серия-номер водительского удостоверения
  • registrationAddress — данные адреса регистрации:
  • postalCode — индекс/почтовый код
  • region — регион
  • district — район
  • city — город
  • street — улица
  • house — номер дома
  • houseBuilding — строение
  • flat — квартира/офис

Заявка (Identification)

Заявка — это запрос на удалённую идентификацию, позволяющий собрать данные физического лица.

Заявка содержит технический идентификатор, статус, ссылку прохождения, собранные данные, результаты проверок, согласия и ошибки, если сценарий завершился неуспешно.

Жизненный цикл заявки

  1. Создание заявки — создаётся запрос на идентификацию для конкретного заявителя
  2. Сбор данных — заявитель предоставляет необходимые данные через модуль
  3. Обработка — система обрабатывает собранные данные
  4. Завершение — заявка получает финальный статус

Статусы заявки

Заявки на идентификацию имеют технические статусы (identificationStatus):

  • waitingForApplicantActions — заявка зарегистрирована, ожидание действий заявителя
  • collectingApplicantData — заявитель начал предоставлять данные
  • identificationInProgress — началась обработка данных по заявке
  • identificationFailed — заявка не прошла идентификацию (конечный статус)
  • identificationSucceeded — заявка прошла идентификацию (конечный статус)
  • systemError — произошла системная ошибка (конечный статус)
  • identificationManuallyAccepted — заявка одобрена вручную (конечный статус)
  • identificationManuallyRejected — заявка отклонена вручную (конечный статус)

Подробнее см. Справочник статусов.

Схема взаимодействия

Работа с заявителем

  1. Создание заявителя через API
  2. Обновление данных заявителя (при необходимости)
  3. Запуск идентификации по workflow
  4. Получение результатов идентификации
  5. Обезличивание заявителя, если персональные данные больше не должны храниться в платформе

Работа с заявкой

  1. Создание запроса на идентификацию по workflow
  2. Получение ссылки или интеграция модуля (см. Интеграция)
  3. Прохождение заявителем процесса идентификации
  4. Получение колбэка о завершении или PostMessage
  5. Получение результатов идентификации

Работа с контейнером MobileID

  1. Настройка контейнера MobileID
  2. Интеграция в процесс идентификации
  3. Получение данных через MobileID
  4. Обработка результатов

Инструкции по контейнеру MobileID и мобильным SDK относятся к интеграционному слою платформы. В API Reference фиксируются REST-методы, а инструкции по встраиванию лучше держать в продуктовых разделах интеграции.