К содержимому
OneKYC
Tenant API (KYC)

Аудит

Обновлено:

Tenant API предоставляет доступ к журналу аудита тенанта, содержащему записи обо всех действиях пользователей, изменениях конфигурации и операциях, выполненных через API. Требуемый scope: audit:read.

Получение записей аудита

GET
/v1/kyc/audit

Authorization

ApiKeyAuth
headerAuthorization<token>

HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.

Query Parameters

page?integer

Page (default 1)

page_size?integer

Page size (1-100, default 50)

action?string

Filter by action

actorId?string

Filter by actor UUID

dateFrom?string

From (RFC3339)

dateTo?string

To (RFC3339)

Header Parameters

X-Timestamp*string

Unix timestamp (seconds, max 5 min drift)

Response Body

Paged audit log items

*/*
  1. response
data?array<>
pagination?
success?boolean
Example Request
curl -X GET 'https://api.onekyc.io/tenant/v1/kyc/audit' \  -H 'X-Timestamp: string'
Example Response
{  "pagination": {    "page": 0,    "page_size": 0,    "total_items": 0,    "total_pages": 0  },  "success": true,  "data": [    {      "action": "string",      "actor_email": "string",      "actor_id": "string",      "actor_type": "string",      "created_at": "string",      "details": {        "changes": [          "string"        ],        "metadata": {          "property1": null,          "property2": null        },        "new_value": {          "property1": null,          "property2": null        },        "old_value": {          "property1": null,          "property2": null        }      },      "id": "string",      "resource_id": "string",      "resource_type": "string",      "tenant_id": "string"    }  ]}

Типы событий аудита

События классифицируются по типам ресурсов.

Сессии верификации

СобытиеОписание
session.createdСоздание сессии
session.startedНачало прохождения сессии
session.approvedОдобрение верификации
session.rejectedОтклонение верификации
session.expiredИстечение срока действия сессии

Ревью

СобытиеОписание
review.assignedНазначение задачи оператору
review.startedНачало проверки оператором
review.decidedПринятие решения по ревью

Флоу (сценарии верификации)

СобытиеОписание
flow.createdСоздание флоу
flow.updatedОбновление флоу
flow.clonedКлонирование флоу (создание копии)
flow.archivedАрхивирование флоу
flow.country_filter_changedИзменение фильтра стран в шаге country_select
flow.deletedУдаление флоу

API-ключи

СобытиеОписание
api_key.createdСоздание ключа
api_key.updatedОбновление параметров ключа (scope, имя, лимиты)
api_key.rotatedРотация секрета ключа
api_key.revokedОтзыв ключа
api_key.deletedУдаление ключа

Пользователи

СобытиеОписание
user.createdСоздание учётной записи
user.updatedОбновление учётной записи
user.deletedУдаление учётной записи
user.loginВход в систему
user.logoutВыход из системы
user.login_failedНеудачная попытка входа
user.password_changedИзменение пароля
user.password_resetСброс пароля администратором

Команда (роли и приглашения)

СобытиеОписание
team.invite_createdСоздание приглашения в команду
team.invite_resentПовторная отправка приглашения
team.invite_deletedУдаление приглашения
team.member_removedУдаление участника из команды
team.role_changedИзменение роли участника
team.permissions_changedИзменение тонких прав участника

Настройки и тенант

СобытиеОписание
settings.updatedИзменение настроек
tenant.createdСоздание тенанта
tenant.updatedОбновление тенанта
tenant.suspendedПриостановка тенанта
tenant.blockedБлокировка тенанта
tenant.unblockedРазблокировка тенанта
tenant.deletedУдаление тенанта
tenant.force_logoutПринудительный выход всех пользователей

Аппликанты и компании (KYC/KYB)

СобытиеОписание
applicant.createdСоздание аппликанта
applicant.updatedОбновление данных аппликанта
applicant.deletedУдаление аппликанта
business.deletedУдаление компании (KYB)

Документы и медиа

СобытиеОписание
document.uploadedЗагрузка документа
document.requestedОператор запросил повторную загрузку
document.deletedУдаление документа
selfie.uploadedЗагрузка селфи

Вебхуки

СобытиеОписание
webhook.configuredНастройка вебхука (общие параметры)
webhook.endpoint_createdСоздание endpoint
webhook.endpoint_updatedОбновление endpoint
webhook.endpoint_deletedУдаление endpoint
webhook.secret_rotatedРотация секрета endpoint
webhook.test_sentОтправка тестового вебхука
webhook.deliveredУспешная доставка вебхука
webhook.failedОшибка доставки вебхука

Ссылки верификации

СобытиеОписание
verification_link.createdСоздание ссылки верификации
verification_link.activatedАктивация ссылки заявителем
verification_link.sentОтправка ссылки (email / SMS)
verification_link.duplicatedСоздание копии ссылки
verification_link.bulk_actionМассовое действие над ссылками
verification_link.revokedОтзыв ссылки

Сессии (управление в админке)

СобытиеОписание
session.pausedСессия приостановлена оператором
session.resumedСессия возобновлена оператором
session.cancelledСессия отменена оператором
session.deletedСессия удалена
session.exportedЭкспорт данных сессии

Ручное ревью (расширенные действия)

СобытиеОписание
review.unassignedСнятие назначения с задачи ревью
review.priority_updatedИзменение приоритета задачи
review.comment_addedДобавлен комментарий к задаче
review.resubmit_requestedЗапрошена повторная загрузка шага у заявителя
review.resubmit_cancelledОтмена запроса на повторную загрузку

Прочее

СобытиеОписание
data.exportedЭкспорт данных
deletion_request.createdСоздан запрос на удаление данных
deletion_request.cancelledЗапрос на удаление отменён

Структура записи аудита

Каждая запись содержит следующие поля:

ПолеОписание
idUUID записи аудита
tenant_idUUID тенанта
actor_typeТип актора: admin_user, superadmin_user (действия со стороны OneKYC support), api_key, system, applicant
actor_idUUID актора (или null для системных событий)
actor_emailАдрес электронной почты актора (при наличии)
actionТип события (см. перечень выше)
resource_typeТип ресурса: session, applicant, document, selfie, flow, api_key, user, tenant, webhook, review
resource_idUUID ресурса
detailsОбъект с детальной информацией об изменениях
created_atВремя события (ISO 8601)

Структура объекта details

ПолеОписание
old_valueПредыдущие значения (для операций обновления)
new_valueНовые значения (для операций обновления)
changesПеречень изменённых полей
metadataДополнительный контекст (IP-адрес, идентификатор сессии и т.д.)

Срок хранения записей

Срок хранения записей аудита определяется параметром data_retention_days в тарифном плане тенанта (поле billing-плана). По истечении срока записи автоматически удаляются.

Для долгосрочного архивирования используйте периодический экспорт данных через GET /v1/kyc/audit с фильтром по диапазону created_at.

Дополнительные сведения

  • Выше приведены наиболее распространённые типы действий. Полный перечень доступен в разделе Аудит административной панели (фильтр по полю «Действие»).
  • Удаление записей аудита через API невозможно — доступно только чтение.
  • Действия, выполненные через Tenant API, фиксируются с actor_type = "api_key".
  • Действия, выполненные службой поддержки OneKYC, фиксируются с actor_type = "superadmin_user".
  • Конфиденциальные данные (пароли, секреты ключей) никогда не включаются в поле details.
  • Для мониторинга событий в реальном времени используйте WebSocket-подключение в административной панели.

Полная спецификация формата данных приведена в Справочнике API (OpenAPI).

Метрики и аналитика

Назад

Ошибки и ограничения

Далее

На этой странице

Получение записей аудитаТипы событий аудитаСессии верификацииРевьюФлоу (сценарии верификации)API-ключиПользователиКоманда (роли и приглашения)Настройки и тенантАппликанты и компании (KYC/KYB)Документы и медиаВебхукиСсылки верификацииСессии (управление в админке)Ручное ревью (расширенные действия)ПрочееСтруктура записи аудитаСтруктура объекта detailsСрок хранения записейДополнительные сведения