> For the complete documentation index, see [llms.txt](https://docs.iexexchanger.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.iexexchanger.com/guide/integracii/kyc-servisy.md).

# KYC сервисы

Раздел «KYC сервисы» используется для подключения и настройки способов проверки личности клиента.

Простыми словами: здесь администратор создаёт сервис, через который клиент будет проходить KYC. Проверка может быть ручной, когда документы смотрит администратор, или автоматической, когда данные отправляются во внешний сервис.

Путь в панели управления: **«Утилиты» — «KYC сервисы»**

***

### Что такое KYC сервис

KYC сервис — это конкретная настройка проверки личности на базе выбранного провайдера.

Важно не путать:

<table><thead><tr><th width="246.171875">Понятие</th><th>Описание</th></tr></thead><tbody><tr><td>Провайдер</td><td>Тип проверки: Manual, SumSub, ID.World, Identomat</td></tr><tr><td>Сервис</td><td>Конкретная настройка на базе провайдера</td></tr></tbody></table>

Например, можно создать несколько сервисов на одном провайдере:

<table><thead><tr><th width="281.71484375">Пример сервиса</th><th>Провайдер</th></tr></thead><tbody><tr><td>Ручной KYC</td><td>Manual</td></tr><tr><td>SumSub Production</td><td>SumSub</td></tr><tr><td>SumSub Test</td><td>SumSub</td></tr><tr><td>Identomat основной</td><td>Identomat</td></tr></tbody></table>

Это удобно, если нужно отдельно держать тестовую и рабочую интеграцию.

***

## Доступные провайдеры

В системе доступны следующие провайдеры KYC:

| Провайдер | Назначение                                 |
| --------- | ------------------------------------------ |
| Manual    | Ручная проверка документов администратором |
| SumSub    | Автоматическая проверка через SumSub       |
| ID.World  | Автоматическая проверка через ID.World     |
| Identomat | Автоматическая проверка через Identomat    |

## Что отображается на странице

На странице «KYC сервисы» отображается список всех созданных сервисов.

В таблице есть следующие колонки:

<table><thead><tr><th width="217.75390625">Колонка</th><th>Описание</th></tr></thead><tbody><tr><td>Сервис</td><td>Название созданного KYC сервиса</td></tr><tr><td>Провайдер</td><td>На базе какого провайдера работает сервис</td></tr><tr><td>Создано</td><td>Дата создания сервиса</td></tr><tr><td>Обновлено</td><td>Дата последнего изменения</td></tr><tr><td>Статус</td><td>Включён сервис или отключён</td></tr><tr><td>Действия</td><td>Дополнительные действия по сервису</td></tr></tbody></table>

***

## Статус сервиса

У каждого сервиса есть переключатель статуса.

| Статус   | Что означает                                                              |
| -------- | ------------------------------------------------------------------------- |
| Включён  | Сервис активен и может использоваться для KYC                             |
| Выключен | Сервис хранится в системе, но не должен использоваться для новых проверок |

<mark style="color:red;">Важно: если отключить единственный активный KYC-сервис, клиенты могут потерять возможность пройти проверку личности. Перед отключением проверьте, какой сервис выбран в основных настройках KYC.</mark>

***

## Добавление KYC сервиса

Чтобы создать новый сервис:

1. Откройте **«Утилиты» — «KYC сервисы».**
2. Нажмите **«Добавить сервис».**
3. Укажите название сервиса.
4. Выберите провайдера.
5. Укажите статус: включён или выключен.
6. Нажмите «Добавить KYC сервис».

***

### Поля при создании

| Поле             | Описание                                                                 |
| ---------------- | ------------------------------------------------------------------------ |
| Название сервиса | Понятное имя сервиса, например `SumSub Production` или `Ручная проверка` |
| Провайдер        | Драйвер, на базе которого будет создан сервис                            |
| Статус           | Включить сервис сразу или оставить отключённым                           |

После создания система подготавливает место для параметров подключения.

Для Manual дополнительные ключи не нужны.\
Для внешних провайдеров после создания нужно открыть сервис и заполнить параметры подключения.

***

## Редактирование сервиса

Чтобы изменить сервис, нажмите на его название в таблице.

В окне редактирования можно изменить:

<table><thead><tr><th width="298.015625">Параметр</th><th>Описание</th></tr></thead><tbody><tr><td>Название сервиса</td><td>Отображаемое имя сервиса</td></tr><tr><td>Статус</td><td>Включён или выключен</td></tr><tr><td>Параметры подключения</td><td>Ключи, токены и другие данные провайдера</td></tr><tr><td>Дополнительные настройки</td><td>Если они предусмотрены выбранным провайдером</td></tr><tr><td>Конструктор формы</td><td>Только для Manual-сервиса</td></tr></tbody></table>

После сохранения изменения применяются сразу.

## Параметры подключения

Параметры подключения зависят от выбранного провайдера.

{% stepper %}
{% step %}

### Manual

Для ручного KYC параметры подключения не требуются.

Manual-сервис используется для ручной проверки документов администратором.
{% endstep %}

{% step %}

### SumSub

Для SumSub доступны следующие параметры:

<table><thead><tr><th width="268.4375">Поле</th><th>Описание</th></tr></thead><tbody><tr><td>Access Token</td><td>Токен доступа SumSub</td></tr><tr><td>Access Secret</td><td>Секретный ключ SumSub</td></tr><tr><td>Level Name</td><td>Название уровня проверки в SumSub</td></tr><tr><td>ExternalUserId Prefix</td><td>Префикс для внешнего ID пользователя</td></tr><tr><td>Fresh seconds</td><td>Время актуальности сессии или токена в секундах</td></tr></tbody></table>

Пример названия сервиса: SumSub Production или SumSub Test.
{% endstep %}

{% step %}

### ID.World

Для ID.World доступны следующие параметры:

<table><thead><tr><th width="214.06640625">Поле</th><th>Описание</th></tr></thead><tbody><tr><td>API Key</td><td>Ключ доступа ID.World</td></tr><tr><td>Timeout</td><td>Время ожидания ответа от сервиса</td></tr><tr><td>Fresh seconds</td><td>Время актуальности сессии или токена в секундах</td></tr></tbody></table>
{% endstep %}

{% step %}

### Identomat

Для Identomat доступны следующие параметры:

<table><thead><tr><th width="267.19921875">Поле</th><th>Описание</th></tr></thead><tbody><tr><td>Поле</td><td>Описание</td></tr><tr><td>Company Key</td><td>Ключ компании</td></tr><tr><td>Secret Key</td><td>Секретный ключ</td></tr><tr><td>Allowed Document Countries</td><td>Разрешённые страны документов через запятую</td></tr><tr><td>Allowed Document Types</td><td>Разрешённые типы документов через запятую</td></tr><tr><td>Fresh seconds</td><td>Время актуальности сессии или токена в секундах</td></tr></tbody></table>
{% endstep %}
{% endstepper %}

***

## Защита секретных данных

Секретные поля хранятся защищённо.

Если секретный ключ уже был заполнен, система не показывает его открытым текстом.

Правила работы с секретными полями:

| Ситуация                                | Что делать                              |
| --------------------------------------- | --------------------------------------- |
| Ключ уже заполнен и менять его не нужно | Оставьте поле пустым                    |
| Нужно заменить ключ                     | Введите новый ключ и сохраните          |
| Нужно проверить, заполнен ли ключ       | Система покажет, что параметр уже задан |

Это защищает токены и секретные ключи от случайного просмотра.

## Действия сервиса

У каждого сервиса есть меню действий.

<table><thead><tr><th width="197.77734375">Действие</th><th>Описание</th></tr></thead><tbody><tr><td>Заявки</td><td>Открывает список KYC-заявок по выбранному сервису</td></tr><tr><td>Логи</td><td>Открывает журнал событий выбранного сервиса</td></tr><tr><td>Конструктор</td><td>Доступен для Manual-сервиса и открывает настройку ручной формы</td></tr><tr><td>Удалить</td><td>Удаляет KYC-сервис</td></tr></tbody></table>

***

## Заявки

Кнопка «Заявки» открывает список KYC-заявок, связанных с выбранным сервисом.

Этот раздел помогает посмотреть:

<table><thead><tr><th width="298.19140625">Что можно проверить</th><th>Описание</th></tr></thead><tbody><tr><td>Кто проходил проверку</td><td>Пользователи, которые запускали KYC через этот сервис</td></tr><tr><td>Какие заявки созданы</td><td>Все попытки проверки</td></tr><tr><td>Какие заявки ожидают проверки</td><td>Актуальные ручные или незавершённые проверки</td></tr><tr><td>Какие проверки завершены</td><td>Одобренные, отклонённые или ошибочные проверки</td></tr></tbody></table>

Например, если открыть заявки у сервиса «Ручной», будут показаны KYC-заявки, которые проходили через ручную проверку.

***

## Конструктор ручной формы

Кнопка **«Конструктор»** доступна только у сервиса с провайдером Manual.

Через конструктор настраивается форма, которую клиент заполняет при ручной проверке личности.

В конструкторе можно настроить:

<table><thead><tr><th width="237.55078125">Настройка</th><th>Описание</th></tr></thead><tbody><tr><td>Название формы</td><td>Заголовок формы</td></tr><tr><td>Описание формы</td><td>Пояснение для клиента</td></tr><tr><td>Список полей</td><td>Какие данные нужно запросить</td></tr><tr><td>Порядок полей</td><td>В каком порядке они отображаются</td></tr><tr><td>Обязательность</td><td>Какие поля клиент обязан заполнить</td></tr><tr><td>Подсказки</td><td>Помощь клиенту при заполнении</td></tr><tr><td>Фото</td><td>Какие изображения нужно загрузить</td></tr></tbody></table>

***

### Типы элементов формы

<table><thead><tr><th width="205.85546875">Тип</th><th>Для чего используется</th></tr></thead><tbody><tr><td>Поле ввода</td><td>Обычное текстовое поле, например Ф.И.О.</td></tr><tr><td>Описание</td><td>Текстовый блок с пояснением</td></tr><tr><td>Фото</td><td>Загрузка изображения, например паспорта или селфи</td></tr></tbody></table>

***

### Настройки одного поля

<table><thead><tr><th width="286.015625">Настройка</th><th>Описание</th></tr></thead><tbody><tr><td>Ключ поля</td><td>Внутреннее имя поля</td></tr><tr><td>Тип поля</td><td>Текст, описание или фото</td></tr><tr><td>Название поля</td><td>Название, которое увидит клиент</td></tr><tr><td>Подсказка внутри поля</td><td>Пример или подсказка в поле</td></tr><tr><td>Описание под полем</td><td>Дополнительное пояснение</td></tr><tr><td>Обязательное поле</td><td>Без него клиент не сможет отправить форму</td></tr><tr><td>Форматы фото</td><td>Разрешённые форматы изображений</td></tr><tr><td>Макс. размер, МБ</td><td>Максимальный размер файла</td></tr></tbody></table>

Поля можно перетаскивать и менять их порядок.

***

### Стандартная ручная форма

Если для Manual-сервиса ещё нет формы, система может использовать стандартный набор полей:

| Поле                           | Что просит у клиента       |
| ------------------------------ | -------------------------- |
| Ф.И.О                          | Фамилия, имя и отчество    |
| Фото или скан паспорта         | Изображение документа      |
| Фото с паспортом на фоне сайта | Селфи клиента с документом |

Для фото обычно используются форматы: `jpg`, `jpeg`, `png`.

***

## Как работает ручная проверка

Процесс ручного KYC выглядит так:

1. Клиент открывает форму верификации.
2. Заполняет данные.
3. Загружает необходимые фото.
4. Отправляет заявку.
5. В админке появляется KYC-заявка на проверку.
6. Администратор открывает заявку.
7. Проверяет данные и файлы.
8. Подтверждает или отклоняет проверку.
9. Результат сохраняется в системе.

Если у клиента уже есть KYC-заявка в ожидании, система не должна создавать вторую такую же ожидающую заявку по той же цели проверки.

***

## Удаление сервиса

Сервис можно удалить через кнопку «Удалить».

При удалении:

<table><thead><tr><th width="327.64453125">Что происходит</th><th>Описание</th></tr></thead><tbody><tr><td>Удаляется KYC-сервис</td><td>Сервис исчезает из списка</td></tr><tr><td>Удаляются настройки подключения</td><td>Защищённые параметры сервиса очищаются</td></tr><tr><td>Обновляется состояние KYC</td><td>Система пересчитывает доступные сервисы</td></tr></tbody></table>

Перед удалением важно проверить, используется ли сервис в основных настройках KYC.

Если удалить активный сервис, клиенты могут потерять возможность пройти проверку.

Рекомендуемый порядок:

1. Создайте новый сервис.
2. Настройте его.
3. Подключите его в основных настройках KYC.
4. Проверьте работу на тестовом клиенте.
5. Только после этого удаляйте старый сервис.

***

## Как подключить внешний KYC

Пример подключения SumSub:

1. Откройте **«Утилиты» — «KYC сервисы».**
2. Нажмите **«Добавить сервис».**
3. Укажите название, например SumSub Production.
4. Выберите провайдера SumSub.
5. Включите статус сервиса.
6. Сохраните сервис.
7. Откройте созданный сервис.
8. Заполните Access Token, Access Secret, Level Name и другие параметры.
9. Сохраните изменения.
10. Перейдите в основные настройки верификации личности.
11. Выберите этот сервис как активный.
12. Проверьте прохождение KYC на тестовом клиенте.

## Как настроить ручной KYC

1. Откройте **«Утилиты» — «KYC сервисы».**
2. Убедитесь, что есть сервис с провайдером Manual.
3. Если его нет, нажмите «Добавить сервис».
4. Укажите название, например Ручной KYC.
5. Выберите провайдера Manual.
6. Включите статус.
7. Сохраните сервис.
8. В меню действий нажмите «Конструктор».
9. Настройте форму для клиента.
10. Добавьте нужные поля и фото.
11. Отметьте обязательные поля.
12. Сохраните форму.
13. Перейдите в основные настройки KYC.
14. Выберите ручной сервис для проверки личности.

***

## Связь с основной верификацией личности

Раздел «KYC сервисы» только создаёт и настраивает сервисы.

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

Логика такая:

1. В разделе «KYC сервисы» создаётся сервис.
2. В сервисе заполняются параметры подключения.
3. В основных настройках KYC выбирается активный сервис.
4. Клиент проходит проверку.
5. Результаты появляются в KYC-заявках и логах.

Если сервис создан, но нигде не выбран, он просто хранится в системе и не используется клиентами.

***

## Что проверить перед изменением сервиса

Перед изменением, отключением или удалением сервиса проверьте:

<table><thead><tr><th width="305.73046875">Что проверить</th><th>Почему важно</th></tr></thead><tbody><tr><td>Включён ли сервис</td><td>Чтобы понимать, используется ли он сейчас</td></tr><tr><td>Выбран ли он в настройках KYC</td><td>Чтобы не отключить активную проверку</td></tr><tr><td>Есть ли по нему заявки</td><td>Чтобы не потерять рабочий процесс</td></tr><tr><td>Есть ли ошибки в логах</td><td>Чтобы понять, корректно ли работает сервис</td></tr><tr><td>Заполнены ли ключи</td><td>Для внешних провайдеров без ключей проверка не заработает</td></tr><tr><td>Есть ли тестовая проверка</td><td>Перед запуском в работу лучше проверить на тестовом клиенте</td></tr></tbody></table>

***

## Частые проблемы

<table><thead><tr><th width="320.09375">Проблема</th><th>Что проверить</th></tr></thead><tbody><tr><td>Проблема</td><td>Что проверить</td></tr><tr><td>Клиент не может пройти KYC</td><td>Включён ли сервис и выбран ли он в основных настройках</td></tr><tr><td>Сервис создан, но не используется</td><td>Возможно он не выбран в настройках верификации личности</td></tr><tr><td>Внешний KYC не запускается</td><td>Проверьте токены, ключи и параметры подключения</td></tr><tr><td>SumSub возвращает ошибку</td><td>Проверьте Access Token, Access Secret и Level Name</td></tr><tr><td>Не отображается конструктор</td><td>Конструктор доступен только для Manual-сервиса</td></tr><tr><td>Ручная форма не отправляется</td><td>Проверьте обязательные поля и настройки загрузки фото</td></tr><tr><td>После отключения KYC не работает</td><td>Возможно был отключён единственный активный сервис</td></tr><tr><td>Старый секретный ключ не виден</td><td>Это нормально: секретные поля скрываются</td></tr></tbody></table>
