Workflow instances

Описание

workflow-instances — основной метод запуска идентификации по заранее настроенному сценарию. Для новых интеграций KYC Platform это целевой способ создать заявку: клиент передает идентификатор workflow, платформa создает запрос на идентификацию и возвращает ссылку для прохождения сценария.

Workflow хранит конфигурацию процесса на стороне платформы: набор шагов, способы сбора данных, проверки, настройки интерфейса, callback-и и правила обработки результата. Это позволяет не передавать полную конфигурацию сценария в каждом API-запросе.

Эндпоинт

POST https://api.mts.ru/rim/2.0/api/v2/identifications/workflow-instances

Prodlike:

POST https://api.mts.ru/rim-api-prodlike/2.0/api/v2/identifications/workflow-instances

Авторизация

Authorization: Bearer {access_token}
Content-Type: application/json

Тело запроса

{
  "workflowId": "019b4524-1cca-4d8a-9ee1-f15b05cbc110",
  "applicantExternalId": "client-user-12345",
  "linkLifetimeInMinutes": 195,
  "redirectUrl": "https://example.com/kyc/callback"
}

Параметры запроса

Параметр	Тип	Обязательный	Описание
`workflowId`	string	Да	Идентификатор заранее настроенного сценария идентификации.
`applicantExternalId`	string	Нет	Внешний идентификатор заявителя в системе клиента. Если заявитель уже создан, используйте тот же идентификатор.
`linkLifetimeInMinutes`	integer	Нет	Время жизни ссылки на прохождение идентификации. По источнику максимальное значение — 195 минут.
`redirectUrl`	string	Нет	URL, на который пользователь будет перенаправлен после завершения сценария.

Как выбирать workflow

Workflow настраивается на стороне KYC Platform заранее. В нём задаются шаги и проверки: сбор паспортных данных, селфи, адрес, Mobile ID, SMS-уведомление, ручной ввод, верификации, ИНН, скоринги, проверки РФМ, MNP и мобильной активности.

Если раньше интеграция передавала подробную конфигурацию через workflowPreferences, для новых подключений эту конфигурацию лучше переносить в настройки workflow. Тогда API-запрос остаётся коротким, а изменение сценария не требует доработки интеграции клиента.

Состав workflow

Блок	Назначение
`smsNotification`	Отправка SMS или уведомления пользователю.
`manualInput`	Ручной ввод данных пользователем.
`esia`	Сценарии, связанные с ЕСИА, если они включены в настройках клиента.
`mobileId`	Использование Mobile ID в составе KYC-сценария.
`bio`	Сбор документов, селфи и других шагов биометрического/визуального сценария.
`verification`	Проверки полученных данных субъекта.
`inn`	Получение или проверка ИНН.
`behaviourScoring`	Рисковые, антифродовые и иные виды скоринга.
`rfm`	Проверка по перечням экстремистов и террористов.
`mnp`	Проверка в сервисе MNP.
`mobileActivity`	Проверка мобильной активности абонента.

Ответ

202 Accepted

Платформа приняла запрос и создала заявку на идентификацию.

{
  "id": "019b550e-5ad2-4e57-9a2e-f37870de1664",
  "idShort": "DlWbAdJaV06aLvN4cN4WZA",
  "url": "https://rim.idscan.mts.ru/i/DlWbAdJaV06aLvN4cN4WZA?ott=bPrpz1VHHUeL7drAqSVnZw"
}

Поле	Описание
`id`	Идентификатор заявки на идентификацию.
`idShort`	Короткий идентификатор, который может использоваться в ссылке прохождения.
`url`	Ссылка, по которой пользователь проходит сценарий идентификации.

Ошибки

Код	Когда возникает
`400 Bad Request`	Некорректное тело запроса, неверный формат параметров или отсутствует обязательный параметр.
`401 Unauthorized`	Не передан или недействителен access token.
`404 Not Found`	Workflow или заявитель не найден.
`409 Conflict`	Запрос конфликтует с текущим состоянием данных.
`500 Server Error`	Внутренняя ошибка сервиса.

Что делать после создания заявки

Передайте пользователю ссылку из поля url или откройте её в модуле/SDK.
Дождитесь завершения сценария через callback или PostMessage.
Получите итоговые данные и статус методом Получить заявку.
Если нужно разобрать ход прохождения, используйте Timeline заявки.