# Аппликанты

Аппликант — это пользователь, проходящий или прошедший процедуру верификации. Tenant API предоставляет возможность получения списка аппликантов, детальных данных по отдельному аппликанту, результатов верификации и AML-скрининга, а также списка документов. Для доступа к эндпоинтам требуются соответствующие scopes API-ключа.

## Список аппликантов [#список-аппликантов]

Эндпоинт возвращает постраничный список аппликантов с поддержкой фильтрации по статусу, дате создания и внешнему идентификатору. Требуемый scope: **applicants:read**.

API operations:

- `GET /v1/kyc/applicants`

## Получение аппликанта по идентификатору [#получение-аппликанта-по-идентификатору]

Возвращает полные данные аппликанта по его внутреннему идентификатору (UUID). Требуемый scope: **applicants:read**.

API operations:

- `GET /v1/kyc/applicants/{applicant_id}`

## Получение аппликанта по внешнему идентификатору [#получение-аппликанта-по-внешнему-идентификатору]

Позволяет найти аппликанта по внешнему идентификатору (`external_id`), переданному при создании ссылки верификации. Требуемый scope: **applicants:read**.

API operations:

- `GET /v1/kyc/applicants/external/{external_id}`

## Сессии верификации аппликанта [#сессии-верификации-аппликанта]

Возвращает список всех сессий верификации, связанных с аппликантом. Требуемый scope: **applicants:read**.

API operations:

- `GET /v1/kyc/applicants/{applicant_id}/sessions`

## История аппликанта [#история-аппликанта]

Возвращает хронологический журнал событий, связанных с аппликантом (создание, обновление статуса, результаты проверок). Требуемый scope: **applicants:read**.

API operations:

- `GET /v1/kyc/applicants/{applicant_id}/history`

## Результат верификации [#результат-верификации]

Возвращает итоговый результат верификации аппликанта, включая статус решения,
детали проверок и контактные поля (`email`, `phone`) из записи аппликанта.
Детали проверок включают нормализованные блоки `ocr`, `doc_liveness`,
`face_liveness` и `face_match`, если соответствующие проверки присутствуют.
Требуемый scope: **verifications:read**.

API operations:

- `GET /v1/kyc/applicants/{applicant_id}/verification`

## Результат AML-скрининга [#результат-aml-скрининга]

Возвращает результаты проверки аппликанта по санкционным спискам и базам PEP (при наличии шага AML в сценарии верификации). Требуемый scope: **verifications:read**.

API operations:

- `GET /v1/kyc/applicants/{applicant_id}/aml`

## Документы аппликанта [#документы-аппликанта]

Возвращает список документов, загруженных аппликантом в рамках верификации.
Если доступны OCR-данные, `extracted_data` включает стандартные поля документа
и `extended_data` для дополнительных нормализованных OCR-полей от провайдера.
Требуемый scope: **documents:read**.

API operations:

- `GET /v1/kyc/applicants/{applicant_id}/documents`

## Удаление данных аппликанта [#удаление-данных-аппликанта]

Создаёт запрос на удаление данных аппликанта, включая документы, селфи и результаты верификации, в соответствии с требованиями GDPR. Фактическое удаление выполняется только после подтверждения OneKYC; после подтверждения удаление необратимо. Требуемый scope: **applicants:write**.

API operations:

- `DELETE /v1/kyc/applicants/{applicant_id}`

---

Полная спецификация полей, коды ошибок и примеры запросов приведены в [Справочнике API (OpenAPI)](/ru/api/api-reference).

## Написание имён и полнота данных [#написание-имён-и-полнота-данных]

Ответы по отдельному аппликанту (по ID, по внешнему ID и детальный просмотр) содержат `full_name`, `middle_name`, `full_name_latin`, `full_name_native` и `full_name_original`, если это поддерживается текущими данными о личности. Латинские варианты формируются только для наблюдаемого текста в латинице; исходные диакритические знаки и национальное написание сохраняются без выдуманной транслитерации. `name_source` указывает результат верификации, шаг и попытку, если имена получены из устаревших проверок документов. Детальный блок `document_details.ocr` сохраняет нормализованные OCR-данные; `extracted_data` документа включает варианты полного имени для этого документа.

Метаданные текущей попытки имеют приоритет над историческими результатами. Новая попытка без результата не может использовать имена или результат AML более ранней попытки. Независимые правки профиля, включая явно пустые поля, имеют приоритет над распознанными частями имени.

Ответы верификации содержат выбранный `session_id`; каждая проверка включает `verification_id`, `step_id`, `attempt_number`, `rejection_reasons` и безопасный типизированный контракт (включая `aml`). Эндпоинт верификации по умолчанию по-прежнему выбирает завершённые сессии. Отдельный ответ AML также содержит корреляцию с источником и типизированный контракт `aml`. Публичные контракты не включают необработанные записи провайдеров и тексты ошибок.

`enrichment` профиля — это асинхронная сводка **на уровне аппликанта**, не зависящая от конкретной сессии верификации. Известные нулевые оценки и счётчики, а также флаги `false` сохраняются. Недоступное необязательное чтение даёт сводку `unavailable` и `enrichment_errors`; отсутствующее обогащение остаётся отсутствующим. Сбои чтения имён обозначаются `name_evidence_unavailable` или `name_attempts_unavailable`, а недоступная идентичность коллекции — `collection_identity_unavailable`.

Ответы по документам содержат известные `session_id` и `step_id` для устаревших записей и записей коллекций. `extracted_data.ocr` содержит полный нормализованный результат распознавания только если он относится именно к этому файлу, клиенту, сессии, шагу и попытке; документы коллекции используют собственное распознавание, привязанное к ревизии. Портреты и геометрия не включаются. Отсутствующая связь с файлом не позволяет заимствовать OCR другого документа.

Если текущий результат OCR содержит имя и фамилию, но не содержит буквального полного имени, отображаемое имя профиля составляется из этих частей той же попытки по тому же документу. Отсутствующая часть имени или транслитерация никогда не додумываются.