Person: назначение и работа в Workflow¶
Person (персона) — профиль физического лица внутри организации. Он объединяет идентификаторы пользователя, фотографии, статус верификации и связанные сессии Workflow.
Person нужен для повторных обращений: клиентская система находит знакомого пользователя, передаёт его идентификатор в новую сессию и может использовать сохранённую фотографию или подходящие результаты прошлых проверок. Это сокращает повторный ввод данных и число повторных запросов к источникам.
Этот раздел состоит из трёх статей:
- Назначение и работа в Workflow — текущая статья.
- Фотографии и верификация — выбор эталона, Face2Face и временная фотография.
- Person Integration API — управление профилем, алиасами и фотографиями из вашей системы.
Что хранится в профиле¶
| Данные | Для чего нужны |
|---|---|
| UUID персоны | Адресация профиля в API |
| Алиасы | Поиск по ИИН, номеру документа, телефону или идентификатору вашей системы |
| Фотографии | Сохранённые изображения и основная фотография для Face2Face |
is_verified |
Статус верификации профиля |
| Связанные сессии | История проверок и источник результатов для повторного использования |
| История действий | Создание и изменение профиля, работа с алиасами и фотографиями |
Каждый профиль принадлежит одной организации. Поиск и операции API ограничены организацией, к которой относится ключ.
Наличие Person и is_verified=true не подтверждают успех новой попытки. Бизнес-решение принимайте по результату текущей сессии, учитывая причины отказа.
Алиасы¶
Алиас — значение, по которому можно найти персону. Одна персона может иметь несколько алиасов.
| Тип в API | Назначение |
|---|---|
SYSTEM_ID |
Автоматически созданный системный идентификатор; нельзя создать или удалить через Integration API |
CUSTOM |
Идентификатор клиента в вашей системе |
PHONE |
Телефон, в том числе из E-Document |
PERSONAL_NUMBER |
ИИН или другой персональный номер |
DOCUMENT_NUMBER |
Номер документа |
Типы чувствительны к регистру. Значение алиаса уникально внутри организации независимо от типа. Для связи с Workflow передаётся только значение, без типа.
Поиск для Workflow и точное получение через API используют активные алиасы. Устаревший алиас не становится доступным для точного поиска при include_expired=true: этот параметр расширяет состав возвращаемого профиля. Подробности — в API чтения.
Если при автоматическом поиске извлечённые алиасы относятся к нескольким персонам, система не объединяет эти профили автоматически: обработка Person завершается конфликтом. Используйте устойчивый уникальный идентификатор вашей системы и проверяйте соответствие алиасов.
Как профиль появляется и обновляется¶
Профиль можно создать через Integration API или получить автоматически из результатов Workflow.
При штатном завершении сессии со статусом FINISHED, если у Workflow есть конфигурация Person, запускается фоновая обработка:
- Система использует найденную при старте персону либо ищет профиль по алиасам из результатов и metadata.
- Если профиль найден, дополняет его данными и связывает с сессией.
- Если профиль не найден и сбор включён, создаёт персону из доступных данных. Без извлечённых данных профиль не создаётся.
- Добавляет алиасы и фотографии с учётом правил устранения повторов.
- Обновляет статус верификации и выбирает основную фотографию.
Обработка асинхронная: завершение Workflow и появление обновлённого профиля могут происходить в разное время. Для создания требуется подходящая подписка Person с доступным лимитом.
Источники данных¶
| Источник | Что попадает в Person |
|---|---|
| E-Document | ИИН, номер документа, телефон и фотография DIGITAL, если они присутствуют в результате |
| Document Recognition | Персональный номер, номер документа и фотография SCAN |
| PPS | ИИН и доступные фотографии DIGITAL из успешного оригинального результата со статусом VALID |
| Liveness | Лучший кадр LIVE успешной проверки |
metadata.person.alias |
Алиас CUSTOM |
| Ручное управление | Алиасы и фотографии, добавленные через API или кабинет |
Для фотографий учитывается источник результата, поэтому одинаковый тип не означает, что изображения дублируют друг друга. Для PPS сохраняются отдельные фотографии одного результата; повторная обработка того же изображения не создаёт копию.
Новый оригинальный PPS с фотографиями переводит предыдущие активные фотографии PPS в историю с причиной SOURCE_REPLACED. Фотографии других источников этим действием не устаревают. Скопированный результат PPS не обновляет профиль как новый источник. Подробности — в жизненном цикле фотографий.
Если у профиля уже есть активный PERSONAL_NUMBER, а PPS вернул другой ИИН, новый алиас PPS не добавляется; конфликт фиксируется в истории. Это правило не является общим автоматическим объединением или исправлением персон.
Связь с новой сессией¶
При создании сессии передайте значение алиаса:
Здесь нужен ключ Workflow. Для прямого управления Person используется ключ организации.
При старте Workflow с Person система ищет профиль по активному алиасу в организации этого Workflow. Найденный профиль используется для повторных проверок. Запрос создания сессии сам по себе не создаёт Person.
Если алиас новый, при завершении сессии профиль может быть найден по другим извлечённым идентификаторам либо создан при включённом сборе. Переданный идентификатор добавляется как CUSTOM, если не конфликтует с существующими данными.
Настройки Person в Workflow¶
Настройки относятся к технологии Person в выбранном Workflow.
| Поле конфигурации | По умолчанию | Поведение |
|---|---|---|
Automatically save personal data |
true |
Разрешает создание новой персоны при обработке завершённой сессии |
Skip person verification |
false |
При автоматическом создании выставляет is_verified=true независимо от Face2Face |
Skip technology with existing Document result |
false |
Разрешает повторное использование подходящих результатов известной персоны |
Saved result validity, days |
null |
Максимальный возраст оригинального результата в днях; при задании — целое число от 1 |
Min days before eDocument expiry |
null |
Запас дней до истечения документа E-Document; при задании — целое число от 0 |
Min days before Document expiry |
null |
Запас дней до истечения документа Document Recognition; при задании — целое число от 0 |
Use person's photo for F2F comparison |
false |
Разрешает использование основной фотографии Person для Face2Face |
Отключение Automatically save personal data запрещает автоматическое создание новых профилей, но не прекращает обновление найденной персоны и привязку завершённой сессии. Поиск, повторное использование результатов и использование фотографии регулируются отдельно.
Skip person verification применяется при создании. Для существующего профиля действуют правила обновления статуса.
Повторное использование результатов¶
При переданном metadata.person.alias и включённом Skip technology with existing Document result система может скопировать результат в новую сессию и пропустить повторное прохождение технологии.
| Технология | Какой результат рассматривается |
|---|---|
| E-Document | Последний успешный оригинальный результат удостоверения личности |
| Document Recognition | Последний успешный оригинальный результат со статусом SUCCESS |
| PPS | Последний успешный оригинальный результат со статусом VALID из другой связанной сессии |
Результат должен относиться к сессии этой персоны; технология должна входить в текущий Workflow. Для каждой технологии сначала выбирается последний подходящий оригинальный результат, затем проверяются ограничения срока. Если он не подходит, более старые результаты не перебираются.
saved_result_ttl_daysотсчитывается от даты создания оригинального результата. Копирование не продлевает его срок.- При заданном запасе дней дата окончания документа должна быть строго позже сегодняшней даты плюс этот запас. При нулевом запасе документ, истекающий сегодня, не подходит.
- Если проверка срока документа включена, но дату невозможно получить или разобрать, результат не используется.
nullотключает соответствующее ограничение. Ограничения срока документа применяются к E-Document и Document Recognition; к PPS применяется ограничение возраста результата.
Наличие Person или фотографии не позволяет пропустить произвольную технологию: этот механизм реализован для трёх источников из таблицы. Liveness и Face2Face выполняются по правилам текущего Workflow.
Срок сохранённого результата и срок временной фотографии — разные настройки. Наличие временной фотографии само по себе не включает и не отключает повторное использование PPS.
Сценарий повторного обращения¶
- Найдите профиль через Integration API или используйте сохранённый алиас.
- Выберите Workflow с нужным набором проверок и настройками Person.
- Создайте отдельную сессию с
metadata.person.alias. - Запустите её через Remote, Widget или WebView.
- Получите результат сессии; при необходимости используйте webhooks для обработки событий.
- Получите обновлённый профиль с учётом фоновой обработки.
Для сценария с изменившейся внешностью перейдите к временной фотографии. Для запросов управления профилем — к Person Integration API.