Ссылка / Redirect

Интеграция через ссылку — самый простой способ подключения модуля идентификации. После создания заявки вы получаете ссылку, которую можно отправить пользователю по любому каналу связи.

Когда использовать

Используйте ссылку, если нужно быстро отправить пользователю готовый KYC-сценарий без встраивания iframe, WebSDK или мобильного SDK. Такой вариант удобен для SMS, email, push, операционных коммуникаций и ручной отправки из CRM.

Создание заявки

Для новых интеграций создайте заявку по настроенному workflow:

POST /api/v2/identifications/workflow-instances

Подробнее см. API: Workflow instances.

В ответе вы получите:

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

Использование ссылки

Отправка по SMS

Отправка SMS может быть частью настроенного workflow или выполняться на стороне клиента после получения url в ответе workflow-instances.

Отправка по собственным каналам

Вы можете отправить ссылку пользователю любым удобным способом:

  • Email
  • Push-уведомление
  • Внутренний мессенджер
  • Чат-бот
  • И т.д.

Пример отправки ссылки

// После создания заявки по workflow
const response = await fetch('/api/v2/identifications/workflow-instances', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer ' + token,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    workflowId: '019b4524-1cca-4d8a-9ee1-f15b05cbc110',
    applicantExternalId: 'user123',
    redirectUrl: 'https://example.com/callback'
  })
});

const { url } = await response.json();

// Отправка ссылки пользователю
sendSMS(userPhone, `Пройдите идентификацию: ${url}`);
// или
sendEmail(userEmail, 'Идентификация', `Перейдите по ссылке: ${url}`);

Redirect URL

Вы можете указать URL для перенаправления пользователя после завершения идентификации:

{
  "workflowId": "019b4524-1cca-4d8a-9ee1-f15b05cbc110",
  "applicantExternalId": "user123",
  "redirectUrl": "https://your-app.com/callback"
}

После завершения идентификации пользователь будет перенаправлен на указанный URL с параметрами результата.

Время жизни ссылки

Время жизни ссылки задается настройками workflow.

Обработка результата

После того, как пользователь пройдёт идентификацию по ссылке:

  1. Колбэк — вы получите автоматическое уведомление на ваш сервер
  2. API запрос — вы можете запросить результат через API
  3. Redirect — если указан redirectUrl, пользователь будет перенаправлен

Пример обработки через колбэк

// На вашем сервере
app.post('/kyc-callback', (req, res) => {
  const { externalId, id, identificationStatus } = req.body;

  if (identificationStatus === 'identificationSucceeded') {
    // Получаем полные данные через API
    fetch(`/api/v2/applicants/${externalId}/identifications/${id}`)
      .then(response => response.json())
      .then(data => {
        // Обработка успешной идентификации
        handleSuccess(data);
      });
  }

  res.status(200).send('OK');
});

Подробнее см. API: Получить заявку и Callback.

Пример обработки через redirect

// На странице callback
const urlParams = new URLSearchParams(window.location.search);
const identificationId = urlParams.get('id');
const status = urlParams.get('status');

if (status === 'success') {
  // Получаем данные через API
  fetch(`/api/v2/applicants/${externalId}/identifications/${identificationId}`)
    .then(response => response.json())
    .then(data => {
      // Обработка успешной идентификации
      showSuccessMessage();
    });
}

Подробнее см. API: Получить заявку. “`

Безопасность

  • Ссылки содержат токены доступа — не передавайте их в открытом виде
  • Используйте HTTPS для всех запросов
  • Проверяйте время жизни ссылки на вашей стороне
  • Валидируйте данные, полученные после идентификации

Преимущества интеграции через ссылку

  • ✅ Простота интеграции — не требуется встраивание в приложение
  • ✅ Универсальность — работает на любых устройствах
  • ✅ Гибкость — можно отправить по любому каналу связи
  • ✅ Мобильность — пользователь может пройти идентификацию на любом устройстве

Ограничения

  • Требуется интернет-соединение
  • Зависит от времени жизни ссылки
  • Пользователь должен перейти по ссылке вручную